Andreas Meyer
30c63fee12
* cosmetic change: underline postconditions, instead of printing them
...
emphasized (can be better distinguished then, from usual \ccc stuff)
* bug fix: macro \lciCloseCommentHeadingTable is now globally defined
by default, and clears itself after usage
2007-03-08 13:56:56 +00:00
Andreas Meyer
8446e48d35
\ccPrecond: use instead of " " to indicate whitespace
2007-03-01 13:59:40 +00:00
Andreas Meyer
09e6b8cb5b
now, the whole text after each \ccPrecond,\ccPostcond and \ccRequire
...
is formatted as follows:
Precondition: bla text
blubb more text
Postcondition: another text
2007-03-01 13:43:33 +00:00
Andreas Meyer
39d20b9f69
html converter layout improvements
...
* wider table
* better utilization of middle column in 3-column-layout
* if no text appears before \ccPrecond, no html linebreak is inserted before it
2007-03-01 00:43:58 +00:00
Sylvain Pion
572ccc4617
Add some ALT to some IMG for LaTeX math symbols
2007-02-28 18:48:22 +00:00
Andreas Meyer
0bb7072412
fixed ccReferToExampleCode (can be used now also
...
in captions)
2007-02-28 00:03:46 +00:00
Andreas Meyer
8271c9fa95
tex2doxy: added
...
* logging with verbosity levels
* cmdline parsing (doxy and tex xml filenames)
2007-02-27 22:53:21 +00:00
Andreas Meyer
46f90ca21a
tex2doxy: normalize function names even more. substitute
...
template parameters by $0...n to work around different spellings
(like ForwardIter and ForwardIterator).
2007-02-26 00:42:52 +00:00
Andreas Meyer
8c972cf9b6
now tex2doxy is immune against different spellings in
...
doc_tex and actual code (regarding function parameters).
before comparing declaration-strings, they are normalized:
* variable names and default values are eliminated
* spaces are compressed/removed
* function argument types can be (nested) template parameters,
pointers and arrays (not mixed with "(" and ")", however)
2007-02-25 20:38:57 +00:00
Andreas Meyer
1894f1146b
now tex2doxy can find for each doc_tex struct/class memberfunction,
...
the corresponding doxygen memberfunction. this demonstrates that
(semi)automatic conversion is feasible.
2007-02-23 22:59:44 +00:00
Andreas Meyer
394579f4f8
introduced an internal switch to select alignment of pkg illustration
...
with rest of pkg description. can be one of
(1) align pic with heading
(2) align pic with summary text (which is now default)
2007-02-22 17:08:21 +00:00
Andreas Meyer
5a74125fd9
html bugfix: now for small displays, the terms "user manual"
...
and "reference manual" are properly aligned in the TOC
2007-02-22 13:45:47 +00:00
Andreas Meyer
bbcde1bf03
removed leftover debug output from cc_anchor_filter
2007-02-22 11:27:49 +00:00
Andreas Meyer
1ab0999859
made the table dimensions less claustrophobic:
...
now there are 850 pixels of width
(most displays have 1024 pixels width nowadays)
2007-02-20 23:05:45 +00:00
Andreas Meyer
b2465c2b82
* bugfix: put long parameter lists on seperate lines, also for operators
...
(previously, only functions and constructors had this feature)
* added rule to install tex2doxy script
* removed duplicate -g in Makefile
2007-02-20 22:12:23 +00:00
Andreas Meyer
71ce100e52
added conversion script doc_tex -> doxygen. currently, it can
...
read in xml files from our tools and from doxygen and list
some interesting features (classes, functions, their locations in c++ code,
their current documentation etc)
2007-02-20 13:47:13 +00:00
Andreas Meyer
7e670c317b
* switched to xml output for comments (makes transition easier from
...
doc_tex to doxygen)
* bugfix (html): made footnotes always appear _after_ alphabetical list of refpages
* bugfix: ccReferToExampleCode is now typeset in alltt
2007-02-20 12:30:06 +00:00
Andreas Meyer
b7d4b4accb
minor bugfix: "long long int" is now properly crosslinked
...
(before, only one space was accepted between words)
2007-02-15 10:31:51 +00:00
Andreas Meyer
283f74d6ac
another step towards doc_tex->doxygen :
...
a file comments.txt is now written by the html converter, that contains
all interesting comment for code related items (methods, variables,
constructors etc)
2007-02-14 15:59:18 +00:00
Andreas Meyer
02e62927f8
first step towards doc_tex->doxygen converter
2007-02-13 10:06:33 +00:00
Laurent Saboret
cd1af6ed5b
Version 0.7.4
2007-02-09 09:59:00 +00:00
Andreas Meyer
40b99417e8
* replaced two-colored with only white background for pkgdesc table
...
* better alignment for pkgdesc images
2007-02-08 16:57:38 +00:00
Andreas Meyer
90b0f7534a
another \bgl, \boost fix
2007-02-07 09:37:29 +00:00
Andreas Meyer
c372d00e0e
moved \boost and \bgl into cc_manual.sty
2007-02-06 15:44:43 +00:00
Andreas Meyer
8ecba2df95
* moved command \bgl out of manual into style file
...
* new command \ccReferToExampleCode
2007-02-06 15:26:40 +00:00
Andreas Meyer
92b4520e93
package description:
...
useless alt="Package Illustration" replaced by
more informative alt="\ccNameOfPackage Illustration"
2007-02-05 10:24:58 +00:00
Andreas Meyer
bca23f0c4e
reorganized \gmp, \mpfr, \lidia etc (are now
...
located in cgal_manual.sty)
2007-02-02 14:30:47 +00:00
Michael Hemmer
45d93c771b
added macros: \core, \gmp, \lidia, \ntl
2007-01-30 14:15:39 +00:00
Andreas Meyer
7da978268a
treat "long int","signed char" etc as one
...
c++ identifier during crosslinking
2007-01-29 23:11:04 +00:00
Andreas Meyer
b32e716fa4
* minor bugfix: package description rows were not uniformly coloured
...
* another bugfix: chapternames that contain newlines have led to problems with
cc_anchor_filter. hotfix: remove newlines from chapter names during
interpretation of stylefiles. (better would be lexer-level removal ... )
2007-01-26 18:08:46 +00:00
Andreas Meyer
1185d08606
fixed transition from HTML 3.2 to 4.0: there was a bug (badly placed
...
lcRawHtml) which prevented cc_anchor_link to crosslink
2007-01-23 15:48:00 +00:00
Sylvain Pion
529034d574
close an open <div>
2007-01-13 22:49:06 +00:00
Sylvain Pion
cb3aa15683
Pleasing validator:
...
Specify charset of Manual HTML pages.
Move style sheet <link ...> within <head>.
2007-01-13 18:45:05 +00:00
Sylvain Pion
cef6858891
Update DOCTYPE of generated HTML files.
2007-01-07 15:09:27 +00:00
Sylvain Pion
a556581c86
Replace -------------- in HTML comments by ============ to please validator.
2007-01-07 13:01:46 +00:00
Andreas Meyer
81db7fa24d
added "support" for recent versions of flex
...
(just replaced unput by yyunput .. other
workarounds did not quite work)
2006-11-30 16:43:51 +00:00
Andreas Meyer
64063cc156
no eigen-classname removal inside template arguments
2006-11-30 13:11:07 +00:00
Andreas Meyer
b2090ec73c
removed border around pkgdesc illustration
2006-11-15 20:32:04 +00:00
Andreas Meyer
36228459ec
html bugfix: write anchors to packages.html, too
2006-11-03 13:42:54 +00:00
Andreas Meyer
f64f2cc2e3
typo
2006-11-03 13:41:25 +00:00
Andreas Meyer
24057e65a0
bugfix ps/pdf: added \usepackage{footnote}
2006-11-03 12:10:20 +00:00
Andreas Meyer
89073778f5
bug: files actually had XPM content instead of GIF! fixed now.
2006-10-29 20:06:44 +00:00
Andreas Meyer
6c98454150
found another instance of "REG_NOERROR". replaced by "0"
2006-10-26 09:52:08 +00:00
Andreas Meyer
1b3d5f3fa1
replaced non-standard REG_NOERROR with plain "0"
2006-10-25 18:45:10 +00:00
Andreas Meyer
bc3b5ce9d2
package description: align images with package names
2006-10-25 15:53:02 +00:00
Andreas Meyer
a4d2e66a14
bugfix: multiline function declarations with
...
multiparagraph comments now work
2006-10-24 12:56:35 +00:00
Andreas Meyer
2aaa1b2072
renamed pkgdescription.html -> packages.html in Biblio
2006-10-24 12:55:36 +00:00
Andreas Meyer
184904975a
added docu for ccPkgDescription and ccIncludeExampleCode
2006-10-15 21:03:30 +00:00
Andreas Meyer
06ec1b8692
new feature: images for package description page
2006-10-13 10:19:55 +00:00
Andreas Meyer
5ffc1dc158
bugfix: avoid .operator() being displayed in
...
return_type creationvariable.operator()( myargumentlist )
2006-10-12 14:00:43 +00:00
Andreas Meyer
b61e418b88
* added a \slash macro
...
* create a default *.stage_0 file
2006-10-10 16:32:25 +00:00
Andreas Meyer
8f3581a3d3
more pretty layout for ccExampleCode. filename is crosslinked now
2006-08-10 13:53:33 +00:00
Andreas Meyer
c3692fed06
bugfix for " [ #1129 ] wrong hyperlinks "
2006-08-09 13:37:27 +00:00
Andreas Meyer
9e7a24500c
new feature: strip license headers from example code
2006-08-08 17:52:23 +00:00
Andreas Meyer
b454b3febd
manual cleanup:
...
* .C ---> .cpp
* removed ../examples from paths
* moved some demo/example files out of doc_tex into their respective place
* now it should build properly, again
2006-08-07 16:43:09 +00:00
Monique Teillaud
def1447551
files fixed manually to solve the problems existing in CGAL-3.2
...
(dead links and so on)
a more automatic solution will need to be found...
2006-07-12 18:59:12 +00:00
Andreas Meyer
336def5d61
2006-05-22 15:46:59 +00:00
Laurent Rineau
2a9425d72a
Fix permission of biblio files.
...
Reminder: install(1), without -m option, sets permissions to "rwxr-xr-x" (0755)
2006-05-12 09:26:43 +00:00
Andreas Meyer
b6d991ff86
html: less aggressive crosslinking (scope reduction now does not
...
extend beyond manual boundary)
2006-05-08 14:30:13 +00:00
Andreas Meyer
c50ca1575e
html: short toc: removed zebra-effect (not needed here, as opposed to usual toc)
...
chapter names are printed in non-bold-face
2006-05-06 21:50:44 +00:00
Andreas Meyer
8a65006a5f
* bugfix: results of matching string with regular expressions
...
are now stored as immediate strings (and not as references)
fixes the package description bug
* renamed package description to package overview
* more whitespace between navigation items
2006-05-06 20:39:47 +00:00
Andreas Meyer
f0258cfe73
part-labels generate anchors in TOC
2006-05-04 21:05:24 +00:00
Andreas Meyer
a2dfc6c62d
better contrast
2006-05-04 14:35:19 +00:00
Andreas Meyer
2cd8af5d42
bugfix: moved bibtex keys in pkgdesc inside table
2006-05-04 12:19:05 +00:00
Andreas Meyer
f54ea86505
new feature for html: additional short table of contents
...
(some more work was needed for this ...)
2006-05-03 20:18:50 +00:00
Andreas Meyer
807fb759a8
html: new feature: \ccHowToCiteCgal{cgal:bibtexentry}
2006-04-29 20:54:38 +00:00
Andreas Meyer
4913a45a88
* bugfix (author did not show up in package description, occasionally)
...
* toc restructured: user/ref manual are now one chapter. still, they show up
in the toc as two parts of one chapter
2006-04-28 21:10:23 +00:00
Andreas Meyer
919d2a3d7a
ccIntroducedInCGAL, ccChapterAuthor mirrored in pkgdescription
2006-04-26 19:03:33 +00:00
Andreas Meyer
0ae4927cbc
html: bugfix (removed spurious list of refpages)
2006-04-26 11:15:59 +00:00
Andreas Meyer
2d229e22f5
typo
2006-04-25 16:24:43 +00:00
Andreas Meyer
dd305c1e41
html: cosmetic changes/do not show the internal refpagecounter,
...
instead re-use the section-counter
2006-04-25 16:18:30 +00:00
Andreas Meyer
69cec3b48e
html: \ref{somelabel} now also produces the corresponding counter, not
...
only the reference icon
2006-04-25 15:50:17 +00:00
Andreas Meyer
c36e96f605
more contrast
2006-04-18 12:28:50 +00:00
Laurent Saboret
520b0056bf
Undo r30322
2006-04-18 08:54:38 +00:00
Laurent Rineau
1e5895830f
revert r30322 for install.config
2006-04-16 22:46:28 +00:00
Andreas Meyer
0f045097a7
ps/pdf: bugfix for the alph.listofrefpages
2006-04-15 21:48:29 +00:00
Andreas Meyer
c046987bd0
alphabetical list of refpages, now also for ps/pdf
2006-04-15 21:19:19 +00:00
Andreas Meyer
b94b2d1539
html: toc layout
...
ps/pdf: towards per-refchapter alphabetical listofrefpages
2006-04-14 16:48:04 +00:00
Laurent Saboret
312353dd51
Global fix of svn:executable property in trunk
2006-04-14 15:07:17 +00:00
Andreas Meyer
3140d79f0d
even better toc
2006-04-13 18:59:18 +00:00
Andreas Meyer
9102a64ef6
better toc
2006-04-13 18:55:43 +00:00
Andreas Meyer
7546053c6c
bugfix: better crosslinking. refpages with local scope n0w also
...
get crosslinked, if the scope is missing at "citation" site.
fixes the SparseLinearAlgebra::Matrix issue.
2006-04-13 11:33:39 +00:00
Laurent Rineau
0f78a07d85
Install config files with mode 644 (which is rw-r--r--).
2006-04-12 08:35:53 +00:00
Andreas Meyer
9496c9a936
2006-04-11 22:19:56 +00:00
Andreas Meyer
3e9da694df
* new feature: regular expressions (based on posix regex)
...
* bugfix: based on regex, \labels inside sections/chapters etc
are now correctly handled (ie, html-anchors above <h1> etc)
* improved layout for pkgdesc
2006-04-11 22:08:32 +00:00
Andreas Meyer
8349425737
bugfix: removed <I> <BR> and the like from chapter's html-header
2006-04-10 13:02:54 +00:00
Andreas Meyer
c2da512444
temporary hack
2006-04-09 22:16:28 +00:00
Andreas Meyer
94e45ca536
bugfix: labels inside the pkgdescription are now written
...
into the global anchor file (prevents broken links)
2006-04-09 22:03:58 +00:00
Andreas Meyer
c7d88b459d
* parts now also show up in pkgdescription.html
...
(unless the part does not have any package
descriptions defined)
2006-04-09 21:22:36 +00:00
Andreas Meyer
b0ff7176da
* durchgehende numerierung fuer chapter (part-uebergreifend)
...
* huebschere TOC auch mit \entry
2006-04-09 19:44:58 +00:00
Andreas Meyer
86d0b83d7a
name change: ccUnsortedList --> ccRawList
...
(unsorted sounds like a lack of feature...)
bugfix: \subsection* now also splits the table of
raw refpage entries
2006-04-09 12:39:24 +00:00
Andreas Meyer
42e6785743
reorganization & improved pkgdescr layout slightly
2006-04-08 18:26:30 +00:00
Andreas Meyer
80b7aa50ed
ccRef: at least print the part within [], if label is not defined
2006-04-08 12:16:10 +00:00
Andreas Meyer
532a2eb5f9
bugfix: no nested <a href..><a href..> anymore
...
introduced \section{Alphabetic listofregpage} again
2006-04-08 10:01:46 +00:00
Andreas Meyer
2e703e3248
new feature: alphabetically sorted list of refpages
...
new feature(internal): sorted maps for the latex-interpreter
2006-04-07 23:13:44 +00:00
Andreas Meyer
fc14e338ef
better layout for ccRefChapter (ps/html)
2006-04-07 14:07:48 +00:00
Andreas Meyer
a5374d6cf3
bugfix: ccRef
2006-04-07 10:02:11 +00:00
Andreas Meyer
dd95d3c3d7
TOCChapterNameSuffix not needed anymore
...
(superceded by \ccRefChapter}
2006-04-06 18:16:05 +00:00
Andreas Meyer
e6e6f13b32
bugfix: cc[Ref,User]Chapter only accept _one_ argument.
2006-04-06 18:09:54 +00:00
Andreas Meyer
5b5a60cecf
rewritten the whole manual
...
ok. seriously:
renamed \chapter into \ccUserChapter and \ccRefChapter
2006-04-06 17:03:37 +00:00
Andreas Meyer
de5241d8c3
changed meaning of
...
ccRefChapter
ccUserChapter
(+some whitespace changes, done by texteditor)
2006-04-06 16:57:00 +00:00
Andreas Meyer
b13677aeaa
bugfix: two-column layout. consider this:
...
\packageleft{somepackage}
\entryleft{\part{something}}
previously, the row did not span the whole table-row.
now, it does
2006-04-06 15:33:14 +00:00
Andreas Meyer
7af7671833
better layout for \ccRef
2006-04-06 14:57:58 +00:00
Andreas Meyer
794a535262
ccRef also for latex. behavior:
...
\ccRef[Section]{label:somesection} will produce
Section 3
[] may be omitted. provided for consistency with the html-version
2006-04-06 14:54:40 +00:00
Andreas Meyer
c33ab30e2e
renamed ref[]{} to \ccRef[]{}
2006-04-06 14:38:50 +00:00
Andreas Meyer
630d143407
worked around a bug in flex 2.5.4. interestingly, the following line
...
leads to an error (in some circumstances. it didnt, for months!)
const char *my_yytext = yytext + 5; // skip [ref:"
2006-04-05 21:25:53 +00:00
Andreas Meyer
cdf609e53a
introduced toc entries that may span the complete row
...
(needed for parts)
2006-04-05 17:56:24 +00:00
Andreas Meyer
62d97773d3
bugfix: [cccbegin]someclass<K,bla>[cccend] can now be matched
...
new feature: \ref[text]{\somelabel} will produce to an html-link with "text"
being the link text, and somelabel as the link target. if no text is given,
the default is to show an image with an up-arrow
2006-04-05 10:02:40 +00:00
Andreas Meyer
14bd1b155a
new "features":
...
* added a configurable toc chapter name suffix (used for adding
"reference manual" to the reference chapter's names)
* alphabetical list of refpages now looks better (no more itemize)
* before alph. list of refpages, a \section{..} is inserted automatically
2006-04-04 18:49:16 +00:00
Andreas Meyer
5a2a695eba
fixed: Qt_widget now get's crosslinked.
...
solution: reset \lciIfHtmlClassLinks to true at each chapter start
(wonder why this ever was a problem ...)
another solution could have been, to rename the Qt_widget class in the
Qt_wigdet reference manual to Qt_widget_. Then, it would have worked, too
.... !?
2006-03-31 20:52:39 +00:00
Andreas Meyer
21af93974c
better cross-referencing of class templates. now, the whole
...
class is referenced by default, unless there is a template parameter
which can be cross-referenced
2006-03-31 19:06:05 +00:00
Andreas Meyer
41dbbfb788
pkgDescr. now has a link to reference manual
2006-03-31 01:45:01 +00:00
Andreas Meyer
6fccd95e93
improved visual appeal of pkg descr
2006-03-23 18:30:50 +00:00
Andreas Meyer
6f728868cf
description for parts (preliminary)
2006-03-23 18:03:22 +00:00
Andreas Meyer
2ecf058582
package descriptions, MK II
2006-03-23 10:12:17 +00:00
Andreas Meyer
35259c9753
added some immature package description mechanism
2006-03-22 22:54:44 +00:00
Andreas Meyer
e9a9ca7ae9
emanate an empty bibliography page, if there are no \cite
...
commands. prevents dead links
2006-03-19 21:44:38 +00:00
Andreas Meyer
4dc6605f94
fixed operator formatting for classes with scope
2006-03-19 17:18:34 +00:00
Andreas Meyer
265c19ab46
Nested_type anchors were undefined, previously! fixed.
2006-03-18 23:57:54 +00:00
Andreas Meyer
dec850c5b2
copied note about flex into top level installation file
2006-03-14 15:29:45 +00:00
Andreas Meyer
fc86095f76
allow multi-paragraph comments in \ccFunction, \ccMethod etc
2006-03-10 12:08:45 +00:00
Andreas Meyer
bd67f399bc
fixed the nested template parameter bug
2006-03-08 22:04:36 +00:00
Andreas Meyer
8b7d944401
* \gtreqless is now defined.
...
* INSTALLATION cleaned up
2006-03-04 22:56:10 +00:00
Andreas Meyer
8f48af5066
LATEX_CONV_INPUT patch sent by Laurent Rineau
2006-03-04 22:55:02 +00:00
Andreas Meyer
e4ea7c87fd
2006-03-03 17:20:20 +00:00
Andreas Meyer
eae25344bc
2006-03-03 17:01:57 +00:00
Andreas Meyer
e358d73dd8
cleanup: flex is not needed anymore at manual build time (since long ago)
2006-03-03 15:17:05 +00:00
Andreas Meyer
98ef8ed9bc
latex_to_html also needs $LATEX_CONV_CONFIG.
...
if not set, aks cc_extract_html for a default value
2006-03-02 10:32:10 +00:00
Andreas Meyer
6fb821db15
not needed anymore
2006-03-01 20:22:50 +00:00
Andreas Meyer
8776a40d63
better installation procedure
...
RCSdef now also works for html converter
2006-03-01 20:05:41 +00:00
Andreas Meyer
9bb2d9972b
2006-03-01 16:34:30 +00:00
Andreas Meyer
7ca0efa9e1
add precompiled manuals for those who need
2006-03-01 16:13:57 +00:00
Andreas Meyer
d935b617de
RCSdef and RCSdefDate now work again, with SVN.
2006-03-01 16:13:07 +00:00
Laurent Rineau
c09aa0325a
Added cc_extract_images_lexer.C to files that need to be cleaned.
2006-02-28 14:56:35 +00:00
Andreas Meyer
a85f923519
hotfix for the $Id: $ and $Date: $ problem, where latex_to_html
...
complained about \lciToggleMathMode.
2006-02-20 11:10:23 +00:00
Laurent Saboret
35cfa18a2a
Change CVS keywords to SVN style
2006-02-17 17:01:13 +00:00
Andreas Meyer
3159516d1c
2006-02-15 18:13:34 +00:00
Andreas Meyer
91813b3321
only got committed by accident. caused problems on cygwin platform
2006-02-15 10:46:07 +00:00
Laurent Saboret
568966fb05
Fix conversion of binary file
2006-02-14 13:40:25 +00:00
Laurent Saboret
1aad55d4cb
Change CVS keywords to SVN style
2006-02-14 10:08:15 +00:00
Laurent Saboret
5dca6087d1
Move packages to trunk root
2006-02-14 08:58:16 +00:00