How does a learner know where they left off?
Users can highlight or write a note where they were last to “bookmark” the page they were last on.
What’s the difference between units, chapters, and pages?
Chapters are largely for organization purposes, and they 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 that you nest more than one page under another page, as this can be tricky to maintain and 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 take a look at our offering of widgets which you can use 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 files, and images to make content engaging and interactive.
Tip: Keep videos to no more than 2 on one page as this can make pages load more slowly.
How do I make certain content visually distinct from other content?
Inkling designs your template to give you hundreds, if not thousands, of options. Use different headers, sections, colors, and images (and more!) to make content visually different. Our tool is excellent at making this easy. It’s a best practice to use headings in order and sections to contain content that is 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’s 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 ellipsis.
Can a collection title be in all caps?
How does search work in Habitat?
Habitat search searches titles only. This is different from the search for end users in the Library which searches titles and content.
Suggested best practice for number of widgets on a page?
We provide general guidance around the amount of interactivity that is added to a page, but not a hard number of how many widgets-- instead, we speak more about best practices for when to add, and when not to add, interactive elements.
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, in a more targeted way, click-through rates and engagement with the content is 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 what the right number of pages is for a given Inkdoc is more about understanding what the content is, who uses it, and how it’s used. Should it be organized as a single or multiple Inkdocs?
If the content has a lot of videos or a lot of widgets, they can impact load times.
Build and loading times increase with Inkdocs over 2GB.
Why won’t my image upload to Habitat?
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’s what the Authoring Guide says about images:
We recommend these guidelines for images:
Format: PNG (24-bit), JPG
File size: Maximum 10 MB
Minimum: 1024 px in the longer dimension
Maximum: 2048 px in the longer dimension
See Chapter 5 > Use Images in the Authoring Guide.
My users are seeing a red X in place of a missing image, but we don’t see them in Habitat. How can we find them?
You can find missing images, files, or broken links by navigating to the “Review Errors” panel for the Inkdoc. 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 (ex. ingredients for a recipe with corresponding measurements), we would recommend using a table element, not 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 isn’t 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 that same tool can be used for reference. In that case, a table might make more sense.
Asides are used to present short pieces of side bar 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 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, to highlight topics of special importance, to make clear visual breaks between individual topics, and to break up 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?
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:
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 can’t exceed a maximum of 100 MB.
Be sure to upload videos formatted in an industry-standard video codec (input format). The Inkling platform supports many video codecs and can play videos in any of the supported browsers.
The video pattern in Habitat only supports videos that are hosted by Vimeo, YouTube, or Inkling. Playing HTML5-formatted videos from other hosting services requires a custom pattern. For more information, contact your Inkling representative.
To embed Vimeo videos in Inkling, you will need to do set the video embed privacy on Vimeo videos to "Only on sites I choose" and whitelist these domains: