Work with See Also and Related Topics

Paieška

Learn about See Also and Related Topics features and how to use these features.

About See Also and Related Topics

The See Also feature links a topic with related/associated topics through keywords. A keyword contains a group of associated topics. Linking a keyword to a topic also links the associated topics in the keyword to the topic. RoboHelp displays associated topics in preview mode and output through a control inserted in the topic applied to the topic.

You can link a keyword to multiple topics so that each topic displays the same set of associated topics from the linked keyword. You can also link multiple keywords to a topic so that the topic displays a combination of different sets of associated topics from each linked keyword.

If you modify the grouping of associated topics in a keyword, RoboHelp automatically updates all the topics linked to the keyword. If you modify the title of a topic in the project, RoboHelp automatically updates the title in all linked keywords.

Use the See Also feature to simultaneously manage related topics at a project level, that is, in multiple topics. If you want to manage related topics explicitly for an individual topic, use the Related Topics feature instead of the See Also feature.

Use the See Also feature

To use the feature, do the following:

  1. Create and manage See Also keywords 
  2. Associate topics to a See Also keyword
  3. Link a topic to a See Also keyword
  4. Insert the See Also placeholder in a topic
  5. View associated topics
  6. Apply styles to the See Also placeholder
  7. Generate a See Also report

Create and manage See Also keywords

To use the See Also feature, first create a See Also keyword. To do so:

  1. In the Author mode, click See Also. The See Also panel appears.

  2. In the See Also panel, click  to create a keyword.

  3. In the New See Also Keyword dialog box, specify the name of the keyword.

  4. Click Done.

    The new keyword is placed in the See Also panel in alphabetical order of keyword names.

  5. To manage See Also keywords, click  against a keyword or right-click a keyword and do the following:

    • To rename a keyword, click Rename. In the Rename Keyword dialog box, specify the new name and click Done.
    • To delete a keyword, click Delete. In the Confirm dialog box, click Yes.

  6. Click  to save the changes.

Associate topics to a See Also keyword

While defining a keyword, add associated topics in the Associated Topics section. To do so:

  1. In the Author toolbar, click See Also. 

  2. In the See Also panel, click  against a keyword to expand it. 

  3. To add an associated topic, click   against Associated Topics.

  4. In the Add Associated Topic dialog box, locate the associated topic. Use the Search field or browse through the Contents or the Recently Used drop-down section. 

  5. Select the associated topic. You can verify topic selection through the preview pane at the right side of the dialog box.

  6. Click Link.

    The associated topic is placed below Associated Topics in alphabetical order of the topic name. You can add multiple associated topics in a keyword.

  7. To manage associated topics, do the following:

    • To reorder a topic in the list of associated topics, click  and use drag-and-drop. 
    • To remove a topic, click  against it.

  8. Click  to save the changes.

You can link topics to keywords in two ways—through a topic’s properties or a keyword.

To link topics to keywords, do the following:

  1. To link through a topic’s properties:

    1. From the Contents panel, right-click the appropriate topic and then click Properties.

    2. In the Topic Properties dialog box, expand the See Also drop-down section.

      The Select Keyword drop-down list displays all keywords in a project.

    3. From the Select Keyword drop-down list, select the appropriate keyword. You can select multiple keywords.

      The keywords appear below the Select Keyword field. To remove a keyword, click  against it.

      Pastaba:

      After you link the topic to keywords, RoboHelp automatically displays the topic in each keyword in the See Also panel > expanded view of each keyword > Used In Topics section. 

  2. To link through a keyword:

    1. In the Author toolbar, click See Also. 

    2. In the See Also panel, click  against a keyword to expand it.

    3. Click  against Used In Topics.

    4. In the Add Used In Topic dialog box, locate the topic to which you want to associate the keyword. Use the Search field or browse through the Contents or the Recently Used drop-down section.

    5. Select the topic. You can verify the topic selection through the preview pane at the right side of the dialog box.

    6. Click Link.

      The topic is placed below Used In Topics in alphabetical order of the topic name. You can associate multiple topics with the keyword.

      Pastaba:

      After you link topics to the keyword, RoboHelp automatically displays the keyword in each topic in the Topic Properties dialog box > See Also drop-down section.

      If a topic is linked to multiple keywords and each keyword contains a different group of associated topics, RoboHelp displays all associated topics from all keywords in the topic. For example, the topic Brochure is linked to two keywords–Sales and Marketing. The Sales keyword has associated topics A, B, and C and the Marketing keyword has associated topics X, Y, and Z. RoboHelp displays the associated topics A, B, C, X, Y, and Z in Brochure.

    7. To remove a topic, click  against it.

  3. Click  to save the changes.

    Pastaba:

    If you want to explicitly insert specific related topics in an individual topic, use the Related Topics feature. 

To insert the placeholder, do the following:

View associated topics

To view the list of associated topics, you can preview the topic or generate an output. To preview the topic, click Preview  on the standard toolbar. In Preview mode and in the output, RoboHelp populates the See Also placeholder with associated topics from linked keywords. 

Apply styles to the See Also placeholder

You can apply various styles to the caption and topic list components in the See Also placeholder.

  1. In the See Also placeholder, click the caption.

    In the Properties panel > General tab, the Type field shows See Also Caption.

  2. Modify the caption, if required, in the Caption field. 

  3. To the caption, apply styles from options in the General and Styles tabs:

    • For information about the General tab, see General tab in Properties panel. Note that for See Also Caption, you can apply only Font, Alignment, and Background options.
    • In the Styles tab, select Paragraph Styles from the styles drop-down list and and click a paragraph style to apply it.

  4. In the See Also placeholder, click the topic list.

    In the Properties panel > General tab, the Type field shows See Also List.

  5. To the topic list, apply styles from options in the General and Styles tabs:

    • For information about the General tab, see General tab in Properties panel. Note that for See Also List, you can apply only Font and Background options.
    • In the Styles tab, select List Styles from the styles drop-down list and click a list style to apply it. 
    Pastaba:

    By default, the following styles are applied to different parts in a See Also placeholder:

    • seealso-caption to a caption
    • seealso-list to a list
    • seealso-list-item to each list item

    These styles are defined in your project's default style sheet (default.css). In a new project, you can control all aspects of See Also styling by copying new classes from default.css. 

  6. Click  to save the changes.

Generate a See Also report

Use the See Also report to view information such as the list of See Also keywords in your project, the topics associated with each keyword, topic titles, and the folder in which the topic exists. You can also filter the report according to folders.

To generate a report, see Open a report. To customize a report, see Customize a report.

To use the feature, do the following:

  1. Insert the related topics placeholder
  2. Add topics to the Related Topics placeholder
  3. View related topics
  4. Apply styles to the Related Topics placeholder

To insert and manage related topics in each topic explicitly, insert the Related Topics placeholder in the topic. To do so:

  1. From the Contents panel, open the topic in which you want to add related topics.

  2. Place the pointer at the location in which you want to insert the placeholder.

  3. In the standard toolbar, click .

    RoboHelp adds the Related Topics placeholder at the specific location in the topic.

    Related Topics placeholder

  4. To delete the placeholder, right-click anywhere in the placeholder and click Delete Related Topics.

  5. Click  to save the changes.

After you insert the Related Topics placeholder in the topic, the Type field in the Properties panel > General tab shows Related Topic List. You can now add related topics to the placeholder. To do so:

  1. In the General tab, against Related Topics, click . 

  2. In the Add Related Topic dialog box, locate the related topic you want to link to the topic. To do so, use the Search field or browse through the Contents or the Recently Used drop-down section.

  3. Select the related topic. You can verify the topic selection through the preview pane at the right side of the dialog box.

  4. Click Link.

    The related topic is placed below Related Topics in alphabetical order of the topic name. You can add multiple related topics.

  5. To manage related topics, do the following:

    • To reorder a topic in the list of related topics, click  and use drag-and-drop. 
    • To remove a topic, click  against it.

  6. Click  to save the changes.

To view the list of related topics, you can preview the topic or generate an output. To preview the topic, click Preview  on the standard toolbar. In Preview mode and in the output, RoboHelp populates the Related Topics placeholder with related topics added to the placeholder.

You can apply various styles to the caption and topic list components in the Related Topics placeholder.

  1. In the Related Topics placeholder, click the caption.

    In the Properties panel > General tab, the Type field shows Related Topics Caption.

  2. Modify the caption, if required, in the Caption field. 

  3. To the caption, apply styles from options in the General and Styles tabs:

    • For information about the General tab, see General tab in Properties panel. Note that for See Also Caption, you can apply only Font, Alignment, and Background options.
    • In the Styles tab, select Paragraph Styles from the styles drop-down list and click a paragraph style to apply it.

  4. In the Related Topics placeholder, click the topic list.

    In the Properties panel > General tab, the Type field shows Related Topics List.

  5. To the topic list, apply styles from options in the General and Styles tabs:

    • For information about the General tab, see General tab in Properties panel. Note that for Related Topics List, you can apply only Font and Background options.
    • In the Styles tab, select List Styles from the styles drop-down list and click a list style to apply it. 
    Pastaba:

    By default, the following styles are applied to different parts in a Related Topics placeholder:

    • reltopics-caption to a caption
    • reltopics-list to a list
    • reltopics-list-item to each list item

    These styles are defined in your project's default style sheet (default.css). In a new project, you can control all aspects of Related Topics styling by copying new classes from default.css. 

  6. Click  to save the changes.

„Adobe“ logotipas

Prisijunkite prie savo paskyros

Greitos nuorodos

Peržiūrėkite visus savo planus Tvarkykite savo planus

Legal Notices    |    Online Privacy Policy