You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

Generating PDF & HTML Documentation from Wiki

How to Generate PDF version of Documentation

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

  • On "General" Tab:
    • Select the "DSpace PDF Template"
    • Select export "This page and its children".
    • Leave "Ad-Hoc workflows" unchecked.
    • Uncheck all Advanced Options.
  • On the "PDF Properties" Tab, give the Document a title (e.g. "DSpace 1.8 Documentation")
  • On the "Linking" Tab, select the "Add page numbers to internal links" option.
  • Finally, click the "Start Export" button
  • After a few minutes, 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 plugin, which generated this PDF)

How to Generate HTML version of Documentation (OBSOLETE: We don't do generate an HTML version anymore, as we have online docs available on the wiki)

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
  • No labels