Commit Graph

386 Commits

Author SHA1 Message Date
Laurent Saboret ed38b56d71 Fixed bug in enumerations documentation. 2009-04-09 12:35:18 +00:00
Laurent Saboret 64c52be8d2 Fixed error messages when Reference manual is empty (no .tex files). 2009-04-09 09:50:36 +00:00
Laurent Saboret 452efbf161 * Fixed rare bug where Doxygen did not expand CGAL_BEGIN/END_NAMESPACE.
* Generate Doxygen XML output to get an index easy to parse (doxygen/xml/index.xml - unused yet).
2009-03-24 17:05:03 +00:00
Laurent Saboret 89da9d7c2e generate_reference_manual version 1.1.1:
* New features:
- Print short help when generate_reference_manual is called without parameters, long help when called with -h.
- Improved traces.

* Fixed bugs discovered when parsing Polyline_simplification_2:
- Check if package parameter exists.
- Fixed bug when parsing item name in a sub-namespace of CGAL::.
- Fixed case where default constructor was nor properly updated.
- Fixed bug in documentation of templated methods of a class.
- Added support of several include files for a class.
2009-03-23 14:46:07 +00:00
Laurent Saboret dba0e4e272 Try: prettier function/method output but the generated Latex is harder to read (commented out) 2009-03-13 17:08:29 +00:00
Laurent Saboret f4def26eb8 Define \itemsep for latex_to_html 2009-02-26 13:40:57 +00:00
Laurent Saboret 82143450e7 generate_reference_manual 1.1:
* Bug fixes:
- Document properly the template parameters of functions. No separate Parameters section.

* Improved formatting of functions and methods:
- Shorter latex code and shorter printed documentation
- Fixed indentation
- Parameter names are in italic instead of bold

* Words surrounded by stars are formatted in bold.
2009-02-26 11:02:59 +00:00
Sylvain Pion 7bd28c2218 Document \ccSum and \ccProd. 2009-02-02 18:08:50 +00:00
Sylvain Pion 80a962c21e New \ccProd. 2009-02-02 17:26:51 +00:00
Sylvain Pion 40200e96cf New \ccsum{a}{b}{c} macro that does \sum_{a}^{b}{c} with nicer html rendering. 2009-02-02 17:06:34 +00:00
Sylvain Pion f04ed5e4e7 Add comment. 2009-02-02 15:21:08 +00:00
Sylvain Pion 9d3827addb In the package overview page, replace
"BibTex Key: cgal:kqjshdfgbqlbchrlqcgalisgreatandmoniqueevenmorebutwhatsthisbibtexthingkjshbfliqsudgldfs"
by
"Citation Entry"
2009-01-31 17:43:37 +00:00
Sylvain Pion a6060ffd6c Fully CSS-ify the ccAdvanced environment, with a background image.
Also add images for Class, Concept, etc... (longer and thiner than the current
ones) to be used in a further commit.
2009-01-28 17:49:41 +00:00
Laurent Rineau 425aeb4621 Merge from branch 3.4:
r47778 | lrineau | 2009-01-22 11:14:13 +0100 (Thu, 22 Jan 2009) | 2 lines

Fix links to acknowledge.html

------------------------------------------------------------------------
r47776 | lrineau | 2009-01-22 11:06:06 +0100 (Thu, 22 Jan 2009) | 2 lines

Fix a link in how_to_cite_cgal.html
2009-01-22 10:16:48 +00:00
Laurent Rineau dc5d2dc434 Remove \cccWithURL and \ccRefIdfierPageWithURL 2009-01-20 22:50:19 +00:00
Laurent Rineau 89908df679 \ccc and \ccRefIdfierPage now have an optional argument. Usage:
\ccc[Kernel::do_intersect]{void do_intersect(int a, int b)}
  \ccRefIdfierPage[Kernel::do_intersect]{do_intersect}

The argument must be a label declared with \ccRefLabel, such as in:
  \ccRefLabel{Kernel::do_intersect}
2009-01-20 21:56:43 +00:00
Laurent Rineau e68504513a ooops. If the *second* argument is to be ignored, then only the *first one*
should be passed.
2009-01-20 14:02:56 +00:00
Laurent Rineau cbacb441a1 Add a wrapper \ccRefIdfierPageWithURL. 2009-01-20 12:41:25 +00:00
Laurent Rineau 554e9dabb6 revert revision r47751 2009-01-20 12:39:24 +00:00
Laurent Rineau 79579c66a6 Add generated files to svn:ignore. 2009-01-20 12:36:38 +00:00
Sylvain Pion 015ed74b19 In the navigation bars, replace the underlying and overlying <hr>,
by a nicer and cleaner CSS equivalent (solid thin border).
2009-01-17 13:39:09 +00:00
Sylvain Pion ea6842b766 Title Page -> Title (in the navigation bar) 2009-01-17 10:12:14 +00:00
Sylvain Pion 659a7bae1f Minor improvements to the navigation bar, and use a meta tag. 2009-01-17 09:59:33 +00:00
Laurent Rineau 54aabfe8c2 Revert the following revision, because it leads to many many warnings!
r47695 | lrineau | 2009-01-08 16:53:03 +0100 (Thu 08 Jan 2009) | 2 lines

Output a warning when two or more anchor rules have the same key.
2009-01-09 10:29:14 +00:00
Laurent Rineau bcec6c9d30 Add a wrapper around \ccc so that one can chose the URL of the HTML link,
instead of the automatic one.
In LaTeX mode, that macro ignores its second argument.

That macro is named \cccWithURL{}{}.
2009-01-09 10:16:54 +00:00
Sylvain Pion fceb87e931 Update comments after last change, and fix thinko. 2009-01-09 09:40:03 +00:00
Sylvain Pion 8727946a30 Simplify treatment of \textsc, since it's trivial to do with a CSS :-). 2009-01-08 23:39:16 +00:00
Laurent Rineau f4109fab64 Output a warning when two or more anchor rules have the same key. 2009-01-08 15:53:03 +00:00
Laurent Saboret 9ec9192f57 Added hack to reference the next papers:
- Poisson Surface Reconstruction [Kazhdan06]   
- Algebraic point set surfaces [Guennebaud07]
- Surface Reconstruction From Unorganized Points [Hoppe92]
2009-01-08 14:17:59 +00:00
Sylvain Pion e82f1490b7 Justify text globally (isn't it nicer?). 2009-01-06 17:19:20 +00:00
Sylvain Pion 7c945fe101 \mathcal does not need char-by-char treatment anymore. 2009-01-06 16:55:37 +00:00
Sylvain Pion 34b5d5f978 bigbig font seems too big (hard to guess right in HTML). 2009-01-06 15:56:59 +00:00
Sylvain Pion 2b851a2517 array : remove VALIGN=TOP (why was it there?), and add more cellspacing. 2009-01-06 15:42:35 +00:00
Sylvain Pion 5b5913b4e4 Add missing class="math" in array. 2009-01-06 15:12:24 +00:00
Sylvain Pion 4464313def Remove closing </TD> and </TR> as they are optional in HMTL
(and it makes less code to read).
2009-01-06 14:51:16 +00:00
Sylvain Pion faee97d3d1 Add a few more Unicode/HTML symbols that we use. 2009-01-06 14:38:34 +00:00
Sylvain Pion 1be6de35ee Allow math style everywhere, so that it can be used in <TD> and not
only in <SPAN>, to simplify the HTML.
2009-01-06 13:29:20 +00:00
Sylvain Pion 371a479654 Fix for array environment. 2009-01-06 12:49:34 +00:00
Sylvain Pion 1d5010386d Replace non-standard compliant <MATH> by <span class="math">. 2009-01-05 15:14:35 +00:00
Sylvain Pion a582086299 Windows workarounds to help it find the right font. 2009-01-05 14:57:05 +00:00
Laurent Rineau 0d332fbce3 Merge revision 47637 from branch 3.4: "Update how_to_cite_cgal.html after Monique's suggestions." 2009-01-05 10:29:08 +00:00
Sylvain Pion d94620a529 Add \prod and reduce bigbig_sym size. 2009-01-05 00:21:24 +00:00
Sylvain Pion 5497900555 Nice \frac rendering, and other minor improvements. 2009-01-04 23:17:54 +00:00
Sylvain Pion 6c8aa0df6b Some minor adjustments. 2009-01-04 19:18:18 +00:00
Sylvain Pion 62a70f2692 Better sqrt and sub/sup. 2009-01-04 18:21:23 +00:00
Sylvain Pion 0d2904df66 Nice HTML display for \TeX and \LaTeX (taken from TeX4ht). 2009-01-03 23:56:00 +00:00
Sylvain Pion 1d2824a9f8 Add Unicode for \gtreqless . 2009-01-03 16:07:34 +00:00
Sylvain Pion 80da0bff1a More obsolete \ccTexHtml removal. 2009-01-03 15:21:38 +00:00
Sylvain Pion dbe4033a50 Add double-struck P (projective space), used in Kernel_d, fixed its use there,
and remove many obsolete ccTexHtml there.
2009-01-03 12:47:55 +00:00
Sylvain Pion 993add6e80 Use HTML or Unicode for *dots. 2009-01-03 09:38:48 +00:00
Sylvain Pion 17a22d8c40 Use italic for <math> in the style sheet instead of everywhere in the HTML,
and use a serif font like in latex.
Introduce sym and big_sym classes for math symbols.
2009-01-02 23:36:55 +00:00
Sylvain Pion f0ca88b74a Replace not so nice cc_ref_up_arrow.gif used with Figures references,
by a nicer Unicode pointing finger.
2009-01-02 16:56:08 +00:00
Sylvain Pion ce4a370172 Use <span> instead of nested <math> for cal fonts. 2008-12-30 23:18:42 +00:00
Sylvain Pion 567795852e Replace mathcal characters by using the "lucida calligraphy" font. 2008-12-30 18:45:45 +00:00
Sylvain Pion a3792749ee Use Unicode symbols for double-struck N, Z, Q, R and C.
Unfortunately, double-struck E is missing.  Let's come back to it in 2009.
2008-12-30 13:31:09 +00:00
Sylvain Pion cf558eb06d Replace a few more gif files by HTML codes. 2008-12-28 22:41:05 +00:00
Sylvain Pion 035929236a Use HTML codes instead of gif files for some math symbols (some remains).
See : http://htmlhelp.com/reference/html40/entities/symbols.html
Tested with firefox, safari and opera.
2008-12-28 13:17:12 +00:00
Sylvain Pion 0d54154d06 Use HTML code &rarr; instead of cc_index_arrow.gif in the index.
(more compact, scalable...)
Tested with firefox, safari and opera.
2008-12-27 20:33:51 +00:00
Laurent Rineau 0fd400caf9 update how-to-cite-CGAL in Manual_tools' trunk 2008-12-15 09:25:20 +00:00
Laurent Rineau 157eba63cf \ccPkgDemo now predend "demo/3.4/" to its argument. 2008-12-10 14:16:12 +00:00
Laurent Rineau d4be6503b7 Add support for the \bar command (overline) to latex_to_html. That command
is used by the PCA's introduction.tex.
2008-12-01 10:07:51 +00:00
Laurent Saboret cb7532d93f Version 1.0.3: Fixed declaration of templated methods 2008-09-30 14:33:42 +00:00
Ben Galehouse 7bc8e45f26 Added #include <stdlib.h> to make it compile on a gcc 4.3 system. 2008-08-22 19:40:47 +00:00
Michael Hemmer cbfe39e67c empty commit (mistake) 2008-08-07 12:11:28 +00:00
Sylvain Pion 538458336c Rename *.C to *.cpp. 2008-07-16 08:46:48 +00:00
Samuel Hornus 153ceb6c26 Added @commentheading keyword 2008-06-20 15:33:49 +00:00
Laurent Saboret af5184b550 Fixed bug in keep_only_if_function() 2008-06-02 17:04:55 +00:00
Fernando Cacciola f93437ca22 Removed *unmodified* auto-generated CMakeLists.txt (now created by create_internal_release) 2008-05-05 14:01:55 +00:00
Monique Teillaud 261a985880 bug fix + feature request 2008-04-30 11:39:20 +00:00
Monique Teillaud eebef3d312 manual tools have no maintainer any more 2008-04-30 11:29:50 +00:00
Laurent Saboret eb9eca14de Version 1.0.2:
- The tool does not display doxygen warnings by default. Use --verbose to have them back.
- \ccInclude, \ccRefine and \ccInheritsFrom commands are extracted from source code.
- Fixed bug when using @related doxygen keywords.
- Fixed bug in removal of cc_ref_wizard placeholder text.
2008-04-04 16:28:36 +00:00
Laurent Saboret 6e827c390e Fixed bug when skipping other definitions of namespaceXXX.tex 2008-04-01 17:37:07 +00:00
Laurent Saboret 34873c05a6 Port to Doxygen 1.5.5 2008-03-21 14:36:41 +00:00
Laurent Saboret bce59d7743 Version 1.0.1:
- Support templates nested in CGAL template.
- Turned on doxygen preprocessor.
2008-03-07 13:43:21 +00:00
Fernando Cacciola b704509dcf Examples/Demos/Test CMake scripts updated 2008-03-05 21:14:02 +00:00
Laurent Saboret ef10ca7e16 Bug fix: process all tex files in doc_tex/*_ref/ 2008-03-05 16:52:04 +00:00
Laurent Saboret 6f41a13ce2 Fixed bug when '@heading Parameters' occurs several times in the same file 2008-03-05 15:12:00 +00:00
Laurent Saboret 826c5677a9 Version 1.0:
- Complete rewrite of the code that extracts new CGAL Manual sections from C++ comments. It uses the new keyword @heading ans is much more generic and robust.
- New keyword @subheading keyword to define a sub-section in CGAL Manual.
2008-02-22 12:55:24 +00:00
Laurent Saboret d64885d524 Improved \ccHasModels parsing 2008-02-20 14:36:52 +00:00
Laurent Saboret 8b1a04b01c Fixed \ccVariables support 2008-02-20 11:46:58 +00:00
Laurent Saboret 743bd6ae88 Remove the placeholder text generated by cc_ref_wizard 2008-02-19 14:15:32 +00:00
Laurent Saboret ef646fd1f9 Words surrounded by simple quotes are emphasized using \ccc 2008-02-18 18:39:17 +00:00
Laurent Saboret 8704390c67 Version 0.9:
- more robust parsing
- removed option --force
2008-02-15 17:59:26 +00:00
Fernando Cacciola a659cd852a Added project() and conditional test for CGAL_DIR 2008-02-14 15:42:36 +00:00
Fernando Cacciola 14043c43a0 Replaced CGALROOT by CGAL_DIR (the latters is used by CMake automatically) 2008-02-08 17:47:21 +00:00
Fernando Cacciola afddfc4fca CMake scripts for demos/examples/test added 2008-02-06 19:06:24 +00:00
Laurent Saboret 1771d4abb1 Updated usage and read-me 2008-01-31 16:13:00 +00:00
Laurent Saboret c7bd5e563c Turn off doxygen preprocessor 2008-01-25 17:38:39 +00:00
Laurent Saboret 647185134f Better progression message 2008-01-25 16:49:44 +00:00
Laurent Saboret 8bd79a18e2 generate_reference_manual version 0.8: compatible with doxygen 1.4 up to 1.5.4 2008-01-25 16:27:37 +00:00
Sylvain Pion a46b55bf71 The files "changes.txt", "description.txt", "long_description.txt" and "maintainer"
are now under /trunk/$Package/package_info/$Package/ .
2007-12-02 15:06:42 +00:00
Laurent Saboret 6c10de0cac Version 0.7.5:
- added support of constants in classes and concepts
- added label to virtual and protected members
2007-09-07 15:35:56 +00:00
Laurent Saboret 02469c010f Added call to \ccRefPageBegin and \ccRefPageEnd in cc_ref_wizard templates 2007-09-07 15:29:10 +00:00
Andreas Meyer e1e91f9678 removed thomas herrmann from linear/quadratic solvers bibentry 2007-05-28 21:22:21 +00:00
Andreas Meyer 967693a0dd update for CGAL 3.3 2007-05-21 15:12:01 +00:00
Andreas Meyer 134181be66 acknowledging CGAL now finally integrated into the manual 2007-05-21 15:05:06 +00:00
Andreas Meyer 72a3da98a8 html bugfix: labels in/reference to packages.html working again 2007-05-18 16:47:50 +00:00
Andreas Meyer 6a05d4874b typo 2007-05-16 20:16:43 +00:00
Andreas Meyer 48e71a73bc less default tocdepth (now 2 instead of 3) for new toc layout 2007-05-15 09:48:14 +00:00
Andreas Meyer 31417fba53 new manual.bib for 3.3 2007-05-10 08:53:47 +00:00
Andreas Meyer 549cd43f96 print better error msg for missing example files 2007-05-10 08:52:34 +00:00
Andreas Meyer f5d7b16a18 * ccPrecond/Postcond/Requirement now also allowed outside of comments
* reverted cosmetic change (DivTOC now again yellow)
2007-05-05 18:05:03 +00:00
Andreas Meyer b0e72025e0 * list of parts now also for packages.html
* cosmetic changes
2007-05-04 16:24:25 +00:00
Andreas Meyer aeceb11255 ccPkgDemo:
* now also known to latex (no-op)
* can be given multiple times (output will accumulate)
2007-05-04 14:05:18 +00:00
Andreas Meyer 94336a3343 finally, crosslinking is restricted to following parts of refpages:
* return types (similar: typedef <crosslinking> <nocrosslinking>)
* template parameters
* function parameters

and in general, \ccc.

so, no more crosslinking from nested types and method names.
2007-05-03 21:41:57 +00:00
Andreas Meyer e64a48d82f added a ccPkgDemo macro 2007-05-03 09:40:40 +00:00
Andreas Meyer 8d3fe497b1 html converter:
* added \expandafter, which was planned to be used for cc_manual_index ..
* fixed the occurrence of plain "\ccPackageName" in index, \expandafter was not needed
  for this, finally
2007-04-25 14:06:15 +00:00
Andreas Meyer d65e37fb5b html benchmark output: got rid of useless <pre></pre> command in
ccBenchmarkInstance
2007-04-25 13:27:32 +00:00
Andreas Meyer 1b71a27e1e * benchmark instance fix: now, the html converter can also handle
instances with exactly one file (what an improvement)
* error if benchmark instance is empty (ie., no files at specified location/pattern)
2007-04-20 15:53:47 +00:00
Andreas Meyer 8e2363712b new html commands overline and underline 2007-04-20 15:15:11 +00:00
Andreas Meyer 69b0516c49 encode backslash "\" as "&#92;" in html output. this should
make it feasible to detect leftover (la)tex commands in html output
2007-04-19 15:08:16 +00:00
Andreas Meyer b07e5c14b9 html regression fix: now, the old layout also works again in oneColumnLayout 2007-04-18 20:34:37 +00:00
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 &nbsp; 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