Juli > juli(1)

juli is an outline processor + offline wiki.

When juli(1) command is executed, HTML is generated under output_top directory. Where, output_top can be configured (please see 'init' command section).

3.1. Options

general options are:

--help:	show help
--version:	show version

3.2. COMMAND

3.2.1. init

Initialize juli-repository(juli-repo in short). Specify output directory with -o option. When no option is specified, empy juli-repo is created and default config file is created.

You can edit the config file later. It's just YAML format file.

3.2.1.1. EXAMPLE

Following example creates:

$HOME/my_memo_root: juli-repo
/var/www/juli: output_top. generated html can be browsed via internet if http server recognizes this.

prepare output directory to browse at internet. Of course, your http server is required to recognize /var/www/juli:

$ sudo mkdir /var/www/juli
$ sudo chown YOURNAME /var/www/juli

prepare memo root directory for juli-repo:

$ cd $HOME
$ mkdir my_memo_root
$ cd my_memo_root
$ juli init -o /var/www/juli

3.2.1.2. options for 'init'

-o output_top: Specify output directory, which points to the top directory for generated html files. default = './html/'
-t template: Specify template under 1) JULI_REPO/.juli or 2) RUBY_LIB/juli/template/. default = 'default.html'.
-e ext: generating html file extention. default = '.shtml'.

Where, JULI_REPO is the directory which you are creating now. RUBY_LIB is the directory which juli library is installed (e.g. /usr/local/lib/ruby/site_ruby/1.9/).

(v1.01) When you want to customize template, please follow the steps below after executing 'juli init':

copy template file under lib/juli/template/ to JULI_REPO/.juli/ (e.g. template name is 'blue_ocean'):
```
$ cp RUBY_LIB/juli/template/default.html JULI_REPO/.juli/blue_ocean.html
```
edit JULI_REPO/.juli/blue_ocean.html as you like
edit JULI_REPO/.juli/config as follow as follows:
```
template: blue_ocean
```

3.2.2. gen

When files are specified, each file will be converted by generator (default is html). When no files are specified, bulk mode is executed. 'gen' command is default.

Example:

juli                          # generate in bulk mode
juli gen doc/poem.txt         # generate for the file
juli gen -g tree              # show text tree in bulk mode
juli gen -g tree doc/poem.txt # show text tree of the file

Wrong Example:

juli doc/poem.txt       # the file is interpreted as command, so resulted error.

3.2.2.1. options for 'gen'

-g generator: specify generator. Supported generators are in lib/juli/visitor/ directory. Default is html.
-f: force update. Even generated HTML file is newer than source text, generate again.
-t template: Specify template; it may be fullpath, relative path from current directory, under JULI_REPO/.juli, or under RUBY_LIB/juli/template/
-o output_path: specify output file path.

Template search priority is as follows:

If -t option is specified
1. check if it is fullpath or relative path from current directory, or
2. check it under JULI_REPO/.juli, or
3. check it under RUBY_LIB/juli/template/
Otherwise
1. check configured template under JULI_REPO/.juli, or
2. check configured template under RUBY_LIB/juli/template/

Where, configured template means the template specified at .juli/config.

3.2.3. sitemap

generates sitemap.shtml under output_top/. je(1) supports this; when edit text by je(1), the sitemap is automatically generated.

3.2.4. recent_update

generates recent_update.shtml under output_top/. je(1) supports this; when edit text by je(1), the recent_update is automatically generated.

3.2.5. tag

generates _tag.shtml under output_top/. This page shows tag list and wiki page related to the tag.

See tag(macro) to define tag.

juli-repo:	directory for memo. 'init' command creates it.
output_dir:	directory for html generated files
juli-repo/.juli/config:	config file
doc/index:	top document for intro, install, syntax

juli(1)

1. NAME

2. SYNOPSIS

3. DESCRIPTION

3.1. Options

3.2. COMMAND

3.2.1. init

3.2.1.1. EXAMPLE

3.2.1.2. options for 'init'

3.2.2. gen

3.2.2.1. options for 'gen'

3.2.3. sitemap

3.2.4. recent_update

3.2.5. tag

4. FILES

5. SEE ALSO

6. MISC

6.1. Author

6.2. License