Re-using content with snippets

<< Click to Display Table of Contents >>

Navigation:  Basic Working Procedures > Editing Topic Files >

Re-using content with snippets

The btn_insert_embedded Insert Snippet tool in Write > Insert Object enables you to insert the contents of another topic or a Help+Manual XML file at the cursor position. You can insert topics and files from the current project, from other Help+Manual projects (there are some restrictions in the Basic version of H+M) and from collections of Help+Manual XML files. This means that you can build up a library of reusable content that you can access very easily.

You can insert snippets in two different modes, Copy and Link. Copy mode is like normal Copy & Paste it pastes the contents of the topic or file at the cursor position and you can then edit it. Link mode creates a live link to the snippet file. To edit the snippet you must then edit the original topic or file, but then it updates automatically in all the places where you have inserted it, even if you are using it in multiple projects.

 

prod_tip       Productivity Tip

If you send your project for translation remember to include any linked external snippet files you have referenced, otherwise the translator won't see them!

Click to expand/collapseInserting topics and XML files as snippets
Click to expand/collapseInserting snippets from a style repository
Click to expand/collapseExporting selected text and topics as snippet files
Click to expand/collapseManaging and organizing snippets
Click to expand/collapseManaging snippets in a 'snippet project'
Click to expand/collapseManaging snippets in a style repository
Click to expand/collapseExcluding the snippets source files from your published output
Click to expand/collapseEditing the contents of snippet files
Click to expand/collapseHyperlinks to anchors in linked snippets
Click to expand/collapseChecking where a snippet topic is used
Click to expand/collapseKeywords in snippets

See also:

Multiple TOC entries for one topic

Snippets and multiple TOC references

Topic include options

Anchors - jump targets