DITA Inline
Elements
Elements
This inline element is used when directing a user to click a button, select a menu option, select a tab, or other things that the user needs to click on to initiate some action.
What is a <ui control>?
This provides definitions of terms and descriptions of user interface, report, and database fields within the Skyward products.
What is a Glossary or term?
A document that organizes topics and other resources into structured collections of information. This is created by the Content Architect (CA).
What is a Map?
This must be ended before you begin a new one.
What is an RMS Action?
This status is used when the CA first creates the topic. You must move the topic from this status in easyDITA in order to author it.
What is New?
This inline element is used to indicate menu navigation to the user.
What is a <menu cascade>?
This provides overview and background information that helps end users understand essential information about a product, interface, or task. It typically answers a "What is..." question. This information is typically read only once or twice to gain the necessary background information required prior to beginning a task.
What is a Concept topic?
The authoring tool and component Content Management System (cCMS) currently being used for authoring content for the Qmlativ software. This is where the majority of the content for training and the help system is developed and maintained.
What is easyDITA?
This is used when authoring or revising a topic, video script, or simulation.
What is the Documentation action type?
This status is used when authoring a topic, applying SME revisions, or applying editor revisions.
What is WIP?
This inline element is used to indicate a window name, browse name, dialog box, or tab name.
What is a <wintitle>?
This provides procedural information, typically with step-by-step instructions for accomplishing a goal. A task typically answers a "How Do I..." question.
What is a Task or How-To topic?
Semantic markers that define the start and end of content in the Source Code. All begin with a “<” and end with a ">".
What is an Element or inline element?
This is used primarily for video editing, and is also used by editors and authors when assisting an author or answering questions related to that author's project. This is also used during new hire training when the senior author or editor is completing topic review for the new hire author or editor.
What is the Documentation Assist action type?
This status is used if the topic is undergoing a SME or SFC review.
What is In Review?
This inline element is used to denote a definition for a word being used.
What is a <term>?
This provides strategies for isolating and solving potential problems end users might encounter using Skyward products. A troubleshooting topic typically answers a "How Do I Identify and Resolve..." question.
What is a Troubleshooting topic?
Darwin Information Typing Architecture - an OASIS standard that defines an XML architecture for designing, authoring, publishing, and managing content.
What is DITA?
This is used for secondary review when sending a project to the editors for review.
What is the Documentation Review action type?
This status is used by the editors, a senior author, or possibly a CA to indicate that revisions are needed to a topic.
What is Revisions Needed?
This inline element is used near the beginning of a topic to indicate that the user needs to perform an action or condition prior to completing the topic.
What is a <prereq>?
This provides "look-up" information that end users can refer to when completing a task. This topic may answer questions like "How Much...", "How Many...", or "What Form..." It is intended to be referred to as often as needed.
What is a Reference topic?
A titled group of information that can be understood in isolation and used in multiple contexts. It should be short enough to address a single subject or answer a single question but long enough to make sense on its own and be authored as a self-contained unit.
What is a Topic?
This is used for interviewing a SME, researching a topic, or creating the Word documents for review via IQ. This is also used for summary actions, such as when you have 3 or more topics within a project and wish to indicate that all topics are ready for review. You would include "Summary Action" in the summary line and indicate all of the topics that are ready in the action notes. Additionally, this is used to track actions on projects without easyDITA topics, such as Technical Writing Training, Professional Development, or Miscellaneous projects.
What is the Work action type?
This status is used when sending a topic for editor review.
What is Secondary Review?