You must have Admin permissions to publish a project.
If you can see the Publish button in the upper right corner of the toolbar, you can publish the project, which distributes the resulting Inkdoc to your users through our reader products: EchoInk library for Web and Mobile or EchoInk Embed. Your organization may have one or both products installed, or choose to distribute content through its own custom digital reader.
Project administrators configure distribution with either or both of these methods:
- The Grant Reading Access interface.
- An embedded web player.
Publish a Project
- For the final release of a project, check the project structure and ensure that all content to be distributed is not in a sandbox chapter. If you are drafting, skip this step.
- Click Publish on the toolbar.
- Click Publish in the Publish window.
- Review the build status message that Habitat displays at the end of the publishing process.
The table shows the build status icons that are displayed. You can only publish 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 |
When Habitat successfully publishes a project, the Publish button changes to Published, with green text. The button remains in the Published state until you edit and save a page, at which point it changes back to Publish.
Publish an Assessment
Publishing a project also publishes any assessments in that project that you have not hidden in a sandbox chapter.
The Take a quiz topic of the EchoInk Guide contains basic instructions for users on how to complete each question type. Be sure to provide any additional instructions that your users may need to complete the assessment.
Republishing a project does not allow users who have already completed an assessment to retake it. You must reset the assessment before republishing the project so users can retake the assessment in EchoInk.
Determine the Published Version
To determine which version is currently being viewed by end users, click Publish. The Publish window displays information about the most recent publish, including the date and revision.
View and Export Previous Published Versions
You can view and export previously published versions in Export and Distribute > Publish History.
Rollback a Published Update
If you published a project to Inkling or a customized digital reader in error, you can use these options to roll back changes and conceal the updates.
Sandbox chapters: Use the Sandbox feature to hide content from the published version so users cannot see it. When you are ready to reveal the content, move the content from the sandbox or clear the sandbox checkmark from the chapter, and then republish the project. See Hide draft content in a sandbox chapter in Configure the Table of Contents.
Restoring the previous page version: Use the Compare Versions functionality to revert a page to its previous version, then republish the project. See Restore an earlier project version in Manage page edits and versions.
We recommend duplicating the current page first and dragging it into a sandboxed chapter. This way, you will not need to redo the changes that you are reverting a second time.
Revoke all access: You can revoke users’ access to the Inkdoc via the Grant Reading Access window. This removes the Inkdoc from all users’ libraries until you are ready to republish.