PG-RST Extensions

PG-RST ExtensionsYou can create custom roles based on the existing ones. This is how you create and then use custom roles... role:: small-caps:class: small-capsThis text is in :small-caps:`Small Caps`.This text is inSmall Caps.You can attach more than one class to a role:.. role:: big-and-bold:class: x-large boldThis text is :big-and-bold:`big and bold`.This text isbig and bold.StylesYou can redefine the rendering of elements:.. style:: emphasis:class: gesperrtNow *emphasis* will be rendered as gesperrt.Nowemphasiswill be rendered as gesperrt... style:: strong:class: small-capsAnd **Strong Emphasis** will be rendered as small-caps.AndStrong Emphasiswill be rendered as small-caps... style:: strong:class: small-caps x-large boldAnd **Strong Emphasis** will be rendered as big bold small-caps.AndStrong Emphasiswill be rendered as big bold small-caps... style:: literal:class: red``literally red``.. style:: superscript:class: green:superscript:`sup`\ er.. style:: title_reference:class: blue:title-reference:`Hamlet` and `Othello`.literally redsuperHamletandOthello.You can semantically markup foreign text:.. role:: french:class: language-fr italics:french:`Pas de double` is the French for "father of twins".Pas de doubleis the French for "father of twins".PaginationPagination is important if you generate PDFs. See the Directives For Pagination Table.Directives For PaginationDirectiveExplanationclearpageThis directive inserts a page break.cleardoublepageThis directive inserts page breaks so that the next item starts on a right-hand page.vfill(PDF only.)This directive generates `elastic´ vertical space. This space expands to all of the free space on one page. If you use this more than once on a page, the free space is equally divided among all invocations.To vertically align an item to the bottom, usevfillbefore that item.To vertically align an item about 1/3 of the page usevfillonce before the item and twice after the item.frontmatter(PDF only.)Put this directive at the start of your book.Thepgheaderdirective uses this directive internally, so you can omitfrontmatterwhenever you usepgheader.This directive turns on roman page numbers.mainmatter(PDF only.)Put this directive after the table of contents and before the first chapter.This directive switches from roman page numbering to arabic page numbering and resets the page counter.backmatter(PDF only.)Put this directive before appendices or indices.Table of ContentsUse the RSTcontentsdirective to automatically generate a table of contents.N.B. You may also provide a table of contents manually.In PG-RST thecontentsdirective requires you to specify an argument or thelocaloption.Thelocaloption displays a local table of contents, containing only the sub-sections of the section in which it is declared.Thepage-numbersoption displays the original page number in the TOC... contents:: A TOC With Page Numbers:depth: 2:page-numbers:A TOC With Page NumbersInstalling EpubMakerWindowsDebianPG-RST ClassesClasses For Inline TextClasses For Block TextClasses For Front Matter MarkupPG-RST ExtensionsStylesPaginationTable of ContentsList of FiguresList of TablesToc-EntryFootnotesPage NumbersDropcapsTablesPG MetadataTop BoilerplateMetadata DirectiveBottom BoilerplatePG-RST Best PracticesExamples and TestsSection 3.1Section 3.2Section 3.3List of FiguresUse thelofdirective to generate a list of figures automatically.N.B. You may also provide a list of figures manually... lof:: A List of Figures:page-numbers::backlinks: noneA List of FiguresRichard and Drucilla MartinList of TablesUse thelotdirective to generate a list of tables.N.B. You may also provide a list of tables manually... lot:: A List of Tables:page-numbers::backlinks: noneA List of TablesClasses For Inline Text IClasses For Inline Text IIClasses For Inline Text IIIClasses For Block TextClasses For Front Matter MarkupDirectives For PaginationFootnote PositionsSupport for dropcaps in output formatsDemo TableTruth table for “and”Fields In the PG SchemeFields In the DC SchemeFields In the MARCREL SchemeFields Without SchemeTABLE 8Types of Computers Used in the Systems ReportedToc-EntryUse thetoc-entrydirective to:provide an alternate toc entrysuppress a toc entry, orswitch toc gathering on or off.Atoc-entrywith argument sets the argument as toc entry for the next section, figure or table.Atoc-entrywithout argument suppresses the toc entry for the next section, figure or table.Use thedepthoption to set the depth up to which section titles are gathered for the toc. A depth of 0 switches toc gathering off... toc-entry:: An Alternative CaptionFootnotesAlways define footnotes right after the paragraph they are referenced.Positioning of footnotesFormatPositionHTMLCollected under the footnotes directive.EPUBIdem.TXTWhere they are defined.PDFAt the bottom of the current page.To collect the footnotes use thefootnotesdirective. This directive will output a section with title and all footnotes in the document will be moved inside the section.In PDF and TXT formats thefootnotesdirective will do nothing.1Test23... footnotes:: Footnotes:class: smallerPage NumbersThe sequence[pg n]will convert into a page number marker of n. n can be any arabic or roman numeral. The sequence itself will be removed from the text flow leaving a page anchor. Theremustbe spaces around the sequence. If the page break is in the middle of a word, join the word and put the sequence at the end of the word.Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diamnonumy eirmod tempor invidunt [pg 42] ut labore et dolore magnaaliquyam erat, sed diam voluptua. At vero eos et accusam et justoduo dolores [pg xviii] et ea rebum.Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt [pg 42] ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores [pg xviii] et ea rebum.A reference to a page number can be inserted with the sequence[pg n]_. This will generate a link to the page anchor.See page [pg 42]_.See page [pg 42]_.An invisible page number can be inserted with the sequence[pg!n].Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diamnonumy eirmod tempor invidunt [pg!43] ut labore et dolore magnaaliquyam erat, sed diam voluptua. At vero eos et accusam et justoduo dolores et ea rebum. See page [pg 43]_.Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt [pg!43] ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. See page [pg 43]_.See page [pg iii]_.DropcapsYou can insert dropcaps with thedropcapdirective. You can use either an enlarged character or an image as dropcap. You can also specify a span of character that should be set in small-caps after the dropcap initial.Support for dropcaps in output formatsFormatLetterImageHTMLenlarged and droppedresized and droppedEPUBenlarged on baselineresized on baselineTXTnormal sizealt textPDFenlarged and dropped5resized and dropped5The first argument (mandatory) states the character(s) to replace with caps. It must match the beginning of the next paragraph.The second (optional) argument states the characters to replace with small-caps. It must also match the beginning of the next paragraph... clearpage::.. dropcap:: L Lorem ipsum:lines: 4:indents: -1.25em 0.5emLorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diamnonumy eirmod tempor invidunt ut labore et dolore magna aliquyamerat, sed diam voluptua. At vero eos et accusam et justo duodolores et ea rebum. Stet clita kasd gubergren, no sea takimatasanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet,consetetur sadipscing elitr, sed diam nonumy eirmod tempor inviduntut labore et dolore magna aliquyam erat, sed diam voluptua.Lorem ipsumdolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.Thelinesoption (PDF only) specifies how many lines the dropcap should span. Default is 2.Theindentsoption (PDF only) can specifiy up to 2 length values. The first one is the indent of the first line, the second one the indent of the following lines. The indent is calculated from the right border of the dropcap letter. Defaults are 0em and 0.5em.Theimageoption specifies the image url. In plain text and EPUB the image will not be used... clearpage::.. dropcap:: G:image: images/G.png:lines: 4Gorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diamnonumy eirmod tempor invidunt ut labore et dolore magna aliquyamerat, sed diam voluptua. At vero eos et accusam et justo duodolores et ea rebum. Stet clita kasd gubergren, no sea takimatasanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet,consetetur sadipscing elitr, sed diam nonumy eirmod tempor inviduntut labore et dolore magna aliquyam erat, sed diam voluptua.[image]orem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.TablesBe careful with tables because the table support of many ereaders is weak or nil.Tables also support these options:widthMakes the table that wide.widthsA space-separated list of unitless values, each specifying the relative width of one table column.If you don’t use the optionwidths, the column widths are calculated from the layout of the table in your source file.alignsHorizontally align the columns.A space-separated list of alignments, each specifying the alignment of one column.Valid alignments values are: left, center, right and justify.vertical-alignsVertically align the columns.A space-separated list of vertical alignments, each specifying the alignment of one column.Valid alignments values are: top, middle, and bottom.Note: vertical alignment is fully supported in HTML only. Other formats may support it in varying degrees.summary(HTML only.)Puts a summary attribute on the table element.These are the extra classes supported by PG-RST:norulesOmits the rules between table rows. (Not the rule between header and body nor the rules at the top and bottom of the table.)Use this class when the eye can follow the table rows without the aid of rules... table:: Demo Table:width: 100%:align: center:widths: 3 1 1 1:aligns: justify justify center right:vertical-aligns: top middle bottom top:summary: This table contains valuable data.+------------------------+-----------+----------+-----------+| Header row, column 1 | Justified | Centered | Price ($) || (header rows optional) | | | |+========================+===========+==========+===========+| row 1 | column | column | 1.23 |+------------------------+-----------+----------+-----------+| row 2 | col col | col | 45.67 || | col col | | || | col col | | || | col | | |+------------------------+-----------+----------+-----------+| row 3 | Cells may span columns. || | Lorem ipsum dolor sit amet, || | consetetur sadipscing elitr, sed || | nonumy eirmod tempor invidunt ut || | labore et dolore magna aliquyam || | sed diam voluptua. At vero eos || | accusam et justo duo dolores et || | rebum. |+------------------------+-----------+----------+-----------+| Cells may span rows and | Cells | row 4 || columns. Lorem ipsum dolor sit | may span +-----------+| amet, consetetur adipiscing. | rows. | row 5 |+------------------------------------+----------+-----------+Demo TableHeader row, column 1 (header rows optional)JustifiedCenteredPrice ($)row 1columncolumn1.23row 2col col col col col col colcol45.67row 3Cells may span columns. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam sed diam voluptua. At vero eos accusam et justo duo dolores et rebum.Cells may span rows and columns. Lorem ipsum dolor sit amet, consetetur adipiscing.Cells may span rows.row 4row 5.. table:: Truth table for “and”:class: norules:align: center:width: 50%===== ===== =========A B A and B===== ===== =========False False FalseTrue False FalseFalse True FalseTrue True True===== ===== =========Truth table for “and”ABA and BFalseFalseFalseTrueFalseFalseFalseTrueFalseTrueTrueTrue

You can create custom roles based on the existing ones. This is how you create and then use custom roles.

.. role:: small-caps:class: small-capsThis text is in :small-caps:`Small Caps`.This text is inSmall Caps.

.. role:: small-caps:class: small-capsThis text is in :small-caps:`Small Caps`.

This text is inSmall Caps.

You can attach more than one class to a role:

.. role:: big-and-bold:class: x-large boldThis text is :big-and-bold:`big and bold`.This text isbig and bold.

.. role:: big-and-bold:class: x-large boldThis text is :big-and-bold:`big and bold`.

This text isbig and bold.

StylesYou can redefine the rendering of elements:.. style:: emphasis:class: gesperrtNow *emphasis* will be rendered as gesperrt.Nowemphasiswill be rendered as gesperrt... style:: strong:class: small-capsAnd **Strong Emphasis** will be rendered as small-caps.AndStrong Emphasiswill be rendered as small-caps... style:: strong:class: small-caps x-large boldAnd **Strong Emphasis** will be rendered as big bold small-caps.AndStrong Emphasiswill be rendered as big bold small-caps... style:: literal:class: red``literally red``.. style:: superscript:class: green:superscript:`sup`\ er.. style:: title_reference:class: blue:title-reference:`Hamlet` and `Othello`.literally redsuperHamletandOthello.You can semantically markup foreign text:.. role:: french:class: language-fr italics:french:`Pas de double` is the French for "father of twins".Pas de doubleis the French for "father of twins".

You can redefine the rendering of elements:

.. style:: emphasis:class: gesperrtNow *emphasis* will be rendered as gesperrt.Nowemphasiswill be rendered as gesperrt.

.. style:: emphasis:class: gesperrtNow *emphasis* will be rendered as gesperrt.

Nowemphasiswill be rendered as gesperrt.

.. style:: strong:class: small-capsAnd **Strong Emphasis** will be rendered as small-caps.AndStrong Emphasiswill be rendered as small-caps.

.. style:: strong:class: small-capsAnd **Strong Emphasis** will be rendered as small-caps.

AndStrong Emphasiswill be rendered as small-caps.

.. style:: strong:class: small-caps x-large boldAnd **Strong Emphasis** will be rendered as big bold small-caps.AndStrong Emphasiswill be rendered as big bold small-caps.

.. style:: strong:class: small-caps x-large boldAnd **Strong Emphasis** will be rendered as big bold small-caps.

AndStrong Emphasiswill be rendered as big bold small-caps.

.. style:: literal:class: red``literally red``.. style:: superscript:class: green:superscript:`sup`\ er.. style:: title_reference:class: blue:title-reference:`Hamlet` and `Othello`.literally redsuperHamletandOthello.

.. style:: literal:class: red``literally red``.. style:: superscript:class: green:superscript:`sup`\ er.. style:: title_reference:class: blue:title-reference:`Hamlet` and `Othello`.

literally redsuperHamletandOthello.

literally red

super

HamletandOthello.

You can semantically markup foreign text:

.. role:: french:class: language-fr italics:french:`Pas de double` is the French for "father of twins".Pas de doubleis the French for "father of twins".

.. role:: french:class: language-fr italics:french:`Pas de double` is the French for "father of twins".

Pas de doubleis the French for "father of twins".

PaginationPagination is important if you generate PDFs. See the Directives For Pagination Table.Directives For PaginationDirectiveExplanationclearpageThis directive inserts a page break.cleardoublepageThis directive inserts page breaks so that the next item starts on a right-hand page.vfill(PDF only.)This directive generates `elastic´ vertical space. This space expands to all of the free space on one page. If you use this more than once on a page, the free space is equally divided among all invocations.To vertically align an item to the bottom, usevfillbefore that item.To vertically align an item about 1/3 of the page usevfillonce before the item and twice after the item.frontmatter(PDF only.)Put this directive at the start of your book.Thepgheaderdirective uses this directive internally, so you can omitfrontmatterwhenever you usepgheader.This directive turns on roman page numbers.mainmatter(PDF only.)Put this directive after the table of contents and before the first chapter.This directive switches from roman page numbering to arabic page numbering and resets the page counter.backmatter(PDF only.)Put this directive before appendices or indices.

Pagination is important if you generate PDFs. See the Directives For Pagination Table.

Directive

Explanation

clearpage

This directive inserts a page break.

cleardoublepage

This directive inserts page breaks so that the next item starts on a right-hand page.

vfill

(PDF only.)

This directive generates `elastic´ vertical space. This space expands to all of the free space on one page. If you use this more than once on a page, the free space is equally divided among all invocations.

To vertically align an item to the bottom, usevfillbefore that item.

To vertically align an item about 1/3 of the page usevfillonce before the item and twice after the item.

frontmatter

(PDF only.)

Put this directive at the start of your book.

Thepgheaderdirective uses this directive internally, so you can omitfrontmatterwhenever you usepgheader.

This directive turns on roman page numbers.

mainmatter

(PDF only.)

Put this directive after the table of contents and before the first chapter.

This directive switches from roman page numbering to arabic page numbering and resets the page counter.

backmatter

(PDF only.)

Put this directive before appendices or indices.

Table of ContentsUse the RSTcontentsdirective to automatically generate a table of contents.N.B. You may also provide a table of contents manually.In PG-RST thecontentsdirective requires you to specify an argument or thelocaloption.Thelocaloption displays a local table of contents, containing only the sub-sections of the section in which it is declared.Thepage-numbersoption displays the original page number in the TOC... contents:: A TOC With Page Numbers:depth: 2:page-numbers:A TOC With Page NumbersInstalling EpubMakerWindowsDebianPG-RST ClassesClasses For Inline TextClasses For Block TextClasses For Front Matter MarkupPG-RST ExtensionsStylesPaginationTable of ContentsList of FiguresList of TablesToc-EntryFootnotesPage NumbersDropcapsTablesPG MetadataTop BoilerplateMetadata DirectiveBottom BoilerplatePG-RST Best PracticesExamples and TestsSection 3.1Section 3.2Section 3.3

Use the RSTcontentsdirective to automatically generate a table of contents.

N.B. You may also provide a table of contents manually.

In PG-RST thecontentsdirective requires you to specify an argument or thelocaloption.

Thelocaloption displays a local table of contents, containing only the sub-sections of the section in which it is declared.

Thepage-numbersoption displays the original page number in the TOC.

.. contents:: A TOC With Page Numbers:depth: 2:page-numbers:

A TOC With Page NumbersInstalling EpubMakerWindowsDebianPG-RST ClassesClasses For Inline TextClasses For Block TextClasses For Front Matter MarkupPG-RST ExtensionsStylesPaginationTable of ContentsList of FiguresList of TablesToc-EntryFootnotesPage NumbersDropcapsTablesPG MetadataTop BoilerplateMetadata DirectiveBottom BoilerplatePG-RST Best PracticesExamples and TestsSection 3.1Section 3.2Section 3.3

Installing EpubMakerWindowsDebianPG-RST ClassesClasses For Inline TextClasses For Block TextClasses For Front Matter MarkupPG-RST ExtensionsStylesPaginationTable of ContentsList of FiguresList of TablesToc-EntryFootnotesPage NumbersDropcapsTablesPG MetadataTop BoilerplateMetadata DirectiveBottom BoilerplatePG-RST Best PracticesExamples and TestsSection 3.1Section 3.2Section 3.3

Installing EpubMaker

Windows

Debian

PG-RST Classes

Classes For Inline Text

Classes For Block Text

Classes For Front Matter Markup

PG-RST Extensions

Styles

Pagination

Table of Contents

List of Figures

List of Tables

Toc-Entry

Footnotes

Page Numbers

Dropcaps

Tables

PG Metadata

Top Boilerplate

Metadata Directive

Bottom Boilerplate

PG-RST Best Practices

Examples and Tests

Section 3.1

Section 3.2

Section 3.3

List of FiguresUse thelofdirective to generate a list of figures automatically.N.B. You may also provide a list of figures manually... lof:: A List of Figures:page-numbers::backlinks: noneA List of FiguresRichard and Drucilla Martin

Use thelofdirective to generate a list of figures automatically.

N.B. You may also provide a list of figures manually.

.. lof:: A List of Figures:page-numbers::backlinks: noneA List of FiguresRichard and Drucilla Martin

.. lof:: A List of Figures:page-numbers::backlinks: none

A List of FiguresRichard and Drucilla Martin

Richard and Drucilla Martin

List of TablesUse thelotdirective to generate a list of tables.N.B. You may also provide a list of tables manually... lot:: A List of Tables:page-numbers::backlinks: noneA List of TablesClasses For Inline Text IClasses For Inline Text IIClasses For Inline Text IIIClasses For Block TextClasses For Front Matter MarkupDirectives For PaginationFootnote PositionsSupport for dropcaps in output formatsDemo TableTruth table for “and”Fields In the PG SchemeFields In the DC SchemeFields In the MARCREL SchemeFields Without SchemeTABLE 8Types of Computers Used in the Systems Reported

Use thelotdirective to generate a list of tables.

N.B. You may also provide a list of tables manually.

.. lot:: A List of Tables:page-numbers::backlinks: noneA List of TablesClasses For Inline Text IClasses For Inline Text IIClasses For Inline Text IIIClasses For Block TextClasses For Front Matter MarkupDirectives For PaginationFootnote PositionsSupport for dropcaps in output formatsDemo TableTruth table for “and”Fields In the PG SchemeFields In the DC SchemeFields In the MARCREL SchemeFields Without SchemeTABLE 8Types of Computers Used in the Systems Reported

.. lot:: A List of Tables:page-numbers::backlinks: none

A List of TablesClasses For Inline Text IClasses For Inline Text IIClasses For Inline Text IIIClasses For Block TextClasses For Front Matter MarkupDirectives For PaginationFootnote PositionsSupport for dropcaps in output formatsDemo TableTruth table for “and”Fields In the PG SchemeFields In the DC SchemeFields In the MARCREL SchemeFields Without SchemeTABLE 8Types of Computers Used in the Systems Reported

Classes For Inline Text IClasses For Inline Text IIClasses For Inline Text IIIClasses For Block TextClasses For Front Matter MarkupDirectives For PaginationFootnote PositionsSupport for dropcaps in output formatsDemo TableTruth table for “and”Fields In the PG SchemeFields In the DC SchemeFields In the MARCREL SchemeFields Without SchemeTABLE 8Types of Computers Used in the Systems Reported

Toc-EntryUse thetoc-entrydirective to:provide an alternate toc entrysuppress a toc entry, orswitch toc gathering on or off.Atoc-entrywith argument sets the argument as toc entry for the next section, figure or table.Atoc-entrywithout argument suppresses the toc entry for the next section, figure or table.Use thedepthoption to set the depth up to which section titles are gathered for the toc. A depth of 0 switches toc gathering off... toc-entry:: An Alternative Caption

Use thetoc-entrydirective to:

provide an alternate toc entry

suppress a toc entry, or

switch toc gathering on or off.

Atoc-entrywith argument sets the argument as toc entry for the next section, figure or table.

Atoc-entrywithout argument suppresses the toc entry for the next section, figure or table.

Use thedepthoption to set the depth up to which section titles are gathered for the toc. A depth of 0 switches toc gathering off.

.. toc-entry:: An Alternative Caption

FootnotesAlways define footnotes right after the paragraph they are referenced.Positioning of footnotesFormatPositionHTMLCollected under the footnotes directive.EPUBIdem.TXTWhere they are defined.PDFAt the bottom of the current page.To collect the footnotes use thefootnotesdirective. This directive will output a section with title and all footnotes in the document will be moved inside the section.In PDF and TXT formats thefootnotesdirective will do nothing.1Test23... footnotes:: Footnotes:class: smaller

Always define footnotes right after the paragraph they are referenced.

Format

Position

HTML

Collected under the footnotes directive.

EPUB

Idem.

TXT

Where they are defined.

PDF

At the bottom of the current page.

To collect the footnotes use thefootnotesdirective. This directive will output a section with title and all footnotes in the document will be moved inside the section.

In PDF and TXT formats thefootnotesdirective will do nothing.1

Test23.

.. footnotes:: Footnotes:class: smaller

Page NumbersThe sequence[pg n]will convert into a page number marker of n. n can be any arabic or roman numeral. The sequence itself will be removed from the text flow leaving a page anchor. Theremustbe spaces around the sequence. If the page break is in the middle of a word, join the word and put the sequence at the end of the word.Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diamnonumy eirmod tempor invidunt [pg 42] ut labore et dolore magnaaliquyam erat, sed diam voluptua. At vero eos et accusam et justoduo dolores [pg xviii] et ea rebum.Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt [pg 42] ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores [pg xviii] et ea rebum.A reference to a page number can be inserted with the sequence[pg n]_. This will generate a link to the page anchor.See page [pg 42]_.See page [pg 42]_.An invisible page number can be inserted with the sequence[pg!n].Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diamnonumy eirmod tempor invidunt [pg!43] ut labore et dolore magnaaliquyam erat, sed diam voluptua. At vero eos et accusam et justoduo dolores et ea rebum. See page [pg 43]_.Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt [pg!43] ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. See page [pg 43]_.See page [pg iii]_.

The sequence[pg n]will convert into a page number marker of n. n can be any arabic or roman numeral. The sequence itself will be removed from the text flow leaving a page anchor. Theremustbe spaces around the sequence. If the page break is in the middle of a word, join the word and put the sequence at the end of the word.

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diamnonumy eirmod tempor invidunt [pg 42] ut labore et dolore magnaaliquyam erat, sed diam voluptua. At vero eos et accusam et justoduo dolores [pg xviii] et ea rebum.Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt [pg 42] ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores [pg xviii] et ea rebum.

A reference to a page number can be inserted with the sequence[pg n]_. This will generate a link to the page anchor.

See page [pg 42]_.See page [pg 42]_.

See page [pg 42]_.

An invisible page number can be inserted with the sequence[pg!n].

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diamnonumy eirmod tempor invidunt [pg!43] ut labore et dolore magnaaliquyam erat, sed diam voluptua. At vero eos et accusam et justoduo dolores et ea rebum. See page [pg 43]_.Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt [pg!43] ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. See page [pg 43]_.

See page [pg iii]_.

DropcapsYou can insert dropcaps with thedropcapdirective. You can use either an enlarged character or an image as dropcap. You can also specify a span of character that should be set in small-caps after the dropcap initial.Support for dropcaps in output formatsFormatLetterImageHTMLenlarged and droppedresized and droppedEPUBenlarged on baselineresized on baselineTXTnormal sizealt textPDFenlarged and dropped5resized and dropped5The first argument (mandatory) states the character(s) to replace with caps. It must match the beginning of the next paragraph.The second (optional) argument states the characters to replace with small-caps. It must also match the beginning of the next paragraph... clearpage::.. dropcap:: L Lorem ipsum:lines: 4:indents: -1.25em 0.5emLorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diamnonumy eirmod tempor invidunt ut labore et dolore magna aliquyamerat, sed diam voluptua. At vero eos et accusam et justo duodolores et ea rebum. Stet clita kasd gubergren, no sea takimatasanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet,consetetur sadipscing elitr, sed diam nonumy eirmod tempor inviduntut labore et dolore magna aliquyam erat, sed diam voluptua.Lorem ipsumdolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.Thelinesoption (PDF only) specifies how many lines the dropcap should span. Default is 2.Theindentsoption (PDF only) can specifiy up to 2 length values. The first one is the indent of the first line, the second one the indent of the following lines. The indent is calculated from the right border of the dropcap letter. Defaults are 0em and 0.5em.Theimageoption specifies the image url. In plain text and EPUB the image will not be used... clearpage::.. dropcap:: G:image: images/G.png:lines: 4Gorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diamnonumy eirmod tempor invidunt ut labore et dolore magna aliquyamerat, sed diam voluptua. At vero eos et accusam et justo duodolores et ea rebum. Stet clita kasd gubergren, no sea takimatasanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet,consetetur sadipscing elitr, sed diam nonumy eirmod tempor inviduntut labore et dolore magna aliquyam erat, sed diam voluptua.[image]orem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.

You can insert dropcaps with thedropcapdirective. You can use either an enlarged character or an image as dropcap. You can also specify a span of character that should be set in small-caps after the dropcap initial.

Format

Letter

Image

HTML

enlarged and dropped

resized and dropped

EPUB

enlarged on baseline

resized on baseline

TXT

normal size

alt text

PDF

enlarged and dropped5

resized and dropped5

The first argument (mandatory) states the character(s) to replace with caps. It must match the beginning of the next paragraph.

The second (optional) argument states the characters to replace with small-caps. It must also match the beginning of the next paragraph.

.. clearpage::.. dropcap:: L Lorem ipsum:lines: 4:indents: -1.25em 0.5emLorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diamnonumy eirmod tempor invidunt ut labore et dolore magna aliquyamerat, sed diam voluptua. At vero eos et accusam et justo duodolores et ea rebum. Stet clita kasd gubergren, no sea takimatasanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet,consetetur sadipscing elitr, sed diam nonumy eirmod tempor inviduntut labore et dolore magna aliquyam erat, sed diam voluptua.Lorem ipsumdolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.

Lorem ipsumdolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.

Thelinesoption (PDF only) specifies how many lines the dropcap should span. Default is 2.

Theindentsoption (PDF only) can specifiy up to 2 length values. The first one is the indent of the first line, the second one the indent of the following lines. The indent is calculated from the right border of the dropcap letter. Defaults are 0em and 0.5em.

Theimageoption specifies the image url. In plain text and EPUB the image will not be used.

.. clearpage::.. dropcap:: G:image: images/G.png:lines: 4Gorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diamnonumy eirmod tempor invidunt ut labore et dolore magna aliquyamerat, sed diam voluptua. At vero eos et accusam et justo duodolores et ea rebum. Stet clita kasd gubergren, no sea takimatasanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet,consetetur sadipscing elitr, sed diam nonumy eirmod tempor inviduntut labore et dolore magna aliquyam erat, sed diam voluptua.[image]orem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.

[image]orem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.

[image]

TablesBe careful with tables because the table support of many ereaders is weak or nil.Tables also support these options:widthMakes the table that wide.widthsA space-separated list of unitless values, each specifying the relative width of one table column.If you don’t use the optionwidths, the column widths are calculated from the layout of the table in your source file.alignsHorizontally align the columns.A space-separated list of alignments, each specifying the alignment of one column.Valid alignments values are: left, center, right and justify.vertical-alignsVertically align the columns.A space-separated list of vertical alignments, each specifying the alignment of one column.Valid alignments values are: top, middle, and bottom.Note: vertical alignment is fully supported in HTML only. Other formats may support it in varying degrees.summary(HTML only.)Puts a summary attribute on the table element.These are the extra classes supported by PG-RST:norulesOmits the rules between table rows. (Not the rule between header and body nor the rules at the top and bottom of the table.)Use this class when the eye can follow the table rows without the aid of rules... table:: Demo Table:width: 100%:align: center:widths: 3 1 1 1:aligns: justify justify center right:vertical-aligns: top middle bottom top:summary: This table contains valuable data.+------------------------+-----------+----------+-----------+| Header row, column 1 | Justified | Centered | Price ($) || (header rows optional) | | | |+========================+===========+==========+===========+| row 1 | column | column | 1.23 |+------------------------+-----------+----------+-----------+| row 2 | col col | col | 45.67 || | col col | | || | col col | | || | col | | |+------------------------+-----------+----------+-----------+| row 3 | Cells may span columns. || | Lorem ipsum dolor sit amet, || | consetetur sadipscing elitr, sed || | nonumy eirmod tempor invidunt ut || | labore et dolore magna aliquyam || | sed diam voluptua. At vero eos || | accusam et justo duo dolores et || | rebum. |+------------------------+-----------+----------+-----------+| Cells may span rows and | Cells | row 4 || columns. Lorem ipsum dolor sit | may span +-----------+| amet, consetetur adipiscing. | rows. | row 5 |+------------------------------------+----------+-----------+Demo TableHeader row, column 1 (header rows optional)JustifiedCenteredPrice ($)row 1columncolumn1.23row 2col col col col col col colcol45.67row 3Cells may span columns. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam sed diam voluptua. At vero eos accusam et justo duo dolores et rebum.Cells may span rows and columns. Lorem ipsum dolor sit amet, consetetur adipiscing.Cells may span rows.row 4row 5.. table:: Truth table for “and”:class: norules:align: center:width: 50%===== ===== =========A B A and B===== ===== =========False False FalseTrue False FalseFalse True FalseTrue True True===== ===== =========Truth table for “and”ABA and BFalseFalseFalseTrueFalseFalseFalseTrueFalseTrueTrueTrue

Be careful with tables because the table support of many ereaders is weak or nil.

Tables also support these options:

Makes the table that wide.

A space-separated list of unitless values, each specifying the relative width of one table column.

If you don’t use the optionwidths, the column widths are calculated from the layout of the table in your source file.

Horizontally align the columns.

A space-separated list of alignments, each specifying the alignment of one column.

Valid alignments values are: left, center, right and justify.

Vertically align the columns.

A space-separated list of vertical alignments, each specifying the alignment of one column.

Valid alignments values are: top, middle, and bottom.

Note: vertical alignment is fully supported in HTML only. Other formats may support it in varying degrees.

Puts a summary attribute on the table element.

These are the extra classes supported by PG-RST:

Omits the rules between table rows. (Not the rule between header and body nor the rules at the top and bottom of the table.)

Use this class when the eye can follow the table rows without the aid of rules.

.. table:: Demo Table:width: 100%:align: center:widths: 3 1 1 1:aligns: justify justify center right:vertical-aligns: top middle bottom top:summary: This table contains valuable data.+------------------------+-----------+----------+-----------+| Header row, column 1 | Justified | Centered | Price ($) || (header rows optional) | | | |+========================+===========+==========+===========+| row 1 | column | column | 1.23 |+------------------------+-----------+----------+-----------+| row 2 | col col | col | 45.67 || | col col | | || | col col | | || | col | | |+------------------------+-----------+----------+-----------+| row 3 | Cells may span columns. || | Lorem ipsum dolor sit amet, || | consetetur sadipscing elitr, sed || | nonumy eirmod tempor invidunt ut || | labore et dolore magna aliquyam || | sed diam voluptua. At vero eos || | accusam et justo duo dolores et || | rebum. |+------------------------+-----------+----------+-----------+| Cells may span rows and | Cells | row 4 || columns. Lorem ipsum dolor sit | may span +-----------+| amet, consetetur adipiscing. | rows. | row 5 |+------------------------------------+----------+-----------+Demo TableHeader row, column 1 (header rows optional)JustifiedCenteredPrice ($)row 1columncolumn1.23row 2col col col col col col colcol45.67row 3Cells may span columns. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam sed diam voluptua. At vero eos accusam et justo duo dolores et rebum.Cells may span rows and columns. Lorem ipsum dolor sit amet, consetetur adipiscing.Cells may span rows.row 4row 5

Demo TableHeader row, column 1 (header rows optional)JustifiedCenteredPrice ($)row 1columncolumn1.23row 2col col col col col col colcol45.67row 3Cells may span columns. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam sed diam voluptua. At vero eos accusam et justo duo dolores et rebum.Cells may span rows and columns. Lorem ipsum dolor sit amet, consetetur adipiscing.Cells may span rows.row 4row 5

Header row, column 1 (header rows optional)

Justified

Centered

Price ($)

row 1

column

1.23

row 2

col col col col col col col

col

45.67

row 3

Cells may span columns. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam sed diam voluptua. At vero eos accusam et justo duo dolores et rebum.

Cells may span rows and columns. Lorem ipsum dolor sit amet, consetetur adipiscing.

Cells may span rows.

row 4

row 5

.. table:: Truth table for “and”:class: norules:align: center:width: 50%===== ===== =========A B A and B===== ===== =========False False FalseTrue False FalseFalse True FalseTrue True True===== ===== =========Truth table for “and”ABA and BFalseFalseFalseTrueFalseFalseFalseTrueFalseTrueTrueTrue

Truth table for “and”ABA and BFalseFalseFalseTrueFalseFalseFalseTrueFalseTrueTrueTrue

A and B

False

True

False

True

False

True

Back to Index Next