1. Takafumi Arakaki
  2. tkf.bitbucket.org

Commits

Takafumi Arakaki  committed 0c00929

neorg-doc/a71d0d025a45

  • Participants
  • Parent commits ddbad45
  • Branches default

Comments (0)

Files changed (24)

File neorg-doc/_sources/commands.txt

View file
+NEOrg commands
+==============
+
+.. admonition:: NEOrg sub-commands
+
+   * init_
+   * serve_
+
+.. [[[cog from genecommands import genehelp; genehelp() ]]]
+
+::
+
+    usage: neorg [-h] {init,serve} ...
+
+    NEOrg - Numerical Simulation Organizer
+
+    positional arguments:
+      {init,serve}
+        init        initialize neorg directory
+        serve       start stand-alone webserver
+
+    optional arguments:
+      -h, --help    show this help message and exit
+
+.. [[[end]]]
+
+
+``init``
+--------
+
+.. [[[cog from genecommands import genehelp; genehelp('init') ]]]
+
+::
+
+    usage: neorg init [-h] [dest]
+
+    positional arguments:
+      dest        root directory to initialize (default: ".")
+
+    optional arguments:
+      -h, --help  show this help message and exit
+
+.. [[[end]]]
+
+
+``serve``
+---------
+
+.. [[[cog from genecommands import genehelp; genehelp('serve') ]]]
+
+::
+
+    usage: neorg serve [-h] [-p PORT] [-R ROOT] [-b] [--debug]
+
+    optional arguments:
+      -h, --help            show this help message and exit
+      -p PORT, --port PORT  port to listen (default: 8000)
+      -R ROOT, --root ROOT  root directory (where `.neorg/` exists)
+      -b, --browser         open web browser
+      --debug               set DEBUG=True to run in debug mode
+
+.. [[[end]]]

File neorg-doc/_sources/examples.txt

View file
+.. contents::
+
+Example usages of the special directives
+========================================
+
+.. _file-tree:
+
+File tree
+---------
+
+The following examples assume we have the file tree under the
+:envvar:`DATADIRPATH` like this::
+
+    DATADIRPATH
+    `- my/
+       `- experiment/
+          |- 2011-02-25-182001/
+          |  |- graph_1.png
+          |  |- graph_2.png
+          |  `- data.json
+          |
+          |- 2011-02-25-182002/
+          |  |- graph_1.png
+          |  |- graph_2.png
+          |  `- data.json
+          |
+          |- 2011-02-25-182003/
+          |  |- graph_1.png
+          |  |- graph_2.png
+          |  `- data.json
+          |
+          |- 2011-02-26-182001/
+          |  |- graph_1.png
+          |  |- graph_2.png
+          |  `- data.json
+          |
+          `- 2011-02-26-182002/
+             |- graph_1.png
+             |- graph_2.png
+             `- data.json
+
+
+.. _examples/table-data:
+
+Example usages of :rst:dir:`table-data`
+---------------------------------------
+
+Basic example
+^^^^^^^^^^^^^
+
+.. sourcecode:: rst
+
+    .. table-data:: my/experiment/2011-02-25-*/data.json
+       :data: alpha beta result.gamma
+       :link: %(path)s
+
+will produce a table like this:
+
+.. list-table:: Data found in: ``my/experiment/2011-02-25-*/data.json``
+   :widths: 3 1 1 2 5
+   :header-rows: 1
+
+   * -
+     - alpha
+     - beta
+     - result.gamma
+     - link(s)
+   * - my/experiment/2011-02-25-182001/data.json
+     - 1
+     - 0.1
+     - 0.01
+     - *(link to the page /my/experiment/2011-02-25-182001/)*
+   * - my/experiment/2011-02-25-182002/data.json
+     - 2
+     - 0.2
+     - 0.02
+     - *(link to the page /my/experiment/2011-02-25-182001/)*
+   * - my/experiment/2011-02-25-182003/data.json
+     - 3
+     - 0.3
+     - 0.03
+     - *(link to the page /my/experiment/2011-02-25-182003/)*
+
+
+Use of ``:base:`` option
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. sourcecode:: rst
+
+    .. table-data:: 2011-02-25-*/data.json
+                    2011-02-26-*/data.json
+       :base: my/experiment
+       :data: alpha beta result.gamma
+       :link: %(relpath)s
+
+will produce a table like this:
+
+.. list-table:: Data found in:
+                ``my/experiment/{2011-02-25-*/data.json, 2011-02-26-*/data.json}``
+   :widths: 3 1 1 2 4
+   :header-rows: 1
+
+   * -
+     - alpha
+     - beta
+     - result.gamma
+     - link(s)
+   * - 2011-02-25-182001/data.json
+     - 1
+     - 0.1
+     - 0.01
+     - *(link to the page 2011-02-25-182001/)*
+   * - 2011-02-25-182002/data.json
+     - 2
+     - 0.2
+     - 0.02
+     - *(link to the page 2011-02-25-182001/)*
+   * - 2011-02-25-182003/data.json
+     - 3
+     - 0.3
+     - 0.03
+     - *(link to the page 2011-02-25-182003/)*
+   * - 2011-02-26-182001/data.json
+     - 1
+     - 0.2
+     - 0.01
+     - *(link to the page 2011-02-26-182001/)*
+   * - 2011-02-26-182002/data.json
+     - 2
+     - 0.1
+     - 0.02
+     - *(link to the page 2011-02-26-182001/)*
+
+
+Newest results on top
+^^^^^^^^^^^^^^^^^^^^^
+
+.. sourcecode:: rst
+
+    .. table-data:: 2011-02-25-*/data.json
+       :path-order: sort_r
+       :base: my/experiment
+       :data: alpha beta result.gamma
+       :link: %(relpath)s
+
+will produce a table like this:
+
+.. list-table:: Data found in: ``my/experiment/2011-02-25-*/data.json``
+   :widths: 3 1 1 2 4
+   :header-rows: 1
+
+   * -
+     - alpha
+     - beta
+     - result.gamma
+     - link(s)
+   * - 2011-02-25-182003/data.json
+     - 3
+     - 0.3
+     - 0.03
+     - *(link to the page 2011-02-25-182003/)*
+   * - 2011-02-25-182002/data.json
+     - 2
+     - 0.2
+     - 0.02
+     - *(link to the page 2011-02-25-182001/)*
+   * - 2011-02-25-182001/data.json
+     - 1
+     - 0.1
+     - 0.01
+     - *(link to the page 2011-02-25-182001/)*
+
+
+.. _examples/table-data-and-image:
+
+Example usages of :rst:dir:`table-data-and-image`
+-------------------------------------------------
+
+Basic example
+^^^^^^^^^^^^^
+
+.. sourcecode:: rst
+
+    .. table-data-and-image:: 2011-02-25-*/data.json
+       :image: graph_1.png graph_2.png
+       :path-order: sort_r
+       :base: my/experiment
+       :data: alpha beta result.gamma
+       :link: %(relpath)s
+
+will produce a table like this:
+
+.. list-table:: Data found in: ``my/experiment/2011-02-25-*/data.json``
+   :widths: 1 2 2
+
+   * - .. list-table:: 2011-02-25-182003/data.json
+
+          * - alpha
+            - 3
+          * - beta
+            - 0.3
+          * - result.gamma
+            - 0.03
+
+       - *(link to the page 2011-02-25-182003/)*
+
+     - *(image of 2011-02-25-182003/graph_1.png)*
+     - *(image of 2011-02-25-182003/graph_2.png)*
+
+   * - .. list-table:: 2011-02-25-182002/data.json
+
+          * - alpha
+            - 2
+          * - beta
+            - 0.2
+          * - result.gamma
+            - 0.02
+
+       - *(link to the page 2011-02-25-182002/)*
+
+     - *(image of 2011-02-25-182002/graph_1.png)*
+     - *(image of 2011-02-25-182002/graph_2.png)*
+
+   * - .. list-table:: 2011-02-25-182001/data.json
+
+          * - alpha
+            - 1
+          * - beta
+            - 0.1
+          * - result.gamma
+            - 0.01
+
+       - *(link to the page 2011-02-25-182001/)*
+
+     - *(image of 2011-02-25-182001/graph_1.png)*
+     - *(image of 2011-02-25-182001/graph_2.png)*
+
+
+Scaling image
+^^^^^^^^^^^^^
+
+To scale the image with the table, you can use ``:image-width:``
+option.
+
+.. sourcecode:: rst
+
+    .. table-data-and-image:: 2011-02-25-*/data.json
+       :image: graph_1.png
+       :image-width: 0:100%
+       :path-order: sort_r
+       :base: my/experiment
+       :data: alpha beta result.gamma
+       :link: %(relpath)s
+
+will produce a table like this:
+
+.. list-table:: Data found in: ``my/experiment/2011-02-25-*/data.json``
+   :widths: 1 2
+
+   * - .. list-table:: 2011-02-25-182003/data.json
+
+          * - alpha
+            - 3
+          * - beta
+            - 0.3
+          * - result.gamma
+            - 0.03
+
+       - *(link to the page 2011-02-25-182003/)*
+
+     - *(image of 2011-02-25-182003/graph_1.png)*
+
+       <- the width varied with the width of the table. ->
+
+   * - .. list-table:: 2011-02-25-182002/data.json
+
+          * - alpha
+            - 2
+          * - beta
+            - 0.2
+          * - result.gamma
+            - 0.02
+
+       - *(link to the page 2011-02-25-182002/)*
+
+     - *(image of 2011-02-25-182002/graph_1.png)*
+
+   * - .. list-table:: 2011-02-25-182001/data.json
+
+          * - alpha
+            - 1
+          * - beta
+            - 0.1
+          * - result.gamma
+            - 0.01
+
+       - *(link to the page 2011-02-25-182001/)*
+
+     - *(image of 2011-02-25-182001/graph_1.png)*
+
+
+.. _examples/dictdiff:
+
+Example usages of :rst:dir:`dictdiff`
+-------------------------------------
+
+Basic example
+^^^^^^^^^^^^^
+
+.. sourcecode:: rst
+
+    .. dictdiff:: 2011-02-25-*/data.json
+       :base: my/experiment
+       :link: %(relpath)s
+
+
+.. list-table:: Diff of data found in:
+                ``my/experiment/2011-02-25-*/data.json``
+   :widths: 3 1 1 1 2 5
+   :header-rows: 1
+
+   * -
+     - seed
+     - alpha
+     - beta
+     - result.gamma
+     - link(s)
+   * - my/experiment/2011-02-25-182001/data.json
+     - 8906300472
+     - 1
+     - 0.1
+     - 0.01
+     - *(link to the page /my/experiment/2011-02-25-182001/)*
+   * - my/experiment/2011-02-25-182002/data.json
+     - 2634932505
+     - 2
+     - 0.2
+     - 0.02
+     - *(link to the page /my/experiment/2011-02-25-182001/)*
+   * - my/experiment/2011-02-25-182003/data.json
+     - 2510325972
+     - 3
+     - 0.3
+     - 0.03
+     - *(link to the page /my/experiment/2011-02-25-182003/)*
+
+
+Exclude data
+^^^^^^^^^^^^
+
+If you don't want to see ``seed`` in the data, you can exclude it
+using the ``:exclude:`` option.
+
+.. sourcecode:: rst
+
+    .. dictdiff:: 2011-02-25-*/data.json
+       :base: my/experiment
+       :link: %(relpath)s
+       :exclude: seed
+
+
+.. list-table:: Diff of data found in:
+                ``my/experiment/2011-02-25-*/data.json``
+   :widths: 3 1 1 2 5
+   :header-rows: 1
+
+   * -
+     - alpha
+     - beta
+     - result.gamma
+     - link(s)
+   * - my/experiment/2011-02-25-182001/data.json
+     - 1
+     - 0.1
+     - 0.01
+     - *(link to the page /my/experiment/2011-02-25-182001/)*
+   * - my/experiment/2011-02-25-182002/data.json
+     - 2
+     - 0.2
+     - 0.02
+     - *(link to the page /my/experiment/2011-02-25-182001/)*
+   * - my/experiment/2011-02-25-182003/data.json
+     - 3
+     - 0.3
+     - 0.03
+     - *(link to the page /my/experiment/2011-02-25-182003/)*
+
+
+.. _examples/grid-images:
+
+Example usages of :rst:dir:`grid-images`
+----------------------------------------
+
+Basic example
+^^^^^^^^^^^^^
+
+.. sourcecode:: rst
+
+    .. grid-images:: 2011-02-25-*[12]/data.json
+                     2011-02-26-*/data.json
+       :base: my/experiment
+       :image: graph_1.png
+       :param: alpha beta
+
+.. list-table:: Comparing images of data found in:
+                ``my/experiment{2011-02-25-*[12]/data.json, 2011-02-26-*/data.json}``
+   :widths: 1 5 5
+
+   * -
+     - **beta=0.1**
+     - **beta=0.2**
+   * - **alpha=1**
+     - *(image of 2011-02-25-182001/graph_1.png)*
+     - *(image of 2011-02-26-182001/graph_1.png)*
+   * - **alpha=2**
+     - *(image of 2011-02-26-182002/graph_1.png)*
+     - *(image of 2011-02-25-182002/graph_1.png)*
+
+
+.. _examples/find-images:
+
+Example usage of :rst:dir:`find-images`
+---------------------------------------
+
+.. sourcecode:: rst
+
+    .. find-images:: 2011-02-25-*/graph_1.png
+       :base: my/experiment
+
+will produce paragraphs like this:
+
+    my/experiment/2011-02-25-182001/graph_1.png
+
+    *(image of 2011-02-25-182001/graph_1.png)*
+
+    my/experiment/2011-02-25-182002/graph_1.png
+
+    *(image of 2011-02-25-182002/graph_1.png)*
+
+    my/experiment/2011-02-25-182003/graph_1.png
+
+    *(image of 2011-02-25-182003/graph_1.png)*
+
+
+.. _examples/template-page:
+
+Example usages of the template page
+===================================
+
+With the above data tree, you may want to generate the similar page
+when you access the page ``/my/experiment/...``.  For that purpose,
+you can make a :term:`template page` ``/my/experiment/_temp_`` with
+the following contents:
+
+.. sourcecode:: rst
+
+   Table data
+   ==========
+
+   .. table-data:: data.json
+      :base: my/experiment/{{ args[0] }}/
+      :data: *
+      :trans:
+      :widths: 1 9
+
+   Images
+   ======
+
+    .. find-images:: *.png
+       :base: my/experiment/{{ args[0] }}/
+
+This :term:`template page` generates the following page when you
+access to the page ``/my/experiment/2011-02-25-182001``.
+
+.. sourcecode:: rst
+
+   Table data
+   ==========
+
+   .. table-data:: data.json
+      :base: my/experiment/2011-02-25-182001/
+      :data: *
+      :trans:
+      :widths: 1 9
+
+   Images
+   ======
+
+    .. find-images:: *.png
+       :base: my/experiment/2011-02-25-182001/
+
+Note that ``{{ args[0] }}`` is replaced by ``2011-02-25-182001``.
+
+
+The above page can also be generated by the following template pages:
+
+.. sourcecode:: rst
+
+   .. an example using "relpath"
+
+   Table data
+   ==========
+
+   .. table-data:: data.json
+      :base: my/experiment/{{ relpath }}
+      :data: *
+      :trans:
+      :widths: 1 9
+
+   Images
+   ======
+
+    .. find-images:: *.png
+       :base: my/experiment/{{ relpath }}
+
+and
+
+.. sourcecode:: rst
+
+   .. an example using "path"
+
+   Table data
+   ==========
+
+   .. table-data:: data.json
+      :base: {{ path }}
+      :data: *
+      :trans:
+      :widths: 1 9
+
+   Images
+   ======
+
+    .. find-images:: *.png
+       :base: {{ path }}

File neorg-doc/_sources/index.txt

View file
+.. contents::
+
+=========================
+  NEOrg Reference Guide
+=========================
+
+
+.. _special-directives:
+
+Special directives
+==================
+
+A :term:`directive` is a general reST block markup.
+With the special directives defined by NEOrg, you can fetch data and
+images, show them effectively, and organize your notes.
+
+
+Show data in a table - :rst:dir:`table-data`
+--------------------------------------------
+
+.. rst:directive:: .. table-data:: path [path ...]
+
+   Search data file under the given list of `path` and show matched
+   data.
+   You can use :term:`Unix shell-style pattern matching`.
+
+   base : string (newlines removed)
+       This is an optional parameter to specify the directory
+       where the data files are searched from.
+       The data files will be searched from :envvar:`DATADIRPATH` if
+       not specified.
+
+       For example,
+
+       .. sourcecode:: rst
+
+           .. table-data:: 2011-02-*/data.json
+                           2011-03-*/data.json
+              :base: my/experiment
+
+       will search the files matches to
+       ``my/experiment/2011-02-*/data.json`` and
+       ``my/experiment/2011-03-*/data.json``.
+
+   data : text [, text, ...]
+       A comma- or space-separated list of the :term:`dictionary path`.
+       You can use :term:`Unix shell-style pattern matching`.
+
+   widths : integer [, integer...]
+       A comma- or space-separated list of relative column widths.
+
+   link : text [, text]
+       A comma- or space-separated list of path to the link(s).
+       Magic words ``%(path)s`` and ``%(relpath)s`` are available.
+
+       ``%(path)s``
+           This represents full path to the parent directory of the
+           data file.
+       ``%(relpath)s``
+           This is the relative path of the ``%(path)s`` from the
+           :term:`base` directory.
+
+   path-order : {'sort', 'sort_r'}
+       Sort the matched data paths.
+       ``sort`` will sort the paths in alphabetical order
+       and ``sort_r`` is the reversed version of ``sort``.
+       The default is ``'sort'``.
+       Note that
+
+       .. sourcecode:: rst
+
+           .. table-data:: 2011-02-*/data.json
+                           2011-03-*/data.json
+              :path-order: sort_r
+
+       does not makes ``2011-03-01/data.json`` higher than
+       ``2011-02-01/data.json``.  You will need to write
+
+       .. sourcecode:: rst
+
+           .. table-data:: 2011-03-*/data.json
+                           2011-02-*/data.json
+              :path-order: sort_r
+
+   trans : flag
+       Transpose the table.
+
+   .. seealso:: :ref:`examples/table-data`
+
+
+Show data and images in a table - :rst:dir:`table-data-and-image`
+-----------------------------------------------------------------
+
+.. rst:directive:: .. table-data-and-image:: path [path ...]
+
+   Search data under the given list of `path` and show matched data and
+   corresponding image(s).
+   You can use :term:`Unix shell-style pattern matching`.
+
+   base : string (newlines removed)
+       This is an optional parameter to specify the directory
+       where the data files are searched from.
+       See :rst:dir:`table-data` for the details.
+
+   data : text [, text, ...]
+       A comma- or space-separated list of the :term:`dictionary path`.
+       See :rst:dir:`table-data` for the details.
+
+   image : text [, text, ...]
+       A comma- or space-separated list of path to the images.
+       The path is the relative path from the parent directory of
+       the data file.
+
+   widths : integer [, integer...]
+       A comma- or space-separated list of relative column widths.
+       Note that the first column is data sub-table and the second and
+       the after are the images specified in `:image:`.
+
+   image-{OPTION} : integer:{VAL} [, integer:{VAL} ...]
+       `integer` is the index of the image.
+       `{VAL}` specifies the value of the `{OPTION}` of the
+       `image directive`_.
+
+   link : text [, text]
+       A comma- or space-separated list of path to the link(s).
+       See :rst:dir:`table-data` for the details.
+
+   path-order : {'sort', 'sort_r'}
+       Sort the matched data paths.
+       See :rst:dir:`table-data` for the details.
+
+   sort : text [, text]
+       A comma- or space-separated list of the :term:`dictionary path`.
+       The table will be sorted by values of the keys.
+
+   .. seealso:: :ref:`examples/table-data-and-image`
+
+.. _`image directive`:
+   http://docutils.sourceforge.net/docs/ref/rst/directives.html#image
+
+
+See the difference of data - :rst:dir:`dictdiff`
+------------------------------------------------
+
+.. rst:directive:: .. dictdiff:: path [path ...]
+
+   Search data under the given list of `path` and show the difference
+   of the data.
+   You can use :term:`Unix shell-style pattern matching`.
+
+   base : string (newlines removed)
+       This is an optional parameter to specify the directory
+       where the data files are searched from.
+       See :rst:dir:`table-data` for the details.
+
+   link : text [, text]
+       A comma- or space-separated list of path to the link(s).
+       See :rst:dir:`table-data` for the details.
+
+   include : text [, text]
+       A comma- or space-separated list of :term:`regular expression`
+       of the :term:`dictionary path` to include.
+
+   exclude : text [, text]
+       A comma- or space-separated list of :term:`regular expression`
+       of the :term:`dictionary path` to exclude.
+
+   path-order : {'sort', 'sort_r'}
+       Sort the matched data paths.
+       See :rst:dir:`table-data` for the details.
+
+   trans : flag
+       Transpose the table.
+
+   .. seealso:: :ref:`examples/dictdiff`
+
+
+Show effects of the parameter change - :rst:dir:`grid-images`
+-------------------------------------------------------------
+
+.. rst:directive:: .. grid-images:: path [path ...]
+
+   Search data and show the images related to the data on "**grid**".
+   You can use :term:`Unix shell-style pattern matching`.
+
+   In experiments, you may change parameters systematically
+   to see what will happen.  For example, when you do experiments
+   varying two parameters *a=1, 2, 3* and *b=0.1, 0.2, 0.3*,
+   you will get 9 results.  Viewing the results in a linear list is
+   a bad idea: you should see it in a 3x3 matrix like this!:
+
+   .. list-table::
+      :widths: 1 5 5 5
+
+      * -
+        - **b=0.1**
+        - **b=0.2**
+        - **b=0.3**
+      * - **a=1**
+        - result with *a=1* and *b=0.1*
+        - result with *a=1* and *b=0.2*
+        - result with *a=1* and *b=0.3*
+      * - **a=2**
+        - result with *a=2* and *b=0.1*
+        - result with *a=2* and *b=0.2*
+        - result with *a=2* and *b=0.3*
+      * - **a=3**
+        - result with *a=3* and *b=0.1*
+        - result with *a=3* and *b=0.2*
+        - result with *a=3* and *b=0.3*
+
+   The grid is a N-dimensional version of this matrix.
+   To see it in 2D display (because we don't have N-dim display),
+   NEOrg generates the nested table.
+
+   base : string (newlines removed)
+       The base path for searching data. Real path to be used
+       This is an optional parameter to specify the directory
+       where the data files are searched from.
+       See :rst:dir:`table-data` for the details.
+
+   param : text [, text]
+       A comma- or space-separated list of the :term:`dictionary path`
+       for the axes of the grid.
+
+   image : text [, text]
+       A comma- or space-separated list of path to the images.
+       The path is the relative path from the parent directory of
+       the data file.
+
+   .. seealso:: :ref:`examples/grid-images`
+
+
+Find images - :rst:dir:`find-images`
+------------------------------------
+
+.. rst:directive:: .. find-images:: path [path ...]
+
+   Search images under the given list of `path` and show matched images.
+   You can use :term:`Unix shell-style pattern matching`.
+
+   base : string (newlines removed)
+       This is an optional parameter to specify the directory
+       where the data files are searched from.
+       See :rst:dir:`table-data` for the details.
+
+   .. seealso:: :ref:`examples/find-images`
+
+
+List Pages - :rst:dir:`list-pages`
+----------------------------------
+
+.. rst:directive:: .. list-pages::
+
+   Insert list of sub-pages.
+
+
+.. _template-page:
+
+Template page - ``_temp_``
+==========================
+
+When you do experiments repeatedly, you may want to see the results
+in a fixed format.  The template page can be used for that purpose.
+
+The page which has ``_temp_`` in its :term:`page path` is a
+:term:`template page`.
+The template page is used for generating page.
+If the page path does not exist but the template page which matches to
+the page path exists, generated page will be shown.
+
+Examples of the template :term:`page path`:
+
+    (a) ``/my/page/_temp_/``
+    (b) ``/my/page/_temp_/_temp_/``
+    (c) ``/my/page/_temp_/images/``
+    (d) ``/my/page/_temp_/subdata/_temp_/``
+    (e) ``/my/page/_temp_/_temp_/subdata``
+
+    * ``/my/page/2011-05-21/`` matches to (a)
+    * ``/my/page/2011-05-21/some-data/`` matches to (b)
+    * ``/my/page/2011-05-21/images/`` matches to (c)
+    * ``/my/page/2011-05-21/subdata/000/`` matches to (d)
+    * ``/my/page/2011-05-21/000/subdata/`` matches to (e)
+    * ``/my/page/2011-05-21/subdata/subdata/`` matches to (e)
+
+
+``{{ args[N] }}`` (where ``N`` is an integer)
+    N-th replacement of the ``_temp_`` in the URL.
+    For example, at the page ``/my/page/2011-05-21/subdata/000/``
+    in the above example, ``{{ args[0] }}`` and ``{{ args[1] }}``
+    will be replaced by ``2011-05-21`` and ``000``.
+
+``{{ path }}``
+    This will be replaced by the full path to this directory.
+
+``{{ relpath }}``
+    This will be replaced by the relative path from the parent page of
+    the leftmost ``_temp_`` page.
+
+.. seealso:: :ref:`examples/template-page`
+
+
+Glossary
+========
+
+.. glossary::
+
+   directive
+       A directive is one of the reST block markup in the following
+       shape:
+
+       .. sourcecode:: rst
+
+          .. directive-name:: argument(s)
+             :option: parameter
+             :another_option: another_parameter
+
+             some contents
+
+       See `reStructuredText Directives`_ for more information and
+       the basic directives defined by docutils.
+
+       NEOrg defines varikous special for displaying and organizing
+       data effectively (see :ref:`special-directives`).
+
+   page path
+       The page path is the URL to the page.
+
+   unix shell-style pattern matching
+       Unix shell-style pattern matching supports the following
+       wild-cards.
+
+       +------------+------------------------------------+
+       | Pattern    | Meaning                            |
+       +============+====================================+
+       | ``*``      | matches everything                 |
+       +------------+------------------------------------+
+       | ``?``      | matches any single character       |
+       +------------+------------------------------------+
+       | ``[seq]``  | matches any character in *seq*     |
+       +------------+------------------------------------+
+       | ``[!seq]`` | matches any character not in *seq* |
+       +------------+------------------------------------+
+
+   ``base``
+       This is the optional parameter for the directives which searches
+       the data files.
+       See :rst:dir:`table-data` for the details.
+
+   ``link``
+       This is the optional parameter for the directives which generates
+       the links to the other pages.
+       See :rst:dir:`table-data` for the details.
+
+   magic words
+       Magic words are the special words which are replaced by NEOrg.
+
+       Magic words ``%(path)s`` and ``%(relpath)s`` are available
+       in the :term:`link` parameter.
+
+       Magic words ``%(root)s`` and ``%(neorg)s`` are available in the
+       configuration file for the variables :envvar:`DATADIRPATH` and
+       :envvar:`DATABASE`.
+
+   dictionary path
+       To specify the value in the nested dictionary, NEOrg uses
+       period-separated keys.  For example, the values in the
+       following nested dictionary can be accessed by the
+       "dictionary path" such as ``'key1.nestedkey1'``.
+
+       .. sourcecode:: js
+
+          {'key1': {
+               'nestedkey1': 1,
+               'nestedkey2': 2
+           }
+           'key2': 2
+          }
+
+   regular expression
+       NEOrg uses python regular expression to filtering out/in
+       :term:`dictionary path`.
+
+       See `Regular Expression Syntax --- Python documentation`_ for
+       more information about the regular expression syntax.
+
+   template page
+       A template page is the page which has at least one ``_temp_``
+       in its :term:`page path`.
+       See also :ref:`template-page`.
+
+   debug mode
+       In debug mode, python interactive shell will be invoked in your
+       browser when NEOrg clashes.
+       See `Debugging Applications -- Werkzeug documentation`_ and
+       `Debug Mode --- Flask documentation`_  for more information.
+
+       .. warning::
+
+          If someone can access to
+          NEOrg running in debug mode, he can do anything your python
+          can do, such as deleting files.  Thus, **debug mode should
+          not be used on an untrusted network.**
+
+.. _`Regular Expression Syntax --- Python documentation`:
+   http://docs.python.org/library/re.html#re-syntax
+.. _`Debugging Applications -- Werkzeug documentation`:
+   http://werkzeug.pocoo.org/docs/debug/
+.. _`Debug Mode --- Flask documentation`:
+   http://flask.pocoo.org/docs/quickstart/#debug-mode
+
+
+Configuration variables
+=======================
+
+.. envvar:: DATADIRPATH
+
+   Path to your data directory.
+   :term:`Magic words` ``%(root)s`` and ``%(neorg)s`` are available.
+   The string ``~`` will be replaced by the user's home directory.
+   Also, the environment variables are available.  For example, you
+   can also use ``$HOME`` or ``${HOME}`` to specify your home directory.
+   The default is ``%(root)s``.
+
+   ``%(root)s``
+       The directory you specified by ``neorg init`` command.
+       If you did not specify, this is the directory where you ran
+       ``neorg init`` command.
+
+   ``%(neorg)s``
+       This is equivalent to ``%(root)s/.neorg/``.
+
+.. envvar:: DATABASE
+
+   The path to the sqlite data base file.
+   :term:`Magic words` ``%(root)s`` and ``%(neorg)s``,
+   special character ``~``, and the environment variables are available.
+   The default is ``'%(neorg)s/neorg.db'``.
+
+.. envvar:: DEBUG
+
+   If it is set to ``True``, ``neorg serve`` runs in :term:`debug mode`
+   always.
+
+
+FAQs
+====
+
+How do I make a new page?
+-------------------------
+
+Just type a page path to the browser's address bar, e.g.::
+
+    http://localhost:8000/my/new/page/
+
+and then you will see the edit form, if the page does not exist.
+
+
+Docuitils links
+===============
+
+- `Docutils Project Documentation Overview`_
+
+  - `reStructuredText`_
+
+    - `A ReStructuredText Primer`_
+    - `Quick reStructuredText`_
+    - `reStructuredText Cheat Sheet (text only)`_
+    - `reStructuredText Demonstration`_
+    - `reStructuredText Markup Specification`_
+    - `reStructuredText Directives`_
+    - `reStructuredText Interpreted Text Roles`_
+
+
+.. _`Docutils Project Documentation Overview`:
+   http://docutils.sourceforge.net/docs/
+
+.. _`reStructuredText`:
+   http://docutils.sourceforge.net/rst.html
+
+.. _`A ReStructuredText Primer`:
+   http://docutils.sourceforge.net/docs/user/rst/quickstart.html
+.. _`Quick reStructuredText`:
+   http://docutils.sourceforge.net/docs/user/rst/quickref.html
+.. _`reStructuredText Cheat Sheet (text only)`:
+   http://docutils.sourceforge.net/docs/user/rst/cheatsheet.txt
+.. _`reStructuredText Demonstration`:
+   http://docutils.sourceforge.net/docs/user/rst/demo.html
+.. _`reStructuredText Markup Specification`:
+   http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
+.. _`reStructuredText Interpreted Text Roles`:
+   http://docutils.sourceforge.net/docs/ref/rst/roles.html
+.. _`reStructuredText Directives`:
+   http://docutils.sourceforge.net/docs/ref/rst/directives.html
+
+
+Other contents
+==============
+
+.. toctree::
+   :maxdepth: 1
+
+   examples
+   commands

File neorg-doc/_static/alert_info_32.png

Added
New image

File neorg-doc/_static/alert_warning_32.png

Added
New image

File neorg-doc/_static/basic.css

View file
+/*
+ * basic.css
+ * ~~~~~~~~~
+ *
+ * Sphinx stylesheet -- basic theme.
+ *
+ * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+/* -- main layout ----------------------------------------------------------- */
+
+div.clearer {
+    clear: both;
+}
+
+/* -- relbar ---------------------------------------------------------------- */
+
+div.related {
+    width: 100%;
+    font-size: 90%;
+}
+
+div.related h3 {
+    display: none;
+}
+
+div.related ul {
+    margin: 0;
+    padding: 0 0 0 10px;
+    list-style: none;
+}
+
+div.related li {
+    display: inline;
+}
+
+div.related li.right {
+    float: right;
+    margin-right: 5px;
+}
+
+/* -- sidebar --------------------------------------------------------------- */
+
+div.sphinxsidebarwrapper {
+    padding: 10px 5px 0 10px;
+}
+
+div.sphinxsidebar {
+    float: left;
+    width: 230px;
+    margin-left: -100%;
+    font-size: 90%;
+}
+
+div.sphinxsidebar ul {
+    list-style: none;
+}
+
+div.sphinxsidebar ul ul,
+div.sphinxsidebar ul.want-points {
+    margin-left: 20px;
+    list-style: square;
+}
+
+div.sphinxsidebar ul ul {
+    margin-top: 0;
+    margin-bottom: 0;
+}
+
+div.sphinxsidebar form {
+    margin-top: 10px;
+}
+
+div.sphinxsidebar input {
+    border: 1px solid #98dbcc;
+    font-family: sans-serif;
+    font-size: 1em;
+}
+
+img {
+    border: 0;
+}
+
+/* -- search page ----------------------------------------------------------- */
+
+ul.search {
+    margin: 10px 0 0 20px;
+    padding: 0;
+}
+
+ul.search li {
+    padding: 5px 0 5px 20px;
+    background-image: url(file.png);
+    background-repeat: no-repeat;
+    background-position: 0 7px;
+}
+
+ul.search li a {
+    font-weight: bold;
+}
+
+ul.search li div.context {
+    color: #888;
+    margin: 2px 0 0 30px;
+    text-align: left;
+}
+
+ul.keywordmatches li.goodmatch a {
+    font-weight: bold;
+}
+
+/* -- index page ------------------------------------------------------------ */
+
+table.contentstable {
+    width: 90%;
+}
+
+table.contentstable p.biglink {
+    line-height: 150%;
+}
+
+a.biglink {
+    font-size: 1.3em;
+}
+
+span.linkdescr {
+    font-style: italic;
+    padding-top: 5px;
+    font-size: 90%;
+}
+
+/* -- general index --------------------------------------------------------- */
+
+table.indextable {
+    width: 100%;
+}
+
+table.indextable td {
+    text-align: left;
+    vertical-align: top;
+}
+
+table.indextable dl, table.indextable dd {
+    margin-top: 0;
+    margin-bottom: 0;
+}
+
+table.indextable tr.pcap {
+    height: 10px;
+}
+
+table.indextable tr.cap {
+    margin-top: 10px;
+    background-color: #f2f2f2;
+}
+
+img.toggler {
+    margin-right: 3px;
+    margin-top: 3px;
+    cursor: pointer;
+}
+
+div.modindex-jumpbox {
+    border-top: 1px solid #ddd;
+    border-bottom: 1px solid #ddd;
+    margin: 1em 0 1em 0;
+    padding: 0.4em;
+}
+
+div.genindex-jumpbox {
+    border-top: 1px solid #ddd;
+    border-bottom: 1px solid #ddd;
+    margin: 1em 0 1em 0;
+    padding: 0.4em;
+}
+
+/* -- general body styles --------------------------------------------------- */
+
+a.headerlink {
+    visibility: hidden;
+}
+
+h1:hover > a.headerlink,
+h2:hover > a.headerlink,
+h3:hover > a.headerlink,
+h4:hover > a.headerlink,
+h5:hover > a.headerlink,
+h6:hover > a.headerlink,
+dt:hover > a.headerlink {
+    visibility: visible;
+}
+
+div.body p.caption {
+    text-align: inherit;
+}
+
+div.body td {
+    text-align: left;
+}
+
+.field-list ul {
+    padding-left: 1em;
+}
+
+.first {
+    margin-top: 0 !important;
+}
+
+p.rubric {
+    margin-top: 30px;
+    font-weight: bold;
+}
+
+img.align-left, .figure.align-left, object.align-left {
+    clear: left;
+    float: left;
+    margin-right: 1em;
+}
+
+img.align-right, .figure.align-right, object.align-right {
+    clear: right;
+    float: right;
+    margin-left: 1em;
+}
+
+img.align-center, .figure.align-center, object.align-center {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+.align-left {
+    text-align: left;
+}
+
+.align-center {
+    clear: both;
+    text-align: center;
+}
+
+.align-right {
+    text-align: right;
+}
+
+/* -- sidebars -------------------------------------------------------------- */
+
+div.sidebar {
+    margin: 0 0 0.5em 1em;
+    border: 1px solid #ddb;
+    padding: 7px 7px 0 7px;
+    background-color: #ffe;
+    width: 40%;
+    float: right;
+}
+
+p.sidebar-title {
+    font-weight: bold;
+}
+
+/* -- topics ---------------------------------------------------------------- */
+
+div.topic {
+    border: 1px solid #ccc;
+    padding: 7px 7px 0 7px;
+    margin: 10px 0 10px 0;
+}
+
+p.topic-title {
+    font-size: 1.1em;
+    font-weight: bold;
+    margin-top: 10px;
+}
+
+/* -- admonitions ----------------------------------------------------------- */
+
+div.admonition {
+    margin-top: 10px;
+    margin-bottom: 10px;
+    padding: 7px;
+}
+
+div.admonition dt {
+    font-weight: bold;
+}
+
+div.admonition dl {
+    margin-bottom: 0;
+}
+
+p.admonition-title {
+    margin: 0px 10px 5px 0px;
+    font-weight: bold;
+}
+
+div.body p.centered {
+    text-align: center;
+    margin-top: 25px;
+}
+
+/* -- tables ---------------------------------------------------------------- */
+
+table.docutils {
+    border: 0;
+    border-collapse: collapse;
+}
+
+table.docutils td, table.docutils th {
+    padding: 1px 8px 1px 5px;
+    border-top: 0;
+    border-left: 0;
+    border-right: 0;
+    border-bottom: 1px solid #aaa;
+}
+
+table.field-list td, table.field-list th {
+    border: 0 !important;
+}
+
+table.footnote td, table.footnote th {
+    border: 0 !important;
+}
+
+th {
+    text-align: left;
+    padding-right: 5px;
+}
+
+table.citation {
+    border-left: solid 1px gray;
+    margin-left: 1px;
+}
+
+table.citation td {
+    border-bottom: none;
+}
+
+/* -- other body styles ----------------------------------------------------- */
+
+ol.arabic {
+    list-style: decimal;
+}
+
+ol.loweralpha {
+    list-style: lower-alpha;
+}
+
+ol.upperalpha {
+    list-style: upper-alpha;
+}
+
+ol.lowerroman {
+    list-style: lower-roman;
+}
+
+ol.upperroman {
+    list-style: upper-roman;
+}
+
+dl {
+    margin-bottom: 15px;
+}
+
+dd p {
+    margin-top: 0px;
+}
+
+dd ul, dd table {
+    margin-bottom: 10px;
+}
+
+dd {
+    margin-top: 3px;
+    margin-bottom: 10px;
+    margin-left: 30px;
+}
+
+dt:target, .highlighted {
+    background-color: #fbe54e;
+}
+
+dl.glossary dt {
+    font-weight: bold;
+    font-size: 1.1em;
+}
+
+.field-list ul {
+    margin: 0;
+    padding-left: 1em;
+}
+
+.field-list p {
+    margin: 0;
+}
+
+.refcount {
+    color: #060;
+}
+
+.optional {
+    font-size: 1.3em;
+}
+
+.versionmodified {
+    font-style: italic;
+}
+
+.system-message {
+    background-color: #fda;
+    padding: 5px;
+    border: 3px solid red;
+}
+
+.footnote:target  {
+    background-color: #ffa;
+}
+
+.line-block {
+    display: block;
+    margin-top: 1em;
+    margin-bottom: 1em;
+}
+
+.line-block .line-block {
+    margin-top: 0;
+    margin-bottom: 0;
+    margin-left: 1.5em;
+}
+
+.guilabel, .menuselection {
+    font-family: sans-serif;
+}
+
+.accelerator {
+    text-decoration: underline;
+}
+
+.classifier {
+    font-style: oblique;
+}
+
+/* -- code displays --------------------------------------------------------- */
+
+pre {
+    overflow: auto;
+    overflow-y: hidden;  /* fixes display issues on Chrome browsers */
+}
+
+td.linenos pre {
+    padding: 5px 0px;
+    border: 0;
+    background-color: transparent;
+    color: #aaa;
+}
+
+table.highlighttable {
+    margin-left: 0.5em;
+}
+
+table.highlighttable td {
+    padding: 0 0.5em 0 0.5em;
+}
+
+tt.descname {
+    background-color: transparent;
+    font-weight: bold;
+    font-size: 1.2em;
+}
+
+tt.descclassname {
+    background-color: transparent;
+}
+
+tt.xref, a tt {
+    background-color: transparent;
+    font-weight: bold;
+}
+
+h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
+    background-color: transparent;
+}
+
+.viewcode-link {
+    float: right;
+}
+
+.viewcode-back {
+    float: right;
+    font-family: sans-serif;
+}
+
+div.viewcode-block:target {
+    margin: -1px -10px;
+    padding: 0 10px;
+}
+
+/* -- math display ---------------------------------------------------------- */
+
+img.math {
+    vertical-align: middle;
+}
+
+div.body div.math p {
+    text-align: center;
+}
+
+span.eqno {
+    float: right;
+}
+
+/* -- printout stylesheet --------------------------------------------------- */
+
+@media print {
+    div.document,
+    div.documentwrapper,
+    div.bodywrapper {
+        margin: 0 !important;
+        width: 100%;
+    }
+
+    div.sphinxsidebar,
+    div.related,
+    div.footer,
+    #top-link {
+        display: none;
+    }
+}

File neorg-doc/_static/bg-page.png

Added
New image

File neorg-doc/_static/bullet_orange.png

Added
New image

File neorg-doc/_static/doctools.js

View file
+/*
+ * doctools.js
+ * ~~~~~~~~~~~
+ *
+ * Sphinx JavaScript utilties for all documentation.
+ *
+ * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+/**
+ * select a different prefix for underscore
+ */
+$u = _.noConflict();
+
+/**
+ * make the code below compatible with browsers without
+ * an installed firebug like debugger
+if (!window.console || !console.firebug) {
+  var names = ["log", "debug", "info", "warn", "error", "assert", "dir",
+    "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace",
+    "profile", "profileEnd"];
+  window.console = {};
+  for (var i = 0; i < names.length; ++i)
+    window.console[names[i]] = function() {};
+}
+ */
+
+/**
+ * small helper function to urldecode strings
+ */
+jQuery.urldecode = function(x) {
+  return decodeURIComponent(x).replace(/\+/g, ' ');
+}
+
+/**
+ * small helper function to urlencode strings
+ */
+jQuery.urlencode = encodeURIComponent;
+
+/**
+ * This function returns the parsed url parameters of the
+ * current request. Multiple values per key are supported,
+ * it will always return arrays of strings for the value parts.
+ */
+jQuery.getQueryParameters = function(s) {
+  if (typeof s == 'undefined')
+    s = document.location.search;
+  var parts = s.substr(s.indexOf('?') + 1).split('&');
+  var result = {};
+  for (var i = 0; i < parts.length; i++) {
+    var tmp = parts[i].split('=', 2);
+    var key = jQuery.urldecode(tmp[0]);
+    var value = jQuery.urldecode(tmp[1]);
+    if (key in result)
+      result[key].push(value);
+    else
+      result[key] = [value];
+  }
+  return result;
+};
+
+/**
+ * small function to check if an array contains
+ * a given item.
+ */
+jQuery.contains = function(arr, item) {
+  for (var i = 0; i < arr.length; i++) {
+    if (arr[i] == item)
+      return true;
+  }
+  return false;
+};
+
+/**
+ * highlight a given string on a jquery object by wrapping it in
+ * span elements with the given class name.
+ */
+jQuery.fn.highlightText = function(text, className) {
+  function highlight(node) {
+    if (node.nodeType == 3) {
+      var val = node.nodeValue;
+      var pos = val.toLowerCase().indexOf(text);
+      if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) {
+        var span = document.createElement("span");
+        span.className = className;
+        span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+        node.parentNode.insertBefore(span, node.parentNode.insertBefore(
+          document.createTextNode(val.substr(pos + text.length)),
+          node.nextSibling));
+        node.nodeValue = val.substr(0, pos);
+      }
+    }
+    else if (!jQuery(node).is("button, select, textarea")) {
+      jQuery.each(node.childNodes, function() {
+        highlight(this);
+      });
+    }
+  }
+  return this.each(function() {
+    highlight(this);
+  });
+};
+
+/**
+ * Small JavaScript module for the documentation.
+ */
+var Documentation = {
+
+  init : function() {
+    this.fixFirefoxAnchorBug();
+    this.highlightSearchWords();
+    this.initIndexTable();
+  },
+
+  /**
+   * i18n support
+   */
+  TRANSLATIONS : {},
+  PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; },
+  LOCALE : 'unknown',
+
+  // gettext and ngettext don't access this so that the functions
+  // can safely bound to a different name (_ = Documentation.gettext)
+  gettext : function(string) {
+    var translated = Documentation.TRANSLATIONS[string];
+    if (typeof translated == 'undefined')
+      return string;
+    return (typeof translated == 'string') ? translated : translated[0];
+  },
+
+  ngettext : function(singular, plural, n) {
+    var translated = Documentation.TRANSLATIONS[singular];
+    if (typeof translated == 'undefined')
+      return (n == 1) ? singular : plural;
+    return translated[Documentation.PLURALEXPR(n)];
+  },
+
+  addTranslations : function(catalog) {
+    for (var key in catalog.messages)
+      this.TRANSLATIONS[key] = catalog.messages[key];
+    this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
+    this.LOCALE = catalog.locale;
+  },
+
+  /**
+   * add context elements like header anchor links
+   */
+  addContextElements : function() {
+    $('div[id] > :header:first').each(function() {
+      $('<a class="headerlink">\u00B6</a>').
+      attr('href', '#' + this.id).
+      attr('title', _('Permalink to this headline')).
+      appendTo(this);
+    });
+    $('dt[id]').each(function() {
+      $('<a class="headerlink">\u00B6</a>').
+      attr('href', '#' + this.id).
+      attr('title', _('Permalink to this definition')).
+      appendTo(this);
+    });
+  },
+
+  /**
+   * workaround a firefox stupidity
+   */
+  fixFirefoxAnchorBug : function() {
+    if (document.location.hash && $.browser.mozilla)
+      window.setTimeout(function() {
+        document.location.href += '';
+      }, 10);
+  },
+
+  /**
+   * highlight the search words provided in the url in the text
+   */
+  highlightSearchWords : function() {
+    var params = $.getQueryParameters();
+    var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
+    if (terms.length) {
+      var body = $('div.body');
+      window.setTimeout(function() {
+        $.each(terms, function() {
+          body.highlightText(this.toLowerCase(), 'highlighted');
+        });
+      }, 10);
+      $('<li class="highlight-link"><a href="javascript:Documentation.' +
+        'hideSearchWords()">' + _('Hide Search Matches') + '</a></li>')
+          .appendTo($('.sidebar .this-page-menu'));
+    }
+  },
+
+  /**
+   * init the domain index toggle buttons
+   */
+  initIndexTable : function() {
+    var togglers = $('img.toggler').click(function() {
+      var src = $(this).attr('src');
+      var idnum = $(this).attr('id').substr(7);
+      $('tr.cg-' + idnum).toggle();
+      if (src.substr(-9) == 'minus.png')
+        $(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
+      else
+        $(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
+    }).css('display', '');
+    if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) {
+        togglers.click();
+    }
+  },
+
+  /**
+   * helper function to hide the search marks again
+   */
+  hideSearchWords : function() {
+    $('.sidebar .this-page-menu li.highlight-link').fadeOut(300);
+    $('span.highlighted').removeClass('highlighted');
+  },
+
+  /**
+   * make the url absolute
+   */
+  makeURL : function(relativeURL) {
+    return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
+  },
+
+  /**
+   * get the current relative url
+   */
+  getCurrentURL : function() {
+    var path = document.location.pathname;
+    var parts = path.split(/\//);
+    $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
+      if (this == '..')
+        parts.pop();
+    });
+    var url = parts.join('/');
+    return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
+  }
+};
+
+// quick alias for translations
+_ = Documentation.gettext;
+
+$(document).ready(function() {
+  Documentation.init();
+});

File neorg-doc/_static/file.png

Added
New image

File neorg-doc/_static/haiku.css

View file
+/*
+ * haiku.css_t
+ * ~~~~~~~~~~~
+ *
+ * Sphinx stylesheet -- haiku theme.
+ *
+ * Adapted from http://haiku-os.org/docs/Haiku-doc.css.
+ * Original copyright message:
+ *
+ *     Copyright 2008-2009, Haiku. All rights reserved.
+ *     Distributed under the terms of the MIT License.
+ *
+ *     Authors:
+ *              Francois Revol <revol@free.fr>
+ *              Stephan Assmus <superstippi@gmx.de>
+ *              Braden Ewing <brewin@gmail.com>
+ *              Humdinger <humdingerb@gmail.com>
+ *
+ * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+@import url("basic.css");
+
+html {
+    margin: 0px;
+    padding: 0px;
+    background: #FFF url(bg-page.png) top left repeat-x;
+}
+
+body {
+    line-height: 1.5;
+    margin: auto;
+    padding: 0px;
+    font-family: "DejaVu Sans", Arial, Helvetica, sans-serif;
+    min-width: 59em;
+    max-width: 70em;
+    color: #333333;
+}
+
+div.footer {
+    padding: 8px;
+    font-size: 11px;
+    text-align: center;
+    letter-spacing: 0.5px;
+}
+
+/* link colors and text decoration */
+
+a:link {
+    font-weight: bold;
+    text-decoration: none;
+    color: #dc3c01;
+}
+
+a:visited {
+    font-weight: bold;
+    text-decoration: none;
+    color: #892601;
+}
+
+a:hover, a:active {
+    text-decoration: underline;
+    color: #ff4500;
+}
+
+/* Some headers act as anchors, don't give them a hover effect */
+
+h1 a:hover, a:active {
+    text-decoration: none;
+    color: #0c3762;
+}
+
+h2 a:hover, a:active {
+    text-decoration: none;
+    color: #0c3762;
+}
+
+h3 a:hover, a:active {
+    text-decoration: none;
+    color: #0c3762;
+}
+
+h4 a:hover, a:active {
+    text-decoration: none;
+    color: #0c3762;
+}
+
+a.headerlink {
+    color: #a7ce38;
+    padding-left: 5px;
+}
+
+a.headerlink:hover {
+    color: #a7ce38;
+}
+
+/* basic text elements */
+
+div.content {
+    margin-top: 20px;
+    margin-left: 40px;
+    margin-right: 40px;
+    margin-bottom: 50px;
+    font-size: 0.9em;
+}
+
+/* heading and navigation */
+
+div.header {
+    position: relative;
+    left: 0px;
+    top: 0px;
+    height: 85px;
+    /* background: #eeeeee; */
+    padding: 0 40px;
+}
+div.header h1 {
+    font-size: 1.6em;
+    font-weight: normal;
+    letter-spacing: 1px;
+    color: #0c3762;
+    border: 0;
+    margin: 0;
+    padding-top: 15px;
+}
+div.header h1 a {
+    font-weight: normal;
+    color: #0c3762;
+}
+div.header h2 {
+    font-size: 1.3em;
+    font-weight: normal;
+    letter-spacing: 1px;
+    text-transform: uppercase;
+    color: #aaa;
+    border: 0;
+    margin-top: -3px;
+    padding: 0;
+}
+
+div.header img.rightlogo {
+    float: right;
+}
+
+
+div.title {
+    font-size: 1.3em;
+    font-weight: bold;
+    color: #0c3762;
+    border-bottom: dotted thin #e0e0e0;
+    margin-bottom: 25px;
+}
+div.topnav {
+    /* background: #e0e0e0; */
+}
+div.topnav p {
+    margin-top: 0;
+    margin-left: 40px;
+    margin-right: 40px;
+    margin-bottom: 0px;
+    text-align: right;
+    font-size: 0.8em;
+}
+div.bottomnav {
+    background: #eeeeee;
+}
+div.bottomnav p {
+    margin-right: 40px;
+    text-align: right;
+    font-size: 0.8em;
+}
+
+a.uplink {
+    font-weight: normal;
+}
+
+
+/* contents box */
+
+table.index {
+    margin: 0px 0px 30px 30px;
+    padding: 1px;
+    border-width: 1px;
+    border-style: dotted;
+    border-color: #e0e0e0;
+}
+table.index tr.heading {
+    background-color: #e0e0e0;
+    text-align: center;
+    font-weight: bold;
+    font-size: 1.1em;
+}
+table.index tr.index {
+    background-color: #eeeeee;
+}
+table.index td {
+    padding: 5px 20px;
+}
+
+table.index a:link, table.index a:visited {
+    font-weight: normal;
+    text-decoration: none;
+    color: #dc3c01;
+}
+table.index a:hover, table.index a:active {
+    text-decoration: underline;
+    color: #ff4500;
+}
+
+
+/* Haiku User Guide styles and layout */