From e9c80fcc7c7c77fa0d09725cbb9c0fea120d1e9d Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Mon, 3 Oct 2011 21:17:05 -0400 Subject: v2 v3: documentation, manpage --- man/man1/sisu.1 | 152 ++++++++++++++++++++++++++++++++++++++++++++++++++++--- man/man1/sisu2.1 | 1 + 2 files changed, 145 insertions(+), 8 deletions(-) create mode 120000 man/man1/sisu2.1 (limited to 'man/man1') diff --git a/man/man1/sisu.1 b/man/man1/sisu.1 index 0b9a2fce..9a3e5535 100644 --- a/man/man1/sisu.1 +++ b/man/man1/sisu.1 @@ -1,4 +1,4 @@ -.TH "sisu" "1" "2011-07-26" "3.0.14-beta-rb1.9.2p180" "SiSU" +.TH "sisu" "1" "2011-10-03" "3.1.0" "SiSU" .br .SH NAME .br @@ -6,7 +6,7 @@ sisu \- documents: markup, structuring, publishing in multiple standard formats, .br .SH SYNOPSIS .br -sisu [\-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0\-9] [filename/wildcard] +sisu [\-abCcDdeFGghIikLMmNnoPpQqRrSsTtUuVvWwXxYyZ_0\-9] [filename/wildcard] .br sisu [\-Ddcv] [instruction] [filename/wildcard] @@ -15,13 +15,16 @@ sisu [\-Ddcv] [instruction] [filename/wildcard] sisu [\-CcFLSVvW] .br -sisu \-\-v2 [operations] +sisu [operations] .br sisu \-\-v3 [operations] .br -sisu3 [operations] +sisu \-\-v2 [operations] + +.br +sisu2 [operations] .SH SISU \- MANUAL, RALPH AMISSAH .br @@ -2277,10 +2280,10 @@ documents under consideration, and occasionally supported have been. << |filename.ssi|@|^| .fi -.SH MARKUP SYNTAX HISTORY +.SH 11. MARKUP SYNTAX HISTORY .br -.SH 11. NOTES RELATED TO FILES\-TYPES AND MARKUP SYNTAX +.SH 11.1 NOTES RELATED TO FILES\-TYPES AND MARKUP SYNTAX .br 2.0 introduced new headers and is therefore incompatible with 1.0 though @@ -2977,10 +2980,47 @@ Under consideration is to permit the placement of a CSS file with a different name in directory _sisu/css directory or equivalent, and change the default CSS file that is looked for in a skin.[^18] -.SH 17. ORGANISING CONTENT +.SH 17. ORGANISING CONTENT \- DIRECTORY STRUCTURE AND MAPPING .br -.SH 17.1 DIRECTORY STRUCTURE AND MAPPING +.br +.B SiSU +v3 has new options for the source directory tree, and output directory +structures of which there are 3 alternatives. + +.SH 17.1 DOCUMENT SOURCE DIRECTORY + +.br +The document source directory is the directory in which sisu processing +commands are given. It contains the sisu source files (.sst \.ssm \.ssi), or +(for sisu v3 may contain) subdirectories with language codes which contain the +sisu source files, so all English files would go in subdirectory en/, French in +fr/, Spanish in es/ and so on. ISO \... codes are usedr. A list of available +languages (and possible sub\-directory names) can be obtained with the command +"sisu \-\-help lang" The list of languages is limited to langagues supported by +XeTeX polyglosia. + +.SH 17.1.1 GENERAL DIRECTORIES + +.nf + ./subject_name/ + % files stored at this level e.g. sisu_manual.sst or + % for sisu v3 may be under language sub\-directories + % e.g. + ./subject_name/en + ./subject_name/fr + ./subject_name/es + ./subject_name/_sisu + % configuration file e.g. sisurc.yml + ./subject_name/_sisu/skin + % skins in various skin directories doc, dir, site, yml + ./subject_name/_sisu/css + ./subject_name/_sisu/image +.fi + +.SH 17.2 DOCUMENT OUTPUT DIRECTORY STRUCTURES + +.SH 17.2.1 OUTPUT DIRECTORY ROOT .br The output directory root can be set in the sisurc.yml file. Under the root, @@ -3008,6 +3048,102 @@ output directory. Skins could be associated with each institution on a directory basis and resulting documents will take on the appropriate different appearance. +.SH 17.2.2 ALTERNATIVE OUTPUT STRUCTURES + +.br +There are 3 possibile output structures described as being, by language, by +filetype or by filename, the selection is made in sisurc.yml + +.nf + #% output_dir_structure_by: language; filetype; or filename + output_dir_structure_by: language #(language & filetype, preferred?) + #output_dir_structure_by: filetype + #output_dir_structure_by: filename #(default, closest to original v1 & v2) +.fi + +.SH 17.2.3 BY LANGUAGE + +.br +The by language directory structure places output files + +.br +The by language directory structure separates output files by language code +(all files of a given language), and within the language directory by filetype. + +.br +Its selection is configured in sisurc.yml + +.br +output_dir_structure_by: language + +.br +#by: language subject_dir/en/manifest/filename.html + +.SH 17.2.4 BY FILETYPE + +.br +The by filetype directory structure separates output files by filetype, all +html files in one directory pdfs in another and so on. Filenames are given a +language extension. + +.br +Its selection is configured in sisurc.yml + +.br +output_dir_structure_by: filetype + +.br +#by: filetype subject_dir/html/filename/manifest.en.html + +.SH 17.2.5 BY FILENAME + +.br +The by filename directory structure places most output of a particular file +(the different filetypes) in a common directory. + +.br +Its selection is configured in sisurc.yml + +.br +output_dir_structure_by: filename + +.br +#by: filename subject_dir/filename/manifest.en.html + +.SH 17.2.6 REMOTE DIRECTORIES + +.nf + ./subject_name/ + % containing sub_directories named after the generated files from which they are made + ./subject_name/src + % contains shared source files text and binary e.g. sisu_manual.sst and sisu_manual.sst.zip + ./subject_name/_sisu + % configuration file e.g. sisurc.yml + ./subject_name/_sisu/skin + % skins in various skin directories doc, dir, site, yml + ./subject_name/_sisu/css + ./subject_name/_sisu/image + % images for documents contained in this directory + ./subject_name/_sisu/mm +.fi + +.SH 17.2.7 SISUPOD + +.nf + ./sisupod/ + % files stored at this level e.g. sisu_manual.sst + ./sisupod/_sisu + % configuration file e.g. sisurc.yml + ./sisupod/_sisu/skin + % skins in various skin directories doc, dir, site, yml + ./sisupod/_sisu/css + ./sisupod/_sisu/image + % images for documents contained in this directory + ./sisupod/_sisu/mm +.fi + +.SH 17.3 ORGANISING CONTENT + .SH 18. HOMEPAGES .br diff --git a/man/man1/sisu2.1 b/man/man1/sisu2.1 new file mode 120000 index 00000000..09708b31 --- /dev/null +++ b/man/man1/sisu2.1 @@ -0,0 +1 @@ +sisu.1 \ No newline at end of file -- cgit v1.2.3