From 64a212eb29cbf672e4abf4d8e4ae09a5486f9acb Mon Sep 17 00:00:00 2001 From: Simon Giraudot Date: Thu, 10 Mar 2016 16:12:34 +0100 Subject: [PATCH 1/6] Move Hello World to tutorials --- .../{Introduction.txt => Tutorials/Tutorial_hello_world.txt} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename Documentation/doc/Documentation/{Introduction.txt => Tutorials/Tutorial_hello_world.txt} (100%) diff --git a/Documentation/doc/Documentation/Introduction.txt b/Documentation/doc/Documentation/Tutorials/Tutorial_hello_world.txt similarity index 100% rename from Documentation/doc/Documentation/Introduction.txt rename to Documentation/doc/Documentation/Tutorials/Tutorial_hello_world.txt From b83659fa8762be501f589ba6fcaf994829d5df89 Mon Sep 17 00:00:00 2001 From: Simon Giraudot Date: Thu, 10 Mar 2016 16:12:57 +0100 Subject: [PATCH 2/6] Remove reference to Hello World from Getting_started --- Documentation/doc/Documentation/Getting_started.txt | 6 ------ 1 file changed, 6 deletions(-) diff --git a/Documentation/doc/Documentation/Getting_started.txt b/Documentation/doc/Documentation/Getting_started.txt index 22e349b15e2..d8dcfa659f2 100644 --- a/Documentation/doc/Documentation/Getting_started.txt +++ b/Documentation/doc/Documentation/Getting_started.txt @@ -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 traits classes 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. From 3b840a2c04c3e633b39630e2da5dddbf65e3dd97 Mon Sep 17 00:00:00 2001 From: Simon Giraudot Date: Thu, 10 Mar 2016 16:13:27 +0100 Subject: [PATCH 3/6] Change tag of page Hello World --- .../doc/Documentation/Tutorials/Tutorial_hello_world.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/doc/Documentation/Tutorials/Tutorial_hello_world.txt b/Documentation/doc/Documentation/Tutorials/Tutorial_hello_world.txt index 7a5e85a0e48..58d48d6664a 100644 --- a/Documentation/doc/Documentation/Tutorials/Tutorial_hello_world.txt +++ b/Documentation/doc/Documentation/Tutorials/Tutorial_hello_world.txt @@ -11,7 +11,7 @@ namespace CGAL { /*! -\page introduction Hello World +\page tutorial_hello_world Hello World \cgalAutoToc \author %CGAL Editorial Board From b9d9db321c451e5f70b876491537e8cf3ae5ca69 Mon Sep 17 00:00:00 2001 From: Simon Giraudot Date: Thu, 10 Mar 2016 16:13:49 +0100 Subject: [PATCH 4/6] Add new page to manual: Tutorials --- .../doc/Documentation/Tutorials/Tutorials.txt | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 Documentation/doc/Documentation/Tutorials/Tutorials.txt diff --git a/Documentation/doc/Documentation/Tutorials/Tutorials.txt b/Documentation/doc/Documentation/Tutorials/Tutorials.txt new file mode 100644 index 00000000000..ac3dd2c9197 --- /dev/null +++ b/Documentation/doc/Documentation/Tutorials/Tutorials.txt @@ -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 traits classes which + define what primitives are used by a geometric algorithm, the + notions of \em concept and \em model. + +*/ From cec789483dec05c0455f87e43b99eb13fe366b0b Mon Sep 17 00:00:00 2001 From: Simon Giraudot Date: Thu, 10 Mar 2016 16:14:37 +0100 Subject: [PATCH 5/6] Reference tutorial page in sidebar menu and header menu --- Documentation/doc/Documentation/main.txt | 1 + Documentation/doc/resources/header.html | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/Documentation/doc/Documentation/main.txt b/Documentation/doc/Documentation/main.txt index ce7b9c8784b..5800eea5fc7 100644 --- a/Documentation/doc/Documentation/main.txt +++ b/Documentation/doc/Documentation/main.txt @@ -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 diff --git a/Documentation/doc/resources/header.html b/Documentation/doc/resources/header.html index 19f123ac241..c1e426d6a78 100644 --- a/Documentation/doc/resources/header.html +++ b/Documentation/doc/resources/header.html @@ -44,7 +44,7 @@ $search
  • cgal.org
  • Top
  • Getting Started
    • -
  • Organization of the Manual
    • +
  • Tutorials
  • Package Overview
  • Acknowledging CGAL
    • From b9606f5d6c293f11e815764cc47477cce57567b8 Mon Sep 17 00:00:00 2001 From: Simon Giraudot Date: Thu, 10 Mar 2016 16:31:50 +0100 Subject: [PATCH 6/6] Some text corrections in Hello World --- .../doc/Documentation/Tutorials/Tutorial_hello_world.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/doc/Documentation/Tutorials/Tutorial_hello_world.txt b/Documentation/doc/Documentation/Tutorials/Tutorial_hello_world.txt index 58d48d6664a..61d3792b047 100644 --- a/Documentation/doc/Documentation/Tutorials/Tutorial_hello_world.txt +++ b/Documentation/doc/Documentation/Tutorials/Tutorial_hello_world.txt @@ -15,7 +15,7 @@ namespace CGAL { \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/. */