TopicTemplate

Note: The topic title is pulled from the HTML title tag. To change the topic title, edit the topic properties.

UNDER CONSTRUCTION

The first thing on the page should be an intro of some sort. Depending on what type of topic this is you will include different info:

• For About topics, briefly describe the topic, including links to the concepts discussed in the topic.

• For the first page of an editor, include a link to the associated About topic.

• For secondary pages of an editor, just get right into the description of the UI features.

Next, write a description of features in table form, stepped instructions, or possible actions, depending on the type of code page:

• If you are writing an About topic, describe the concept behind the feature and include links to the associated editor pages; for example:
  
  To learn about the User editor, click one of the following editor pages:

• Main Settings
• Mobile Device Authentication
• Properties and Names

• Migration History and Status (only available when editing a User)

• If you are describing a page that displays information, you might use the following format.

Column	Description
Content Item	Displays the name of the content item assigned to you. Click the content item name to open it in the Content Item Editor (this does not check out the item).
Stage	Displays the workflow stage of the item assigned to you.
Due Date	If you must move this content item to the next workflow stage by a certain date (and time), that date is displayed.

 

• If you are describing a form-like page that requires fields to be completed in a particular order, you might use the following format:
  
  To create a Data Entry Template:

1. In the left pane of Content Server Explorer, open the section or folder in which you want to create a Data Entry Template.

2. On the toolbar, click New, and then click Data Entry Template.

3. In the Name box, type a unique name for your Data Entry Template. (The name must not duplicate the name of any other Data Entry Template in the folder.)

4. You can automatically insert content items created with this Data Entry Template into a list in another content item. For example, when you create new News articles, you want them to display in the News Gadget Index content item.
   
   To set up automatic list insertion:

1. Click Change Item to the right of the Insert items into box.

2. In the Selecting Content Item dialog box, open the folders as necessary to select the content item into which you want to insert list entries, and then click Finish.

3. In the drop-down list to the right of the content item you just inserted, choose the List to which you want to add entries.

• If you are describing a page that allows you to perform actions in any order, you might use the following format:
  
  You can perform the following tasks in the workflow section:

• To move a stage to the top of this list, click to the right of the stage name.
• To move a stage up one space in this list, click to the right of the stage name.
• To move a stage down one space in this list, click to the right of the stage name.
• To move a stage to the bottom of this list, click to the right of the stage name.
• To delete a stage from Content Server, click to the right of the stage name.

When you include images in your topics, copy the image file from the portal server to your help project. In the future, we want to reference the images used by the portal, rather than copying them to the help project.

Next, if necessary, add links to any additional/related info that was not linked within the topic text. For example, when documenting Authentication Sources, you might include links to user/group topics. Use the following formatting:

Related Topics:

• topic link

• topic link

If this is a context-sensitive topic, include a horizontal rule and describe how to navigate to the associated code page.

Use the Path paragraph tag to get the correct open door icon and use the following formatting:

• To display the page associated with this help topic, click:
  Community Page | Collaboration Server Administration | Configure Guest Portal Access

If the navigation is more complex, you can instead use the following formatting:

• To display the page associated with this help topic:

1. Click Administration.
2. Open the User editor:
• To create a new user:
1. Open an administrative folder.
2. In the Create Object drop-down list, click User.
• To edit an existing user:
1. Navigate to the user you want to edit.
2. Click the user name.
3. On the left, under Edit Object Settings, click Mobile Device Authentication.