Skip to content

Commit b8781ba

Browse files
committed
Update introduction etc. page
1 parent e2e441e commit b8781ba

1 file changed

Lines changed: 23 additions & 9 deletions

File tree

src/IntroductionAndConclusion.asciidoc

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
1-
:doctitle: Introduction and Conclusion Files
1+
:doctitle: Introduction, Conclusion Files and Additional Files
2+
:sectnums:
3+
:toc: left
4+
:toclevels: 4
25

3-
You can use the link:CommandLine[CommandLine] options `--introduction=FILE-NAME` and `--conclusion=FILE-NAME` to add additional special pages to your documentation.
6+
## Introduction
47

5-
Since PasDoc 0.16.0 you can also use option `--additional=FILE-NAME` to provide any number of additional files. Option `--additional` can be shortened to `-A`.
8+
You can provide extra documentation files to be included in your documentation, like an introduction and a conclusion. This is useful if you want to have some general information about your codebase, not related to any particular item in the code.
9+
10+
Use these link:CommandLine[CommandLine] options:
11+
12+
- `--introduction=FILE-NAME`
13+
- `--conclusion=FILE-NAME`
14+
- `--additional=FILE-NAME` (use this as many time as you need, to add any number of additional files). Short form: `-A`.
615
716
## [[simple-example]] Simple example
817

@@ -25,7 +34,7 @@ In HTML output you will get an additional page introduction.html in your documen
2534

2635
## [[format-of-introductionconclusion-files]] Format of introduction/conclusion files
2736

28-
The text inside the introduction/conclusion files is treated very much like normal pasdoc descriptions. This means that all rules explained in link:WritingDocumentation[WritingDocumentation] apply here too: @-tags are allowed, you must write @@ to get single @ character, URLs are automatically turned into links, an empty line starts a new paragraph etc.
37+
The text inside the introduction/conclusion files is treated very much like normal pasdoc descriptions. This means that all rules explained in link:WritingDocumentation[Writing Documentation] apply here too: @-tags are allowed, you must write `@@` to get single `@` character, URLs are automatically turned into links, an empty line starts a new paragraph etc.
2938

3039
In particular, you can use the link:LinkTag[@link tag] to link _from_ introduction/conclusion to other items in your documentation. Also, you can create links _to_ the introduction/conclusion by specifying the introduction/conclusion filename (without extension) as the link target, e.g.
3140

@@ -45,17 +54,22 @@ Specify the title of introduction/conclusion. In HTML output, the argument is th
4554

4655
@section(HeadingLevel AnchorName Section title)::
4756
Start a new section. The `@section` tag contains:
48-
* _HeadingLevel_: a number used to indicate section nesting. It must be an integer >= 1. E.g. in link:HtmlOutput[HtmlOutput] HeadingLevel = 1 results in <h2>Section title</h2>, HeadingLevel = 2 results in <h3>Section title</h3> etc. In link:LatexOutput[LatexOutput] HeadingLevel = 1 results in `\section{Section title}` , HeadingLevel = 2 results in `\subsection{Section title}` etc.
49-
* _AnchorName_: used to link to a given section (from the introduction/conclusion files or a Pascal items descriptions) using a LinkTag_. Allowed AnchorNames are valid Pascal identifiers (first character is an underscore or a letter, followed by any combination of letters, digits and underscores).
50-
* _Section title_: title shown in the documentation.
57+
* _HeadingLevel_: a number used to indicate section nesting. It must be an integer >= 1. E.g.
58+
+
59+
--
60+
- in the link:HtmlOutput[HTML output format] HeadingLevel = 1 results in `<h2>Section title</h2>`, HeadingLevel = 2 results in `<h3>Section title</h3>` etc.
61+
- In the link:LatexOutput[LaTeX output format] HeadingLevel = 1 results in `\section{Section title}` , HeadingLevel = 2 results in `\subsection{Section title}` etc.
62+
--
63+
* _AnchorName_: used to link to a given section (from the introduction/conclusion files or a Pascal items descriptions) using a link:LinkTag[@link tag]. Allowed `AnchorNames` are valid Pascal identifiers (first character is an underscore or a letter, followed by any combination of letters, digits and underscores).
64+
* _Section title_: title shown in the documentation.
5165

5266
@anchor(AnchorName)::
53-
Set up an anchor at this place. The anchor name must be a valid Pascal identifier. Anchors are not visible in the generated documentation, but you can link to them with a link:LinkTag[@link tag]
67+
Set up an anchor at this place. The anchor name must be a valid Pascal identifier. Anchors are not visible in the generated documentation, but you can link to them with a link:LinkTag[@link tag].
5468

5569
link:TableOfContentsTag[@tableOfContents]::
5670
Insert table of contents here.
5771

5872
## [[more-examples]] More examples
5973

6074
* See the https://github.com/pasdoc/pasdoc/blob/master/tests/testcases/ok_introduction.txt[test introduction file].
61-
* See also link:PasDocAutoDoc[PasDocAutoDoc] -- there's an "Overview" page included, and it was generated using --introduction command-line option.
75+
* See also link:PasDocAutoDoc[PasDocAutoDoc] -- there's an "Overview" page included, and it was generated using `--introduction` command-line option.

0 commit comments

Comments
 (0)