Page History
...
Exporting Documentation from Wiki
Table of Contents | ||||||
---|---|---|---|---|---|---|
|
How to Generate PDF from a Space (using built in Confluence Tools)
- Go to "Space Tools" → "Content Tools"
- "Export" tab
- Select export to PDF, click Next
- Select Custom Export & "Include Page Numbers"
- Deselect the root page ("DSpace 7.x Documentation"). But select all other pages
- To change the Title page or header/footer, use the "Editing the PDF Stylesheet" tools in Confluence
- Space Tools → Look And Feel
- PDF Layout and PDF Stylesheet tabs
How to Generate PDF version of Documentation (using Scroll PDF Exporter Plugin)
To generate the PDF document, we currently use the "Export to PDF" option (Tools Scroll PDF Exporter plugin for Confluence.
- Select " ... -> Export to PDF
...
- " on the
...
- Documentation homepage, e.g. DSDOC7x
- Select Template: "Documentation", Export Scope "This page and its children"
- Click "Show Details"
- Modify "PDF Metadata"
- Title: "DSpace 7.x Documentation"
- Author: "DSpace Developer Team"
- Other default settings should be fine, but feel free to double check them.
- Click "Export" button
- Wait for 5-10 minutes while the PDF is
- Select the "DSpace PDF Template"
- Select export this page & all children.
- Uncheck all Advanced Options.
- On the PDF Tab, give the Document a title (e.g. "DSpace 1.8. Documentation")
- 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 (OBSOLETE: We don't do generate an HTML version anymore)
To generate the HTML document, just use the normal Confluence HTML export:
- PDF Exporter plugin, which generated this PDF)
- Once complete, rename to "DSpace-Manual.pdf" and upload to the Release in GitHub: https://github.com/DSpace/DSpace/releases
- Also add as a download link on the Documentation Homepage.
- 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
Overview
Content Tools