Generating PDF & HTML Documentation from Wiki

How to Generate PDF version of Documentation

To generate the PDF document, use the "Scroll Wiki Exporter" option (Tools -> Scroll Wiki Exporter) from the DSpace System Documentation page of the Wiki.

• On "Document Information" Tab
  • Title: "DSpace Documentation"
  • Authors: "DSpace Developers"

  • Version: [DSDOCDEV:DSpace version number] (e.g. 1.7.0)

• On "Formatting" Tab:
  • Format: "PDF"
  • Theme: "DSpace"
  • Make sure to select the checkbox next to all of the following options:
    • Create Table of Contents - generates a table of contents page at beginning of PDF
    • Ignore toc macros - ignores all Table of Contents on individual pages
    • Ignore children macros - ignores any child page listings on individual pages
• Finally, click the "Export>" button
• After about a minute, a PDF should be generated. Give it a quick look through for formatting errors (larger errors may be highlighted in RED automatically by the Scroll Wiki Exporter

How to Generate HTML version of Documentation

To generate the HTML document, just use the normal Confluence HTML export:

• Go to Browse -> Advanced, Click on "HTML Export"
  • Make sure to deselect the "DSpace Documentation" Homepage (top page), as this is not officially part of the DSpace Documentation (it's just a splash page). Instead, select the "DSpace System Documentation" page as the main page (this should also auto-select all other pages below it).
  • Make sure to also deselect the "Include comments" option, as they are not officially part of the DSpace Documentation
  • Finally, click the "Export" button at the bottom.
• After generating the HTML Documentation, we'll want to do some minor HTML cleanup to make it look nicer.
  • Edit the 'index.html' page. You'll want to clean up the following text to make it easier to understand:
    • Near the top, replace the text "Space Details:" with "DSpace x.y.z Documentation"
    • Remove the entire "<table>" at the top of the page which includes last modified & creation info. That table is not as useful outside of a Wiki context.
    • Just after the <table>, replace the text "Available Pages:" with "Index:"
  • The end result should look something like the HTML version of the DSpace 1.7.0 Documentation