Versions Compared

Old Version 69

changes.mady.by.user Tim Donohue

Saved on

compared with

New Version 70

changes.mady.by.user Tim Donohue

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Move docs about generating PDF & HTML wiki exports over to DSDOCDEV space & linked to them

...

Info
titleHow to Generate PDF & HTML Documentation

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

  • On "Document Information" Tab
    • Title: "DSpace Documentation"
    • Authors: "DSpace Developers"
    • Wiki Markup
      Version: \[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
Info
titleHow to Generate HTML Documentation

To generate the HTML document, just use the normal 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

    See this DSpace documentation management guide: How To Export Downloadable Docs from Wiki

    Note
    titleWatch for conflicts when updating HTML Documentation in SVN

    It's often easier to completely remove all current HTML content before committing the updated HTML content. Because of the HTML directory structure exported by Confluence, it can be very difficult to determine which files need removing (especially old attachments). So, you may want to completely remove the old HTML directory, before committing the updated content. An example follows:

    1. Delete old HTML docs: e.g. svn delete http://scm.dspace.org/svn/repo/dspace/trunk/dspace/docs/html (Or delete from branch, as appropriate)
    2. Update your checked-out copy of Trunk/Branch: svn up
    3. Wiki Markup
      Locally, recreate the {{\[dspace-source\]/dspace/docs/html/}} in your checked out copy of Trunk/Branch
    4. Wiki Markup
      Copy new HTML docs to {{\[dspace-source\]/dspace/docs/html/}}, so that the {{index.html}} file is at {{html/index.html}}
    5. Commit new docs back to SVN

    ...