Habitat automatically generates reports every time you build a draft, release, or publish a project. Reports evaluate important aspects of the title, content, and code.
Reports categorize the severity of items as follows:
- Error: Errors must be corrected before you can build a title. The number of errors appears in a red box.
- Warning: Warnings do not block the building of a title. Review warnings for possible correction. The number of warnings appears in a yellow box.
Review these reports frequently. Take action on errors by correcting them or assigning comments to other team members.
Review Error and Warning Reports
- Open the project and in the top bar, click Review Errors.
Click Reports Overview.
This gives you a summary of the reports generated by the most recent save of the title content.
- Yellow icons show the number of warnings.
- Red icons show the number of errors.
- A green dot indicates a section with no errors or warnings.
- To access a specific report, click the report title in any section:
- Validation and Structure
- Issues in Content
If the Index column for a report displays chapters, click a chapter to display report details about that chapter. Some details appear in blue, which means you can click them to open the file and make the correction.
Filter Report Details
As you hover over the column headings of the report, a small funnel icon may appear to the right of the heading.
This means you can filter the results. Filtering lets you focus on a single type of result. A long report becomes easier to analyze and review.
- Click the funnel icon to the right of the heading.
- Enter the text of the item, for example, a class name or tag name, that you want to filter on, exactly as it appears in the report.
Click OK.
Habitat filters out all report entries except those that match your search text.
To see all results in the report again, click the funnel icon and click Remove Filter.
Correct Errors and Warnings
- Click Review Errors.
Click a section with a red error or yellow warning icon.
A green dot indicates a section with no errors or warnings.
- Click a dropdown arrow to view the issues within a specific chapter.
Click the link listed under SOURCE.
Habitat opens the page with the issue in code mode in a separate browser window and highlights the element you must fix.
- Fix the issue.
- Save your work.
- After you have fixed the build issues, build another draft or release.
Fix Duplicate Data-Uuid Errors
- Copy the duplicate
data-uuidfrom thes9idcolumn of the report. - Click the SOURCE link on the report to access the page with the duplicate
data-uuid. - Place your cursor in the HTML code editor in the newly opened tab.
Search (Ctrl + F or Cmd + F) for the
data-uuidyou copied.This will highlight the exact location of the
data-uuidthat needs to be removed.Delete the
data-uuidand leave the field blank, and then click Save.Habitat automatically adds a new
data-uuid.- Repeat steps 1-5 for all duplicate
data-uuidissues.
Informational Reports
Curious to know how many headings are in your title? How many glossary definitions are referenced in the text? You can get information on all these and many more elements of an Inkdoc by reviewing the Chapter Stats and Content Stats reports, which can be found in the Issues in Content section.