Commit Graph

224 Commits

Author SHA1 Message Date
Andreas Meyer a6db8092bf yet another ccAnchor fix. this time: line breaks and ?,& characters 2007-04-18 19:11:31 +00:00
Andreas Meyer 9a0c6d5a5d ps/pdf bugfix related to ccAnchor (prevented developers manual to build) 2007-04-18 18:20:52 +00:00
Andreas Meyer 9e78b61a53 html new toc: cosmetic fix 2007-04-17 20:32:02 +00:00
Andreas Meyer f3fe85187e new html toc layout: better alignment for part numbers and part names 2007-04-17 20:11:11 +00:00
Andreas Meyer 9be3adb929 * reintroduced part/chapter counters in main toc
* made user/ref manual more visible (less grey, more black)
2007-04-17 18:49:21 +00:00
Sylvain Pion 5225d918de Add some notes. 2007-04-17 18:08:58 +00:00
Sylvain Pion cbb51fb5f2 More words 2007-04-17 16:34:16 +00:00
Sylvain Pion ee53593538 More words 2007-04-17 16:32:15 +00:00
Sylvain Pion 9bb24a7369 More words 2007-04-17 16:00:50 +00:00
Sylvain Pion e3b1698ffc More words 2007-04-17 15:55:47 +00:00
Sylvain Pion 5980a37423 More words 2007-04-17 15:37:16 +00:00
Sylvain Pion 531d875221 More words 2007-04-17 15:32:31 +00:00
Sylvain Pion dc3214f89f More words 2007-04-17 15:27:12 +00:00
Sylvain Pion 069a6dbc47 More words 2007-04-17 15:22:56 +00:00
Sylvain Pion 698dcb5a35 More words 2007-04-17 15:16:22 +00:00
Sylvain Pion ade985a563 More words 2007-04-17 13:37:35 +00:00
Sylvain Pion 57a04fca26 More words 2007-04-17 13:28:30 +00:00
Sylvain Pion ae477f90de More words. 2007-04-17 13:11:59 +00:00
Andreas Meyer dcf96d954a new toc layout :
* removed short table of contents
* main TOC contains 
  + list of parts
  + list of packages
* moved everything below chapter into a 
* minitoc 

* old layout is still the default
2007-04-16 23:38:26 +00:00
Andreas Meyer c31827bf13 use pdf hyperref inside ccAnchor. made ps output look the same 2007-04-16 10:09:51 +00:00
Andreas Meyer 7a80cfa1a3 fixed operator() layout 2007-04-13 15:55:35 +00:00
Andreas Meyer 84c7248654 added numbering for tables/figures 2007-04-12 21:16:46 +00:00
Andreas Meyer 38174ea0d5 small benchmark instances bugfix 2007-04-07 20:08:58 +00:00
Efi Fogel 9460c13d8e updated accepted words 2007-04-03 19:21:01 +00:00
Andreas Meyer 74d513dda8 make manual_tools not complain about missing 'benchmarks' directory 2007-04-01 10:31:18 +00:00
Sylvain Pion fc7881c4d7 Updates.
(I tried to fix some issues, but aspell does not have support for
LaTeX environments (only commands), so I found no good way to improve
the situation)
2007-03-30 15:06:34 +00:00
Sylvain Pion c61eaac33d More words after treating the Kernel manual. 2007-03-29 15:11:20 +00:00
Sylvain Pion dac846260c More words. 2007-03-29 14:28:55 +00:00
Sylvain Pion 042e387d50 aspell configuration files for spell-checking the Manual. 2007-03-29 14:01:01 +00:00
Andreas Meyer 79c1bde675 added benchark stuff:
* collect *.bff files, according to path/filename pattern
* create tar-files with unique filename
* provide links from web page to those tar-files, included in the manual 
  (below doc_html/benchmarks/)
2007-03-28 10:57:59 +00:00
Andreas Meyer 3b5ee7a6eb added a shell extension 2007-03-27 16:15:28 +00:00
Andreas Meyer d42d5011fc towards perl-script extension 2007-03-27 08:50:47 +00:00
Andreas Meyer 58944630a6 * tex2doxy now automatically creates required doxygen and html
documentation
* more matches between tex and doxy
2007-03-21 12:45:46 +00:00
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