Writing Text Paragraphs

If a book consists of chapters, a chapter consists of paragraphs. Paragraphs are divided into text, image, table, object, and other paragraphs. Each text paragraph has its own type. To write efficiently, you need to know which type of text paragraph to use in which situation. This chapter provides information to help you decide.

The text paragraph types are as follows.

Text paragraph types

Paragraph Type

Line Breaks Allowed

Textile Syntax

Normal

No1

No

Heading 1 to Heading 5

No

No

Headline

No

No

Code

Yes

No

Command

Yes

No

Preformatted

Yes

No

Blockquote

Yes

No

Epigraph

Yes

No

Ordered List

Yes

Yes

Unordered List

Yes

Yes

Definition List

Yes

No

Callout List

Yes

No

Step

No

No

Note

Yes

No

Tip

Yes

No

Caution

Yes

No

Proofreading

Yes

No

The text paragraph types(hereafter, paragraph types) you use most depend on the kind of book you write. For novels and essays, you can write most of the content with just a few paragraph types, such as Normal, Headline, and Blockquote. For technical books and product manuals, however, you need more paragraph types.

Select the text paragraph type from the drop-down list at the lower right of the editing area, or press Ctrl + / and use the arrow keys.

Selecting a text paragraph type

Selecting a text paragraph type

The purpose, characteristics, and usage of each paragraph type are as follows.

Normal and Preformatted

The most common paragraph type is the “Normal” paragraph. If you insert line breaks in a Normal paragraph and save it, the paragraph is split at each line break into one or more Normal paragraphs.

In a “Preformatted” paragraph, line breaks do not split the paragraph; it stays as one paragraph. Use it for content such as poems, where line breaks must not separate paragraphs.

Who Has Seen the Wind? —Christina Rossetti, 1872

Who has seen the wind? 
Neither I nor you: 
But when the leaves hang trembling, 
The wind is passing through. 

Who has seen the wind? 
Neither you nor I: 
But when the trees bow down their heads, 
The wind is passing by.

Headings and Headlines

Headings divide the content of each chapter into sections and emphasize paragraphs. When you organize sections hierarchically with Heading 1 through Heading 5, the table of contents is created automatically to match.

If the structure skips a level, for example Heading 3 follows Heading 1 instead of Heading 2, an empty heading is added in between for the Heading 2 level.

A headline is similar to a heading in that it emphasizes content, but it does not divide sections and does not appear in the table of contents.

Code and Command

These paragraph types are used for technical books and manuals about software programming, system administration, and similar topics.

Using a fixed-width(monospace) font for code and command paragraphs improves readability. In a fixed-width font, all characters have the same width, so characters on multiple lines line up in columns.

A code paragraph looks like this.

public static void main(String[] args) {
  System.out.println("Hello, World!");
}

A command paragraph looks like this.

ps -ef | grep java

Code Highlighting and Line Numbers in Code Paragraphs

You can set code highlighting and line numbers in a code paragraph, as shown below.

$r_title(Code Highlighting and Line Numbers)
{
    "status": "success",
    "group": {
        "id": "5b969d63e97cfec7",
    	"groupId": "group01",
		"name": "Group 01",
		"description": "ManualWorks Group 01"
    }
}

Set code highlighting and line numbers in <Optionscheck_box> of the code paragraph. You can also start the line numbers of a code paragraph at a value other than 1.

Code highlighting and line number options

Code highlighting and line number options

The supported languages are as follows. They are always shown in English, regardless of the user's language.

Supported in the web viewer and PDF.

Turning Off Code Line Numbers

By default, “Show Line Numbers” is selected for code paragraphs, so line numbers are shown. You can change the default for the code paragraphs you create in “Setting” in the editor sidebar. To make no line numbers the default when a user has no personal setting, run the following command in the Console.

set-preference -name CODE_NUMBERING -value false

Turning Off Code Highlighting

You can turn off code highlighting for all code. Run the following command in the Console.

set-preference -name IGNORE_CODE_HIGHLIGHT -value true

Adding a Title to a Code Paragraph

Write the code as shown in 1 to set a title for the code paragraph.

The result is as follows.

$r_title(JSON Example)
{
    "status": "success",
    "group": {
        "id": "5b969d63e97cfec7",
    	"groupId": "group01",
		"name": "Group 01",
		"description": "ManualWorks Group 01"
    }
}

As with figure and table captions, you can set the format, including numbering, in the theme, and you can create a chapter that lists the code.

Blockquote and Epigraph

A blockquote is a paragraph type for quoting another author's book, paper, essay, material, or speech to support your explanation or argument.

Blockquote

Blockquote

An epigraph is a quotation placed at the beginning of a chapter to express its purpose or theme. An epigraph is usually the first paragraph(of the chapter).

Epigraph

Epigraph

Ordered and Unordered Lists

To write ordered and unordered lists, you use part of the Textile syntax used in wikis.

If you select ‘Ordered List’ or ‘Unordered List’ as the paragraph type and save, a first-level list is created even if you do not type the characters(#, *).

Ordered Lists

Write an ordered list as follows.

# Soccer
# Basketball
# Baseball

It appears as follows.

  1. Soccer

  2. Basketball

  3. Baseball

Up to three levels are supported.

# Seoul
## Yangcheon-gu
### Mok-dong
### Sinwol-dong
### Sinjeong-dong
## Yeongdeungpo-gu
### Daerim-dong
### Singil-dong
### Yeouido-dong
# Busan

It appears as follows.

  1. Seoul

    1. Yangcheon-gu

      1. Mok-dong

      2. Sinwol-dong

      3. Sinjeong-dong

    2. Yeongdeungpo-gu

      1. Daerim-dong

      2. Singil-dong

      3. Yeouido-dong

  2. Busan

To insert a line break without a number, use “+ ”3 instead of the last “# ”.

# Seoul
+ The capital of South Korea
## Yangcheon-gu
#+ A district in western Seoul
### Mok-dong
##+ Until the Joseon Dynasty, it was Naemok-dong and Oemok-dong in Wolchon-ri, Namsan-myeon, Yangcheon-gun
### Sinwol-dong
##+ In the Joseon Dynasty, it belonged to Yangcheon-hyeon, Gyeonggi Province. 
### Sinjeong-dong
##+ In the Joseon Dynasty, it belonged to Yangcheon-hyeon, Gyeonggi Province.

It appears as follows.

  1. Seoul

    The capital of South Korea

    1. Yangcheon-gu

      A district in western Seoul

      1. Mok-dong

        Until the Joseon Dynasty, it was Naemok-dong and Oemok-dong in Wolchon-ri, Namsan-myeon, Yangcheon-gun

      2. Sinwol-dong

        In the Joseon Dynasty, it belonged to Yangcheon-hyeon, Gyeonggi Province.

      3. Sinjeong-dong

        In the Joseon Dynasty, it belonged to Yangcheon-hyeon, Gyeonggi Province.

“+ ” is not part of the Textile syntax.

Continuing the Numbering of Ordered Lists

By default, each new “Ordered List” paragraph starts its numbering over. To continue the numbering from the preceding ordered list paragraph, clear the “1Renumbered” option in the paragraph <Optionscheck_box>.

You can also continue the numbering by selecting the 2Ordered List(Continuing Numbering) paragraph type when you add an ordered list paragraph. With the Ordered List(Continuing Numbering) paragraph type, the numbering continues without clearing the “Renumbered” option in the paragraph <Optionscheck_box>.

Ordered List(Continuing Numbering) paragraph type

Ordered List(Continuing Numbering) paragraph type

The Ordered List(Continuing Numbering) paragraph type appears in the drop-down list only when you first create a text paragraph. After the paragraph is created, set the option in the paragraph <Optionscheck_box> as before.

Unordered Lists

Write an unordered list the same way as an ordered list, but use “* ”4 instead of “# ”. Unordered lists also support up to three levels.

* Seoul
+ The capital of South Korea
** Yangcheon-gu
*+ A district in western Seoul
*** Mok-dong
**+ Until the Joseon Dynasty, it was Naemok-dong and Oemok-dong in Wolchon-ri, Namsan-myeon, Yangcheon-gun
*** Sinwol-dong
**+ In the Joseon Dynasty, it belonged to Yangcheon-hyeon, Gyeonggi Province. 
*** Sinjeong-dong
**+ In the Joseon Dynasty, it belonged to Yangcheon-hyeon, Gyeonggi Province.

It appears as follows.

To change an ordered list to an unordered list, you do not need to replace “# ” with “* ”. Just change the paragraph type, and the list type changes automatically. The same applies when you change an unordered list to an ordered list.

Using Ordered and Unordered Lists Together

You can also use ordered and unordered lists together. Levels are applied as follows.

# Seoul
** Yangcheon-gu
### Mok-dong
### Sinwol-dong
### Sinjeong-dong
** Yeongdeungpo-gu
### Daerim-dong
### Singil-dong
### Yeouido-dong
# Busan

It appears as follows.

  1. Seoul

    • Yangcheon-gu

      1. Mok-dong

      2. Sinwol-dong

      3. Sinjeong-dong

    • Yeongdeungpo-gu

      1. Daerim-dong

      2. Singil-dong

      3. Yeouido-dong

  2. Busan

In a list paragraph, press the Tab key to add a character(#, *) and create a lower-level list item, and press Shift + Tab to remove it. However, when you combine ordered and unordered lists, type the characters yourself.

Indenting Paragraphs That Follow Ordered and Unordered Lists

You can indent some paragraphs that follow ordered and unordered lists. The following paragraphs support indentation.

Press Tab to indent, and press Shift + Tab to remove the indentation.

The editor does not indent the paragraph but shows it 1as follows.

Inserting Line Breaks with Shift + Enter in Ordered and Unordered List Paragraphs

When you edit an ordered or unordered list paragraph, pressing Shift + Enter automatically inserts the line break marker (+ ) for the current list level.

The inserted prefix depends on the list level.

If you press Shift + Enter on a line that already has the line break marker (+ ), only a plain line break is inserted, without a prefix.

Definition Lists

A definition list is a paragraph type that repeatedly pairs a term(or a word, menu name, and so on) with its description.

Separate the term and the description with a line break.

Title
Enter the title of the book.

Subtitle
Enter a subtitle to add to the book title. 

Edition
Enter the edition of the book you are writing.

It appears as follows.

Title

Enter the title of the book.

Subtitle

Enter a subtitle to add to the book title.

Edition

Enter the edition of the book you are writing.

To add a line break within a description, use “+ ”.

Title
Enter the title of the book.
+ The book title is required.

Subtitle
Enter a subtitle to add to the book title.

It appears as follows.

Title

Enter the title of the book.

The book title is required.

Subtitle

Enter a subtitle to add to the book title.

Setting the Layout of Definition Lists

Set the 1layout of a definition list in <Optionscheck_box> of the definition list paragraph.

Setting the layout of a definition list paragraph

Setting the layout of a definition list paragraph

Depending on the selected layout, the definition list appears as follows.

None

Shows the list in the default form.

Column 2

Shows the list in two columns.

Column 3

Shows the list in three columns.

Applies only to the web viewer and HTML. It does not apply to PDF and other formats.

Callout Lists

A callout list is a paragraph type used with image paragraphs. You add callout numbers to an image and describe them in a text paragraph. Create a callout list paragraph as follows.

  1. Add callout numbers to the parts of the image you want to describe.

  2. In a text paragraph, enter the descriptions in the order of the callout numbers in the image.

  3. Select Callout List as the text paragraph type, and then click .

  4. The callout numbers appear in the text paragraph.

Watermelon
Grape
Korean melon

It appears as follows.

1Watermelon

2Grape

3Korean melon

Inserting Line Breaks in Callout List Paragraphs

To insert a line break without creating a new item, use “+ ”.

Watermelon
+ Watermelon is an annual vine native to southern Africa, or its fruit.
Grape
Korean melon

It appears as follows.

1Watermelon
Watermelon is an annual vine native to southern Africa, or its fruit.

2Grape

3Korean melon

“+ ” is not part of the Textile syntax.

Setting Custom Callout Numbers

You can set callout numbers yourself.

#3 Watermelon
#A Grape
#b1 Korean melon

It appears as follows.

3Watermelon

AGrape

b1Korean melon

MS Word has limited support for circled characters. If creating MS Word files is important, use only callout numbers 1 through 10, because the Wingdings font, which provides circled numbers, supports only 1 through 10.

Steps

A step is a paragraph type that describes a procedure step by step. For details, see the following example.

When a heading paragraph appears, the step number is reset to “1”.

In the web viewer and PDF, paragraphs that follow a step paragraph are indented automatically. If you do not want paragraphs that follow a step paragraph to be indented, set this as follows.

  1. Select the paragraph that you do not want to indent.

  2. In the paragraph <Optionscheck_box>, select the “Ignore step indent.” option.

  3. Click the button.

    • In the editor, Ignore step indent. appears on paragraphs with the “Ignore step indent.” option selected.

Note, Tip, and Caution

Information, tips, warnings, and similar content provided separately from the main text are called admonitions. ManualWorks provides the Note, Tip, and Caution paragraph types for this purpose.

Note

Provides a short explanation, reference, or comment added briefly to the main text.

Tip

Provides tips, such as helpful hints.

Caution

Provides text that calls the attention of readers or users.

Proofreading

A proofreading paragraph organizes information or task lists needed to revise content. It does not appear in the web viewer, PDF, EPUB, or other outputs.

You can view all proofreading paragraphs in a document on the document details page or in the <Progress Management> menu of the project.

Managing Document Progress

Explains how to track and manage the progress of writing documents.

You can also view the proofreading list in the 1Table of Contents panel of the editor sidebar.

Markdown

If you select “Markdown” as the paragraph type when you create a new text paragraph, the content written in Markdown is split into multiple paragraphs when you save. Headings, ordered and unordered lists, code, blockquotes, tables, images, horizontal lines, and so on are converted to paragraphs of the corresponding types.

You can change the default paragraph type to “Markdown” in “Setting” in the editor sidebar.


  1. If you insert a line break in a “Normal” paragraph and save it, the paragraph is automatically split into multiple paragraphs.
  2. You must type a space after '#'.
  3. You must type a space after ‘+’.
  4. You must type a space after ‘*’.