Using Plain Text Comments

The Plain Text model is the simplest comment model, supporting a minimal amount of formatting available in earlier versions of TechWriter. Unlike the other comment models that support a rich set of formatting tags, the "tagless" Plain Text model is limited to using blank lines between your text in order to create multiple paragraphs and separate your description and remarks. By being "tagless", this model has the advantage of being easier to maintain outside of TechWriter. But the lack of support for many of the formatting capabilities of TechWriter limits the use of this model.

If you are using or plan to use Plain Text for your XML schema comments, you must set the comment format to Plain Text on the XML Schema Settings dialog.

Below is an example of a comment that uses Plain Text:

Job status.

Represents the status of the job.

In the above example, the blank line separates the text that will represent the description from the text that will represent the remarks.