1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-08-04 13:13:25 +03:00

0027191: Documentation - redesign of information architecture -- revision (overview and samples)

Revision of Introduction, Overview, Samples, Tutorial

- Technical Overview is incorporated into Introduction
- Samples (from Overview) and Tutorial are moved into new section Tutorials and Samples
- Content of Getting Started section (Draw Test Harness and Experimenting with Draw Test Harness) is moved into Tutorial and Samples section.
- Content changes: links to Open Cascade website promoting paid training and support are deleted.
- Some pictures in User Guides (Foundation Classes, Modeling Data, Modeling Algorithms) and Tutorial are updated to improve quality and correct mistakes.
This commit is contained in:
Vera Sdobnova
2020-10-01 15:18:59 +03:00
committed by abv
parent 06ce029fb9
commit 0a6d974274
47 changed files with 1702 additions and 809 deletions

View File

@@ -5,6 +5,22 @@
@section OCCT_DM_SECTION_1 Introduction
OCCT documentation is provided in several forms:
- This overview provides general description of OCCT structure, functionality, modules, and features.
It is available in HTML format (generated by Doxygen) and includes User and Developer Guides.
The sources of this documentation are contained in **dox** subdirectory of OCCT sources
(plain text format is used, with mixed MarkDown / Doxygen syntax mark-up).
- User and Developer Guides describing in details OCCT modules and development tools are also available in
Adobe Portable Document Format (PDF). To read this format, you need Adobe Acrobat Reader,
which is a freeware and can be downloaded from the Adobe site.
- Full reference documentation covering all OCCT classes generated automatically by Doxygen
software is provided in HTML format.
Reference documentation is presented in **Modules --> Toolkits --> Packages --> Classes**
logic structure with cross-references to all OCCT classes and complete in-browser search by all classes.
This document provides practical guidelines for generation and editing of OCCT user documentation.
@section OCCT_DM_SECTION_2 Prerequisites
@@ -122,16 +138,16 @@ The documentation is generated in subfolder *doc* :
@section OCCT_DM_SECTION_4 Adding a New Document
Place a new document in the folder taking into account its logical position in the documentation hierarchy. For instance, the document *svn.md* about the use of SVN to work with OCCT source code can be placed into <i>/dox/dev_guides/</i>.
Place a new document in the folder taking into account its logical position in the documentation hierarchy. For instance, the document *svn.md* about the use of SVN to work with OCCT source code can be placed into <i>/dox/contribution/</i>.
If there are images in the document, it should be placed in its own folder containing a subfolder for images. For instance:
* <i> /dox/dev_guides/svn/ </i> -- for *svn.md* file;
* <i> /dox/dev_guides/svn/images/ </i> -- for images.
* <i> /dox/contribution/svn/ </i> -- for *svn.md* file;
* <i> /dox/contribution/svn/images/ </i> -- for images.
Add a relative path to *svn.md* in file <i>dox/FILES.txt</i>. For instance
@verbatim
dev_guides/svn/svn.md
contribution/svn/svn.md
@endverbatim
**Note** that the order of paths to documents in *FILES.txt* is reproduced in the Table of Contents in the HTML output, thus they need to be placed logically.
@@ -154,7 +170,7 @@ http://www.stack.nl/~dimitri/doxygen/manual
A document file in *.md format must start with a proper header defining a caption and a unique tag.
@verbatim
Documentation System {#dev_guides__documentation}
Documentation System {#contribution__documentation}
=====================
@endverbatim