Navigation: Basic Working Procedures > Editing Topic Files Writing and formatting text |
Scroll Prev Top Next More |
For more detailed information on formatting text see Text Formatting and Styles.
The editor:The Help+Manual editor has two or three tabs, depending on the version of Help+Manual you are using: •The Page Editor tab is where you edit the content of your topic files. This is basically just like a normal word processor. You can enter text, copy and paste, apply styles, insert images etc. You can also use special help authoring features that a word processor does not have. •The Topic Options tab provides access to settings that are saved separately for each individual topic, including index keywords assigned to topics. •The XML tab (Professional and Floating license versions only) allows you to view and edit the XML source code of your topic. If you don't understand what you see here just ignore it! The topic header area:The area above the main editor window contains the topic header. This corresponds to the header of topics in help files and supplies the titles of topics for PDF and other printed formats. By default, the header box contains the same text as the topic caption in the Table of Contents but you can add additional text if you like. You can also insert graphics, hyperlinks etc., but such additional content is not used in all output formats. Multiple topic tabs:You can edit multiple topics in multiple tabs. Right-click on a topic in the TOC on the left and select Open Topic in a New Tab to open an additional tab. This makes it easy to refer to or edit additional topics and not lose your place in the main topic you are working on. |
The editing and formatting tools are grouped in the Write tab of the Ribbon. Many of these tools can also be selected with keyboard shortcuts. Select Program Options in the View tab of the Ribbon to view and change all available keyboard shortcuts. ![]() Applying formatting and copying, cutting and pasting work in the same way as in any modern word processor. •To format existing text manually you must first select it and then apply the formatting, using a formatting tool or a style. •If you select a formatting tool without selecting text (font, bold, underline, color, background color etc.) it will apply from the cursor position onwards if you continue typing. •To delete the word to the left of the editing cursor press Ctrl+Backspace. •Use the Format Painter tool in the Clipboard group (Write and Project tabs) to copy formatting. The Format Painter works in the same way as similar tools in word processors. Click once to select and use once, double-click for multiple use, click again or Escape key to turn off. ![]() •See Text Formatting and Styles for detailed information on formatting text and using styles. •See Special characters, lines and breaks for inserting typographic quotes and other special characters. |
You can zoom the entire contents of the editor quickly with the Zoom control in the status bar below the editor window. This control is also available in the View tab in the ribbon toolbar. You can also switch the editor display between the styles defined for electronic help formats (HTML Help, WebHelp, Visual Studio Help and eWriter Help) print-style help formats (PDF, printed manuals, Word DOCX and ePUB and Kindle Mobi eBooks). This will only have an effect if you have defined different settings for screen and print output in your style definitions. See Multiple style sets for more information on using different style sets for different output formats. Display buttons in the status bar:![]() |
Sometimes you want to make sure that text will not be changed or translated, particularly when you are working on a project in a team. •Select the text you want to protect, then click on the The text will be displayed with shading in the editor to show that it is protected. In the XML file it will also be tagged with a translate="false" attribute to inform the translator that you do not want it to be translated. |
Zoom editor: |
Use the Zoom control in the status bar below the editor or in the View tab of the ribbon toolbar. |
Go to hyperlink: |
Hold down Ctrl and click on the link (double-clicking on links opens the link editing dialog). |
Word left/right: |
Ctrl+Cursor Left/Right |
Next/previous topic: |
Ctrl+Cursor Up/Down |
Other nav. controls: |
PgUp, PgDown, Ctrl+Home, Ctrl+End |
Edit history: |
The |
Double-click, triple click: |
A double-click selects a word, a triple-click selects the entire paragraph. |
Keyboard shortcuts: |
Select Program Options in the View tab for a full list of all available keyboard shortcuts. You can change the shortcuts and assign your own shortcuts to most of Help+Manual's functions. |
Display paragraph marks: |
Click on the |
Preview Windows large/small fonts settings: |
Click on the 96/120 DPI button in the status bar at the bottom of the program window to emulate Windows' small and large font modes in the editor. This is useful for making sure that your layouts will work correctly with both settings. |
Show Screen/Print styles in the editor: |
Click on the Screen/Print button in the status bar at the bottom of the program window to switch between the style definitions for screen output (electronic help files) and print style output (PDF, printed manuals, Word DOCX). This will only show any changes if you have actually defined different styles for screen and print output. See Multiple style sets for more details on this subject. |
This tab is only available in the Professional and Floating license versions of Help+Manual and it is designed for advanced users only. Please don't edit anything in this tab unless you have plenty of experience in XML editing and understand all the code. XML syntax is very strict and unlike HTML not even a single mistake in the code is permitted! If you enter incorrect code Help+Manual will perform a syntax check and delete it automatically (and silently!) when you return to the main editor window. You can find a detailed reference to the Help+Manual XML syntax in the Helpman_XML_ref.chm file in the Help+Manual program directory. |
See also