Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info
titleNotes about Generating PDF & HTML
  • When generating the PDF document, use the "Scroll Wiki Exporter" option. Make sure to select the checkbox next to the following options on the "Formatting Tab":
    • Ignore toc macros - ignores all Table of Contents on individual pages
    • Ignore children macros - ignores any child page listings on individual pages
  • When generating to HTML document, just use the normal HTML export (Browse -> Advanced) option. Make sure to deselect the Homepage, as this is not officially part of the DSpace Documentation.
Note
titleWatch for conflicts when updating HTML Documentation

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: svn delete http://scm.dspace.org/svn/repo/dspace/trunk/dspace/docs/html
  2. Update your checked-out copy of Trunk: svn up
  3. Wiki Markup
    Locally, recreate the {{\[dspace-source\]/dspace/docs/html/}} in your checked out copy of Trunk
  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

...