Habitat can export to two archival formats: HTML and PDF. This enables you to:
- Store a copy of the published Inkdoc for future reference.
- Retain much of the interactivity of the original published Inkdoc.
If you have at least Edit and Comment permissions and your project administrator adds a new export format, you use the Export functionality to create and download HTML and PDF files.
Decide Between HTML or PDF for Storage
When deciding which export format to use for archiving, consider your requirements and limitations. The HTML export format provides greater support for interactive elements, such as audio and video files and Inkling widgets. However, the resulting .zip file will generally be larger than the PDF. The PDF does not provide robust support for some interactive elements, but the file size is generally smaller.
Create and Download an HTML or PDF File
Go to Export and Distribute > Export and Embed.
Your organization and administrators determine the export formats available to you on Export and Embed. Contact your project administrator or Inkling administrator with any questions.
- Click Export.
Review the export build status.
The table shows the build status icons that are displayed. You can only export builds that show either a green checkmark or a yellow exclamation point.
Icon Description Can publish? wrench
Build is in progress. NA green checkmark
Build successfully completed with no errors. Yes yellow exclamation point
Build successfully completed with no errors but warnings. Yes red X mark
Build has errors and did not complete.
You must fix the errors and rebuild the project.No - Click Download.
- By default, Habitat places the .pdf or .zip file in your machine’s Downloads directory.
- The file title is in the format:
{Habitat project title}_b{number}.{file extension}- Example:
Firefly_Product_Guide_b6.docx
- See View the exported HTML for how to review the HTML build in a browser window.
- You can copy the .pdf or .zip file to another directory for storage, like an archive directory on your machine or your organization’s network.
- Review and test the exported file before moving it to an archive.
See View the exported HTML for how to unzip and navigate the HTML files.
If the widgets do not display or work in the HTML files, this may indicate that your installed widget version is outdated. Contact your project administrator for help.
View the Exported HTML
Access the downloaded .zip file from its stored location.
This may be your Downloads folder or an archival directory managed by your organization.
Double-click on the file to unzip it.
It unzips as a folder.
Open the folder, then double-click the
index.htmlfile.The file launches in a browser window and displays the TOC of the Habitat project.
- Navigate to any page using the links in the TOC.
- Return to the TOC using your browser's back button.
The exported HTML files are the release build of the Habitat project, excluding sandboxed chapters.
We designed the exported HTML files to be accessible as a standalone content package for all users, including those without EchoInk accounts. This means you will not see EchoInk functionality in the browser, such as the left-side navigation panel or the Search feature.
The images show two versions of the TOC for an example guide. In the first image, the Backup Copies sandbox chapter is excluded from the exported HTML, while the second image shows that this content is included.