Show data in a table - table-data¶

.. table-data:: path [path ...]¶

Search data file under the given list of path and show matched data. You can use 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 DATADIRPATH if not specified.

For example,

.. table-data:: 2011-02-*/data.json
                2011-03-*/data.json
   :base: my/experiment

will search the files which match to my/experiment/2011-02-*/data.json or my/experiment/2011-03-*/data.json.

file : string (newlines removed)

This is an optional parameter to specify the name of the data file. If the tailing parts of the arguments are the you can specify it using this option.

For example,

.. table-data:: 2011-02-* 2011-03-*
   :file: data.json
   :base: my/experiment

will search the files which matche to my/experiment/2011-02-*/data.json or my/experiment/2011-03-*/data.json.

data : text [, text, ...]

A comma- or space-separated list of the dictionary path. You can use 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 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

.. 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

.. table-data:: 2011-03-*/data.json
                2011-02-*/data.json
   :path-order: sort_r

trans : flag

Transpose the table.

ftype-{TYPE} : text [, text]

A comma- or space-separated list of unix shell-style pattern matching to be matched the path of data file where {TYPE} is a file type. Currently supported file types are: pickle, python, yaml and json. This is used for loading data file with unusual extension, e.g.:

.. table-data:: */data.txt
   :ftype-json: *.txt

See also

Example usages of table-data

Show data and images in a table - table-data-and-image¶

.. 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 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 table-data for the details.

file : string (newlines removed)

Specifies the tailing part of the directory where the data files are searched from. See table-data for the details.

data : text [, text, ...]

A comma- or space-separated list of the dictionary path. See 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 table-data for the details.

path-order : {‘sort’, ‘sort_r’}

Sort the matched data paths. See table-data for the details.

sort : text [, text]

A comma- or space-separated list of the dictionary path. The table will be sorted by values of the keys.

ftype-{TYPE} : text [, text]

Load data file with unusual extension. See table-data for the details.

See also

Example usages of table-data-and-image

See the difference of data - dictdiff¶

.. dictdiff:: path [path ...]¶

Search data under the given list of path and show the difference of the data. You can use 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 table-data for the details.

file : string (newlines removed)

Specifies the tailing part of the directory where the data files are searched from. See table-data for the details.

link : text [, text]

A comma- or space-separated list of path to the link(s). See table-data for the details.

include : text [, text]

A comma- or space-separated list of regular expression of the dictionary path to include.

exclude : text [, text]

A comma- or space-separated list of regular expression of the dictionary path to exclude.

path-order : {‘sort’, ‘sort_r’}

Sort the matched data paths. See table-data for the details.

trans : flag

Transpose the table.

ftype-{TYPE} : text [, text]

Load data file with unusual extension. See table-data for the details.

See also

Example usages of dictdiff

Show effects of the parameter change - grid-images¶

.. grid-images:: path [path ...]¶

Search data and show the images related to the data on “grid”. You can use 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!:

	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 table-data for the details.

file : string (newlines removed)

Specifies the tailing part of the directory where the data files are searched from. See table-data for the details.

param : text [, text]

A comma- or space-separated list of the 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.

link : text

A URL to specify the link to a page related to the found data file. Note that unlike the link option of table-data, only one link is supported. See table-data for the details.

See also

Example usages of grid-images

Find images - find-images¶

.. find-images:: path [path ...]¶

Search images under the given list of path and show matched images. You can use 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 table-data for the details.

file : string (newlines removed)

Specifies the tailing part of the directory where the data files are searched from. See table-data for the details.

See also

Example usage of find-images

List Pages - list-pages¶

.. list-pages:: ¶

Insert list of sub-pages.

Recently Updated Sub-pages - recent-pages¶

.. recent-pages:: ¶

Insert list of recently updated sub-pages.

num : int

Number of pages to show (default is 10).

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.

How do I make a link to the other page?¶

If a string starts with /, ./ or ../, ends with / and contains only alphabets, numbers and _.+-` then it will be regarded as a link. For example:

/full/path/link/
./link/to/a/sub/page/
../link/to/a/sibling/page/

Note that this markup is weaker than any other reStructuredText markups. For example, the following is not regraded as a link:

/texsts_with_a_-hyphen-after-the-under_score/

This is because texsts_with_a_ is regraded as a hyper link target (and you will get a “Docutils Sysmtem Message” unexpectedly!). You should escape the “tailing” underscore _ with a slash \ like this:

/texsts_with_a\_-hyphen-after-the-under_score/