Merge pull request #900 from sgiraudot/CGAL_Tutorials

CGAL Manual: Tutorials
This commit is contained in:
Laurent Rineau 2016-03-22 11:02:34 +01:00
commit 5b0f00df33
5 changed files with 28 additions and 11 deletions

View File

@ -3,12 +3,6 @@
- \subpage installation describes how to install %CGAL, and lists the third party libraries on which %CGAL depends, or for which %CGAL provides interfaces.
- \subpage introduction presents you some short example programs to
get a first idea for the look and feel of a program that uses \cgal.
We introduce the notion of the \em kernel which defines geometric primitives,
the notion of <em>traits classes</em> which define what primitives are used
by a geometric algorithm, the notions of \em concept and \em model.
- \subpage manual gives an idea where you should look for documentation.
The documentation for a class, may be spread over manual pages of
base classes, and reference manual pages of concepts the class is a model of.

View File

@ -11,11 +11,11 @@ namespace CGAL {
/*!
\page introduction Hello World
\page tutorial_hello_world Hello World
\cgalAutoToc
\author %CGAL Editorial Board
This chapter is for the %CGAL newbie, who knows C++ and has
This tutorial is for the %CGAL newbie, who knows C++ and has
a basic knowledge of geometric algorithms. The first section
shows how to define a point and segment class, and how to
apply geometric predicates on them. The section further raises
@ -333,8 +333,8 @@ Tutorial and Reference" by Nicolai M. Josuttis from Addison-Wesley, or
"Generic Programming and the STL" by Matthew H. Austern for the \stl
and its notion of *concepts* and *models*.
Other resources for \cgal are the tutorials at
http://www.cgal.org/Tutorials/ and the user support page at
Other resources for \cgal are the rest of the \ref tutorials "tutorials"
and the user support page at
http://www.cgal.org/.
*/

View File

@ -0,0 +1,22 @@
/*!
\page tutorials Tutorials
\cgal provides a large number of data structures and algorithms dedicated to
various applications. Most of these data structures and algorithms can be
combined to achieve extensive and complex geometric tasks. The tutorials aim at
providing help and ideas on how to use CGAL beyond the simple examples of the
User Manual.
\section tuto_list List of available tutorials
- \subpage tutorial_hello_world presents you some short example
programs to get a first idea for the look and feel of a program that
uses \cgal. We introduce the notion of the \em kernel which defines
geometric primitives, the notion of <em>traits classes</em> which
define what primitives are used by a geometric algorithm, the
notions of \em concept and \em model.
*/

View File

@ -52,6 +52,7 @@ For releases X.Y, with 3.1 <= X.Y <= 4.1 visit
\endhtmlonly
\subpage general_intro
\subpage tutorials
\subpage packages
\subpage dev_manual

View File

@ -44,7 +44,7 @@ $search
<li><a href="http://www.cgal.org/">cgal.org</a></li>
<li><a href="../Manual/index.html">Top</a></li>
<li><a href="../Manual/general_intro.html">Getting Started</a></li>
<li><a href="../Manual/manual.html">Organization of the Manual</a></li>
<li><a href="../Manual/tutorials.html">Tutorials</a></li>
<li><a href="../Manual/packages.html">Package Overview</a></li>
<li><a href="../Manual/how_to_cite_cgal.html">Acknowledging CGAL</a></li>
</ul>