How does a learner know where they left off?
Users can highlight or write a note where they were when they last bookmarked the page.
What is the difference between units, chapters, and pages?
- Chapters are primarily for organizational purposes and must contain at least one page. All content lives on pages. Chapters are useful for organizing pages, since they do not contain content themselves. Chapters contain pages, and the pages contain content.
- You can nest pages under other pages. We do not recommend nesting more than one page under another page, as this can be tricky to maintain and to find information in the TOC.
- Units are larger containers for one or more chapters.
How do I make my content more interactive?
- We encourage you to explore our widget offering to create engaging content. If you need help thinking through what could work for your needs, please reach out. In the meantime, our Authoring Guide has good descriptions of each. Search widget.
-
You can use videos, audio, and images to make content more engaging and interactive.
Tip: Keep videos to no more than 2 per page to avoid slower page load times.
How do I make certain content visually distinct from other content?
EchoInk designs your template to give you hundreds, if not thousands, of options. Use different headers, sections, colors, images (and more!) to make your content visually distinct. Our tool makes this easy. It is best practice to use headings in order and to place sections that contain content outside the main flow of the page. This helps you structure content well, helps if you ever update your pattern, and makes content more accessible.
What is the font size for the title of the collection? Can it be adjusted, or is it fixed? What font is it?
18px. Source Sans Pro. It is fixed.
What is the character limit for a collection title?
After 50 characters, we truncate the title and add ellipses.
Can a collection title be in all caps?
Yes.
How does search work in Habitat?
Habitat search searches titles only. This differs from the Library's search for end users, which searches titles and content.
Suggested best practice for the number of widgets on a page?
We provide general guidance on the amount of interactivity to add to a page, but not a specific number of widgets. Instead, we focus on best practices for when to add and when not to add interactive elements.
Considerations:
- What is the overall quantity of interactive content in general terms? For example, if too many exhibits are interactive, users can become overwhelmed and skip over them. If interactive content is used sparingly and more targeted, click-through rates and engagement are generally higher.
- Is the interactive element the best way to present the information?
- Is the interactive element appropriate in the given context?
- Is the content being enhanced in a consistent and predictable way?
Determining the right number of pages for a given Inkdoc is more about understanding the content, who uses it, and how it is used. Should it be organized as a single or multiple Inkdocs?
If the content has many videos or widgets, it can affect load times.
Build and loading times increase with Inkdocs over 2GB.
My image will not upload to Habitat?
Possible reasons:
- Image file is too large (max file size = 10 MB)
- In addition to using a supported image format, images also need to use a supported color profile (ie, RGB)
Here is what the Authoring Guide says about images:
We recommend these guidelines for images:
- Format: PNG (24-bit), JPG
- File size: Maximum 10 MB
Dimensions:
- Minimum: 1024 px in the longer dimension
- Maximum: 2048 px in the longer dimension
My users are seeing a red X where a missing image should be, but we do not see them in Habitat. How can we find them?
You can find missing images, files, or broken links by navigating to the Inkdoc's Review Errors panel. Missing images will display under Missing Files, and when you click on the link associated with the error, you will be taken directly to the location of the missing image in the code.
Where can an author find the current size of an Inkdoc?
You can see the number of pages and chapters on the Edit Structure page. If you need more information, your CSM can get this information for you.
When to use a heading vs. a section? Or an aside vs. a grid vs. callouts?
Headings, sections, and asides are semantic patterns. The use of these HTML elements conveys specific meanings to the reader.
Grids are a visual style, with no inherent semantic purpose. Grids can include semantic elements (paragraphs, asides, headings, etc.). For example, if an author is trying to convey tabular information (e.g., recipe ingredients with corresponding measurements), we would recommend using a table element rather than a grid.
If an author wants to display a paragraph and an image side-by-side (regardless of device width), they should likely use a grid rather than a table.
This is not black and white. The relationship between text and images can be semantically connected. For example, a text description of a tool and a visual of the same tool can serve as a reference. In that case, a table might make more sense.
Asides are used to present short pieces of sidebar content (marginalia, sidenotes, etc), whereas grids are used to create side-by-side layouts.
A callout is a sub-classification of an aside that disrupts the main flow of content to prioritize a single/simplified important point, such as a warning, note, caution, or best practice.
Sections are used to present discrete topics or pieces of content that are typically separate from the main narrative flow on the page. They can be used to break out sub-topics, highlight topics of special importance, create clear visual breaks between individual topics, and break long pages of content into smaller, more bite-sized chunks that are easier for end users to consume.
Headings are used to provide structure and to organize content into an information hierarchy. Different heading levels are used to convey the relative position of information within that hierarchy, and can be used directly on the page or within sections and other patterns.
How do you create a fraction in Habitat with 2 digits in the numerator or denominator?
This is an HTML issue. Workaround here: How should I express fractions like 15/16ths in HTML?
How do I use private YouTube Videos in my Inkdoc?
You must set the YouTube videos to unlisted or higher permission level to see them in Inkdocs.
This resource has more information:
Change video privacy settings - Computer - YouTube Help
How do I use my private Vimeo videos in my Inkdoc?
In some cases, we have to whitelist your Vimeo space. The video file size cannot exceed 100 MB.
Be sure to upload videos formatted in an industry-standard video codec (input format). The EchoInk platform supports many video codecs and can play videos in any supported browser.
The video pattern in Habitat only supports videos hosted on Vimeo, YouTube, or EchoInk. Playing HTML5-formatted videos from other hosting services requires a custom pattern. For more information, contact your EchoInk representative.
To embed Vimeo videos in EchoInk, you will need to set the video embed privacy on Vimeo videos to Only on sites I choose and whitelist these domains:
<orgname>.read.inkling.comhabitat.inkling.comapp.inkling.com<orgname>