There's a manual on Org mode, which is software used in Emacs. This manual describes the Org syntax, along with how to use Org mode.

I've mostly learned the syntax by just seeing it used.  Here's how it looks:


* Section Title

  You write some text.  You may indent the text
  with two spaces, if it look good to you.  I do
  it like this.

  The line "* Section Title" may be showed in a
  different color, if your editor knows the Org
  syntax.  GNU Emacs can collapse (hide) sections,
  by pressing TAB on them.

** Subsection Title

  This is text is within a subsection - a section
  within a section.

  I made the lines shorter in ordred to fit the
  Trisquel forums.

* Lists
** Types

  You can do:

    * Ordered lists:
      1. Using 1., 2. and so on.
      2. Using 1), 2) and so on.
    * Unordered lists:
      + Using "*"
      + Using "+"
      + Using "-"

  Org mode can automatically order numbers in
  ordered.  It can also change the list type with
  a key stroke.

** Spacing

  When list items span multiple lines, you may
  want to put empty lines between the items:

    + In lists, when you have really long lines,
      you may want to write them like this.

    + Then follow them with another multiline text
      block.  Maybe with several sentences.

    + GNU Emacs will align things itself, but in
      other editor may have to do it yourself.

* Tables

  Tables can be written like this:


  | Text 1    | Text 2    | Nums |
  |-----------+-----------+------|
  | Some data | More data |   51 |
  | Also data |           |   51 |
  | N/A       | N/A       |      |

  There's also syntax for table calculations, but
  that's for some other time.

  Org mode will can do table calculations, put
  table spacing, and make rows and columns.

* Other stuff

  You can also do links, footnotes, definition
  lists, tags, TODO items, metadata and other
  things.  You can make emphasis, like *bold* and
  /italic/, _underlined_ and others.

  An editor which understands the syntax will
  display things in different styles.  But even
  when an editor to doesn't understand the syntax,
  the text it's still very easy to read and
  understand.


The Org mode manual is at http://orgmode.org/manual/.

You can look at some of the Org file I've made and see how I write them. Here are some of them:


  http://www.libtec.org/dev/notebooks/gpg.org
  http://www.libtec.org/dev/notebooks/hardware.org
  http://www.libtec.org/dev/notebooks/coding/javascript.org
  http://www.libtec.org/dev/notebooks/coding/c.org
  http://www.libtec.org/dev/notebooks/mercurial.org
  http://www.libtec.org/dev/notebooks/gnu/graphics.org

Reply via email to