Oracle® DARB XML Templates Book Title Release 6 for Adobe FrameMaker 10 on Windows A12345-01 |
|
![]() Previous |
![]() Next |
Beta Draft: 2013-10-01
There is NO LONGER a maximum number of pages in an 8.5 by 11 inch book. Therefore, splitting books into volumes is NOT required if the book is more than 500 pages.
The cvrspine FILE IS NO LONGER REQUIRED.
You can continue to submit books that are split into volumes and you can continue to include a cvrspine file but you do not need to do this and there is no advantage. If you are required to split your book into volumes (extremely rare), you will know this before archiving and you will probably have other requirements.
You must include an introductory element, such as a Para, before inserting the first Sect1 element. This requirement prevents arriving at an empty XHTML page for a chapter or appendix if you have selected the option of breaking at Sect1 when generating XHTML output. Consider supplying links to the Sect1 or RefSect1 elements if you plan to break at Sect1, RefSect1, or lower.
You create a reference-type chapter or appendix by using the following elements inside the RefEntry element within a chapter or appendix template file.
RefSect1
RefSect2
RefSect3
RefSect4
RefSubSect
Note: You do not need the template file ref_chap.fm to create a reference-type chapter or appendix. All elements and formats you need to create reference-type documentation are in the chapter.fm or the appendix.fm template. |
You can include Sectn elements at the beginning of a chapter or appendix that contains reference information. However, once you insert a RefEntry, you can no longer insert Sectn elements. Therefore, place all narrative or tutorial-type text at the beginning of a chapter or appendix, before reference information.
Beta Draft: 2013-10-01
The construction of this first-level reference information is RefEntry, followed by RefSect1, followed by Title. The underlying paragraph format, CM1 CmdHead1, breaks to a new page.
RefSect1 elements appear as entries in the table of contents.
The first paragraph should contain the command overview or a short description of the reference information.
Command Parameters - Uses RefSubSect Element
Text - within VariableList, uses ListIItem > Para
Text.
Text.
Code in this parameter description.
Text.
Format - Uses RefSubSect Element
Use RefSubSect elements for repetitive headings that do not produce table of contents entries. A RefSubSect is usually followed by syntax, code, or a railroad diagram. Sometimes. it might be followed by a Syntax table.
Command Parameters - Uses RefSubSect Element
Text.
Text.
Text.
Code in this parameter description.
Text.
Nesting VariableList Elements
You can nest VariableList elements. However, the only difference is indentation. Across several pages, PDF or HTML, it can be difficult to follow the level.
Description of option.
Description of option.
Description of option.
Description of option.
Description of option.
Description of option.
Text.
RefSect2 elements appear as entries in the table of contents, break to page, and form a running heading on verso pages. Typically, RefSect2 elements are rarely used. Instead, RefSubSect elements are used to provide redundant headings that do not appear in the table of contents, such as, Format, Description, Syntax, Examples.
Text.
Although this is a RefSect2 element, it uses the RenderAs = RefSect3 attribute which causes the table of contents entry to be aligned with RefSect3 elements, rather than RefSect2 elements. Because reference information has no numbering in the headings, this is acceptable formatting.
Although this is a RefSect3 element, it uses the RenderAs = RefSect4 attribute which causes the table of contents entry to be aligned with RefSect4 elements, rather than RefSect3 elements. Because reference information has no numbering in the headings, this is acceptable formatting.