|
How To Use
|
|
How To Use
|
Your topic can be organized as pages and subpages, each of which build a single visible page in the generated document. Pages may or may not be organized in different files. Each page can be defined as a subpage within exactly one parent page. Principle: parent page defines contained subpages.
Each page has an internal structure consisting of sections and subsections. You can add an automatically generated table of contents by adding "[TOC]" somewhere within your page.
// MyMainTopic.markdown \page PageMainTopic Some main title [TOC] // define subpages if existing − \subpage PageSubTopicA − \subpage PageSubTopicB \section SecTopA Some headline ... \subsection SubSecTopA_1 Another headline ...
// MySubTopicA.markdown \page PageSubTopicA Some title [TOC] \section SecSubTopA_HeaderA Some headline ... \subsection SubSecSubTopA_HeaderA_1 Another headline ...
Example page: AboutDemoPage - Some Topic (pages and sections)
Your topic can be organized as groups and subgroups, each of which build a single visible page in the generated document. Groups may or may not be organized in different files. Each group can be defined as a subgroup within exactly one parent group. Principle: Subgroup defines parent group it belongs to.
Each page has an internal structure consisting of head lines of differing levels. Headlines can be written as simple underlined text, with prefixes "#" or with html tags.
// MyMainTopic.markdown \defgroup GrpMainTopic Some main title @{ ... Some headline ============= ... Another headline ---------------- ... @}
// MySubTopicA.markdown \defgroup GrpSubTopicA Some title @{ \ingroup GrpMainTopic ... Some headline ============= ... Another headline ---------------- ... @}
Example page: AboutDemoPage - Some other topic (groups and subgroups)
1.8.8 
