diff --git a/documents/Makefile.am b/documents/Makefile.am index e99cfe9..9ae4667 100644 --- a/documents/Makefile.am +++ b/documents/Makefile.am @@ -15,7 +15,7 @@ PANDOC_AUTHORS="SANO Masatoshi" pandoc -f markdown_phpextra -t man -V title="$*" -V section=$(subst .,,$(suffix $@)) -V author=$(PANDOC_AUTHORS) --template=default.man $< > $@ %.html: %.md - pandoc -f markdown_phpextra -t html5 -V title="$*" -V author=$(PANDOC_AUTHORS) --template=default.html $< > $@ + pandoc -f markdown_phpextra -t html5 -V title="$*(1)" -V pagetitle="$*(1)" -V css=ros.css -V author=$(PANDOC_AUTHORS) --template=default.html $< > $@ if MANUAL_GENERATE man1_MANS = $(shell ls *.md | sed s/md/1/g ; ls *.md | sed s/md/html/g) diff --git a/documents/default.html b/documents/default.html index 8caea26..338042a 100644 --- a/documents/default.html +++ b/documents/default.html @@ -1,17 +1,17 @@ - - + + - - - + + + $for(author-meta)$ - + $endfor$ $if(date-meta)$ - + $endif$ $if(keywords)$ - + $endif$ $if(title-prefix)$$title-prefix$ – $endif$$pagetitle$ @@ -24,11 +24,14 @@ $highlighting-css$ $endif$ $for(css)$ - + $endfor$ $if(math)$ $math$ $endif$ + $for(header-includes)$ $header-includes$ $endfor$ @@ -38,23 +41,25 @@ $for(include-before)$ $include-before$ $endfor$ $if(title)$ -
+

$title$

$if(subtitle)$

$subtitle$

$endif$ +
    $for(author)$ -

    $author$

    +
  • $author$
    • $endfor$ +
$if(date)$

$date$

$endif$ -
+ $endif$ $if(toc)$ -
+
+ $endif$ $body$ $for(include-after)$ diff --git a/documents/ros-dump.md b/documents/ros-dump.md index d468633..c986ce7 100644 --- a/documents/ros-dump.md +++ b/documents/ros-dump.md @@ -1,8 +1,6 @@ -# name - ros-dump - make a dumped image of a roswell script -# synopsis +# Synopsis **ros [options] dump** *type* args... @@ -16,7 +14,7 @@ executable : Create an executable. -# description +# Description `ros-dump` creates a dumped lisp image of the state after processing all arguments passed. @@ -45,7 +43,3 @@ and even between the same implementations with different versions. # SEE ALSO _sbcl_(1) _ros_(1) - -# Author - -SANO Masatoshi diff --git a/documents/ros-init.md b/documents/ros-init.md index 63d1a58..20bfba5 100644 --- a/documents/ros-init.md +++ b/documents/ros-init.md @@ -1,8 +1,6 @@ -# name - ros-init - Create a roswell script (optionally based on a template) -# synopsis +# Synopsis **ros init [template]** name @@ -12,7 +10,7 @@ template : Specify the name of a template. -# description +# Description Initialises [name].ros. @@ -37,6 +35,3 @@ This is basically a shell script which immediately invokes Roswell by exec (see # SEE ALSO _sbcl_(1) _ros_(1) -# Author - -SANO Masatoshi diff --git a/documents/ros-install.md b/documents/ros-install.md index f4620f0..0e17cf1 100644 --- a/documents/ros-install.md +++ b/documents/ros-install.md @@ -1,8 +1,6 @@ -# name - ros-install - Install lisp implementations or quicklisp system -# synopsis +# Synopsis **ros install** [name] @@ -73,6 +71,3 @@ When the system comes with a **roswell script** created by _ros-init_(1) in the # SEE ALSO _sbcl_(1), _ros_(1), _ros-list_(1), _ros-init_(1) -# Author - -SANO Masatoshi diff --git a/documents/ros-list.md b/documents/ros-list.md index 9a706f4..66deda7 100644 --- a/documents/ros-list.md +++ b/documents/ros-list.md @@ -1,8 +1,6 @@ -# name - ros-list - list the materials installed by roswell -# synopsis +# Synopsis **ros list [type] [options]** @@ -11,7 +9,7 @@ ros-list - list the materials installed by roswell -# description +# Description **ros list** shows the list of the materials installed by roswell. @@ -34,6 +32,3 @@ versions # SEE ALSO _sbcl_(1) _ros_(1) -# Author - -SANO Masatoshi diff --git a/documents/ros-setup.md b/documents/ros-setup.md index 44f8354..5ed7eb3 100644 --- a/documents/ros-setup.md +++ b/documents/ros-setup.md @@ -1,8 +1,6 @@ -# name - ros-setup - install sbcl-bin and quicklisp -# synopsis +# Synopsis **ros setup** @@ -11,7 +9,7 @@ ros-setup - install sbcl-bin and quicklisp -# description +# Description Runs some initial setup of roswell. @@ -22,6 +20,3 @@ Runs some initial setup of roswell. # SEE ALSO _sbcl_(1) _ros_(1) -# Author - -SANO Masatoshi diff --git a/documents/ros.css b/documents/ros.css new file mode 100644 index 0000000..93f5d97 --- /dev/null +++ b/documents/ros.css @@ -0,0 +1,6 @@ + + +.author { + font-size : smaller; + font-style : italic; +} diff --git a/documents/ros.md b/documents/ros.md index 19a75df..92bfcc1 100644 --- a/documents/ros.md +++ b/documents/ros.md @@ -1,12 +1,10 @@ -# name - Roswell - Common Lisp environment setup Utility -# synopsis +# Synopsis -**ros** [**options**] [[_command_ [args...]] | [[--]script [args...]]] +**ros** [**options**] `[[_command_ [args...]] | [[--]script [args...]]]` -# description +# Description Roswell is a command line tool for installing and managing Common Lisp implementations, as well as a scripting infrastructure for templating, writing, executing, compiling, distributing, downloading and installing ROSWELL-SCRIPTS written in Common Lisp. @@ -14,7 +12,7 @@ Currently roswell supports sbcl, ccl, clisp and ecl as its supported lisp implem Scripts installed by roswell will be system wide if appropriate directory is included in PATH. -# subcommands +# Subcommands In an order of utility/frequency. @@ -74,7 +72,7 @@ help : Show the subcommand help. -# options +# Options Options are processed in left-to-right order. @@ -191,41 +189,39 @@ ROSWELL_INSTALL_DIR : Specifies the install directory of roswell, defaulted to $HOME/.roswell . Roswell scripts are installed in $ROSWELL_INSTALL_DIR/bin . -ROSWELL_HTML_TEST - - : - ROSWELL_BRANCH - : + : used for testing roswell itself. ROSWELL_REPO - : + : used for testing roswell itself. LISP_IMPLS_DIR - : + : used for testing roswell itself. LISP_IMPLS_BIN - : + : used for testing roswell itself. ROSWELL_TARBALL_PATH - : + : used for testing roswell itself. ROSWELL_URI - : + : used for testing roswell itself. + + + + # Bugs Check out issues list (https://github.com/snmsts/roswell/issues) + # SEE ALSO _sbcl_(1) -# Author - -SANO Masatoshi