6.Text Element

Download PDFEdit

Just like a book is made of chapters, a chapter is made of elements. Elements are classified into text, figures, tables and objects and individual text elements have their own unique types. To write efficiently, you must be able to accurately determine which type of text element should be used in which kind of situation. In this chapter, we will present you with advices on how to make such a decision.

The following text element types are available.

Table 6-1Text Element Types

Element type

Line change allowed

Textile grammar used

Normal

No1

No

Heading 1~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

Note

Yes

No

Tip

Yes

No

Caution

Yes

No

Proofreading

Yes

No

Depending on the characteristics of a book that you’re preparing, the text element type(hereinafter element types) that is used frequently may vary. In case of novels, or essays, the element types such as normal, headline, or blockquote can be used for most of contents. To the contrary, in case of technical descriptions or product manuals, more element types should be used.

Each element type’s usage, characteristics and method for use are shown as follows.

In editing mode, element types can be quickly set by pressing the <Ctrl + /> shortcut and in normal mode, you can click on the <Change Type> button in the right bottom of the selected element.

6.1Normal, Preformatted

A general element type is “Normal”. When you change line and save it in a normal element, it will be divided into multiple elements from the changed line.

If try to change lines in the preformatted element, it will not cause branching into multiple elements but instead, everything is maintained in one element. When you write a poem where line change should have no effect on an element, you should use this preformatted element.

A Thousand Winds

Do not stand at my grave and weep.
I am not there. I do not sleep.
 
I am in a thousand winds that blow.
I am the softly falling snow.
I am the gentle showers of rain.
I am the feild of ripening grain.
I am in the morning hush.
 
I am in the graceful rush beautiful birds in circleing flight.
I am the starshine of the night.
I am in the flowers that bloom.
I am in a quiet room.
I am in the birds that sing.
 
I am in the each lovely thing.
 
Do not stand at my grave and cry.
I am not there. I do not die.

6.2Heading and Headline

Heading divided the contents into sections and emphasizes an element. Using Heading 1 through 5, you can form a layer of sections, and as a result, the table of contents will be automatically generated.

If you omit heading 2 following heading 1, then an empty heading corresponding to heading 2 will be inserted in between.

Headline is similar to heading in that it emphasizes the content. But, the difference is that it dose not distinguish sections and it is not included in the table of contents.

6.3Code and Command

This element type is frequently used when preparing technical documents or manuals related to S/W programming, system management and etc.

If you use monospace font in code and command elements, you can greatly improve the readability. The fixed width font has the same width for all letters, so every letter over many rows looked as if they are sorted by columns.

Code elements are shown as follows.

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

Command elements are shown as follows.

ps -ef | grep java

6.4Blockquote and Epigraph

A blockquote is an element type frequently used to quote other author’s book, article, study, data or statement which can help convincing the readers of your explanations or arguments.

Figure 6-1Blockquote

An epigraph is a quotation at the beginning of each chapter to express the philosophy and mottos. In general, an epigraph is the first paragraph of a chapter.

Figure 6-2Epigraph

6.5Ordered, Unordered List

When you prepare an ordered or unordered list, you use parts of the Textile grammar used in Wiki.

An ordered list can be prepared in the following way.

# Football
# Basketball
# Baseball

It is expressed as follows.

  1. Football

  2. Basketball

  3. Baseball

It supports up to level 3.

# Software
## Web Browser
### Chrome
### Firefox
### Safari
## Operation System
### Windows
### Linux
### Unix
# Hardware

It is expressed as follows.

  1. Software

    1. Web Browser

      1. Chrome

      2. Firefox

      3. Safari

    2. Operation System

      1. Windows

      2. Linux

      3. Unix

  2. Hardware

If you want just line change without making a new item, then you can use “+ ” instead of “# ” at the end.

# Software
+ Computer software is a collection of computer programs and related data that provides the instructions for telling a computer what to do and how to do it. S
## Web Browser
#+ A web browser is a software application for retrieving, presenting, and traversing information resources on the World Wide Web.
### Chrome
##+ Google Chrome is a browser that combines a minimal design with sophisticated technology to make the web faster, safer, and easier.
### Firefox
##+ Mozilla Firefox is a free and open source web browser descended from the Mozilla Application Suite and managed by Mozilla Corporation.
### Safari
##+ Safari is a web browser developed by Apple Inc. and included with the Mac OS X and iOS operating systems.
Use of “+ ” is not a grammar of the Textile.

It is expressed as follows.

  1. Software

    Computer software is a collection of computer programs and related data that provides the instructions for telling a computer what to do and how to do it. S

    1. Web Browser

      A web browser is a software application for retrieving, presenting, and traversing information resources on the World Wide Web.

      1. Chrome

        Google Chrome is a browser that combines a minimal design with sophisticated technology to make the web faster, safer, and easier.

      2. Firefox

        Mozilla Firefox is a free and open source web browser descended from the Mozilla Application Suite and managed by Mozilla Corporation.

      3. Safari

        Safari is a web browser developed by Apple Inc. and included with the Mac OS X and iOS operating systems.

If you want to continue numbering from the ordered list appearing earlier, then go to the element option panel, and select the “Renumbered” option. For more details, please refer to 5.8 Element Option Setting.

In an unordered list, the same method is used. But instead of “# ”, you need to use “* ”.

* Software
+ Computer software is a collection of computer programs and related data that provides the instructions for telling a computer what to do and how to do it. S
** Web Browser
*+ A web browser is a software application for retrieving, presenting, and traversing information resources on the World Wide Web.
*** Chrome
**+ Google Chrome is a browser that combines a minimal design with sophisticated technology to make the web faster, safer, and easier.
*** Firefox
**+ Mozilla Firefox is a free and open source web browser descended from the Mozilla Application Suite and managed by Mozilla Corporation.
*** Safari
**+ Safari is a web browser developed by Apple Inc. and included with the Mac OS X and iOS operating systems.

It is expressed as follows.

When you change an ordered list to an unordered list, you don’t need to change each of “# ” to “* ” one by one. If you change the element type, then automatic changes will be made. The same rule shall apply when you change an unordered list to an ordered list.

You can use an ordered list and an unordered list altogether.

# Software
** Web Browser
### Chrome
### Firefox
### Safari
** Operation System
### Windows
### Linux
### Unix
# Hardware

It is expressed as follows.

  1. Software

    • Web Browser

      1. Chrome

      2. Firefox

      3. Safari

    • Operation System

      1. Windows

      2. Linux

      3. Unix

  2. Hardware

6.6Definition List

A definition list is an element type where a pair of term and description is repeatedly expressed.

By line change, terms and descriptions are distinguished.

Title
Enter the title of a book.

Subtitle
Enter the subtitle of a book.

Edition
Enter the edit version of a book you are preparing.

It is expressed as follows.

Title

Enter the title of a book.

Subtitle

Enter the subtitle of a book.

Edition

Enter the edit version of a book you are preparing.

6.7Note, Tip, Caution

Admonition refers to providing information, tips and cautions aside from the main text.

Admonition provides element types such as note, tip or caution. But there is no clear guideline as to which type of element should be used for which type of contents.

Note

A brief explanation, reference and remark added to the main text.

Tip

Used to provide helping words.

Caution

Used to clear attention of a reader or user.

DocBook uses caution, important, note, tip, and warning as admonition.

6.8Proofreading

Proofreading element is used to arrange the necessary information or task list for proofreading. It is not displayed in Web Viewer, PDF or EPUB.


  1. If you make line change and save the results in “Normal” elements, then it will be automatically separated into multiple elements.To Content
  2. You need spacing after '#'.To Content