Building an Outline

From UPK wiki
Jump to: navigation, search

Contents

Overview

Outline in the Player

The Outline is the thing that appears in the leftmost pane of the Player. It organizes all of the Content Objects into a hierarchical structure that can be navigated by the user. An Outline consists of Modules, Sections, and Topics. It may also contain Questions and Assessments. Outlines are built in the Outline Editor (which is the editor that is opened when you double-click on a Module or Section in the Library.

You can only publish or preview a Topic from within the Outline Editor. This means that a Topic must be included within an Outline before you can preview or publish it. This presents problems for Topics created via the Record It Wizard, because the Record It Wizard does not allow access to Modules or Sections. As a workaround, the Record It Wizard includes the ability to preview a Topic that is not included in an Outline Element, but only in See It! mode.

Creating a new Outline Element

From the Library

To create a new Module or Section from the Library, carry out the fololowing steps:

  1. Navigate to the Folder in which you want to create the Module or Section.
  2. Select menu option File | New | Module or File | New | Section as appropriate.
  3. The New Module (or New Section) dialog box is displayed. Complete the following fields:
    • Name - Enter the name of your new Module/Section. This is the name that will appear in the Outline.
    • Location This will default to the Folder selected in Step 1, but you can use the Browse button to navigate to another folder if necessary.
    • Language - Select the default language for documents created from within this Module/Section.
    • Template - Select the default Template Text Template for documents created from within this Module/Section.
    • Glossary - Select the Glossary that will be assigned to documents created from within this Module/Section.
    • Screen Resolution - Select the default resolution for Topics created from within this Module/Section.
  4. Click on OK.
  5. You are passed into the Outline Editor and can continue building your Outline as required (see below).
  6. once you have finished, close the tab for this Module/Section. You will not be prompted to save your changes - they are automatically saved (so what does the Save button do on this screen??)

From the Outline Editor

You can create a new Module or Section from within the Outline Editor itself, as follows:

  1. Open up the Module or [[Section] within which you want to create the Module or Section.
  2. Select menu option Link | New Module or Link New | Section as appropriate.
  3. The New Module (or New Section) dialog box is displayed. Complete the same fields as those described above (under From the Library), and then click on OK.

Adding existing documents to an Outline Element

Once you have created a Module or Section, you can build your Outline by adding elements to it. These elements can be more new Modules or Sections (as explained under From the Outline Editor above), or they can be existing Modules, Sections, Topics, Assessments, or Questions. There are three ways of doing this:

  • Use menu option Link | Existing Document, and navigate to and select the document that you want to insert.
  • Use Split-screen mode, and drag the documents from the Library and drop them onto the Module/Section.
  • Select the documents in the Library, copy them (right-click then Copy, or menu option Edit | Copy, or CTRL+C), then paste them into your Module/Section (right-click then Paste, or menu option Edit | Paste, or CTRL+V).

Note that when you insert/drop/paste document into an Outline Element, they will be inserted as follows:

  • If the currently-selected object (or the one you right-click on, or drop onto) is a Module or Section then the documents will be inserted as the last elements in the Module/Section
  • If the currently-selected object is a Topic, then the documents will be inserted immediately below this Topic.

Note that if you cut/paste documents, the documents will be inserted into the Module/Section in the order in which they were selected.

Creating a Title

Outline in the Library

When you publish content, you do so by selecting the Module or Section that contains the content you want to publish in the Outline Editor, and clicking on the Publish button ( Publish Icon.png ) on the Standard Toolbar. However, it is important to note that what UPK publishes is the content of the selected Module or Section. If the Module/Section that you selected has a Concept Page attached to it, this Concept Page will not appear in the published Player. Instead, the name of this Module or Section will appear in the title bar of the browser window (in which the Player is displayed).

This is best understood by comparing the two images above. In the image Outline in the Library, you can see that we have selected a Module called Global SAP Training. This has a Concept Page with a red background attached to it. However, in the image Outline in the Player, this red Concept Page does not appear, and the name of the module appears instead in the title bar. Effectively, the published Outline appears to start from one level down in the actual Outline (as it appears in the Library]]. This means that when you build your Outline, you should include all of the content that you want to appear in your published Outline inside another Module or Section, that you will select for publishing.

Why does it work this way? Really, this is a throwback to the days of OnDemand 8.x, where the highest level of an Outline was effectively the Title, which then contained a strict three-level hierarchy of Module -> Section -> Topic. Although UPK no longer enforces this same hierarchical limitation, it still expects to have a Title that is selected for publishing.

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox