This is the chapter template file of the for Software Documentation Layout Templates. The first level heading is tagged H1 , with lower level headings from H2 to H6 .
This is the chapter template file of the for Software Documentation Layout Templates. The first level heading is tagged H1 , with lower level headings from H2 to H6 .
The basic text paragraph style to use is Body . Other paragraph styles are available also, as indicated by the following sequence of paragraphs.
A BodyComment paragraph is similar a basic paragraph but the text font is italic.
An information of secondary importance can be formatted using the BodySmall style, which is similar to normal text paragraphs except that the text font size is smaller than normal body text.
Pieces of code, or text that requires a fixed font, can be tagged with the BodyVerbatim tag, as in the following excerpt:1 if (snd != null) { snd.play(); }
Bulleted and numbered list paragraphs, as well as list continuation paragraphs, are available at 3 levels. Other lists, such as alphabetic, roman and dashed, are only available at the first level. The following sequence indicates the use of these paragraph formsts.
A normal paragraph of text to separate the 2 list blocks...
Ofcourse, continuation paragraphs may also be inserted in numbered list items, using the LCont1 paragraph style.
...bla, bla, bla... Ridebis, et licet rideas. Ego ille quem nosti apros et quidem pulcherrimos cepi. Ipse? inquis. Ipse; non tamen ut omnino ab inertia mea et quete discederem.
LCont1 . ...bla, bla, bla... Ridebis, et licet rideas. Ego ille quem nosti apros et quidem pulcherrimos cepi.
LContVerbatim1 ...bla, bla, bla... Ridebis, et licet rideas. ...bla, bla, bla... Ridebis, et licet rideas.
LContVerbatim3 ...bla, bla, bla... Ridebis, et licet rideas. ...bla, bla, bla... Ridebis, et licet rideas.
...bla, bla, bla... Ridebis, et licet rideas. Ego ille quem nosti apros et quidem pulcherrimos cepi. Ipse? inquis. Ipse; non tamen ut omnino ab inertia mea et quete discederem.
LCont2 . ...bla, bla, bla... Ridebis, et licet rideas. Ego ille quem nosti apros et quidem pulcherrimos cepi.
LContVerbatim2 ...bla, bla, bla... Ridebis, et licet rideas. ...bla, bla, bla... Ridebis, et licet rideas.
Information that has the form of term and description can be formatted using a term paragraph followed by a description paragraph. There are 2 term and 3 description formats, which may be combined together to get the required effect.
We can divide the different possible combinations by whether the description starts on a new line or not.
This is the case when the term is tagged with the Dfn1.1Term paragraph format.
This is the case when the term is tagged with the Dfn1.1TermRIH (Run-In Head) paragraph format.
The definition of an acronym is formatted by using one of the above pairs of term-description paragraph formats, namely Dfn1.1TermRIH followed by Dfn1.2Desc , e.g.
When using acronyms in the text, you may improve the printed results by typing the acronym in lowercase and then tagging it wih the Acronym character tag. The following two examples show the results obtained using the Acronym chbaracter tag (a) and just using standard uppercase (b).
The disadvantage of using the Acronym character tag is that conversion to HTML may not have the same effect.
Tables, like figures and code listings, are always anchored in an empty PlaceHolder paragraph.
TblCellHeading
|
Aligning on decimals
|
TblCellHeadingCentre
|
---|---|---|
TblCellBody 2 |
||
hey.there 3 |
...bla, bla, bla... Ridebis, et licet rideas. Ego ille quem nosti apros et quidem pulcherrimos cepi. Ipse? inquis. Ipse; non tamen ut omnino ab inertia mea et quete discederem. . Ego ille quem nosti apros et quidem pulcherrimos cepi. Ipse? inquis. 4
Figures are formatted by first creating a PlaceHolder paragraph and then inserting a table using the Fig table format. An anchored frame is then inserted into the upper cell of the table, to contain the graphics for the figure.
...bla, bla, bla... Ridebis, et licet rideas. Ego ille quem nosti apros et quidem pulcherrimos cepi. Ipse? inquis. Ipse; non tamen ut omnino ab inertia mea et quete discederem. . Ego ille quem nosti apros et quidem pulcherrimos cepi. Ipse? inquis.
A full page figure may be inserted by clicking in a text paragraph5 and inserting a table of type FigFullPage . In the single cell of this table an Anchored Frame (17 x 21.4 cm, Below Current Line, Centred and Cropped) is inserted. This frame forces the table, which is set to float, to occupy exactly the next full page.
...bla, bla, bla... Ridebis, et licet rideas. Ego ille quem nosti apros et quidem pulcherrimos cepi. Ipse? inquis. Ipse; non tamen ut omnino ab inertia mea et quete discederem. . Ego ille quem nosti apros et quidem pulcherrimos cepi. Ipse? inquis.
Code listings are formatted by first creating a PlaceHolder paragraph and then inserting a table using the CodeListing table format. The code is then inserted into the single table cell, formatted as 1 paragraph per line. If you would like the lines to be numbered then use the CodeLine paragraph tags. Otherwise you can just use the CodeVerbatim style.
...bla, bla, bla... Ridebis, et licet rideas. Ego ille quem nosti apros et quidem pulcherrimos cepi. Ipse? inquis. Ipse; non tamen ut omnino ab inertia mea et quete discederem. . Ego ille quem nosti apros et quidem pulcherrimos cepi. Ipse? inquis.
Commands or tiny excerpts may be formatted using the Snippet table format, which does not require a caption. Again the table is encapsulated into a blank PlaceHolder paragraph.
uncompress archive.tar.Z tar xvf archive.tar |
...bla, bla, bla... Ridebis, et licet rideas. Ego ille quem nosti apros et quidem pulcherrimos cepi. Ipse? inquis. Ipse; non tamen ut omnino ab inertia mea et quete discederem. . Ego ille quem nosti apros et quidem pulcherrimos cepi. Ipse? inquis.
A little side margin note, relevant to adjacent text. |
There are a few special utility paragraphs provided for convenience. These are UtilClearRestOfPage , that forces anything that follows it to the top of next page, UtilSideSticky , that can be used as a little margin note to record a comment at a particluar point in the document such as the margin note next to this paragraph, and UtilTBD , that can be used in draft documents to record an issue that is still to be discussed or done, as is indicated below.
TBD Can other useful utility formats also be provided ?
...bla, bla, bla... Ridebis, et licet rideas. Ego ille quem nosti apros et quidem pulcherrimos cepi. Ipse? inquis. Ipse; non tamen ut omnino ab inertia mea et quete discederem. . Ego ille quem nosti apros et quidem pulcherrimos cepi. Ipse? inquis.
...bla, bla, bla... Ridebis, et licet rideas. Ego ille quem nosti apros et quidem pulcherrimos cepi. Ipse? inquis. Ipse; non tamen ut omnino ab inertia mea et quete discederem. . Ego ille quem nosti apros et quidem pulcherrimos cepi. Ipse? inquis
...bla, bla, bla... Ridebis, et licet rideas. Ego ille quem nosti apros et quidem pulcherrimos cepi. Ipse? inquis. Ipse; non tamen ut omnino ab inertia mea et quete discederem. . Ego ille quem nosti apros et quidem pulcherrimos cepi. Ipse? inquis.
...bla, bla, bla... Ridebis, et licet rideas. Ego ille quem nosti apros et quidem pulcherrimos cepi. Ipse? inquis. Ipse; non tamen ut omnino ab inertia mea et quete discederem. . Ego ille quem nosti apros et quidem pulcherrimos cepi. Ipse? inquis
[Document Date] - WebMaster | Copyright © CERN |