Book Contents Editor - On Premises 6.4

Author-it Knowledge Center

Author-it Administrator
Apply a licence to a library
User & group permissions
Create a new group
Delete a group
Resolving conflicts between permissions from different groups
Active Directory groups
Create a new user
Set the groups a user belongs to
Clear a user password
Change a user password
Delete a user
Set up libraries to use Active Directory
Map Author-it groups to Active Directory groups
Map existing users for Active Directory
New user library sign in
Integrated Active Directory user name examples
Active Directory in Contribute
Folder action permissions
Folder action permission options
Add or remove folder permissions
Modify folder properties
Author-it XML Format
AuthorIT Element
Objects Element
Book Element
Object Element
BasedOn Element
CreatedBy Element
CreatedDate Element
Description Element
FolderID Element
GUID Element
ID Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
IsTemplate Element
Key Element
LocalizationID Element
ModifiedBy Element
ModifiedDate Element
ReleaseStateID Element
Status Element
Type Element
Version Element
VersionParent Element
VersionRoot Element
VariantParentID Element
LocID Element
ModifiedComments Element
ContentsNodes Element
Node Element
ChildNodes Element
VariableAssignments Element
VariableAssignment Element
ID Element
Name Element
Value Element
ValueObject Element
Style Element
PrintByLine Element
PrintTitle Element
PrintSubTitle Element
PrintSuperTitle Element
PrintVersion Element
PrintWordTemplate Element
HelpAltPrefix Element
HelpCitation Element
HelpCompression Element
HelpCopyright Element
HelpFileName Element
HelpIncludeFile Element
HelpMacro Element
HelpTitle Element
HelpTopicOffset Element
WebAdditionalFiles Element
AdditionalFile Element
Filename Element
WebBaseFontSize Element
WebBaseURL Element
WebByLine Element
WebFramesetTemplate Element
WebSuperTitle Element
WebTitle Element
WebVersion Element
File Element
Object Element
BasedOn Element
CreatedBy Element
CreatedDate Element
Description Element
FolderID Element
GUID Element
ID Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
IsTemplate Element
Key Element
LocalizationID Element
ModifiedBy Element
ModifiedDate Element
ReleaseStateID Element
Status Element
Type Element
Version Element
VersionParent Element
VersionRoot Element
VariantParentID Element
LocID Element
ModifiedComments Element
EmbeddedPicture Element
EmbeddedPictureExt Element
HyperLink Element
VariableAssignments Element
VariableAssignment Element
ID Element
Name Element
Value Element
ValueObject Element
Style Element
PrintBorderBottom Element
PrintBorderLeft Element
PrintBorderRight Element
PrintBorderTop Element
PrintCaptionLabel Element
PrintCaptionPosition Element
PrintCaptionTitle Element
PrintFilename Element
PrintFolder Element
PrintOutputFormat Element
PrintParagraphStyle Element
PrintScaleHeight Element
PrintScaleWidth Element
PrintSizeHeight Element
PrintSizeWidth Element
PrintSizingMethod Element
PrintSourceType Element
HelpBitmapAlignment Element
HelpFileName Element
HelpFolder Element
HelpOutputFormat Element
HelpParagraphStyle Element
HelpScaleHeight Element
HelpScaleWidth Element
HelpSizeHeight Element
HelpSizeWidth Element
HelpSizingMethod Element
HelpSourceType Element
HelpVideoPlay Element
HelpVideoRepeat Element
HelpVideoShowMenuButton Element
HelpVideoShowPlaybar Element
WebAdditionalFiles Element
AdditionalFile Element
Filename Element
WebAlignment Element
WebAltText Element
WebBorder Element
WebFolder Element
WebHorizontalSpace Element
WebImageMap Element
WebOutputFormat Element
WebSizeHeight Element
WebSizeWidth Element
WebSourceType Element
WebVerticalSpace Element
WebVideoRepeat Element
WebVideoRepeatTimes Element
WebVideoShowControls Element
WebVideoStart Element
Glossary Element
Object Element
BasedOn Element
CreatedBy Element
CreatedDate Element
Description Element
FolderID Element
GUID Element
ID Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
IsTemplate Element
Key Element
LocalizationID Element
ModifiedBy Element
ModifiedDate Element
ReleaseStateID Element
Status Element
Type Element
Version Element
VersionParent Element
VersionRoot Element
VariantParentID Element
LocID Element
ModifiedComments Element
VariableAssignments Element
VariableAssignment Element
ID Element
Name Element
Value Element
ValueObject Element
Style Element
PrintAddLetterHeadings Element
PrintMedia Element
PrintSortTerms Element
PrintTitle Element
HelpPopUpColor Element
HelpPopUpType Element
HelpTitle Element
WebLinkType Element
WebMedia Element
WebTitle Element
Hyperlink Element
Object Element
BasedOn Element
CreatedBy Element
CreatedDate Element
Description Element
FolderID Element
GUID Element
ID Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
IsTemplate Element
Key Element
LocalizationID Element
ModifiedBy Element
ModifiedDate Element
ReleaseStateID Element
Status Element
Type Element
Version Element
VersionParent Element
VersionRoot Element
VariantParentID Element
LocID Element
ModifiedComments Element
HyperLinksTargets Element
Relation Element
ID Element
SyncAnchorText Element
VariableAssignments Element
VariableAssignment Element
ID Element
Name Element
Value Element
ValueObject Element
Style Element
PrintCrossRefBrackets Element
PrintCrossRefIncludeHeading Element
PrintCrossRefIncludePageNum Element
PrintCrossRefPageNumText Element
PrintCrossRefText Element
PrintFootnoteCustomRef Element
PrintFootnoteNumberFormat Element
PrintFootnoteNumberType Element
PrintLinkType Element
HelpIncludeButton element
HelpJumpType Element
HelpRemoveUnderline Element
HelpWindow Element
WebHHPopupFontName Element
WebHHPopupFontSize Element
WebHHPopupMarginsLR Element
WebHHPopupMarginsTB Element
WebJumpType element
WebJumpURLs Element
Index Element
Object Element
BasedOn Element
CreatedBy Element
CreatedDate Element
Description Element
FolderID Element
GUID Element
ID Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
IsTemplate Element
Key Element
LocalizationID Element
ModifiedBy Element
ModifiedDate Element
ReleaseStateID Element
Status Element
Type Element
Version Element
VersionParent Element
VersionRoot Element
VariantParentID Element
LocID Element
ModifiedComments Element
IndexNodes Element
Node Element
ChildNodes Element
VariableAssignments Element
VariableAssignment Element
ID Element
Name Element
Value Element
ValueObject Element
Style Element
PrintFromEntries Element
PrintFromHeadings Element
PrintFromLinks Element
PrintIndexType Element
PrintMedia Element
PrintRightAlign Element
PrintTitle Element
HelpFromEntries Element
HelpFromLinks Element
HelpFromHeadings Element
Targets Element
Relation Element
ID Element
WebFromEntries Element
WebFromHeadings Element
WebFromLinks Element
WebHHIndexTemplate Element
WebHHSitemapTemplate Element
WebIndexType Element
WebJHIndexTemplate Element
WebMedia Element
WebOHIndexTemplate Element
WebTitle Element
IndexEntry Element
Object Element
BasedOn Element
CreatedBy Element
CreatedDate Element
Description Element
FolderID Element
GUID Element
ID Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
IsTemplate Element
Key Element
LocalizationID Element
ModifiedBy Element
ModifiedDate Element
ReleaseStateID Element
Status Element
Type Element
Version Element
VersionParent Element
VersionRoot Element
VariantParentID Element
LocID Element
ModifiedComments Element
Targets Element
Relation Element
ID Element
VariableAssignments Element
VariableAssignment Element
ID Element
Name Element
Value Element
ValueObject Element
Style Element
PrintEntryText Element
HelpEntryText Element
HelpMacro Element
WebEntryText element
Macro Element
Object Element
BasedOn Element
CreatedBy Element
CreatedDate Element
Description Element
FolderID Element
GUID Element
ID Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
IsTemplate Element
Key Element
LocalizationID Element
ModifiedBy Element
ModifiedDate Element
ReleaseStateID Element
Status Element
Type Element
Version Element
VersionParent Element
VersionRoot Element
VariantParentID Element
LocID Element
ModifiedComments Element
HelpActions Element
Action Element
Name Element
Parameters Element
VariableAssignments Element
VariableAssignment Element
ID Element
Name Element
Value Element
ValueObject Element
Style Element
Media Element
Object Element
BasedOn Element
CreatedBy Element
CreatedDate Element
Description Element
FolderID Element
GUID Element
ID Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
IsTemplate Element
Key Element
LocalizationID Element
ModifiedBy Element
ModifiedDate Element
ReleaseStateID Element
Status Element
Type Element
Version Element
VersionParent Element
VersionRoot Element
VariantParentID Element
LocID Element
ModifiedComments Element
VariableAssignments Element
VariableAssignment Element
ID Element
Name Element
Value Element
ValueObject Element
Style Element
PrintDifferentFirst Element
PrintDifferentOddEven Element
PrintEvenFooter element
PrintEvenHeader Element
PrintFirstFooter element
PrintFirstHeader Element
PrintMarginBottom Element
PrintMarginFooter Element
PrintMarginGutter Element
PrintMarginHeader Element
PrintMarginLeft Element
PrintMarginRight Element
PrintMarginTop Element
PrintMirrorMargins Element
PrintNumColumns Element
PrintOddFooter element
PrintOddHeader Element
PrintOrientation Element
PrintPageNumberFormat Element
PrintPageNumberStartFrom Element
PrintPageNumberStartType Element
PrintPaperSize Element
PrintSectionStart Element
PrintSizeHeight Element
PrintSizeWidth Element
HelpAutoSize Element
HelpBack Element
HelpBrowse Element
HelpColourHeading Element
HelpColourTopic Element
HelpContents Element
HelpFind Element
HelpHeight Element
HelpIndex Element
HelpKeepOnTop Element
HelpLeft Element
HelpMacro Element
HelpMaximise Element
HelpOptions Element
HelpPrintTopic Element
HelpTitle Element
HelpTop Element
HelpTopics Element
HelpWidth Element
HelpWindowName Element
WebALinkColour Element
WebAdditionalFiles Element
AdditionalFile Element
Filename Element
WebBackColour Element
WebBackImage Element
WebBackImageNonScrolling Element
WebBackSound Element
WebBackSoundRepeat Element
WebMetaData Element
MetaDataItem Element
Name Element
Content Element
WebLinkColour Element
WebTemplate Element
WebTextColour Element
WebTitle Element
WebVLinkColour Element
Style Element
Object Element
BasedOn Element
CreatedBy Element
CreatedDate Element
Description Element
FolderID Element
GUID Element
ID Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
IsTemplate Element
Key Element
LocalizationID Element
ModifiedBy Element
ModifiedDate Element
ReleaseStateID Element
Status Element
Type Element
Version Element
VersionParent Element
VersionRoot Element
VariantParentID Element
LocID Element
ModifiedComments Element
BorderBottom Element
BorderLeft Element
BorderRight Element
BorderStyle Element
BorderShadow Element
BorderTop Element
Bullet Element
FontBold Element
FontColour Element
FontItalics Element
FontName Element
FontSize Element
FontUnderline Element
FontSubscript Element
FontSuperscript Element
Number Element
Numbering Element
NumberStart Element
OutlineLevel Element
ParaAfter Element
ParaAlignment Element
ParaBefore Element
ParaFirstLine Element
ParaLeft Element
ParaLineSpacing Element
ParaRight Element
StyleName Element
StyleType Element
TabDefault Element
Tabs Element
Tab Element
Alignment Element
Position Element
VariableAssignments Element
VariableAssignment Element
ID Element
Name Element
Value Element
ValueObject Element
Style Element
PrintStyleName Element
HelpBorderBottom Element
HelpBorderLeft Element
HelpBorderRight Element
HelpBorderShadow Element
HelpBorderStyle Element
HelpBorderTop Element
HelpBullet Element
HelpFontBold Element
HelpFontColour Element
HelpFontItalics Element
HelpFontName Element
HelpFontSize Element
HelpNonWrapping Element
HelpNumber Element
HelpNumbering Element
HelpNumberStart Element
HelpParaAfter Element
HelpParaAlignment Element
HelpParaBefore Element
HelpParaFirstLine Element
HelpParaLeft Element
HelpParaLineSpacing Element
HelpParaRight Element
HelpTabDefault Element
HelpTabs Element
Tab Element
Alignment Element
Position Element
WebBackAttach Element
WebBackColour Element
WebBackPositionX Element
WebBackPositionY Element
WebBackRepeat Element
WebBackURL Element
WebBorderColourBottom Element
WebBorderColourLeft Element
WebBorderColourRight Element
WebBorderColourTop Element
WebBorderStyleBottom Element
WebBorderStyleLeft Element
WebBorderStyleRight Element
WebBorderStyleTop Element
WebBorderWidthBottom Element
WebBorderWidthLeft Element
WebBorderWidthRight Element
WebBorderWidthTop Element
WebBlockTag Element
WebBulletStyle Element
WebBulletURL Element
WebClear Element
WebFloat Element
WebFontColour Element
WebFontName Element
WebFontSize Element
WebFontStyle Element
WebFontVariant Element
WebFontWeight Element
WebHeight Element
WebLetterSpacing Element
WebLineHeight Element
WebMarginBottom Element
WebMarginLeft Element
WebMarginRight Element
WebMarginTop Element
WebNumbering Element
WebNumberStyle Element
WebPaddingBottom Element
WebPaddingLeft Element
WebPaddingRight Element
WebPaddingTop Element
WebTextAlign Element
WebTextDecoration Element
WebTextIndent Element
WebTextTag Element
WebTextTransform Element
WebVerticalAlign Element
WebWhiteSpace Element
WebWidth Element
WebWordSpacing Element
TableOfContents Element
Object Element
BasedOn Element
CreatedBy Element
CreatedDate Element
Description Element
FolderID Element
GUID Element
ID Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
IsTemplate Element
Key Element
LocalizationID Element
ModifiedBy Element
ModifiedDate Element
ReleaseStateID Element
Status Element
Type Element
Version Element
VersionParent Element
VersionRoot Element
VariantParentID Element
LocID Element
ModifiedComments Element
VariableAssignments Element
VariableAssignment Element
ID Element
Name Element
Value Element
ValueObject Element
Style Element
PrintAddSuperHeadings Element
PrintMedia Element
PrintPageNumber Element
PrintRightAlign Element
PrintShowLevel Element
PrintTitle Element
HelpMultiBookTargets Element
Relation Element
ID Element
HelpTitle Element
HelpWindow Element
WebContentsType Element
WebFrameType Element
WebFrameWidth Element
WebHHSitemapTemplate Element
WebHHTocTemplate Element
WebJHTocTemplate Element
WebMedia Element
WebOHTocTemplate Element
WebTitle Element
TableOfFigures Element
Object Element
BasedOn Element
CreatedBy Element
CreatedDate Element
Description Element
FolderID Element
GUID Element
ID Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
IsTemplate Element
Key Element
LocalizationID Element
ModifiedBy Element
ModifiedDate Element
ReleaseStateID Element
Status Element
Type Element
Version Element
VersionParent Element
VersionRoot Element
VariantParentID Element
LocID Element
ModifiedComments Element
VariableAssignments Element
VariableAssignment Element
ID Element
Name Element
Value Element
ValueObject Element
Style Element
PrintCaption Element
PrintLabelType Element
PrintMedia Element
PrintPageNumber Element
PrintRightAlign Element
PrintTitle Element
TitlePage Element
Object Element
BasedOn Element
CreatedBy Element
CreatedDate Element
Description Element
FolderID Element
GUID Element
ID Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
IsTemplate Element
Key Element
LocalizationID Element
ModifiedBy Element
ModifiedDate Element
ReleaseStateID Element
Status Element
Type Element
Version Element
VersionParent Element
VersionRoot Element
VariantParentID Element
LocID Element
ModifiedComments Element
VariableAssignments Element
VariableAssignment Element
ID Element
Name Element
Value Element
ValueObject Element
Style Element
PrintFile Element
PrintIncludeByLine Element
PrintIncludeSubTitle Element
PrintIncludeSuperTitle Element
PrintIncludeTitle Element
PrintIncludeVersion Element
PrintMedia Element
Topic Element
Object Element
BasedOn Element
CreatedBy Element
CreatedDate Element
Description Element
FolderID Element
GUID Element
ID Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
IsTemplate Element
Key Element
LocalizationID Element
ModifiedBy Element
ModifiedDate Element
ReleaseStateID Element
Status Element
Type Element
Version Element
VersionParent Element
VersionRoot Element
VariantParentID Element
LocID Element
ModifiedComments Element
Headings Element
All Element
PrintHeading Element
HelpHeading Element
WebHeading Element
RelatedGroups Element
RelatedGroup Element
Alignment Element
Children Element
ColumnWidth Element
Contents Element
ExcludeHeadingText Element
Heading Element
HeadingFile Element
HeadingStyle Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
Index Element
ItemStyle Element
NextTopic Element
ParentTopic Element
PopUp Element
Position Element
PreviousTopic Element
RelatedGroupID Element
Sequence Element
Siblings Element
SpecificLinks Element
Relation Element
ID Element
Text Element
p Element
br Element
cs Element
fref Element
tref Element
href Element
mref Element
nbd Element
nbs Element
table Element
tr Element
td Element
VariableAssignments Element
VariableAssignment Element
ID Element
Name Element
Value Element
ValueObject Element
Style Element
PrintAutoNumber Element
PrintBreakType Element
PrintHeadingStyle Element
PrintMedia Element
PrintSuperHeading Element
HelpAlias Element
HelpContextID Element
HelpContextString Element
HelpCustomFootnotes Element
HelpFootnote Element
Type Element
Data Element
HelpHeadingStyle Element
HelpIncludeInSequence Element
HelpJumpMacro Element
HelpJumpType Element
HelpJumpWindow Element
HelpNewSequence Element
HelpNonScrolling Element
HelpTopicMacro Element
WebFilename Element
WebMedia Element
WebTitle Element
WebTOCImage Element
Inherited Attribute
Inherit Attribute
Folder Element
ID Element
Name Element
GUID Element
ParentFolderID Element
ObjectSummary Element
ID Element
Type Element
GUID Element
Description Element
ReleaseState Element
ID Element
Name Element
GUID Element
Color Element
ReviewColor Element
Type Element
Variable Element
ID Element
Name Element
Description Element
Value Element
ValueObject Element
Style Element
Prompt Element
IsVariantCriteria Element
Type Element
Hidden Element
ListOfValues Element
Item Element
Information Element
Description Element
Date Element
Library Element
Name Element
GUID Element
User Element
Locale Element
ID Element
Description Element
TranslationJob Element
Description Element
GUID Element
WordCount Element
Historical changes to Author-it XML Format
Changes to Author-it XML, Release 6
Changes to Author-it XML, Release 5.5
Author-it XML format for translation
Historical changes to Author-it XML Format
Changes to Author-it XML, Release 6
Changes to Author-it XML, Release 5.5
XML for translators
Translating content using XML-based editors
Translate content with SDL Trados Studio 2009
Translating with SDLx
XML Elements - All objects
XML Elements - Book object
XML Elements - File object
XML Elements - Glossary object
XML Elements - Hyperlink object
XML Elements - Index object
XML Elements - Index Entry object
XML Elements - Table of Contents object
XML Elements - Table of Figures object
XML Elements - Topic object
XML Elements - Topic text
XML Elements - Variable assignments
Preserve variables in translated text
Remove variables from translated text
Add and Manage Content
Add content
Create a new object or template
Topic objects
Topic templates
Copy text between topics
Text select options in a topic
Paste content by using an import profile
Split a topic into two topics
Type in languages other than English
Insert a symbol or special character into text
Add an equation to your topic
Spell checking text in an object
Change the spell check options
Add a topic to a book
Object positioning
Troubleshooting topic save issues
Frontmatter & boilerplate topics
Index object
Building an index with index entries
Index contents outliner
Adding entries to the index contents outline
Promoting, Demoting or Moving an Index Entry
Expanding and Collapsing Levels
Removing Index Entries from the Index Contents
Creating "see" entries in the index
Control yomi-based indexing of Japanese content
Hyperlink object
Hyperlinks overview
Hyperlink types
Create a new hyperlink object
Insert a hyperlink
Create a hyperlink by using drag-and-drop
Create a hyperlink to an external file or address
Setting the style for hyperlink text in Word
Synchronize topic heading & hyperlink anchor text option
Glossary object
Table of Contents object
Table of Figures object
Using a Table of Figures, Table of Tables, and Table of Equations in a Single Book
Find & view objects
Locate an object
Opening an object
Select multiple objects
Compare two objects
View content in the Preview Pane
Show object relationships
Share an Author-it object over email
Modify an object
Modify object properties
Set object properties in the Properties window
Windows controls on the Properties window
Related topic groups
Find & replace text
Set a one-to-one relationship between objects
Set "Don't Inherit" states for properties
Set a color property
Change inherited property settings
Exclude an object from selected output formats
Object versioning
Duplicate an object
Replace an object
Object Versioning OP 6.4
Create a new version of an object
Delete or remove an object
Remove an object from a book
Delete an object from the library
Delete a book and its contents from the library
Structured authoring
Structured authoring in Author & Contribute
Plan the conversion to structured authoring
Enable structured templates
Structure parent node properties
Release states enforce structure validation for topics
Link an example topic to the structured template
Structure rule properties
Paragraph rules & styles
Create rules in the book structure builder
Create rules in the topic structure builder
Copy a structured template
Modify the structure of a template
Considerations for updating topic template structures
Book rules
Analyzing book content before creating structures
Boilerplate objects in structured book templates
Single-level book
Basic two-level book
Multilevel book
Front matter in a multilevel structure
First chapter in a multilevel structure
User guide chapters in a multilevel structure
FAQ chapter in a multilevel structure
Reference chapter in a multilevel structure
Glossary in a multilevel structure
Index in a multilevel structure
Topic rules
Analyze topic content before creating structures
Topic with an image
Topic with a list & child rules
Specification topic with a simple table
Topic with procedure steps
Topic with an optional image and table
Validating content
Prompting validation
Rule validation in a topic
Topic validation example
Paragraph rule validation examples
Fixed paragraph rules
Flexible paragraph rules
Mixture of fixed & flexible paragraph rules
Child rules & validation examples
No child rules defined
Child rules defined
Table validation rules
Table rule validation examples
Group rule validation requirements
Validation in the Editor
Rule validation for a topic in the Editor
Rule validation for a book in the Editor
When content doesn't validate
Considerations for updating a validated object
Publishing validated content
Structured authoring in Contribute
Structured authoring support in Contribute
AdditionalFile Element
Filename Element
Introduction
Working with css
Finding a css element
Setup of the css files
Editing the css
Hide the "Resources" Widget
Change the colors of the Icons in the header
Hide the "Settings" icon
Set the limits of "Recently Updated Pages"
Fix the margins in the Footer
Working with style(s)
Working with tables
Highlight the TOC selection
Enhancing Links
Working with images
Working with videos
Video and Audio
Preparing a youtube video
Preparing a Vimeo video
Adding css
Future goodies
Book Element
Object Element
BasedOn Element
CreatedBy Element
CreatedDate Element
Description Element
FolderID Element
GUID Element
ID Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
IsTemplate Element
Key Element
LocalizationID Element
ModifiedBy Element
ModifiedDate Element
ReleaseStateID Element
Status Element
Type Element
Version Element
VersionParent Element
VersionRoot Element
VariantParentID Element
LocID Element
ModifiedComments Element
ContentsNodes Element
Node Element
ChildNodes Element
VariableAssignments Element
VariableAssignment Element
ID Element
Name Element
Value Element
ValueObject Element
Style Element
PrintByLine Element
PrintTitle Element
PrintSubTitle Element
PrintSuperTitle Element
PrintVersion Element
PrintWordTemplate Element
HelpAltPrefix Element
HelpCitation Element
HelpCompression Element
HelpCopyright Element
HelpFileName Element
HelpIncludeFile Element
HelpMacro Element
HelpTitle Element
HelpTopicOffset Element
WebAdditionalFiles Element
AdditionalFile Element
Filename Element
WebBaseFontSize Element
WebBaseURL Element
WebByLine Element
WebFramesetTemplate Element
WebSuperTitle Element
WebTitle Element
WebVersion Element
Book Generator
Description
Duplicate a Book with Book Generator
Troubleshooting
Create Books
Create a new book
Book templates
Sub books
Add content to a book
Create a new topic in a book
Drag a topic into a book
Object positioning
Remove an object from a book
Open a book in Editor
Design guidelines for complex HTML5 assets in Author-it
What are interactive assets and how they are managed in Author-it
The published output, and the role of the HTML5 asset
What’s going on under the hood, and how this influences development and packaging of your interactive assets
Iframes vs embedded assets
Tools to create HTML5 assets
Recommended structure for an HTML5 asset
Support
Dock Editor layout tabs
Dock tabs inside the Editor
Dock tabs in the Editor & the reset panels option
Hide & display Editor layout tabs
Publish to (Author-it Honeycomb)
Author-it Honeycomb Overview
Overview
Author-it Honeycomb at a glance
Benefits of Author-it Honeycomb
Applications for Author-it Honeycomb
Main concepts to understand in Author-it Honeycomb
Author-it Honeycomb browser support
Considerations for Author-it Honeycomb
Standard WBT components
Book template (Honeycomb course)
Course navigation
Knowledge transfer topic templates
Accordions
Buttons with Images
Clickable Buttons
Carousels
Conversations
Flip Cards
Flip Books
Timelines
Snippets
Transitions
Knowledge check topic templates
Multiple Choice Multiple Selection
Multiple Choice Single Selection
Drag and Drop One to One
Drag and Drop One to One Immediate Feedback
Drag and Drop Sequence
Drag and Drop Categorization
Knowledge assessment topic templates
Spinner assessments
Standard assessments
Linked HTML file object templates
Other object templates
Styles
WBT styles
Hidden styles
Media objects
Publishing in Honeycomb
Substituting media objects
Before and After Publish actions
Variables
Building knowledge slides
Creating a course book
Structuring slides and their elements
Using Static topics
Creating Accordions
Creating Clickable Buttons
Creating Buttons with Images
Creating Image-Text Snippets
Creating Flip Cards
Creating Flip Books
Creating Carousels
Creating Timelines
Creating Text-Image Transitions
Creating Conversations
Adding audio, video, and animation
Inserting audio, video, or animation
Creating an HTML file
Examples of HTML files for Video, Audio, and Animation
Creating an HTML file object
Creating a transcript for audio files
Building knowledge checks
Defining feedback topics
Creating Multiple Choice Multiple Selection checks
Creating Multiple Choice Single Selection checks
Creating Drag and Drop One to One checks
Creating Drag and Drop One to One Immediate Feedback checks
Creating Drag and Drop Categorization checks
Creating Drag and Drop Sequence checks
Building knowledge assessments
Assessment and group metadata
Creating an Assessment
Building the glossary
Creating a glossary
Building the resources folder
Creating the resources folder
Adding keywords to scorm output
Tin Can support
Viewing the output
Viewing the WBT output
Navigating the WBT output
Using the WBT training window
Main menu
Course menu
Resource links
Help
Course and slide title
Course exit
Content area
Progress indicators
Slide counter
Audio controls
Slide navigation controls
Playing videos
Troubleshooting
Author-it Honeycomb Publishing
Possible causes for publishing failing
Possible causes for interactive slides not working
Output does not look correct
Author-it Honeycomb ignores some Author-it settings
How do I link to a PDF?
Carousel not loading
Course Completion
Course Completion Values for LMS
Slide Completion
Knowledge Check Completion
Assessment Completion
Modifying Course Completion Criteria
Design guidelines for complex HTML5 assets in Author-it
What are interactive assets and how they are managed in Author-it
The published output, and the role of the HTML5 asset
What’s going on under the hood, and how this influences development and packaging of your interactive assets
Iframes vs embedded assets
Tools to create HTML5 assets
Recommended structure for an HTML5 asset
Support
Author-it Honeycomb Template Design
Brief overview of the publishing process for Author-it Honeycomb
Actions tab
Understanding the output
Changing Content in published output
Contents of the Author-it Honeycomb templates folder
Author-it Honeycomb Source (hv_src)
Organization of the Style Sheets
Fonts
Theme updates
Author-it Honeycomb configuration xml
Instructions for updating Author-it Honeycomb lay-out
Logo
Add a style that is not default in Author-it Honeycomb
Managing the Menu and menu buttons
Change instructional text
Localize instructional texts
Add your own text to the help
Table lay-out
Metadata for correct Author-it Honeycomb publishing
Introduction to embedded topics
Uses for embedded topics
Benefits of using embedded topics
Embedding topics
Rules for embedded topics
Displaying paragraph markers
Selecting container text precisely
Cursor position
Content copying from embedded topics
Character length requirement for embedded topics
Add container content between embedded topics
Add container content above an embedded topic
Manage embedded topics
Embed a topic within another topic
Edit an embedded topic
Remove an embedded topic
Delete embedded content
Create an embedded topic from selected text
Copying Text That Contains an Embedded Topic
Styles & embedded topics
Controlling Style Tagging for an Embedded Topic
Embed a topic that maintains its own styles
Embed a topic that uses the container topic's paragraph style
Control the style applied to the final paragraph in embedded content
Scenario: Embedded list
Scenario: Embedded table followed by a list
Scenario three: Multiple embedded topics
Scenario: Multiple topics in a numbered table
How to ensure the final list item is tagged correctly
Tables & embedded topics
Embedding text strings & table rows
Using embedded table rows to create a table
Creating a single table from embedded table rows
Creating separate tables from embedded table rows
Separating embedded rows in new tables
Insert text between existing embedded table rows
Insert new table rows between existing embedded table rows
Adding content above an embedded table
Separating hyperlinks & embedded topics with a non-breaking space
Using the publishing profile to exclude embedded topics
Extra Functionality with Plugins
The HideUI Plugin
Description
Resource Translator
Description
Using Resource Translator
Start Resource Translator
Create Rules
Create a Job
Run Jobs
Export RESX
Book Generator
Description
Duplicate a Book with Book Generator
Troubleshooting
Installation of Plugins
Plugin settings
Installation and Configuration of Book Generator
Installation and Configuration of Hide UI
Installation and Configuration of Resource Translator
Author-it overview questions
When to use Author-it
How does Author-it increase productivity?
How does Author-it differ from word processing applications?
How does Author-it differ from HTML-based authoring tools?
Author-it vs Word-based Tools
How does Author-it differ from WinHelp-based tools
Can Author-it produce documents in other languages?
How do I evaluate documentation tools?
Author-it concepts FAQ
What are libraries and books in Author-it?
What does object-oriented mean?
Does Author-it use the concept of projects?
Why Are The File Locations Relative?
Author & Contribute FAQ
Can Author-it handle foreign languages?
How do I choose a folder structure?
Should I use linked or embedded graphics?
How can I create links from my graphics?
How do I remove character formatting?
How do I handle interrupted alphabetic or numeric lists where I have added a graphic or a note?
How do I change every instance?
Text find & replace
Object search
Change a template
How do I exclude my topic trom HTML when based on the normal template?
How do I get reports?
Can I export object names and numbers to a text file?
How do I set WinHelp browse sequences?
Content FAQ
Change inherited property settings
How do I know where to start a new topic?
How do I see what my document will look like?
Can graphics be resized without distortion?
How do I add a Flash file?
Does Author-it have a built-in image capture function?
How can I add a graphic to the Contents frame?
How can I combine text with file objects?
How do I create glossary terms?
How do I create multi-level numbered headings?
How does Author-it handle conditional text?
Can I Copy Books Between Libraries?
Team authoring FAQ
Can Author-it be used with ClearCase?
Can more than one person work on the same book?
How do I control authoring standards for the whole team?
Do I need a document management system as well as Author-it?
How do I create sub-books?
How do we work concurrently on the same library?
Publishing FAQ
What publishing formats does Author-it support?
Why do variables assigned to sub-books not get resolved?
What do I do when I have publishing problems?
How long does publishing take?
Can Publishing be done in a batch file, say daily or once a week?
Can I output to PDF?
How do I update my document?
How can I prevent Author-it from publishing the blank 'allowpagebreak' style in the Word document?
How do I make my printed document single-sided
How can I display cropmarks on each page without losing my normal headers and footers?
How do I remove the "Printed On ..." date line?
How do I ensure my graphics are included in my Word document?
Why doesn't search work in published HTML Help?
Why do I have duplicate HTML pages in the same book?
Can I attach my own cascading stylesheets?
How do I get multiple topics to appear as one HTML Help page?
How do I increase the font size of the HTML Help topic heading?
How does context sensitivity in HTML Help compare with Windows Help
How do I deliver the Help project to the client?
How do I distribute Help components to users
What Windows Help components do I need to send someone?
Review FAQ
Review FAQ
Author-it administration & maintenance FAQ
How do I track and report on changes to objects?
Will the library I create with the evaluation edition be compatible with my licensed edition?
Which files should I backup?
Why should you backup your files?
Author-it overview questions
When to use Author-it
How does Author-it increase productivity?
How does Author-it differ from word processing applications?
How does Author-it differ from HTML-based authoring tools?
Author-it vs Word-based Tools
How does Author-it differ from WinHelp-based tools
Can Author-it produce documents in other languages?
How do I evaluate documentation tools?
Author-it concepts FAQ
What are libraries and books in Author-it?
What does object-oriented mean?
Does Author-it use the concept of projects?
Why Are The File Locations Relative?
Author & Contribute FAQ
Can Author-it handle foreign languages?
How do I choose a folder structure?
Should I use linked or embedded graphics?
How can I create links from my graphics?
How do I remove character formatting?
How do I handle interrupted alphabetic or numeric lists where I have added a graphic or a note?
How do I change every instance?
Text find & replace
Object search
Change a template
How do I exclude my topic trom HTML when based on the normal template?
How do I get reports?
Can I export object names and numbers to a text file?
How do I set WinHelp browse sequences?
Content FAQ
Change inherited property settings
How do I know where to start a new topic?
How do I see what my document will look like?
Can graphics be resized without distortion?
How do I add a Flash file?
Does Author-it have a built-in image capture function?
How can I add a graphic to the Contents frame?
How can I combine text with file objects?
How do I create glossary terms?
How do I create multi-level numbered headings?
How does Author-it handle conditional text?
Can I Copy Books Between Libraries?
Team authoring FAQ
Can Author-it be used with ClearCase?
Can more than one person work on the same book?
How do I control authoring standards for the whole team?
Do I need a document management system as well as Author-it?
How do I create sub-books?
How do we work concurrently on the same library?
Publishing FAQ
What publishing formats does Author-it support?
Why do variables assigned to sub-books not get resolved?
What do I do when I have publishing problems?
How long does publishing take?
Can Publishing be done in a batch file, say daily or once a week?
Can I output to PDF?
How do I update my document?
How can I prevent Author-it from publishing the blank 'allowpagebreak' style in the Word document?
How do I make my printed document single-sided
How can I display cropmarks on each page without losing my normal headers and footers?
How do I remove the "Printed On ..." date line?
How do I ensure my graphics are included in my Word document?
Why doesn't search work in published HTML Help?
Why do I have duplicate HTML pages in the same book?
Can I attach my own cascading stylesheets?
How do I get multiple topics to appear as one HTML Help page?
How do I increase the font size of the HTML Help topic heading?
How does context sensitivity in HTML Help compare with Windows Help
How do I deliver the Help project to the client?
How do I distribute Help components to users
What Windows Help components do I need to send someone?
Review FAQ
Review FAQ
Author-it administration & maintenance FAQ
How do I track and report on changes to objects?
Will the library I create with the evaluation edition be compatible with my licensed edition?
Which files should I backup?
Why should you backup your files?
File Element
Object Element
BasedOn Element
CreatedBy Element
CreatedDate Element
Description Element
FolderID Element
GUID Element
ID Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
IsTemplate Element
Key Element
LocalizationID Element
ModifiedBy Element
ModifiedDate Element
ReleaseStateID Element
Status Element
Type Element
Version Element
VersionParent Element
VersionRoot Element
VariantParentID Element
LocID Element
ModifiedComments Element
EmbeddedPicture Element
EmbeddedPictureExt Element
HyperLink Element
VariableAssignments Element
VariableAssignment Element
ID Element
Name Element
Value Element
ValueObject Element
Style Element
PrintBorderBottom Element
PrintBorderLeft Element
PrintBorderRight Element
PrintBorderTop Element
PrintCaptionLabel Element
PrintCaptionPosition Element
PrintCaptionTitle Element
PrintFilename Element
PrintFolder Element
PrintOutputFormat Element
PrintParagraphStyle Element
PrintScaleHeight Element
PrintScaleWidth Element
PrintSizeHeight Element
PrintSizeWidth Element
PrintSizingMethod Element
PrintSourceType Element
HelpBitmapAlignment Element
HelpFileName Element
HelpFolder Element
HelpOutputFormat Element
HelpParagraphStyle Element
HelpScaleHeight Element
HelpScaleWidth Element
HelpSizeHeight Element
HelpSizeWidth Element
HelpSizingMethod Element
HelpSourceType Element
HelpVideoPlay Element
HelpVideoRepeat Element
HelpVideoShowMenuButton Element
HelpVideoShowPlaybar Element
WebAdditionalFiles Element
AdditionalFile Element
Filename Element
WebAlignment Element
WebAltText Element
WebBorder Element
WebFolder Element
WebHorizontalSpace Element
WebImageMap Element
WebOutputFormat Element
WebSizeHeight Element
WebSizeWidth Element
WebSourceType Element
WebVerticalSpace Element
WebVideoRepeat Element
WebVideoRepeatTimes Element
WebVideoShowControls Element
WebVideoStart Element
Glossary Element
Object Element
BasedOn Element
CreatedBy Element
CreatedDate Element
Description Element
FolderID Element
GUID Element
ID Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
IsTemplate Element
Key Element
LocalizationID Element
ModifiedBy Element
ModifiedDate Element
ReleaseStateID Element
Status Element
Type Element
Version Element
VersionParent Element
VersionRoot Element
VariantParentID Element
LocID Element
ModifiedComments Element
VariableAssignments Element
VariableAssignment Element
ID Element
Name Element
Value Element
ValueObject Element
Style Element
PrintAddLetterHeadings Element
PrintMedia Element
PrintSortTerms Element
PrintTitle Element
HelpPopUpColor Element
HelpPopUpType Element
HelpTitle Element
WebLinkType Element
WebMedia Element
WebTitle Element
The HideUI Plugin
Description
Historical changes to Author-it XML Format
Changes to Author-it XML, Release 6
Changes to Author-it XML, Release 5.5
Author-it Honeycomb Template Design
Brief overview of the publishing process for Author-it Honeycomb
Actions tab
Understanding the output
Changing Content in published output
Contents of the Author-it Honeycomb templates folder
Author-it Honeycomb Source (hv_src)
Organization of the Style Sheets
Fonts
Theme updates
Author-it Honeycomb configuration xml
Instructions for updating Author-it Honeycomb lay-out
Logo
Add a style that is not default in Author-it Honeycomb
Managing the Menu and menu buttons
Change instructional text
Localize instructional texts
Add your own text to the help
Table lay-out
Metadata for correct Author-it Honeycomb publishing
How to use variant object in Author
Hyperlink Element
Object Element
BasedOn Element
CreatedBy Element
CreatedDate Element
Description Element
FolderID Element
GUID Element
ID Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
IsTemplate Element
Key Element
LocalizationID Element
ModifiedBy Element
ModifiedDate Element
ReleaseStateID Element
Status Element
Type Element
Version Element
VersionParent Element
VersionRoot Element
VariantParentID Element
LocID Element
ModifiedComments Element
HyperLinksTargets Element
Relation Element
ID Element
SyncAnchorText Element
VariableAssignments Element
VariableAssignment Element
ID Element
Name Element
Value Element
ValueObject Element
Style Element
PrintCrossRefBrackets Element
PrintCrossRefIncludeHeading Element
PrintCrossRefIncludePageNum Element
PrintCrossRefPageNumText Element
PrintCrossRefText Element
PrintFootnoteCustomRef Element
PrintFootnoteNumberFormat Element
PrintFootnoteNumberType Element
PrintLinkType Element
HelpIncludeButton element
HelpJumpType Element
HelpRemoveUnderline Element
HelpWindow Element
WebHHPopupFontName Element
WebHHPopupFontSize Element
WebHHPopupMarginsLR Element
WebHHPopupMarginsTB Element
WebJumpType element
WebJumpURLs Element
Importing in Author-it
Import Word Documents into Author-it
Inspect the rules
Apply Author-it Style rule
Character Style Mapping
Character Style Match Name
Character Style Default, or how to intercept character styles that are not defined in Author It
Paragraph Style Mapping
Numbered Lists, and other lists
Find/Replace Text rul
Importing in Author-it
Import Word Documents into Author-it
Inspect the rules
Apply Author-it Style rule
Character Style Mapping
Character Style Match Name
Character Style Default, or how to intercept character styles that are not defined in Author It
Paragraph Style Mapping
Numbered Lists, and other lists
Find/Replace Text rul
Index Element
Object Element
BasedOn Element
CreatedBy Element
CreatedDate Element
Description Element
FolderID Element
GUID Element
ID Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
IsTemplate Element
Key Element
LocalizationID Element
ModifiedBy Element
ModifiedDate Element
ReleaseStateID Element
Status Element
Type Element
Version Element
VersionParent Element
VersionRoot Element
VariantParentID Element
LocID Element
ModifiedComments Element
IndexNodes Element
Node Element
ChildNodes Element
VariableAssignments Element
VariableAssignment Element
ID Element
Name Element
Value Element
ValueObject Element
Style Element
PrintFromEntries Element
PrintFromHeadings Element
PrintFromLinks Element
PrintIndexType Element
PrintMedia Element
PrintRightAlign Element
PrintTitle Element
HelpFromEntries Element
HelpFromLinks Element
HelpFromHeadings Element
Targets Element
Relation Element
ID Element
WebFromEntries Element
WebFromHeadings Element
WebFromLinks Element
WebHHIndexTemplate Element
WebHHSitemapTemplate Element
WebIndexType Element
WebJHIndexTemplate Element
WebMedia Element
WebOHIndexTemplate Element
WebTitle Element
IndexEntry Element
Object Element
BasedOn Element
CreatedBy Element
CreatedDate Element
Description Element
FolderID Element
GUID Element
ID Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
IsTemplate Element
Key Element
LocalizationID Element
ModifiedBy Element
ModifiedDate Element
ReleaseStateID Element
Status Element
Type Element
Version Element
VersionParent Element
VersionRoot Element
VariantParentID Element
LocID Element
ModifiedComments Element
Targets Element
Relation Element
ID Element
VariableAssignments Element
VariableAssignment Element
ID Element
Name Element
Value Element
ValueObject Element
Style Element
PrintEntryText Element
HelpEntryText Element
HelpMacro Element
WebEntryText element
Overview of a Magellan site
Overview Landing Page
Overview Content Page
Build a Magellan site
Set up a Magellan framework
Set up a new Landing Page.
Landing Page Rotator
Set up the Landing Page Rotator
Landing Page Rotator Item
Landing Page Content
Set up the Landing Page Content
Landing Page Content item
Landing Page Footer
Adding content to the site
Author-it objects
Reusability of Author-it objects
Commonly used objects
Object locking
Introduction
Object-to-object relationships
General object properties
Book object
Book Contents
Book Contents toolbar in Author
Book Print properties
Book Help properties
Book Web properties
File object
File Preview pane in the Properties window
File print properties
Size, caption, & borders tabs
File Help properties
Sizing Tab
Bitmap Options tab
Video Options tab
Linking Tab
File Web properties
Size & Spacing tab
Image Options tab
Video Options tab (HTML)
Linked HTML tab
Glossary object
Glossary Print properties
Glossary Help properties
Glossary Web properties
Hyperlink object
Hypertext Links Tab
Hypertext Link Print properties
Insert Link As
Cross Reference tab
Footnote tab
Hypertext Link Help properties
Hypertext Link Web properties
Jump From Anchor To
Jump tab
Popup tab (HTML Help)
Size & Position tab
DHTML tab
Index object
Index Entries tab
Index Entries toolbar
Index Print properties
Index Help properties
Index Web properties
Index Object Plain HTML tab
Index Object HTML Help tab
Index Object JavaHelp tab
Index Object Oracle Help tab
Index Entry object
Entry Links tab
Index Entry Print properties
Index Entry Help properties
Index Entry Web properties
Macro Procedure object
Help properties
Media object
Media Print properties
Media Help properties
Media Web properties
Publishing Profile object
Applies To tab
Theme tab - Word
Filters tab
Expression builder
Actions tab
Action options
Style object
Style Definition properties
Style Print properties
Style Help properties
Style Web properties
Table of Contents object
TOC Print properties
TOC Help properties
TOC Web properties
Plain HTML tab
HTML Help Tab
JavaHelp tab
Oracle Help tab
Table of Figures object
TOF Print properties
Title Page object
Title page Print properties
Topic object
Related Topics tab
Appearance tab
Position tab
Special Links tab
Specific Links tab
Topic Print properties
Topic Help properties
Display & Contents tab
Linking tab
Custom Footnotes tab
Topic Web properties
Create Books
Create a new book
Book templates
Sub books
Add content to a book
Create a new topic in a book
Drag a topic into a book
Object positioning
Remove an object from a book
Open a book in Editor
Add and Manage Content
Add content
Create a new object or template
Topic objects
Topic templates
Copy text between topics
Text select options in a topic
Paste content by using an import profile
Split a topic into two topics
Type in languages other than English
Insert a symbol or special character into text
Add an equation to your topic
Spell checking text in an object
Change the spell check options
Add a topic to a book
Object positioning
Troubleshooting topic save issues
Frontmatter & boilerplate topics
Index object
Building an index with index entries
Index contents outliner
Adding entries to the index contents outline
Promoting, Demoting or Moving an Index Entry
Expanding and Collapsing Levels
Removing Index Entries from the Index Contents
Creating "see" entries in the index
Control yomi-based indexing of Japanese content
Hyperlink object
Hyperlinks overview
Hyperlink types
Create a new hyperlink object
Insert a hyperlink
Create a hyperlink by using drag-and-drop
Create a hyperlink to an external file or address
Setting the style for hyperlink text in Word
Synchronize topic heading & hyperlink anchor text option
Glossary object
Table of Contents object
Table of Figures object
Using a Table of Figures, Table of Tables, and Table of Equations in a Single Book
Find & view objects
Locate an object
Opening an object
Select multiple objects
Compare two objects
View content in the Preview Pane
Show object relationships
Share an Author-it object over email
Modify an object
Modify object properties
Set object properties in the Properties window
Windows controls on the Properties window
Related topic groups
Find & replace text
Set a one-to-one relationship between objects
Set "Don't Inherit" states for properties
Set a color property
Change inherited property settings
Exclude an object from selected output formats
Object versioning
Duplicate an object
Replace an object
Object Versioning OP 6.4
Create a new version of an object
Delete or remove an object
Remove an object from a book
Delete an object from the library
Delete a book and its contents from the library
Structured authoring
Structured authoring in Author & Contribute
Plan the conversion to structured authoring
Enable structured templates
Structure parent node properties
Release states enforce structure validation for topics
Link an example topic to the structured template
Structure rule properties
Paragraph rules & styles
Create rules in the book structure builder
Create rules in the topic structure builder
Copy a structured template
Modify the structure of a template
Considerations for updating topic template structures
Book rules
Analyzing book content before creating structures
Boilerplate objects in structured book templates
Single-level book
Basic two-level book
Multilevel book
Front matter in a multilevel structure
First chapter in a multilevel structure
User guide chapters in a multilevel structure
FAQ chapter in a multilevel structure
Reference chapter in a multilevel structure
Glossary in a multilevel structure
Index in a multilevel structure
Topic rules
Analyze topic content before creating structures
Topic with an image
Topic with a list & child rules
Specification topic with a simple table
Topic with procedure steps
Topic with an optional image and table
Validating content
Prompting validation
Rule validation in a topic
Topic validation example
Paragraph rule validation examples
Fixed paragraph rules
Flexible paragraph rules
Mixture of fixed & flexible paragraph rules
Child rules & validation examples
No child rules defined
Child rules defined
Table validation rules
Table rule validation examples
Group rule validation requirements
Validation in the Editor
Rule validation for a topic in the Editor
Rule validation for a book in the Editor
When content doesn't validate
Considerations for updating a validated object
Publishing validated content
Structured authoring in Contribute
Structured authoring support in Contribute
Content Management Techniques
Author-it process
Planning the scope of your content creation
Defining your audience
Planning for various methods of content delivery
Standards & conventions
Variables as metadata
First draft
Structure
Create an outline
Add content
Links and cross referencing
Include pictures & graphics
Graphics for different outputs
Indexing
Finish & publish for print
Review
Release states in the review cycle
Release states
Review with Author or Contribute
Review with Review
Review with Word
Review colors
Make changes to drafts
Revision tracking & edit history
View an object's edit history
History window
History comments prompt
Compare an object's history
History compare views
Author-it reuse methods
Slide show presentation
Slide show presentation layout
Set up for a presentation
Extract the presentation files
Presentations templates folder
Slide show transition variables
Default values for transition variables
Import the presentations.zip file
Publish & view the sample presentation
Creating a new presentation
Create a book for a slide show
Create presentation topics
Presentation TOC object
Add a Flash file
Publish the presentation
Move the published slide show
Running a presentation
View the presentation online
Download the presentation
Resolution
Full screen mode
Presentation navigation type
Automated presentation variable values
Manual navigation for presentations
Customizing a presentation theme
Presentation customization with book templates
Customize the slide show background
Modify styles for presentations
Modify a presentation style
Presentation style sheets
Selectors, properties, & values
Style sheet properties
Font family
Font size
Font weight
Font color
Background image
Add a new style sheet
Author-it's style sheets
Presentation.css
Title.css
Slide.css
Footer.css
Toc.css
Publishing templates and files
Presentation frameset
HTML templates
Title_template.htm
Slide_template.htm
Footer.htm
Toc_template.htm
JavaScript files for presentations
Word presentation template
Troubleshooting presentations
Item transitions not working in slides
Text using the list bullet style loses its formatting
Error message when opening presentation in the browser
Presentation won't open after publishing
Slide transition variables aren't working
"Page Cannot Be Displayed" message in the browser
Presentation terminology
Magellan
Overview of a Magellan site
Overview Landing Page
Overview Content Page
Build a Magellan site
Set up a Magellan framework
Set up a new Landing Page.
Landing Page Rotator
Set up the Landing Page Rotator
Landing Page Rotator Item
Landing Page Content
Set up the Landing Page Content
Landing Page Content item
Landing Page Footer
Adding content to the site
Installation of Magellan
Overview
Install Saxon
Install Magellan Search Indexer
Install Magellan Template Folder
Import Author-it Object Templates
Set up the Magellan Publishing Profile (OP)
Logfiles
Customizing Magellan
The Magellan Engine
Customizing your site
Adding a custom template theme (administrator only)
CSS folder
images folder
Change the Loading rotator logo
siteconfig.json
Configuring the site with the menu
Hamburger menu
Configuration menu
Help
Language dropdown selector
Publish to Magellan
The process
Publish
Selecting Variables
Action Tab - Magellan
Published output
Multilingual sites
Customizing the output
Localization with Magellan
assets/resources folder
siteconfig.json
Setting the filter
Defaults - basic website
Locales - basic website
Publications
Locales - Add another language
Add folder (in File Explorer)
Add the entries in the dropdown list (in SiteConfig.json)
Add the publications (in SiteConfig.json)
Introduction
Working with css
Finding a css element
Setup of the css files
Editing the css
Hide the "Resources" Widget
Change the colors of the Icons in the header
Hide the "Settings" icon
Set the limits of "Recently Updated Pages"
Fix the margins in the Footer
Working with style(s)
Working with tables
Highlight the TOC selection
Enhancing Links
Working with images
Working with videos
Video and Audio
Preparing a youtube video
Preparing a Vimeo video
Adding css
Future goodies
Content Management Techniques
Author-it process
Planning the scope of your content creation
Defining your audience
Planning for various methods of content delivery
Standards & conventions
Variables as metadata
First draft
Structure
Create an outline
Add content
Links and cross referencing
Include pictures & graphics
Graphics for different outputs
Indexing
Finish & publish for print
Review
Release states in the review cycle
Release states
Review with Author or Contribute
Review with Review
Review with Word
Review colors
Make changes to drafts
Revision tracking & edit history
View an object's edit history
History window
History comments prompt
Compare an object's history
History compare views
Navigate and Using Contribute
Navigation panes
Content panes
Topic editor toolbars
Topic toolbar in Contribute
Styles toolbar
Acrolinx IQ toolbar
Folders in Contribute
Manage folders in the Favorite Folders pane
Organize the Favorite Folders pane
Remove folders from the Favorite Folders pane
Manage folders in the All Folders pane
Object lists
Paging toolbar
Sorting object lists
Objects in Contribute
Object locking
General tab
Metadata tab
XML tab
History tab
Revert to an earlier version of an object
Book object properties
Book print tab
Book help tab
Book web tab
Topic object properties
View tab
Topic print tab
Topic help tab
Topic web tab
File object properties
File object print tab
Sizing tab
Caption tab
Borders tab
Preview tab
File object help tab
Sizing tab
Bitmap options tab
Linking tab
Image preview tab
File object web tab
Size & spacing tab
Image options tab
Image preview tab
Books in Contribute
Create a new book in Contribute
Book Contents toolbar in Contribute
Open a book in Contribute
Switch a book to edit mode
Save changes to a book
Add and structure book contents
Insert an existing topic into a book
Drag a topic into a book
Move objects with the Book Contents toolbar
Move book objects by dragging
Remove a topic from a book
Create a new topic in Contribute
Spell check in Contribute
Save a topic in Contribute
Apply a style to text
Remove a character style from text
Open a topic in Contribute
Use the split view
Preview a topic in Contribute
Object locking
Change the viewable size of topic content
Print a topic
Close a topic
Modify an object
Modifying objects in Contribute
Locating objects
Change the release state of an object
Show object relationships
Move objects to a different folder
Send object links in email
Create a new version of an object in Contribute
Duplicate an object in Contribute
Replace an object with another object in Contribute
Searching text in Contribute
Find text in Contribute
Find & replace text in Contribute
Modify a topic's description
Tables in Contribute
Contribute Table toolbar
Add a new table in Contribute
Add a row to a table in Contribute
Cut, copy, & paste table rows in Contribute
Delete a row from a table in Contribute
Add a column to a table in Contribute
Delete a column from a table in Contribute
Delete a table in Contribute
Resize a table in Contribute by changing column widths
Merge table cells in Contribute
Split table cells in Contribute to restore merged cells
Format a table cell in Contribute
Use the color picker
Graphics & hyperlinks in Contribute
Images in topics
New embedded or linked File objects
Insert a new embedded image
Insert a new linked image or linked URL image
Edit an image
Insert an existing file object
Insert a file object from thumbnails
Hyperlinks in Contribute
Create a new hyperlink
Create a link to a topic in Contribute
Create an Internet URL link in Contribute
Edit a hyperlink in Contribute
Insert an existing hyperlink
Remove a hyperlink
Object history in Contribute
View the history pane in Contribute
Resize the history pane
View history changes
My Changes tab
Individual user history
Variables in Contribute
Variable types
Variables in topics
Assign variables to an object
Remove variable assignments from an object
Publish with the variable prompt
Variants in Contribute
View variant assignments in Contribute
Identify variants in Contribute
Creating variants in Contribute
Create a new variant in Contribute
Edit variant values in Contribute
Filter locale variant objects in Contribute folders
Identify variants in Contribute
Edit variant values in Contribute
View variant assignments in Contribute
Delete a variant in Contribute
Embedding & inserting topics in Contribute
Embed a topic using the split screen in Contribute
Edit an embedded topic in Contribute
Remove an embedded topic in Contribute
Insert a topic using the split screen in Contribute
Author-it Xtend in Contribute
Author-it Xtend pop-up in Contribute
Setting Author-it Xtend options in Contribute
Add a custom highlighting band for Author-it Xtend in Contribute
Change the fuzzy match band settings for Author-it Xtend in Contribute
Search for objects in Contribute
Search by date
Navigate and Using Contribute
Navigation panes
Content panes
Topic editor toolbars
Topic toolbar in Contribute
Styles toolbar
Acrolinx IQ toolbar
Folders in Contribute
Manage folders in the Favorite Folders pane
Organize the Favorite Folders pane
Remove folders from the Favorite Folders pane
Manage folders in the All Folders pane
Object lists
Paging toolbar
Sorting object lists
Objects in Contribute
Object locking
General tab
Metadata tab
XML tab
History tab
Revert to an earlier version of an object
Book object properties
Book print tab
Book help tab
Book web tab
Topic object properties
View tab
Topic print tab
Topic help tab
Topic web tab
File object properties
File object print tab
Sizing tab
Caption tab
Borders tab
Preview tab
File object help tab
Sizing tab
Bitmap options tab
Linking tab
Image preview tab
File object web tab
Size & spacing tab
Image options tab
Image preview tab
Books in Contribute
Create a new book in Contribute
Book Contents toolbar in Contribute
Open a book in Contribute
Switch a book to edit mode
Save changes to a book
Add and structure book contents
Insert an existing topic into a book
Drag a topic into a book
Move objects with the Book Contents toolbar
Move book objects by dragging
Remove a topic from a book
Create a new topic in Contribute
Spell check in Contribute
Save a topic in Contribute
Apply a style to text
Remove a character style from text
Open a topic in Contribute
Use the split view
Preview a topic in Contribute
Object locking
Change the viewable size of topic content
Print a topic
Close a topic
Modify an object
Modifying objects in Contribute
Locating objects
Change the release state of an object
Show object relationships
Move objects to a different folder
Send object links in email
Create a new version of an object in Contribute
Duplicate an object in Contribute
Replace an object with another object in Contribute
Searching text in Contribute
Find text in Contribute
Find & replace text in Contribute
Modify a topic's description
Tables in Contribute
Contribute Table toolbar
Add a new table in Contribute
Add a row to a table in Contribute
Cut, copy, & paste table rows in Contribute
Delete a row from a table in Contribute
Add a column to a table in Contribute
Delete a column from a table in Contribute
Delete a table in Contribute
Resize a table in Contribute by changing column widths
Merge table cells in Contribute
Split table cells in Contribute to restore merged cells
Format a table cell in Contribute
Use the color picker
Graphics & hyperlinks in Contribute
Images in topics
New embedded or linked File objects
Insert a new embedded image
Insert a new linked image or linked URL image
Edit an image
Insert an existing file object
Insert a file object from thumbnails
Hyperlinks in Contribute
Create a new hyperlink
Create a link to a topic in Contribute
Create an Internet URL link in Contribute
Edit a hyperlink in Contribute
Insert an existing hyperlink
Remove a hyperlink
Object history in Contribute
View the history pane in Contribute
Resize the history pane
View history changes
My Changes tab
Individual user history
Variables in Contribute
Variable types
Variables in topics
Assign variables to an object
Remove variable assignments from an object
Publish with the variable prompt
Variants in Contribute
View variant assignments in Contribute
Identify variants in Contribute
Creating variants in Contribute
Create a new variant in Contribute
Edit variant values in Contribute
Filter locale variant objects in Contribute folders
Identify variants in Contribute
Edit variant values in Contribute
View variant assignments in Contribute
Delete a variant in Contribute
Embedding & inserting topics in Contribute
Embed a topic using the split screen in Contribute
Edit an embedded topic in Contribute
Remove an embedded topic in Contribute
Insert a topic using the split screen in Contribute
Author-it Xtend in Contribute
Author-it Xtend pop-up in Contribute
Setting Author-it Xtend options in Contribute
Add a custom highlighting band for Author-it Xtend in Contribute
Change the fuzzy match band settings for Author-it Xtend in Contribute
Search for objects in Contribute
Search by date
Customizing Magellan
The Magellan Engine
Customizing your site
Adding a custom template theme (administrator only)
CSS folder
images folder
Change the Loading rotator logo
siteconfig.json
Configuring the site with the menu
Hamburger menu
Configuration menu
Help
Language dropdown selector
Design Templates, Styles and Page Layouts
Templates
Object template
Basing objects on a template
Basing an object template on another template
Change inherited property settings
External publishing templates
Paragraph & character styles
Styles in Author & Contribute
System-defined style object names
Apply a paragraph or character style
Remove character formatting from text
Group paragraph & character styles
Change the properties of a style object
Create a new style object
Page layout
Media objects
Title page customization
Relationships between the Title Page & Book objects
Headers & footers in print
Add a header to content
Create or modify header AutoText in Word 2010
Define a header AutoText in Word 2007
Specify header & footer names in Author
Set headers & footers for each section of a document
File objects, graphics, & OLE objects
File object templates
File object properties
Insert objects
Insert a File object from the library
Insert a File object from a thumbnail
Insert a graphic or OLE object
Add an embedded graphic to a topic
Drag to create File objects
Adding a Linked Image or OLE Object
Adding a Linked URL Image
Include an OLE object by using a File object
Modify file objects
Edit an embedded graphic
Remove a File object from a topic
Hyperlink object
Hyperlinks overview
Hyperlink types
Create a new hyperlink object
Insert a hyperlink
Create a hyperlink by using drag-and-drop
Create a hyperlink to an external file or address
Author endnotes
Endnotes
Endnote setup & administration
Create an endnote hyperlink template
Create an endnote topic template topic
Add an endnote style to the Word template
Create an endnote
Create the reference topic
Setting the style for hyperlink text in Word
Synchronize topic heading & hyperlink anchor text option
Import Content
Author-it Import Wizard
Requirements for importing
Transformation import rules & import profiles
Transformation import rules
Topic creation rules
Rule conditions
Type of condition
Logical comparison
Condition criteria
Find & replace rules
Additional formatting
Character
Paragraph
Bullets & numbering
Style mapping rules
Additional formatting
Character
Paragraph
Bullets & numbering
Pattern matching
Rule processing & why profile order is important
Transformation import rules
Add a rule
Modify a rule
Delete a rule
Transformation import profiles
How profiles control imported graphics
Base new file objects on template
Embed all linked graphics
Default file object description from
Breaking image links Word to embed the images using Word 2010
How profiles control new objects
Transformation profiles
Add a profile
Add rules to a profile
Change the sequence of rules in a profile
Modify a profile
Delete a profile
Make import profiles available for pasting text
Copy rules & profiles from another library
Import files to Author
Begin import
Select the file to import
Run the Topic Structure Wizard
Change the style mapping
Preview & modify a document before importing
Import in progress
Import complete
Import log
Invalid import links
Non-TOC topics
Import in a batch
Re-importing content from Word & HTML source files
Best practices for re-importing content
Steps & settings for re-importing source file content
Basic steps for re-importing source files
Import profile settings for re-importing html source files
Rules & behavior when re-importing word files
History points for re-importing source files
Security permissions & re-importing HTML source files
Location of the HTML source files when re-importing
Content handling during re-importation
Object handling when re-importing HTML source files
How file names are used when re-importing HTML source files
Re-importing HTML source files and creating topics
Re-importing HTML source files with links
Re-importing HTML source files with topic-to-topic links
Supported hyperlink formats for HTML source files
Re-importing HTML source files with graphics
Expected outcomes when re-importing modified HTML source files
Reused headings in HTML source file
Importing Word Documents
Pre-import cleanup checklist
Importing a Word document with linked images
Author-it XML in Author
Exporting objects to XML
Search for multiple objects and export to XML
Import from an Author-it XML file
Installation of Author-it On Premises
Introduction
Prerequisites for Installation
Hardware & software recommendations for installations
Upgrade Procedure
Install Sequence Author-it Suite
Windows Server prerequisites
Windows Server Roles
.NET Framework 3.5 Features
Install Author-it Client
Install Author-it Service Manager
Install Contribute
Install Xtend
Install Localize
Install Review
How To's
Create Application Pools
Create web applications
Configure Contribute Publishing
Contribute AD Integration
Installation of Author-it On Premises
Introduction
Prerequisites for Installation
Hardware & software recommendations for installations
Upgrade Procedure
Install Sequence Author-it Suite
Windows Server prerequisites
Windows Server Roles
.NET Framework 3.5 Features
Install Author-it Client
Install Author-it Service Manager
Install Contribute
Install Xtend
Install Localize
Install Review
How To's
Create Application Pools
Create web applications
Configure Contribute Publishing
Contribute AD Integration
Installation of Magellan
Overview
Install Saxon
Install Magellan Search Indexer
Install Magellan Template Folder
Import Author-it Object Templates
Set up the Magellan Publishing Profile (OP)
Logfiles
Localization with Magellan
assets/resources folder
siteconfig.json
Setting the filter
Defaults - basic website
Locales - basic website
Publications
Locales - Add another language
Add folder (in File Explorer)
Add the entries in the dropdown list (in SiteConfig.json)
Add the publications (in SiteConfig.json)
Localize
Localize
Localization process in a single library
Navigate Localize
Translation jobs screen
Screen characteristics
Customize the screen display
Translation job status column
Translation job status screen
Job Name Templates screen
Locales screen
Service Providers screen
Release States screen
Options Screen
Release states in new translation jobs
Release states in imported translation jobs
Variants in localization
Localizing object templates & variables
Publish a translation
Dictionary for spell checking localized content
Plan variants for localized content
Recognize localized variants in the library
How locale variants are used by Author-it
Filter variant objects in the Library Explorer
Variants in the publishing process
Choose a variant structure for localization
Locale variant fall-back paths in Localize
Variant criteria in the translation jobs window
Variant criteria fall-back paths for translation jobs
Variants and Release States
Selections using AND-OR logic in translation jobs
Re-translation process: how flag for re-translation works
Standard re-translation process
Modify the source while a job is out for translation
Two imports of the same job, first import is for review purposes
Two imports of the same job, with an export in between
Object is reused in two books
Object is reused in two books, import of translation jobs in 'wrong' order
When you cancel a job
Translation process with Localize
Exclude primary objects
Single value selection
OR logic within a single variant criterion group
Combining AND-OR logic
Multiple variant criteria groups with multi-select values
Criteria values and object selection in the library
Claytablet Connector for Author-it Localize
Freeway
Prepare for translation
Zip tool requirements
Permissions for objects in translation jobs
Permissions & release states for Localize
Set role & folder permissions for the localizer role
Set the release states for Localize
Prepare variant objects & templates for translation
Variant criteria filter in Author & the translation job window
Set up your variant object templates in Author
Localizing variant templates or objects
Localize variant templates for publishing
Localize the text strings used by your variant templates
Templates & objects providing localized text or content
Related topics group for localized content
Front and back matter objects
Cross-reference text for localized content
Cross-references for Japanese content
Chapter numbering for Japanese content
Localize embedded graphics
Create a variant of an object template in Author
Templates & objects providing attributes
Author-it XML format for translation
Historical changes to Author-it XML Format
Changes to Author-it XML, Release 6
Changes to Author-it XML, Release 5.5
XML for translators
Translating content using XML-based editors
Translate content with SDL Trados Studio 2009
Translating with SDLx
XML Elements - All objects
XML Elements - Book object
XML Elements - File object
XML Elements - Glossary object
XML Elements - Hyperlink object
XML Elements - Index object
XML Elements - Index Entry object
XML Elements - Table of Contents object
XML Elements - Table of Figures object
XML Elements - Topic object
XML Elements - Topic text
XML Elements - Variable assignments
Preserve variables in translated text
Remove variables from translated text
Translatable fields in objects or templates
Table of Contents object
Table of Figures object
Index object
Glossary object
File object
Hyperlink object
Title Page object
Index Entry object
Book object
Topic - related topics groups
Topic object - headings and text
Media objects
Linked file object templates
Style objects for publishing
Translation process with Localize
Localize How to's
Set up translation profiles & options in Localize
Sort the translation jobs screen by filter
Create a translation job filter
Edit a translation job filter
Delete a translation job filter
Job name templates
Create job name templates
Edit a job name template
Delete a job name template
Set up Locales
Create a locale record
Set a dictionary for a locale
Edit a locale record
Delete a locale record
Assign variables to locales
Localize variable for locales
Service provider records
Create service provider records
Edit a service provider record
Delete a service provider record
Configure release states
Configuration options
Create a new translation job
Search for a book to add to the translation job
Translation jobs containing multiple books
Download & export a translation job
Upload a translation job
Import of a translation job as "Draft"
Import of a translation job as "Final"
Re-import a translation job
Open & view a translation job
Cancel a translation job
Managing translated content imported into a library
Review & retranslate
Edit & retranslate
Add new content to a previously translated book
Publishing localized variant content
Navigate Author
Library Explorer
Ribbons, tabs, & commands
File menu
Quick Access toolbar
Recently selected folders list
Library Explorer Tabs
Author tab
Design tab
Manage tab
Import tab
Publish tab
Navigation pane
Navigation pane tabs
Customize the Navigation pane
Folders tab
Search tab
Object list pane
Column layout options on the object List
Add a column
Remove a column
Resize a column
Library Explorer right-click menu
Preview Pane
Object Properties window
File Preview pane in the Properties window
Book Contents Editor
Editor interface
Ribbons, tabs, & commands
Editor layout
Files menu in Book Editor
Quick Access toolbar in Editor
Open the Editor
File menu in Editor
Library Explorer right-click menu
Editor command tabs
Edit tab
Styles toolbar
Grouping styles & templates in menus
Review tab
View tab
Publish tab
Layout tab
Book Contents toolbar in Author
Keyboard shortcuts
Keyboard shortcut keys in the ribbon
Introduction
Object-to-object relationships
General object properties
Book object
Book Contents
Book Contents toolbar in Author
Book Print properties
Book Help properties
Book Web properties
File object
File Preview pane in the Properties window
File print properties
Size, caption, & borders tabs
File Help properties
Sizing Tab
Bitmap Options tab
Video Options tab
Linking Tab
File Web properties
Size & Spacing tab
Image Options tab
Video Options tab (HTML)
Linked HTML tab
Glossary object
Glossary Print properties
Glossary Help properties
Glossary Web properties
Hyperlink object
Hypertext Links Tab
Hypertext Link Print properties
Insert Link As
Cross Reference tab
Footnote tab
Hypertext Link Help properties
Hypertext Link Web properties
Jump From Anchor To
Jump tab
Popup tab (HTML Help)
Size & Position tab
DHTML tab
Index object
Index Entries tab
Index Entries toolbar
Index Print properties
Index Help properties
Index Web properties
Index Object Plain HTML tab
Index Object HTML Help tab
Index Object JavaHelp tab
Index Object Oracle Help tab
Index Entry object
Entry Links tab
Index Entry Print properties
Index Entry Help properties
Index Entry Web properties
Macro Procedure object
Help properties
Media object
Media Print properties
Media Help properties
Media Web properties
Publishing Profile object
Applies To tab
Theme tab - Word
Filters tab
Expression builder
Actions tab
Action options
Style object
Style Definition properties
Style Print properties
Style Help properties
Style Web properties
Table of Contents object
TOC Print properties
TOC Help properties
TOC Web properties
Plain HTML tab
HTML Help Tab
JavaHelp tab
Oracle Help tab
Table of Figures object
TOF Print properties
Title Page object
Title page Print properties
Topic object
Related Topics tab
Appearance tab
Position tab
Special Links tab
Specific Links tab
Topic Print properties
Topic Help properties
Display & Contents tab
Linking tab
Custom Footnotes tab
Topic Web properties
How variants work
Variants vs versions
Definition of standard, primary, & variant objects
Variant icons
Variant topics, file objects, & hyperlink objects
Validation rules for variants
Dragging primary & variant objects
Modify a book structure with variants
View all variants in Author
View variant values in the Editor
View the variants in the object list
Variant options
Setting up object variants
Planning variants in your content
Create a new variant
Create a multi select variant
Multi select variant
Suggested use of multi select variants
Priority rating
Priority setting & preferred matching
Applying variants
Create a new variant object in the object list
Create a new variant object in a book
New variant object in a filtered book
New variant object in an unfiltered book
Assign multi select values to an object
Variant selection window
Create a new variant of a book
Convert an existing object into a variant of another object
Edit an object's variant criteria values
Remove the association between a variant & its primary object
Deleting a Variant Object from the Library
Import objects with variant relationships from another library
Filtering book variants in Author
Filter locale & other variant objects in Author folders
Filter a book with custom filter criteria
Filter locale variant objects in Contribute folders
Variant filters
Create a favorite variant filter
Delete a variant filter
Modify a variant filter
Create a new filter based on an existing filter
Filtering compared to searching
Priority rating in book filtering
Flat and hierarchical structures in filtering
Variants for software releases
Why use variants for software releases?
Variant terminology for software releases
Variant criteria structures for software releases
List of values structure: Comparing fall-back paths & hierarchy
Book filtering for software releases
Variant fall-back path for software releases
Before using variants for software releases
Set the software release variant values
Effect of variants on Help context IDs
Plan software release implementation
Create a variant sample matrix
Manage software releases with variants
Create variant criteria for software releases
Create a variant object
Assign criteria to a standard or primary object
Automatically filtering a book
Filter the book's variant criteria
Publish variants for software releases
Create variants from the object history
Use cases for variants for software releases
Create a fall-back path for software releases
Create a branched fall-back path for software releases
Choose when to create content from the primary or variant object
Add a new feature from a specific release
Remove a topic for a discontinued feature
Create a variant using an object's history
Use variant templates for linked file objects
Advanced use of variants
Using variants in a search
Variant search options
Filtering compared to searching
Variant criteria search
Show relationships for variants
Identifying criteria values assigned to other objects
Reusing variant criteria values
Filtering variants
Publishing
PDF ProCSS Publishing
The process
Minimum After Publish Actions for PDF ProCSS Publishing
Additional After Publish Actions for PDF ProCSS Publishing
Add Your Own CSS Template
Convert EPS Files to PDF
Delete files
The CSS Template
Publish to Magellan
The process
Publish
Selecting Variables
Action Tab - Magellan
Published output
Multilingual sites
Customizing the output
Web Help publishing
Web Help templates display
Web Help licensing
Customize Web Help
Customizing Web Help theming
Change the Web Help template color scheme
Change the default Web Help color scheme
Update the color scheme used by styles in Web Help
Modify the webhelp.css stylesheet
Custom theme in files & folders
Create a custom Web Help theme
Customizing the display of toolbar icons
Show or hide the Home, Previous, & Next icons
Show or hide the Collapse All & Expand All icons
Customizing general layout & behavior
Show & hide the top of page links
Show & hide the contents pane
Change the contents pane width
Change the highlight effect
Modify the footer cell content or layout
Use Author-it variables in the footer
Disable the footer
Hide the footer by commenting out the code
Set the home page
Set the search behavior for partial word match
Show or hide the partial match checkbox option
Set the default search behavior
Change the default text in the feedback email
Change the UI text
Web Help example
Upgrade previous versions of Web Help for Author-it 6
Updating the Web Help Variables
Update Web Help variables
Create links in Web Help
Localization for the Web Help user interface
Perform a Web Help search for Non-Latin UTF-8 content
Create a sitemap file for search engines
Integrate your Web Help with Google Analytics
Configure IIS Manager for Web Help
Enable IIS Manager on your computer
Configure IIS to work with JSON files
Configure your site so other computers can access it
Web Help performance & scalability
Troubleshooting Web Help display issues
Linking an application with online help documentation
Include graphics in an electronic document
Convert linked graphics to embedded graphics
Pagination and Dealing with Unwanted Page Breaks
Copyright Notice
What is Centralized Publishing?
How it Works
Centralized Publishing Components
Install Centralized Publishing
Install and Configure Author-it Service Manager on Publishing Server
Configure the Centralized Publishing Plug-in
Set Publishing Server Path in Author-it Administrator
Set Authorization for Publishing Folders
Create and Assign SYS_PUBLISH_REMOTE variable
Test Centralized Publishing
End User Information
Centralize Publishing for Author-it Users
HTML help & HTML pages
Site map file for search engines
Update the base URL
Include class & ID attributes in tags for HTML & XHTML files
Change HTML template encoding
HTML table classes
Add a customized HTML template
Customized HTML frameset
Add a full text search engine to your published HTML
Set up the DHTML user guide template
TOC objects in HTML-based outputs
Bullet styles & images in HTML outputs
How do I distribute Help components to users
Responsive HTML5
Publish to (Author-it Honeycomb)
Brief overview of the publishing process for Author-it Honeycomb
Actions tab
Understanding the output
Changing Content in published output
Contents of the Author-it Honeycomb templates folder
Author-it Honeycomb Source (hv_src)
Organization of the Style Sheets
Fonts
Theme updates
Author-it Honeycomb configuration xml
Author-it Honeycomb Publishing
Viewing the WBT output
Possible causes for publishing failing
Publish to TouchHelp
TouchHelp objects
View TouchHelp output
Publish books to XML
Publishing to Resolved XML versus Publishing to XML
Publishing to DITA
Set up a book for DITA publishing
DITA publishing configuration
DITA topic templates
About DITA
Publish & view the sample presentation
Publishing templates and files
Presentation frameset
JavaScript files for presentations
Word presentation template
HTML templates
Title_template.htm
Slide_template.htm
Footer.htm
Toc_template.htm
Troubleshooting presentations
Item transitions not working in slides
Text using the list bullet style loses its formatting
Error message when opening presentation in the browser
Presentation won't open after publishing
Slide transition variables aren't working
"Page Cannot Be Displayed" message in the browser
Publish & view the sample presentation
Publishing templates and files
Presentation frameset
JavaScript files for presentations
Word presentation template
HTML templates
Title_template.htm
Slide_template.htm
Footer.htm
Toc_template.htm
Troubleshooting presentations
Item transitions not working in slides
Text using the list bullet style loses its formatting
Error message when opening presentation in the browser
Presentation won't open after publishing
Slide transition variables aren't working
"Page Cannot Be Displayed" message in the browser
Publish to (Author-it Honeycomb)
Brief overview of the publishing process for Author-it Honeycomb
Actions tab
Understanding the output
Changing Content in published output
Contents of the Author-it Honeycomb templates folder
Author-it Honeycomb Source (hv_src)
Organization of the Style Sheets
Fonts
Theme updates
Author-it Honeycomb configuration xml
Author-it Honeycomb Publishing
Viewing the WBT output
Possible causes for publishing failing
Publish to Magellan
The process
Publish
Selecting Variables
Action Tab - Magellan
Published output
Multilingual sites
Customizing the output
PDF ProCSS Publishing
The process
Minimum After Publish Actions for PDF ProCSS Publishing
Additional After Publish Actions for PDF ProCSS Publishing
Add Your Own CSS Template
Convert EPS Files to PDF
Delete files
The CSS Template
The process
The CSS Template
Headers and Footers
Contents of a Header topic
Contents of a Footer topic
Building Blocks for Headers and Footers
Example: Create a Footer
Insert the Footer Content
Modify the Media Objects
Changes to Resolved XML and HTML output between V6.4.2 and 6.4.3
Web Help publishing
Web Help templates display
Web Help licensing
Customize Web Help
Customizing Web Help theming
Change the Web Help template color scheme
Change the default Web Help color scheme
Update the color scheme used by styles in Web Help
Modify the webhelp.css stylesheet
Custom theme in files & folders
Create a custom Web Help theme
Customizing the display of toolbar icons
Show or hide the Home, Previous, & Next icons
Show or hide the Collapse All & Expand All icons
Customizing general layout & behavior
Show & hide the top of page links
Show & hide the contents pane
Change the contents pane width
Change the highlight effect
Modify the footer cell content or layout
Use Author-it variables in the footer
Disable the footer
Hide the footer by commenting out the code
Set the home page
Set the search behavior for partial word match
Show or hide the partial match checkbox option
Set the default search behavior
Change the default text in the feedback email
Change the UI text
Web Help example
Upgrade previous versions of Web Help for Author-it 6
Updating the Web Help Variables
Update Web Help variables
Create links in Web Help
Localization for the Web Help user interface
Perform a Web Help search for Non-Latin UTF-8 content
Create a sitemap file for search engines
Integrate your Web Help with Google Analytics
Configure IIS Manager for Web Help
Enable IIS Manager on your computer
Configure IIS to work with JSON files
Configure your site so other computers can access it
Web Help performance & scalability
Troubleshooting Web Help display issues
Linking an application with online help documentation
Release Notes
Author-it Release 2020.R3 (October 2020)
Major Enhancements - 2020.R3
Improved video and audio support
A new role in reviews
New administration role
User Management in Contribute
New Collaborator License and Contributor Role
Bug fixes
Author-it Release 2020.R2 (June 2020)
Major Enhancements - 2020.R2
Magellan makeover, improved theme configuration
Live side by side output preview in Review
Mulit-select metadata assignments
Metadata search
Streamlined all-in-one publishing prompt
Bug fixes and other improvements
Author-it Release 2020.R1
Author-it Release 7.1
Author-it Release 7.0
Server side (CGI Script) full text search
Set up the server side search
Attach the CGI
CGI scripts customization
Set up your own full text search
Client side (DHTML) full text search
Dock Editor layout tabs
Dock tabs inside the Editor
Dock tabs in the Editor & the reset panels option
Hide & display Editor layout tabs
Author-it terminology
Author-it output formats
Advantages of separating structure & format
File Preview pane menu
Book Contents
Tables
Draw a table by using the Table Selector
Format table borders
Add extra rows or columns to a table
Lock a table layout
Quick Tables
Create a Quick Table
Assign a Quick Tables folder
Insert a table by using Quick Tables
Resize rows and columns in tables
Use the Measurement Selector to resize columns and rows
Resize columns by using the Ruler
Resize rows and columns by dragging the borders
Evenly distribute rows and columns in a table
Copy & paste text in tables
Table rows
Move rows up or down in the table
Set table row headers
Allow rows to break across pages
Table cells
Merge cells in a table
Delete cells from a table
Split cells in a table
Apply background color to cells
Using the Text Direction Selector
Setting up the Magellan Publishing Profile (OP)
Landing Page rotator
Landing Page content
The Page footer
Lorem Ipsum
Review
Review workflow
Review participants
News feed page
Review summary dashboard
Review screen
Review ribbon
The Review User Options Form
Review Table of Contents
Topic content in review
Discussion pane
Collaboration review cycles & phases
Approval review cycles & phases
Moving a topic through multiple review cycles
Single topic in multiple reviews
Review type
Create or edit the review form
Review software login process
UI language in Review
Review browser compatibility
Author editorial functionality
System notifications
Review licensing
Options for freeing reviewer user licenses
Roles & permissions in Author-it Review
Review initiator role
Subscriptions & role limitations in Review
Editor role
Reviewer role
User & group roles in Review
Review release states
Activation of reviewer-only users
Configuring Email Settings for the Notification System
Configure settings & permissions for Review
Folder permissions for roles in Review
Effect of permissions on viewable content in Review
Assign release states for Review
Assign folder permissions for Review
Assign users or groups to roles for Review
Review How to's
Set user options in Review
Review shortcut keys
Requirements for creating a review
Make topics available for a review
Sub book reviews must be configured independently
Initiate a collaboration review
Create a new review
Create a review based on an existing review
Configure the review form
Select a book for the review
Add a book by using the book selector window
Variant values in the Review module
Variant substitutions & fall-back paths
Select the release states for a Collaboration review
Select the release states for an Approval review
Select start & end dates for the review
Reminders & automate moving topics to editorial
Select participants for the review
Automatically complete the review stage
Monitor the Review license usage
Roles & license usage
Initiate an Approval review type
Variant values in the Review module
Variant substitutions & fall-back paths
Complete an Approval review
Manage Approval dashboard
Completing the review phase
Edit a review form
Delete a review
Cancel a review
Manage currently open reviews
Display the review summary statistics in the dashboard
Review a partially updated topic
Add or remove charts & graphs
Adding comments and suggestions in a review
Add a comment or suggestion to a review
Add a review comment
Select content for suggestions
Suggest an insertion or replacement
Suggest a deletion in a review
Reply to a comment in a review
Review images, hyperlinks, & embedded topics
Mark a topic review as complete
Approve or Reject a topic
Move a topic to the editorial stage
Manually complete a review
Links to completed reviews
Completing the editorial phase
Finalize content
Accept or reject - options & best practices
Accept or reject changes in Review
Open a topic in Review from view history in Author
Open a topic using a URL link
Review videos
Search for objects
Advanced search
Advanced search options
Boolean logic to enhance search results
And
Or
Not
Exact Phrase Matching
Match Case
Whole Word
Search using variable metadata
Search for metadata with multiple values
Tables
Draw a table by using the Table Selector
Format table borders
Add extra rows or columns to a table
Lock a table layout
Quick Tables
Create a Quick Table
Assign a Quick Tables folder
Insert a table by using Quick Tables
Resize rows and columns in tables
Use the Measurement Selector to resize columns and rows
Resize columns by using the Ruler
Resize rows and columns by dragging the borders
Evenly distribute rows and columns in a table
Copy & paste text in tables
Table rows
Move rows up or down in the table
Set table row headers
Allow rows to break across pages
Table cells
Merge cells in a table
Delete cells from a table
Split cells in a table
Apply background color to cells
Using the Text Direction Selector
TouchHelp
TouchHelp objects
Publish to TouchHelp
View TouchHelp output
TouchHelp layout
TouchHelp layout in different sized devices
Navigate through the TouchHelp output
Book structure in the TouchHelp TOC
Button bar options
Search options with TouchHelp
Create the feedback contact variable for TouchHelp
Video display on small devices
Troubleshooting Author-it
Troubleshooting: Authentication Error Local Security Authority
Troubleshooting: Connection failed - Revocation Check could not be performed
Troubleshooting: RDP connection failure without explanation
Troubleshooting: RDP connection failed due to saved credentials
Troubleshooting: RemoteApp Disconnected
Troubleshooting: RPD connection and Windows 10
Checking the Workstation Connection to the Certifying Authority Used by Author-it
Library Configuration and Administration
Library administration
Open Author-it Administrator
Upgrade existing libraries
Create a new library database
Using more than one library
Maintenance
Object locking
Clear all object locks
Repair & compact a JET library
Remove empty objects
Re-index the search function
Check Topic Text Relations option
Create a dictionary from a word list
Dictionary word list
Dictionary character map
Create the dictionary
Refresh library properties
Administrative tasks from the command line
Security
Assign a license to the library
Assign the license file and key to your library
Use an Author-it license library
Assign license tokens to users
Export
Export a SQL Server Database to JET
Export a JET Library database to SQL Server
Variables
Reports
Display the External Files Report
Settings
Author-it Xtend settings
General settings
Editing history in Author-it
Configure edit history save points
Archiving history records
Publishing settings
Author-it Localization Manager settings
Timestamp settings
Email settings
Publishing Server settings for Contribute
Review settings
Plugin settings
Help
Determine the current software build of Author-it Administrator
Configure settings in Author
Set user options
General options
Set auto save
View options
Spelling options
Author-it Xtend options
Acrolinx IQ options
Customize the Styles toolbar
Add a style to the styles toolbar
Remove a style from the styles toolbar
Change the position of a style on the toolbar
Change a style icon on the toolbar
Assign a keyboard shortcut to a style
Copy a customized toolbar from another user
Folder structure
Open a folder
Change folder security
Refresh the Library Explorer
Objects in libraries & books
Placing objects in the correct folder
Move an object to another folder
Set object relationships
Variable administration
Create a variable
Edit a variable
Delete a variable
Variable Types
Display variables
Hide variables
Display variable usage in the library
Display variable assignments in the library
Library Configuration and Administration
Library administration
Open Author-it Administrator
Upgrade existing libraries
Create a new library database
Using more than one library
Maintenance
Object locking
Clear all object locks
Repair & compact a JET library
Remove empty objects
Re-index the search function
Check Topic Text Relations option
Create a dictionary from a word list
Dictionary word list
Dictionary character map
Create the dictionary
Refresh library properties
Administrative tasks from the command line
Security
Assign a license to the library
Assign the license file and key to your library
Use an Author-it license library
Assign license tokens to users
Export
Export a SQL Server Database to JET
Export a JET Library database to SQL Server
Variables
Reports
Display the External Files Report
Settings
Author-it Xtend settings
General settings
Editing history in Author-it
Configure edit history save points
Archiving history records
Publishing settings
Author-it Localization Manager settings
Timestamp settings
Email settings
Publishing Server settings for Contribute
Review settings
Plugin settings
Help
Determine the current software build of Author-it Administrator
Configure settings in Author
Set user options
General options
Set auto save
View options
Spelling options
Author-it Xtend options
Acrolinx IQ options
Customize the Styles toolbar
Add a style to the styles toolbar
Remove a style from the styles toolbar
Change the position of a style on the toolbar
Change a style icon on the toolbar
Assign a keyboard shortcut to a style
Copy a customized toolbar from another user
Folder structure
Open a folder
Change folder security
Refresh the Library Explorer
Objects in libraries & books
Placing objects in the correct folder
Move an object to another folder
Set object relationships
Variable administration
Create a variable
Edit a variable
Delete a variable
Variable Types
Display variables
Hide variables
Display variable usage in the library
Display variable assignments in the library
Macro Element
Object Element
BasedOn Element
CreatedBy Element
CreatedDate Element
Description Element
FolderID Element
GUID Element
ID Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
IsTemplate Element
Key Element
LocalizationID Element
ModifiedBy Element
ModifiedDate Element
ReleaseStateID Element
Status Element
Type Element
Version Element
VersionParent Element
VersionRoot Element
VariantParentID Element
LocID Element
ModifiedComments Element
HelpActions Element
Action Element
Name Element
Parameters Element
VariableAssignments Element
VariableAssignment Element
ID Element
Name Element
Value Element
ValueObject Element
Style Element
Build a Magellan site
Overview Landing Page
Overview Content Page
The menu
Setting up landing page content
Landing page background image and logo
Landing Page rotator
Landing Page content
The Page footer
Multi-site
Upload the variant outputs to different folders in the Magellan site
Define locales in siteconfig.json
Define filters in siteconfig.json
Define publications in siteconfig.json
SiteConfig.json example: 2 locales and 2 variant criteria
JSON code, example: 2 locales and 2 variant criteria
Glossary and Index
Localization of the content
Set up Google Translate for Magellan output
Support for Right to Left (RtL) languages
Localization of the Magellan user interface
Google Analytics
Installation of Magellan
Overview
Install Saxon
Install Magellan Search Indexer
Install Magellan Template Folder
Import Author-it Object Templates
Set up the Magellan Publishing Profile (OP)
Logfiles
Developer information on siteconfig.json for Magellan output
Explanation of the json structure
title
version
navigation
googleTranslateApiKey
leftMenu
rightMenu
rtlCss
filter
title
defaults
locale_description
loc_code
loc_ref_id
pub_ref_id
locales
loc_id
loc_description
loc_google
loc_ait
loc_label
loc_language
filter_labels
"label" details, as definied under "filter_labels"
publications
pub_id
"label"
path
Examples
SiteConfig.json example: one locale and no variants
JSON code, example: one locale and no variants
SiteConfig.json example: 1 locale and 1 variant criteria
JSON code, example: 1 locale and 1 variant criteria
SiteConfig.json example: 2 locales and 2 variant criteria
JSON code, example: 2 locales and 2 variant criteria
Developer information on siteconfig.json for Magellan output
Explanation of the json structure
title
version
navigation
googleTranslateApiKey
leftMenu
rightMenu
rtlCss
filter
title
defaults
locale_description
loc_code
loc_ref_id
pub_ref_id
locales
loc_id
loc_description
loc_google
loc_ait
loc_label
loc_language
filter_labels
"label" details, as definied under "filter_labels"
publications
pub_id
"label"
path
Examples
SiteConfig.json example: one locale and no variants
JSON code, example: one locale and no variants
SiteConfig.json example: 1 locale and 1 variant criteria
JSON code, example: 1 locale and 1 variant criteria
SiteConfig.json example: 2 locales and 2 variant criteria
JSON code, example: 2 locales and 2 variant criteria
Media Element
Object Element
BasedOn Element
CreatedBy Element
CreatedDate Element
Description Element
FolderID Element
GUID Element
ID Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
IsTemplate Element
Key Element
LocalizationID Element
ModifiedBy Element
ModifiedDate Element
ReleaseStateID Element
Status Element
Type Element
Version Element
VersionParent Element
VersionRoot Element
VariantParentID Element
LocID Element
ModifiedComments Element
VariableAssignments Element
VariableAssignment Element
ID Element
Name Element
Value Element
ValueObject Element
Style Element
PrintDifferentFirst Element
PrintDifferentOddEven Element
PrintEvenFooter element
PrintEvenHeader Element
PrintFirstFooter element
PrintFirstHeader Element
PrintMarginBottom Element
PrintMarginFooter Element
PrintMarginGutter Element
PrintMarginHeader Element
PrintMarginLeft Element
PrintMarginRight Element
PrintMarginTop Element
PrintMirrorMargins Element
PrintNumColumns Element
PrintOddFooter element
PrintOddHeader Element
PrintOrientation Element
PrintPageNumberFormat Element
PrintPageNumberStartFrom Element
PrintPageNumberStartType Element
PrintPaperSize Element
PrintSectionStart Element
PrintSizeHeight Element
PrintSizeWidth Element
HelpAutoSize Element
HelpBack Element
HelpBrowse Element
HelpColourHeading Element
HelpColourTopic Element
HelpContents Element
HelpFind Element
HelpHeight Element
HelpIndex Element
HelpKeepOnTop Element
HelpLeft Element
HelpMacro Element
HelpMaximise Element
HelpOptions Element
HelpPrintTopic Element
HelpTitle Element
HelpTop Element
HelpTopics Element
HelpWidth Element
HelpWindowName Element
WebALinkColour Element
WebAdditionalFiles Element
AdditionalFile Element
Filename Element
WebBackColour Element
WebBackImage Element
WebBackImageNonScrolling Element
WebBackSound Element
WebBackSoundRepeat Element
WebMetaData Element
MetaDataItem Element
Name Element
Content Element
WebLinkColour Element
WebTemplate Element
WebTextColour Element
WebTitle Element
WebVLinkColour Element
Object Element
BasedOn Element
CreatedBy Element
CreatedDate Element
Description Element
FolderID Element
GUID Element
ID Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
IsTemplate Element
Key Element
LocalizationID Element
ModifiedBy Element
ModifiedDate Element
ReleaseStateID Element
Status Element
Type Element
Version Element
VersionParent Element
VersionRoot Element
VariantParentID Element
LocID Element
ModifiedComments Element
Presentations with Chrysalis
Chrysalis Overview
Overview of supported slide types
Supported content types for slide types
Standards for Chrysalis presentations
Book templates
Topic templates
Styles
Media objects
Publishing in Chrysalis
Variables
Building the Chrysalis slides
General structure of a slide type
Focus on reuse
Standard slides
General presentation settings
Themes
Setting a theme
Slide backgrounds images
Slide transitions times
Slide transition effects
Presentation metadata slides
Titles
Sections
Example section slide
Grids
Grid types
Creating grid slides with rows/columns
Creating grid slides with thirds of the width
Grid layouts and topic order
Grids with rollover
Carousels
Creating carousel slides
Allowable content
Timelines
Using timeline slides
Allowable content
Accordions
Using accordion slides
Allowable content
Adding link buttons
Link behaviour
Adding presenter notes
Image size requirements
Inserting audio, video, or animation
Creating the HTML file
Creating an HTML file object
Audio, video and animation operation
How to add a transcript for audio files
Using external resource files
Adding external resource files
Linked resource files usage
How to publish to the Chrysalis output
Navigating the Chrysalis output
Control panel
Stand alone packages
Grid operation
General content layout
Playing videos
Sharing on social media sites
Troubleshooting log file
Troubleshooting
Re-importing content from Word & HTML source files
Best practices for re-importing content
Steps & settings for re-importing source file content
Basic steps for re-importing source files
Import profile settings for re-importing html source files
Rules & behavior when re-importing word files
History points for re-importing source files
Security permissions & re-importing HTML source files
Location of the HTML source files when re-importing
Content handling during re-importation
Object handling when re-importing HTML source files
How file names are used when re-importing HTML source files
Re-importing HTML source files and creating topics
Re-importing HTML source files with links
Re-importing HTML source files with topic-to-topic links
Supported hyperlink formats for HTML source files
Re-importing HTML source files with graphics
Expected outcomes when re-importing modified HTML source files
Reused headings in HTML source file
Relation Element
ID Element
Resource Translator
Description
Using Resource Translator
Start Resource Translator
Create Rules
Create a Job
Run Jobs
Export RESX
Set up translation profiles & options in Localize
Sort the translation jobs screen by filter
Create a translation job filter
Edit a translation job filter
Delete a translation job filter
Job name templates
Create job name templates
Edit a job name template
Delete a job name template
Set up Locales
Create a locale record
Set a dictionary for a locale
Edit a locale record
Delete a locale record
Assign variables to locales
Localize variable for locales
Service provider records
Create service provider records
Edit a service provider record
Delete a service provider record
Configure release states
Configuration options
Structured authoring
Structured authoring in Author & Contribute
Plan the conversion to structured authoring
Enable structured templates
Structure parent node properties
Release states enforce structure validation for topics
Link an example topic to the structured template
Structure rule properties
Paragraph rules & styles
Create rules in the book structure builder
Create rules in the topic structure builder
Copy a structured template
Modify the structure of a template
Considerations for updating topic template structures
Book rules
Analyzing book content before creating structures
Boilerplate objects in structured book templates
Single-level book
Basic two-level book
Multilevel book
Front matter in a multilevel structure
First chapter in a multilevel structure
User guide chapters in a multilevel structure
FAQ chapter in a multilevel structure
Reference chapter in a multilevel structure
Glossary in a multilevel structure
Index in a multilevel structure
Topic rules
Analyze topic content before creating structures
Topic with an image
Topic with a list & child rules
Specification topic with a simple table
Topic with procedure steps
Topic with an optional image and table
Validating content
Prompting validation
Rule validation in a topic
Topic validation example
Paragraph rule validation examples
Fixed paragraph rules
Flexible paragraph rules
Mixture of fixed & flexible paragraph rules
Child rules & validation examples
No child rules defined
Child rules defined
Table validation rules
Table rule validation examples
Group rule validation requirements
Validation in the Editor
Rule validation for a topic in the Editor
Rule validation for a book in the Editor
When content doesn't validate
Considerations for updating a validated object
Publishing validated content
Structured authoring in Contribute
Structured authoring support in Contribute
Style Element
Object Element
BasedOn Element
CreatedBy Element
CreatedDate Element
Description Element
FolderID Element
GUID Element
ID Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
IsTemplate Element
Key Element
LocalizationID Element
ModifiedBy Element
ModifiedDate Element
ReleaseStateID Element
Status Element
Type Element
Version Element
VersionParent Element
VersionRoot Element
VariantParentID Element
LocID Element
ModifiedComments Element
BorderBottom Element
BorderLeft Element
BorderRight Element
BorderStyle Element
BorderShadow Element
BorderTop Element
Bullet Element
FontBold Element
FontColour Element
FontItalics Element
FontName Element
FontSize Element
FontUnderline Element
FontSubscript Element
FontSuperscript Element
Number Element
Numbering Element
NumberStart Element
OutlineLevel Element
ParaAfter Element
ParaAlignment Element
ParaBefore Element
ParaFirstLine Element
ParaLeft Element
ParaLineSpacing Element
ParaRight Element
StyleName Element
StyleType Element
TabDefault Element
Tabs Element
Tab Element
Alignment Element
Position Element
VariableAssignments Element
VariableAssignment Element
ID Element
Name Element
Value Element
ValueObject Element
Style Element
PrintStyleName Element
HelpBorderBottom Element
HelpBorderLeft Element
HelpBorderRight Element
HelpBorderShadow Element
HelpBorderStyle Element
HelpBorderTop Element
HelpBullet Element
HelpFontBold Element
HelpFontColour Element
HelpFontItalics Element
HelpFontName Element
HelpFontSize Element
HelpNonWrapping Element
HelpNumber Element
HelpNumbering Element
HelpNumberStart Element
HelpParaAfter Element
HelpParaAlignment Element
HelpParaBefore Element
HelpParaFirstLine Element
HelpParaLeft Element
HelpParaLineSpacing Element
HelpParaRight Element
HelpTabDefault Element
HelpTabs Element
Tab Element
Alignment Element
Position Element
WebBackAttach Element
WebBackColour Element
WebBackPositionX Element
WebBackPositionY Element
WebBackRepeat Element
WebBackURL Element
WebBorderColourBottom Element
WebBorderColourLeft Element
WebBorderColourRight Element
WebBorderColourTop Element
WebBorderStyleBottom Element
WebBorderStyleLeft Element
WebBorderStyleRight Element
WebBorderStyleTop Element
WebBorderWidthBottom Element
WebBorderWidthLeft Element
WebBorderWidthRight Element
WebBorderWidthTop Element
WebBlockTag Element
WebBulletStyle Element
WebBulletURL Element
WebClear Element
WebFloat Element
WebFontColour Element
WebFontName Element
WebFontSize Element
WebFontStyle Element
WebFontVariant Element
WebFontWeight Element
WebHeight Element
WebLetterSpacing Element
WebLineHeight Element
WebMarginBottom Element
WebMarginLeft Element
WebMarginRight Element
WebMarginTop Element
WebNumbering Element
WebNumberStyle Element
WebPaddingBottom Element
WebPaddingLeft Element
WebPaddingRight Element
WebPaddingTop Element
WebTextAlign Element
WebTextDecoration Element
WebTextIndent Element
WebTextTag Element
WebTextTransform Element
WebVerticalAlign Element
WebWhiteSpace Element
WebWidth Element
WebWordSpacing Element
TableOfContents Element
Object Element
BasedOn Element
CreatedBy Element
CreatedDate Element
Description Element
FolderID Element
GUID Element
ID Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
IsTemplate Element
Key Element
LocalizationID Element
ModifiedBy Element
ModifiedDate Element
ReleaseStateID Element
Status Element
Type Element
Version Element
VersionParent Element
VersionRoot Element
VariantParentID Element
LocID Element
ModifiedComments Element
VariableAssignments Element
VariableAssignment Element
ID Element
Name Element
Value Element
ValueObject Element
Style Element
PrintAddSuperHeadings Element
PrintMedia Element
PrintPageNumber Element
PrintRightAlign Element
PrintShowLevel Element
PrintTitle Element
HelpMultiBookTargets Element
Relation Element
ID Element
HelpTitle Element
HelpWindow Element
WebContentsType Element
WebFrameType Element
WebFrameWidth Element
WebHHSitemapTemplate Element
WebHHTocTemplate Element
WebJHTocTemplate Element
WebMedia Element
WebOHTocTemplate Element
WebTitle Element
TableOfFigures Element
Object Element
BasedOn Element
CreatedBy Element
CreatedDate Element
Description Element
FolderID Element
GUID Element
ID Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
IsTemplate Element
Key Element
LocalizationID Element
ModifiedBy Element
ModifiedDate Element
ReleaseStateID Element
Status Element
Type Element
Version Element
VersionParent Element
VersionRoot Element
VariantParentID Element
LocID Element
ModifiedComments Element
VariableAssignments Element
VariableAssignment Element
ID Element
Name Element
Value Element
ValueObject Element
Style Element
PrintCaption Element
PrintLabelType Element
PrintMedia Element
PrintPageNumber Element
PrintRightAlign Element
PrintTitle Element
Tab Element
Alignment Element
Position Element
Video and Audio
TitlePage Element
Object Element
BasedOn Element
CreatedBy Element
CreatedDate Element
Description Element
FolderID Element
GUID Element
ID Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
IsTemplate Element
Key Element
LocalizationID Element
ModifiedBy Element
ModifiedDate Element
ReleaseStateID Element
Status Element
Type Element
Version Element
VersionParent Element
VersionRoot Element
VariantParentID Element
LocID Element
ModifiedComments Element
VariableAssignments Element
VariableAssignment Element
ID Element
Name Element
Value Element
ValueObject Element
Style Element
PrintFile Element
PrintIncludeByLine Element
PrintIncludeSubTitle Element
PrintIncludeSuperTitle Element
PrintIncludeTitle Element
PrintIncludeVersion Element
PrintMedia Element
Topic Element
Object Element
BasedOn Element
CreatedBy Element
CreatedDate Element
Description Element
FolderID Element
GUID Element
ID Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
IsTemplate Element
Key Element
LocalizationID Element
ModifiedBy Element
ModifiedDate Element
ReleaseStateID Element
Status Element
Type Element
Version Element
VersionParent Element
VersionRoot Element
VariantParentID Element
LocID Element
ModifiedComments Element
Headings Element
All Element
PrintHeading Element
HelpHeading Element
WebHeading Element
RelatedGroups Element
RelatedGroup Element
Alignment Element
Children Element
ColumnWidth Element
Contents Element
ExcludeHeadingText Element
Heading Element
HeadingFile Element
HeadingStyle Element
IncludeInHelp Element
IncludeInPrint Element
IncludeInWeb Element
Index Element
ItemStyle Element
NextTopic Element
ParentTopic Element
PopUp Element
Position Element
PreviousTopic Element
RelatedGroupID Element
Sequence Element
Siblings Element
SpecificLinks Element
Relation Element
ID Element
Text Element
p Element
br Element
cs Element
fref Element
tref Element
href Element
mref Element
nbd Element
nbs Element
table Element
tr Element
td Element
VariableAssignments Element
VariableAssignment Element
ID Element
Name Element
Value Element
ValueObject Element
Style Element
PrintAutoNumber Element
PrintBreakType Element
PrintHeadingStyle Element
PrintMedia Element
PrintSuperHeading Element
HelpAlias Element
HelpContextID Element
HelpContextString Element
HelpCustomFootnotes Element
HelpFootnote Element
Type Element
Data Element
HelpHeadingStyle Element
HelpIncludeInSequence Element
HelpJumpMacro Element
HelpJumpType Element
HelpJumpWindow Element
HelpNewSequence Element
HelpNonScrolling Element
HelpTopicMacro Element
WebFilename Element
WebMedia Element
WebTitle Element
WebTOCImage Element
Translatable fields in objects or templates
Table of Contents object
Table of Figures object
Index object
Glossary object
File object
Hyperlink object
Title Page object
Index Entry object
Book object
Topic - related topics groups
Topic object - headings and text
Node Element
ChildNodes Element
Build a Magellan site
Overview Landing Page
Overview Content Page
The menu
Setting up landing page content
Landing page background image and logo
Landing Page rotator
Landing Page content
The Page footer
Multi-site
Upload the variant outputs to different folders in the Magellan site
Define locales in siteconfig.json
Define filters in siteconfig.json
Define publications in siteconfig.json
SiteConfig.json example: 2 locales and 2 variant criteria
JSON code, example: 2 locales and 2 variant criteria
Glossary and Index
Localization of the content
Set up Google Translate for Magellan output
Support for Right to Left (RtL) languages
Localization of the Magellan user interface
Google Analytics
VariableAssignments Element
VariableAssignment Element
ID Element
Name Element
Value Element
ValueObject Element
Style Element
Variable use & best practice
Different values assigned to variables used by multiple objects
Variables in topic text
Use a variable in a topic
View variables in topic text
Variables assigned to an object
Assign a variable to an object
View variable values assigned to an object
Update the variable value assigned to an object
Display library level variables
Display variable usage for the library
Display variable assignments for the library
Limits on variable use in topics
Text variables
Assign an empty string to variables
Prompting for variable values before publshing
System variables on the variables list
Additional system variables
Using variables to assign file names on the web
Using the SYS_PUBLISH_FILENAME variable
Using Variables in External Files and Templates
Add breadcrumbs to HTML outputs
Adding keywords to a topic for HTML outputs
Variants for software releases
Why use variants for software releases?
Variant terminology for software releases
Variant criteria structures for software releases
List of values structure: Comparing fall-back paths & hierarchy
Book filtering for software releases
Variant fall-back path for software releases
Before using variants for software releases
Set the software release variant values
Effect of variants on Help context IDs
Plan software release implementation
Create a variant sample matrix
Manage software releases with variants
Create variant criteria for software releases
Create a variant object
Assign criteria to a standard or primary object
Automatically filtering a book
Filter the book's variant criteria
Publish variants for software releases
Create variants from the object history
Use cases for variants for software releases
Create a fall-back path for software releases
Create a branched fall-back path for software releases
Choose when to create content from the primary or variant object
Add a new feature from a specific release
Remove a topic for a discontinued feature
Create a variant using an object's history
Use variant templates for linked file objects
Author-it Xtend
Barriers to reusing content
Benefits of Author-it Xtend
Content reuse in the library
Text fragments
The Authoring Process with Author-it Xtend
Topic & fragment reuse
Calculating a match
Administrator Settings
Author-it Xtend user options
Noise words
Create a noise words list
Fragment highlighting
Add a custom highlighting band
Change the highlighting color
Suggestive reuse pop-up window
Author-it Xtend suggestions
Topic & pop-up window focus
Triggering the pop-up window
Insert text fragments from the pop-up window
Insert topics from the pop-up window
Embed topics from the pop-up window
Advanced search
Using the Author-it Xtend advanced search
Locating topics that use a fragment
About the Knowledge Center
Getting help
Log a support case
Author-it videos
Resources
Introduction to Personal books
Manage Personal books
Create a Personal book
Add a topic to a Personal book
Write Personal Content
Modify the Structure of a Personal book
Delete a Personal book
Consult a Personal book
Publish a full version of a Personal book
Share a Personal book

Back to home page