mirror of https://github.com/CGAL/cgal
Add a page on the Organization of the Manual
This commit is contained in:
Andreas Fabri
parent
34a06c004a
commit
631e3452cc
File diff suppressed because one or more lines are too long
|
Before Width: | Height: | Size: 8.3 KiB After Width: | Height: | Size: 8.2 KiB |
|
|
@ -303,6 +303,8 @@
|
|||
"$ref": "AAAAAAFKBsPvQLRHkCg="
|
||||
},
|
||||
"wordWrap": false,
|
||||
"suppressAttributes": false,
|
||||
"suppressOperations": false,
|
||||
"showMultiplicity": true,
|
||||
"showOperationSignature": true,
|
||||
"attributeCompartment": {
|
||||
|
|
@ -597,6 +599,8 @@
|
|||
"$ref": "AAAAAAFKBsY0xbRwnD0="
|
||||
},
|
||||
"wordWrap": false,
|
||||
"suppressAttributes": false,
|
||||
"suppressOperations": false,
|
||||
"showMultiplicity": true,
|
||||
"showOperationSignature": true,
|
||||
"attributeCompartment": {
|
||||
|
|
@ -789,8 +793,8 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 417,
|
||||
"top": 97,
|
||||
"left": 413,
|
||||
"top": 101,
|
||||
"width": 83,
|
||||
"height": 13,
|
||||
"autoResize": false,
|
||||
|
|
@ -815,8 +819,8 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 417,
|
||||
"top": 112,
|
||||
"left": 413,
|
||||
"top": 116,
|
||||
"width": 83,
|
||||
"height": 13,
|
||||
"autoResize": false,
|
||||
|
|
@ -841,8 +845,8 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 0,
|
||||
"top": 0,
|
||||
"left": -12,
|
||||
"top": 12,
|
||||
"width": 72,
|
||||
"height": 13,
|
||||
"autoResize": false,
|
||||
|
|
@ -867,8 +871,8 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 0,
|
||||
"top": 0,
|
||||
"left": -12,
|
||||
"top": 12,
|
||||
"width": 0,
|
||||
"height": 13,
|
||||
"autoResize": false,
|
||||
|
|
@ -887,8 +891,8 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 412,
|
||||
"top": 92,
|
||||
"left": 408,
|
||||
"top": 96,
|
||||
"width": 93,
|
||||
"height": 38,
|
||||
"autoResize": false,
|
||||
|
|
@ -934,8 +938,8 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 417,
|
||||
"top": 135,
|
||||
"left": 413,
|
||||
"top": 139,
|
||||
"width": 83,
|
||||
"height": 13,
|
||||
"autoResize": false,
|
||||
|
|
@ -955,8 +959,8 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 412,
|
||||
"top": 130,
|
||||
"left": 408,
|
||||
"top": 134,
|
||||
"width": 93,
|
||||
"height": 23,
|
||||
"autoResize": false
|
||||
|
|
@ -990,8 +994,8 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 417,
|
||||
"top": 158,
|
||||
"left": 413,
|
||||
"top": 162,
|
||||
"width": 83,
|
||||
"height": 13,
|
||||
"autoResize": false,
|
||||
|
|
@ -1011,8 +1015,8 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 412,
|
||||
"top": 153,
|
||||
"left": 408,
|
||||
"top": 157,
|
||||
"width": 93,
|
||||
"height": 23,
|
||||
"autoResize": false
|
||||
|
|
@ -1036,8 +1040,8 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 0,
|
||||
"top": 0,
|
||||
"left": -8,
|
||||
"top": 8,
|
||||
"width": 10,
|
||||
"height": 10,
|
||||
"autoResize": false
|
||||
|
|
@ -1053,8 +1057,8 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 412,
|
||||
"top": 92,
|
||||
"left": 408,
|
||||
"top": 96,
|
||||
"width": 93,
|
||||
"height": 93,
|
||||
"autoResize": false,
|
||||
|
|
@ -1067,6 +1071,8 @@
|
|||
"$ref": "AAAAAAFKB1Lo0rSnmcc="
|
||||
},
|
||||
"wordWrap": false,
|
||||
"suppressAttributes": false,
|
||||
"suppressOperations": false,
|
||||
"showMultiplicity": true,
|
||||
"showOperationSignature": true,
|
||||
"attributeCompartment": {
|
||||
|
|
@ -1108,8 +1114,8 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 299,
|
||||
"top": 119,
|
||||
"left": 298,
|
||||
"top": 121,
|
||||
"width": 56,
|
||||
"height": 13,
|
||||
"autoResize": false,
|
||||
|
|
@ -1143,8 +1149,8 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 327,
|
||||
"top": 104,
|
||||
"left": 326,
|
||||
"top": 106,
|
||||
"width": 0,
|
||||
"height": 13,
|
||||
"autoResize": false,
|
||||
|
|
@ -1177,8 +1183,8 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 328,
|
||||
"top": 148,
|
||||
"left": 326,
|
||||
"top": 151,
|
||||
"width": 0,
|
||||
"height": 13,
|
||||
"autoResize": false,
|
||||
|
|
@ -1212,7 +1218,7 @@
|
|||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 270,
|
||||
"top": 119.30232558139534,
|
||||
"top": 121,
|
||||
"width": 0,
|
||||
"height": 13,
|
||||
"autoResize": false,
|
||||
|
|
@ -1245,8 +1251,8 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 272,
|
||||
"top": 106.30232558139534,
|
||||
"left": 273,
|
||||
"top": 107,
|
||||
"width": 0,
|
||||
"height": 13,
|
||||
"autoResize": false,
|
||||
|
|
@ -1280,7 +1286,7 @@
|
|||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 266,
|
||||
"top": 147.30232558139534,
|
||||
"top": 148,
|
||||
"width": 0,
|
||||
"height": 13,
|
||||
"autoResize": false,
|
||||
|
|
@ -1313,8 +1319,8 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 384,
|
||||
"top": 117.72868217054264,
|
||||
"left": 381,
|
||||
"top": 121,
|
||||
"width": 0,
|
||||
"height": 13,
|
||||
"autoResize": false,
|
||||
|
|
@ -1347,8 +1353,8 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 382,
|
||||
"top": 104.72868217054264,
|
||||
"left": 378,
|
||||
"top": 107,
|
||||
"width": 0,
|
||||
"height": 13,
|
||||
"autoResize": false,
|
||||
|
|
@ -1381,8 +1387,8 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 389,
|
||||
"top": 144.72868217054264,
|
||||
"left": 385,
|
||||
"top": 148,
|
||||
"width": 0,
|
||||
"height": 13,
|
||||
"autoResize": false,
|
||||
|
|
@ -1464,7 +1470,7 @@
|
|||
"$ref": "AAAAAAFKBsPvQLRGncY="
|
||||
},
|
||||
"lineStyle": 1,
|
||||
"points": "245:141.30232558139534;411:138.72868217054264",
|
||||
"points": "245:142;407:142",
|
||||
"stereotypeDisplay": "label",
|
||||
"showVisibility": true,
|
||||
"showProperty": true,
|
||||
|
|
@ -1539,9 +1545,9 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 409,
|
||||
"top": 297,
|
||||
"width": 101,
|
||||
"left": 365,
|
||||
"top": 289,
|
||||
"width": 183,
|
||||
"height": 13,
|
||||
"autoResize": false,
|
||||
"underline": false,
|
||||
|
|
@ -1565,13 +1571,13 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 409,
|
||||
"top": 312,
|
||||
"width": 101,
|
||||
"left": 365,
|
||||
"top": 304,
|
||||
"width": 183,
|
||||
"height": 13,
|
||||
"autoResize": false,
|
||||
"underline": false,
|
||||
"text": "DerivedConcept",
|
||||
"text": "RefinedConcept",
|
||||
"horizontalAlignment": 2,
|
||||
"verticalAlignment": 5
|
||||
},
|
||||
|
|
@ -1591,8 +1597,8 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": -72,
|
||||
"top": 72,
|
||||
"left": -204,
|
||||
"top": 48,
|
||||
"width": 72,
|
||||
"height": 13,
|
||||
"autoResize": false,
|
||||
|
|
@ -1617,8 +1623,8 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": -72,
|
||||
"top": 72,
|
||||
"left": -204,
|
||||
"top": 48,
|
||||
"width": 0,
|
||||
"height": 13,
|
||||
"autoResize": false,
|
||||
|
|
@ -1637,9 +1643,9 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 404,
|
||||
"top": 292,
|
||||
"width": 111,
|
||||
"left": 360,
|
||||
"top": 284,
|
||||
"width": 193,
|
||||
"height": 38,
|
||||
"autoResize": false,
|
||||
"stereotypeLabel": {
|
||||
|
|
@ -1674,9 +1680,9 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 404,
|
||||
"top": 330,
|
||||
"width": 111,
|
||||
"left": 360,
|
||||
"top": 322,
|
||||
"width": 193,
|
||||
"height": 10,
|
||||
"autoResize": false
|
||||
},
|
||||
|
|
@ -1709,9 +1715,9 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 409,
|
||||
"top": 345,
|
||||
"width": 101,
|
||||
"left": 365,
|
||||
"top": 337,
|
||||
"width": 183,
|
||||
"height": 13,
|
||||
"autoResize": false,
|
||||
"underline": false,
|
||||
|
|
@ -1730,9 +1736,9 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 404,
|
||||
"top": 340,
|
||||
"width": 111,
|
||||
"left": 360,
|
||||
"top": 332,
|
||||
"width": 193,
|
||||
"height": 23,
|
||||
"autoResize": false
|
||||
},
|
||||
|
|
@ -1755,8 +1761,8 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": -48,
|
||||
"top": 48,
|
||||
"left": -136,
|
||||
"top": 32,
|
||||
"width": 10,
|
||||
"height": 10,
|
||||
"autoResize": false
|
||||
|
|
@ -1772,10 +1778,10 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 404,
|
||||
"top": 292,
|
||||
"width": 111,
|
||||
"height": 97,
|
||||
"left": 360,
|
||||
"top": 284,
|
||||
"width": 193,
|
||||
"height": 113,
|
||||
"autoResize": false,
|
||||
"stereotypeDisplay": "label",
|
||||
"showVisibility": true,
|
||||
|
|
@ -1786,6 +1792,8 @@
|
|||
"$ref": "AAAAAAFKB1Z5GLWbvqY="
|
||||
},
|
||||
"wordWrap": false,
|
||||
"suppressAttributes": false,
|
||||
"suppressOperations": false,
|
||||
"showMultiplicity": true,
|
||||
"showOperationSignature": true,
|
||||
"attributeCompartment": {
|
||||
|
|
@ -1827,8 +1835,8 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 443,
|
||||
"top": 231,
|
||||
"left": 439,
|
||||
"top": 229,
|
||||
"width": 0,
|
||||
"height": 13,
|
||||
"autoResize": false,
|
||||
|
|
@ -1861,8 +1869,8 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 428,
|
||||
"top": 231,
|
||||
"left": 424,
|
||||
"top": 229,
|
||||
"width": 0,
|
||||
"height": 13,
|
||||
"autoResize": false,
|
||||
|
|
@ -1895,8 +1903,8 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 472,
|
||||
"top": 232,
|
||||
"left": 468,
|
||||
"top": 230,
|
||||
"width": 0,
|
||||
"height": 13,
|
||||
"autoResize": false,
|
||||
|
|
@ -1928,7 +1936,7 @@
|
|||
"$ref": "AAAAAAFKB1Z5GLWaJhQ="
|
||||
},
|
||||
"lineStyle": 1,
|
||||
"points": "458.75742574257424:291;458.23267326732673:185",
|
||||
"points": "455.42424242424244:283;454.47474747474746:189",
|
||||
"stereotypeDisplay": "label",
|
||||
"showVisibility": true,
|
||||
"showProperty": true,
|
||||
|
|
@ -1971,7 +1979,7 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 296,
|
||||
"left": 274,
|
||||
"top": 319,
|
||||
"width": 56,
|
||||
"height": 13,
|
||||
|
|
@ -2006,7 +2014,7 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 324,
|
||||
"left": 302,
|
||||
"top": 304,
|
||||
"width": 0,
|
||||
"height": 13,
|
||||
|
|
@ -2040,7 +2048,7 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 324,
|
||||
"left": 302,
|
||||
"top": 349,
|
||||
"width": 0,
|
||||
"height": 13,
|
||||
|
|
@ -2176,7 +2184,7 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 377,
|
||||
"left": 333,
|
||||
"top": 319,
|
||||
"width": 0,
|
||||
"height": 13,
|
||||
|
|
@ -2210,7 +2218,7 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 374,
|
||||
"left": 330,
|
||||
"top": 305,
|
||||
"width": 0,
|
||||
"height": 13,
|
||||
|
|
@ -2244,7 +2252,7 @@
|
|||
"showShadow": true,
|
||||
"containerChangeable": false,
|
||||
"containerExtending": true,
|
||||
"left": 381,
|
||||
"left": 337,
|
||||
"top": 346,
|
||||
"width": 0,
|
||||
"height": 13,
|
||||
|
|
@ -2327,7 +2335,7 @@
|
|||
"$ref": "AAAAAAFKBsY0xbRv6tk="
|
||||
},
|
||||
"lineStyle": 1,
|
||||
"points": "245:340;403:340",
|
||||
"points": "245:340;359:340",
|
||||
"stereotypeDisplay": "label",
|
||||
"showVisibility": true,
|
||||
"showProperty": true,
|
||||
|
|
@ -2556,6 +2564,7 @@
|
|||
"visibility": "public",
|
||||
"isStatic": false,
|
||||
"isLeaf": false,
|
||||
"type": "",
|
||||
"isReadOnly": false,
|
||||
"isOrdered": false,
|
||||
"isUnique": false,
|
||||
|
|
@ -2591,7 +2600,7 @@
|
|||
"_parent": {
|
||||
"$ref": "AAAAAAFF+qBWK6M3Z8Y="
|
||||
},
|
||||
"name": "DerivedConcept",
|
||||
"name": "RefinedConcept",
|
||||
"ownedElements": [
|
||||
{
|
||||
"_type": "UMLGeneralization",
|
||||
|
|
|
|||
|
|
@ -21,63 +21,6 @@ solver for linear and quadratic programs. It further offers interfaces
|
|||
to third party software such as the GUI libraries Qt, Geomview, and
|
||||
the Boost Graph Library.
|
||||
|
||||
Organization of the Manual
|
||||
==========================
|
||||
|
||||
This manual is organized in several parts covering the many domains
|
||||
of computational geometry. Each part consists of several chapters,
|
||||
and each chapter is split into a *user manual* and a *reference
|
||||
manual*. The user manual gives the general idea and comes with examples.
|
||||
The reference manual presents the \sc{Api} of the various classes
|
||||
and functions.
|
||||
|
||||
The manual has a \ref packages with a short paragraph explaining
|
||||
what each package is about, what license
|
||||
it has, and on which other packages it depends. It further provides
|
||||
links to precompiled demo programs for the Windows platform.
|
||||
|
||||
The manual further has a class index, as well as a search box in the upper right of
|
||||
each page.
|
||||
The scope of the search box is the package you currently look at and the
|
||||
packages it depends on, or it is the whole manual when you are in
|
||||
a top level page such as the package overview.
|
||||
|
||||
Organization of the Reference Manual
|
||||
====================================
|
||||
|
||||
The \cgal library is a library of class templates. Consequently, we express
|
||||
the requirements on template arguments by specifying \em concepts
|
||||
and by providing \em models for concepts. See \ref intro_concept "here"
|
||||
for an explanation of concept/model.
|
||||
|
||||
The reference manual has pages for concepts and for models,
|
||||
and just as classes can be derived from other classes, concepts
|
||||
can \em refine other concepts, by adding requirements.
|
||||
|
||||
When a class is a model of a concept, its reference manual
|
||||
page has a link to the concept, and the API is mainly documented
|
||||
on the reference manual page of the concept. As a concept
|
||||
may refine another concept, the full API of a class is sometimes
|
||||
distributed over the pages of base classes and over the pages
|
||||
of several concepts.
|
||||
|
||||
Let's have a look at the following concepts and models.
|
||||
|
||||
\cgalFigureBegin{Manuak_Fig_concept_model,ConceptModel.svg}
|
||||
Models and concepts
|
||||
\cgalFigureEnd
|
||||
|
||||
On the reference manual page of the class `Derived` you
|
||||
will find a link to its base class `Base`, and a link to
|
||||
the concept `DerivedConcept`. Only the member function
|
||||
`Derived::two()` is documented in the reference manual
|
||||
page of `Derived`, as it inherits the method `one()` from
|
||||
its base class, and as it has to implement `eins()`
|
||||
and `zwei()`, because it is model of the concepts
|
||||
`DerivedConcept` and `BaseConcept`.
|
||||
|
||||
|
||||
|
||||
Demos and Examples
|
||||
==================
|
||||
|
||||
|
|
|
|||
|
|
@ -43,8 +43,10 @@ $search
|
|||
<ul>
|
||||
<li><a href="../Manual/index.html">Home</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/packages.html">Package Overview</a></li>
|
||||
<li><a href="../Manual/how_to_cite_cgal.html">Acknowledging CGAL</a></li>
|
||||
|
||||
</ul>
|
||||
<!--BEGIN DISABLE_INDEX-->
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
|
|
|
|||
|
|
@ -60,6 +60,7 @@ MathJax.Hub.Config({
|
|||
<ul>
|
||||
<li><a href="../Manual/index.html">Home</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/packages.html">Package Overview</a></li>
|
||||
<li><a href="../Manual/how_to_cite_cgal.html">Acknowledging CGAL</a></li>
|
||||
</ul>
|
||||
|
|
|
|||
Loading…
Reference in New Issue