Merge commit 'b91237c1ede98e7e025227f5d38a42837f97d378' into v0.4

Author: jceb

doc/orgguide.txt

@@ -0,0 +1,230 @@
+*orgguide.txt*     For Vim version 7.3   Last change: 2011 August 5
+
+==============================================================================
+TABLE OF CONTENTS                                        *orgguide* *orgguide-toc*
+
+    1.  About Org mode guide             |orgguide-about|
+    2.  Introduction                     |orgguide-introduction|
+    3.  Document structure               |orgguide-docstructure|
+    4.  Tables                           |orgguide-tables|
+    5.  Hyperlinks                       |orgguide-hyperlinks|
+    6.  Todo items                       |orgguide-todoitems|
+    7.  Tags                             |orgguide-tags|
+    8.  Properties                       |orgguide-properties|
+    9.  Dates and times                  |orgguide-dates|
+    10. Capture - refile - archive       |orgguide-capture|
+    11. Agenda views                     |orgguide-agenda|
+    12. Markup for rich export           |orgguide-richexport|
+    13. Publishing                       |orgguide-publishing|
+    14. Working with source code         |orgguide-source|
+    14. Miscellaneous                    |orgguide-misc|
+
+==============================================================================
+ORG MODE GUIDE                                                  *orgguide-about*
+
+Copyright © 2010 Free Software Foundation
+
+  Permission is granted to copy, distribute and/or modify this document
+  under the terms of the GNU Free Documentation License, Version 1.3 or
+  any later version published by the Free Software Foundation; with no
+  Invariant Sections, with the Front-Cover texts being “A GNU Manual,”
+  and with the Back-Cover Texts as in (a) below. A copy of the license
+  is included in the section entitled “GNU Free Documentation License.”
+
+  (a) The FSF’s Back-Cover Text is: “You have the freedom to copy and
+  modify this GNU manual. Buying copies from the FSF supports it in
+  developing GNU and promoting software freedom.”
+
+  This document is part of a collection distributed under the GNU Free
+  Documentation License. If you want to distribute this document
+  separately from the collection, you can do so by adding a copy of the
+  license to the document, as described in section 6 of the license.
+
+==============================================================================
+INTRODUCTION                                             *orgguide-introduction*
+
+Preface~
+   Org is a mode for keeping notes, maintaining TODO lists, and doing
+   project planning with a fast and effective plain-text system. It is also
+   an authoring and publishing system.
+
+   This document is a a copy of the orgmode-guide for emacs with modifications
+   for vim. It contains all basic features and commands, along with important 
+   hints for customization.
+
+
+Installation~
+   TODO
+
+Activation~
+   TODO
+
+Feedback~
+   If you find problems with Org, or if you have questions, remarks, or
+   ideas about it, please create a ticket on
+   https://github.com/jceb/vim-orgmode
+   
+
+==============================================================================
+DOCUMENT STRUCTURE                                       *orgguide-docstructure*
+
+Org is based on Outline mode and provides flexible commands to edit the
+structure of the document.
+
+
+Outlines~
+   Org is implemented on top of Outline mode. Outlines allow a document to
+   be organized in a hierarchical structure, which (at least for me) is the
+   best representation of notes and thoughts. An overview of this structure
+   is achieved by folding (hiding) large parts of the document to show only
+   the general document structure and the parts currently being worked on.
+   Org greatly simplifies the use of outlines by compressing the entire
+   show/hide functionality into a single command, =org-cycle=, which is
+   bound to the <TAB> key.
+
+
+Headlines~
+   Headlines define the structure of an outline tree. The headlines in Org
+   start with one or more stars, on the left margin[[#FOOT1][(1)]]. For
+   example:
+
+>
+    * Top level headline
+    ** Second level
+    *** 3rd level
+        some text
+    *** 3rd level
+        more text
+
+    * Another top level headline
+<
+
+   Some people find the many stars too noisy and would prefer an outline
+   that has whitespace followed by a single star as headline starters.
+   [[#Clean-view][A cleaner outline view]], describes a setup to realize
+   this.
+
+Visibility cycling~
+   Outlines make it possible to hide parts of the text in the buffer. Org
+   uses just two commands, bound to <TAB> and S-<TAB> to change the
+   visibility in the buffer.
+
+   <TAB> :: /Subtree cycling/: Rotate current subtree among the states
+
+>
+       ,-> FOLDED -> CHILDREN -> SUBTREE --.
+       '-----------------------------------'
+<
+
+   When called with a prefix argument (C-u <TAB>) or with the shift key,
+   global cycling is invoked.
+
+   S-<TAB> and C-u <TAB> :: /Global cycling/: Rotate the entire buffer
+   among the states
+
+>
+       ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
+       '--------------------------------------'
+<
+
+   C-u C-u C-u <TAB> :: Show all, including drawers.
+
+   When Emacs first visits an Org file, the global state is set to
+   OVERVIEW, i.e. only the top level headlines are visible. This can be
+   configured through the variable =org-startup-folded=, or on a per-file
+   basis by adding a startup keyword =overview=, =content=, =showall=, like
+   this:
+
+>
+    #+STARTUP: content
+<
+
+Motion~
+   TODO
+
+Structure editing~
+   TODO
+
+Sparse trees~
+   TODO
+
+Plain lists~
+   TODO
+
+Footnotes~
+   TODO
+
+==============================================================================
+TABLES                                                         *orgguide-tables*
+
+   TODO add
+
+==============================================================================
+HYPERLINKS                                                 *orgguide-hyperlinks*
+
+TODO
+
+Link format~
+   TODO
+
+Internal links~
+   TODO
+
+External links~
+   TODO
+
+Handling links~
+   TODO
+
+Targeted links~
+   TODO
+
+==============================================================================
+TODO ITEMS                                                  *orgguide-todoitems*
+
+TODO
+
+==============================================================================
+TAGS                                                             *orgguide-tags*
+
+TODO
+
+==============================================================================
+PROPERTIES                                                 *orgguide-properties*
+
+TODO
+
+==============================================================================
+DATES AND TIMES                                                 *orgguide-dates*
+
+TODO
+
+==============================================================================
+CAPTURE - REFILE - ARCHIVE                                   *orgguide-capture*
+
+TODO
+
+==============================================================================
+AGENDA VIEWS                                                   *orgguide-agenda*
+
+TODO
+
+==============================================================================
+MARKUP FOR RICH EXPORT                                     *orgguide-richexport*
+
+TODO
+
+==============================================================================
+PUBLISHING                                                 *orgguide-publishing*
+
+TODO
+
+==============================================================================
+WORKING WITH SOURCE CODE                                       *orgguide-source*
+
+TODO
+
+==============================================================================
+MISCELLANEOUS                                                    *orgguide-misc*
+
+TODO