Glossary

Content

Article

  • a type of content that you can create with Inline Manual. You can use this feature to create longer texts, such as knowledge base tutorials. When you add an article, it will appear in the widget.

Checklist

  • shows the user’s progress - which walkthroughs have been completed and which ones are still untouched. You can choose to set this up in a way where they’ll need to complete each step in sequence or you can choose to give your users the freedom to take whichever walkthrough they want to take.

Feedback

  • a survey for your users. You can use the feedback feature to get reliable responses from your users. Write your own question, add images or video and you’re ready to go. Below your content, users will see the five-point Likert Scale that they can react with. It shows expressions from displeasure to delight. You can name them to suit your needs.

Hotspot

  • a style of a launcher - an animated, pulsing icon; Hotspots are especially useful when you want to draw attention to a new feature in your application.

Launcher

  • appears in your application as a tooltip, a hotspot or a text. By placing a Launcher, you make it possible for your users to start a walkthrough or open a tooltip from anywhere on your site.

Permalink

  • a direct link to the content you created; This link can be used within your knowledge base or in an e-mail to redirect your users to a page with the specific guide or tutorial.

Popover

  • also a modal window, it’s a graphical box visible on a screen;

Redirect

  • an internal or external link, that upon clicking go to a specified URL. You can use it to redirect your users to another website.

Step

  • a part of a walkthrough; A typical step in a walkthrough might include a popover message highlighting an element, or a welcoming message with an introduction video.

Tooltip

  •  a style of a launcher - a red question mark. A tooltip is a static, clickable UI element that provides additional information about specific parts of your application.

Topic

  • any content created within Inline Manual. It can be a walkthrough, a set of tooltips, an article, feedback form, a redirect or a folder.

Walkthrough

  • a step-by-step guide. Use it to lead your users to explore and learn new features, or perform a certain task. Walkthroughs are designed to get users to follow steps to accomplish the desired goal.

Widget

  • a menu for your content created with Inline Manual. You can use it to list walkthroughs or articles. By default, the widget appears in the lower right-hand corner, with the title "Inline Manual". You can customize the title, placement, design, and all of the content listed there.

Design and Customization

Backdrop

  • darkens the area around a selected element or a popover message. The cover locks down the click-through tour, so users don’t get lost or distracted.

CSS

  • Cascading Style Sheet. CSS describes how HTML elements are displayed on the screen. With CSS codes you can make an advanced customization of your content.

Selector

  • defines the element from the application or website that is used/assigned to a step, launcher, trigger, and/or actions. When the assign button is used, a selector is automatically generated.

Step templates

  • templates make creating guides easier and faster. You can modify already existing templates or create your own.

Settings and Configuration

Element

  • a specific element of your application eg. a button, a field in a form or a link in your menu; You can assign elements to steps of your walkthroughs and tooltips.

Path

  • used to redirect users to a specific page when the step is started. This is available for walkthroughs only.

Triggers

  • use a trigger to respond to user actions such as clicking or hovering on assigned elements. With triggers, you can fully control how your users go through your guides. By default, Inline Manual proceeds from one step to the next as soon as the user clicks on the next button. However, you can change the guide’s flow. For example, you can set up that if the user clicks the assigned element, he goes to a particular step, topic or the walkthrough gets totally deactivated.

Targeting and Analyzing

Analytics

  • provides you with relevant data about your guides and users. Each report shows the count and increment/decrements percentage. It also displays rankings preview for the top played/completed walkthroughs, number of widget clicks per path, and a comparison chart for walkthroughs launched vs completed.

Autolauncher

  • lets you automatically launch topics for specific types of users. Autolaunchers will launch once after the rule or segment is met. For example, you can use this to launch a topic to new users who created their account 30 minutes ago.

Automation

  • with created segments, you can create topics that will automatically launch for a specific group once conditions are met.

Completions

  • the number of guides completed by a user. By default, the guide is completed when the last step of a walkthrough is reached. You can change it in the MISC panel, e.g. if you want a guide to be completed if a user reaches certain step, you can set up that step as END even though it is not the last one.

Funnel

  • allows you to measure how your customers move through your topics. You can shed light on drop-off funnels and find out where you can help users.

Hits

  • the number of page visits on the website.

People tracking

  • with Inline Manual you can track users of your website and display reports describing who they are and how they behave. You can use these reports to discover where they are from, which tutorials they completed, and their latest activity. Enabled people tracking allows you to use analytics and automation.

Segment

  • a specific group of users.

Segmentation

  • used to create segments within your user-base. You can identify groups of users based on their behavior or a user role. Use this feature to send different messages to different groups of users.

Management and Publishing

Diagnostics tool

  • helps you troubleshoot possible problems. The tool checks the currently viewed site in the browser against the active site you provided in the authoring tool.

HEAD

  • the current and latest updated version of your tutorials.

Release

  • a named state of revision.

Revision

  • each time you edit a topic, a new revision is created. This means you can see when the content was changed and also revert back to the previous one.

Site

  • your application, the one that you want to create content for.

Site ID

  • a unique number of a site created. You can find the ID of a site in the portal (it’s the number in the URL of a given site).

Tags

  • used to identify topics more easily. Tags appear in the topic list when you add them to a site.

Topic ID

  • a unique number of a topic created. You can find the ID in the authoring tool (it's the number below the topic title), or in the portal (it’s the number in parenthesis, next to the topic title). The ID is also visible in the URL of a given topic.

Version control system

  • helps you manage changes to topics over time. You can safely develop and test new tutorials on your staging environment and push them to production when you're ready to go live.

Implementation

Authoring tool

  • a chrome extension that allows you to create and edit content for your application: walkthroughs, tooltips, feedback forms, redirects, and articles. You can install the editor and begin creating your in-app walkthroughs and tutorials at any moment, but they won't play until the player is installed on the site.

Frames

  • a frame or an iframe is an HTML element embedded inside another HTML element on a website. The iframe is often used to insert content from another source, such as an advertisement or a survey, into a website.

Integrations

  • currently, we support integrations with: Google Analytics, Heap Analytics, Intercom, Kissmetrics, Marketo, Segment or Woopra.

Player

  • the Inline Manual software that will display the widget, articles, walkthroughs, and tooltips that you create for your site or application. The player consisting of short, JS code can be installed in several ways depending on your preference and platform.

Single-Page Application

  • a web application that loads a single HTML page and dynamically updates that page as the user interacts with the app without a page refresh.

Organization

Account

  • your personal account in Inline Manual.

Active User

  • a user that logs into your application and the Inline Manual player is installed for them.

Organization

  • use organization feature to add and manage users and contributors for your tutorials. If you work in a team, setting up an organization will make working on topics easier and more effective.

Owner

  • a user with full access (read/write/modify) to the Inline Manual and the authoring tool.

Portal

  • a site app.inlinemanual.com. In other words, the dashboard, where you manage all global settings for the player and your account.

Reader

  • a user with reading permissions on the authoring tool (saving is disabled). The reader has read-only access to the following tabs on the portal: topics, analytics, people tracking, automation.

Writer

  •  a user with writing permissions to topics on the authoring tool. The writer has read-only access to the following tabs on the portal: topics, analytics, people tracking, automation.
glossary
Was this article helpful?