Changed the heading levels in documentation again
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
##############
|
||||
***************
|
||||
User Interface
|
||||
##############
|
||||
***************
|
||||
|
||||
The user interface is kept as simple as possible to avoid distractions.
|
||||
The main window contains a tree vew pane with the entire structure of the project, and a small details panel below it to display additional information.
|
||||
@@ -11,9 +11,8 @@ This will open the source editor which uses a simplified markdown format describ
|
||||
The document can also be viewed as html with all the comments and commands stripped out. To view a document, simply press Ctrl+R or select a file and go to :menuselection:`Document --> View Document` in the menu.
|
||||
The document viewed does not need to be the same document currently being edited.
|
||||
|
||||
***************
|
||||
Markdown Format
|
||||
***************
|
||||
===============
|
||||
|
||||
the document editor uses a simplified markdown format.
|
||||
That is, it supports basic formatting like bold, italics and underline, as well as four levels of headings.
|
||||
@@ -24,7 +23,7 @@ The editor also has a minimal set of commands used for setting tags and referenc
|
||||
|
||||
.. csv-table:: Formatting Syntax
|
||||
:header: "Format", "Description"
|
||||
:widths: 15, 70
|
||||
:widths: 15, 50
|
||||
|
||||
"``# Title``", "Heading level one. The space after the # is mandatory."
|
||||
"``## Title``", "Heading level two. The space after the # is mandatory."
|
||||
@@ -36,16 +35,15 @@ The editor also has a minimal set of commands used for setting tags and referenc
|
||||
"``% text...``", "A comment. The text is not exported, seen in viewer, or counted towards word counts."
|
||||
"``@keyword: value``", "A keyword argument followed by a value, or a comma separated list of values."
|
||||
|
||||
******************
|
||||
Keyboard Shortcuts
|
||||
******************
|
||||
==================
|
||||
|
||||
All features are available as keyboard shortcuts.
|
||||
These are as following:
|
||||
|
||||
.. csv-table:: Keyboard Shortcuts
|
||||
:header: "Shortcut", "Description"
|
||||
:widths: 15, 70
|
||||
:widths: 15, 50
|
||||
|
||||
":kbd:`Ctrl-.`", "Correct word under cursor."
|
||||
":kbd:`Ctrl-1`", "Switch focus to tree view pane."
|
||||
|
||||
Reference in New Issue
Block a user