Tutorials

Task-driven tutorials and recipes for PageSeeder

How to configure auto-numbering, equations, footnotes, endnotes and citations

Skills requiredXML
Time required (minutes)45
Intended audienceDeveloper
DifficultyEasy
CategoryDocument

Objective

Publications sometimes require the features below. They are not enabled in PageSeeder by default but can easily be configured as shown in this tutorial.

  • auto-numbering

  • equations

  • footnotes

  • endnotes

  • citations

Prerequisites

To complete this tutorial requires:

  • PageSeeder administrator access to a server with PageSeeder version 5.96 or later installed.

All the necessary files for this tutorial are on Github .

Tutorial

Configure project customizations

  1. Login to PageSeeder as an administrator.
  2. Click on New project and enter the project name "report", any description and any owner, then click Submit.
  3. Click Home page then New group and enter the group name "tutorial", any description, then click Submit.
  4. Select Developer perspective from the cube icon (top left).
  5. Select Project files from the Dev menu.
  6. Drag the ps-report-[date].zip file (downloaded from Github) to the drop files area.
  7. Click the Import icon next to this zip file.
  8. Select Toolbox from the Dev menu, then click on Project files under PageSeeder publisher on the right.
  9. Drag the pspublisher-report-[date].zip file (downloaded from Github) to the drop files area.
  10. Click the Import icon next to this zip file.
  11. Click on Expand all and the following files used for exporting to DocX should be listed:
    FilenameDescription
    build.xmlANT script for exporting to DocX.
    docx-citation-transform.xslXSLT to convert from PSML properties to OOXML citations, see Export citations to docx: Post-processing.
    psml-post-transform.xslXSLT that adds extra inline labels to fig/table captions so they can be auto-numbered in DocX.
    publication-config.xmlThe auto-numbering configuration for the export. Includes paragraph and fig/table numbering, see Publications and publication types.
    word-export-config.xmlThe mapping configuration from PSML to DocX, see Export Microsoft Word docx config.
    word-export-template.docxThe DocX template. It has been customized by creating "Title" and "Appendix [x]" heading styles and adding "Para indent" styles to the Default numbering.
  12. Go back to the first Project files page (it should be in another tab) and click on the report project (top-middle), then click on Labels. The following label configuration should be displayed:
    LabelTypeDescription
    appendixdocumentIdentify appendix for alternate numbering.
    asciimathinlineIdentifies an AsciiMath inline equation (not from library).
    pagesinlineUsed directly after citation XRef to indicate page no. or range (e.g. 10 - 20)
    figure-captionblockIdentifies figure or image caption text.
    table-captionblockIdentifies tabe caption text.
    titleblockIdentifies publication titles (not included in TOC)
  13. Select Document config from the Dev menu. The following project specific publication type should be displayed:
    Publication typeDescription
    reportThe auto-numbering configuration for the user interface. Includes paragraph and fig/table numbering.
  14. The following project specific document types should also be displayed:
    Document typeDescription
    asciimathDocuments in AsciiMath  equation library. One equation per document.
    bibliographySources used in a publication (contains XRefs to source documents). This document must be embedded in the publication but only the <section id="title"> content will be used.
    defaultDefault CSS is overridden to display footnote and endnote references as superscripts.
    definitionsDefinitions of terms in a publication. Each fragment contains the term as a heading and the definition as a paragraph.
    endnotesEndnotes for a publication. This document must be embedded in the publication but will be ignored.
    footnotesFootnotes for a publication. This document must be embedded in the publication but will be ignored.
    indentIncludes CSS for content with indented headings.
    mathmlDocuments in MathML  equation library (experimental). One equation per document. Can only be edited in lab perspective.
    sourceDocuments in source library (bibliography document points to these). One source per document.
  15.  On the Document config page click on the XRef config link (top right). The following XRef configurations should be displayed (see PSML XRef config):
    XRef config nameDescription
    footnoteTo insert a footnote reference
    endnoteTo insert an endnote reference
    citationTo insert a citation
    definitionTo insert a reference to a definition
    paraTo insert a reference to a paragraph
    internal-paraTo insert a reference from a paragraph to it's sub-paragraph
    numbered-headingTo insert a refernce to a numbered heading
    asciimathTo insert an AsciiMath equation
    mathmlTo insert a MathML equation (experimental)

     

Import sample publications

  1. Ensure you are on the home page for the "report-tutorial" group then click on the upload document icon (see below).
    report-tutorial-upload.png
  2. Drag the documents-[date].zip file (downloaded from Github) to the drop files area.
  3. Click the Unzip icon next to this zip file.
  4. Click the Continue button at the bottom.
  5. Wait a little while until the Confirm upload dialog appears, then click Continue and wait for the message "Successfully uploaded".
  6. In the search box at the top type "system report" and click the "System report" document.
  7. Click the Properties tab and under Publication ID enter: sysreport-1
  8. Under Publication Type select "report" and then click the Save button.
  9. Click the View tab and then open the TABLE OF CONTENTS block (bottom left).
  10. In the table of contents click the Functionality heading. The document displayed shows examples of footnotes, citations, equations and auto-numbering for headings, paragraphs, tables and figures.
  11. Try adding an endnote as follows:
    1. Double click on the first paragraph to edit it.
    2. Place the cursor somewhere in the text and click the insert XRef icon .
    3. Next to Configuration select Endnote.
    4. Click Choose target and then click the bottom right add fragment icon .
    5. Type some content text for the end note and click Create Fragment.
    6. Click on the new fragment and then click Insert.
    7. Click Create link and then click Save.
  12. You can try adding some other kinds of XRefs in the same way except:
    1. AsciiMath: select an existing equation or click Create document, enter equation title and Submit. Then click the edit fragment icon , enter the equation and Save.
    2. Citation: after creating the XRef, click on it, then click the edit fragment icon next to the citation fragment. Next to Source click Create document, enter source title and Submit. Then click the add fragment icons to complete the source information.
    3. Definition: when creating the fragment use '#' and space in front of the term to make it a heading e.g.
      # My term
      My definition
      
  13. Click the search icon  at the top and in the search box type "system report 2" and click the "System report 2" document.
  14. Click the Properties tab and under Publication ID enter: sysreport-2
  15. Under Publication Type select "report" and then click the Save button.
  16. Click the View tab and then open the TABLE OF CONTENTS block (bottom left).
  17. In the table of contents click the triangle next to the Requirements heading, then click the Functionality heading. This is the same document as before but being used by a different publication. Note that the headings, tables and figures have different numbers in this publication. This is a powerful feature for re-using content.
  18. Pull down the menu at the top of the table of contents block. This shows which publications the document is used in. Select "System Report" and the document will be displayed in the context of that publication.

Export as a Word document

  1. Go to the root document in the System Report publication by opening the GROUP PUBLICATIONS block (left) and clicking System Report.
  2. Click on the export document icon (top left) , ensure Create DocX is selected and click Export.
  3. Open the document in Microsoft Word and see how the footnotes, endnotes, citations and MathML equations are displayed by Word. Note that AsciiMath equations are not yet supported by the word export.

Created on , last edited on