diff options
Diffstat (limited to 'data/doc/sisu/markup-samples/sisu_manual/sisu_content_directories.ssi')
| -rw-r--r-- | data/doc/sisu/markup-samples/sisu_manual/sisu_content_directories.ssi | 164 |
1 files changed, 157 insertions, 7 deletions
diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_content_directories.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_content_directories.ssi index dedd38f4..b7e09434 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_content_directories.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_content_directories.ssi @@ -22,13 +22,13 @@ :B~? Content Directories -1~organising_content Organising Content +1~organising_content Organising Content - Directory Structure and Mapping -2~ Directory Structure and Mapping +SiSU v3 has new options for the source directory tree, and output directory structures of which there are 3 alternatives. -The output directory root can be set in the sisurc.yml file. Under the root, subdirectories are made for each directory in which a document set resides. If you have a directory named poems or conventions, that directory will be created under the output directory root and the output for all documents contained in the directory of a particular name will be generated to subdirectories beneath that directory (poem or conventions). A document will be placed in a subdirectory of the same name as the document with the filetype identifier stripped (.sst .ssm) +2~ Document Source Directory -The last part of a directory path, representing the sub-directory in which a document set resides, is the directory name that will be used for the output directory. This has implications for the organisation of document collections as it could make sense to place documents of a particular subject, or type within a directory identifying them. This grouping as suggested could be by subject (sales_law, english_literature); or just as conveniently by some other classification (X University). The mapping means it is also possible to place in the same output directory documents that are for organisational purposes kept separately, for example documents on a given subject of two different institutions may be kept in two different directories of the same name, under a directory named after each institution, and these would be output to the same output directory. Skins could be associated with each institution on a directory basis and resulting documents will take on the appropriate different appearance. +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 639-1 codes are used (as varied by po4a). 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. 3~ General Directories @@ -36,7 +36,15 @@ code{ ./subject_name/ -% files stored at this level e.g. sisu_manual.sst +% 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 @@ -50,12 +58,154 @@ code{ ./subject_name/_sisu/image -% images for documents contained in this directory +}code -./subject_name/_sisu/mm +2~ Document Output Directory Structures + +3~ Output Directory Root + +The output directory root can be set in the sisurc.yml file. Under the root, subdirectories are made for each directory in which a document set resides. If you have a directory named poems or conventions, that directory will be created under the output directory root and the output for all documents contained in the directory of a particular name will be generated to subdirectories beneath that directory (poem or conventions). A document will be placed in a subdirectory of the same name as the document with the filetype identifier stripped (.sst .ssm) + +The last part of a directory path, representing the sub-directory in which a document set resides, is the directory name that will be used for the output directory. This has implications for the organisation of document collections as it could make sense to place documents of a particular subject, or type within a directory identifying them. This grouping as suggested could be by subject (sales_law, english_literature); or just as conveniently by some other classification (X University). The mapping means it is also possible to place in the same output directory documents that are for organisational purposes kept separately, for example documents on a given subject of two different institutions may be kept in two different directories of the same name, under a directory named after each institution, and these would be output to the same output directory. Skins could be associated with each institution on a directory basis and resulting documents will take on the appropriate different appearance. + +3~ Alternative Output Structures + +There are 3 possibile output structures described as being, by language, by filetype or by filename, the selection is made in sisurc.yml + +code{ + +#% 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) }code +3~ By Language + +The by language directory structure places output files + +The by language directory structure separates output files by language code (all files of a given language), and within the language directory by filetype. + +Its selection is configured in sisurc.yml + +output_dir_structure_by: language + +% works for html epub odf, pdf, sortof for info NOT for man pages + +code{ + + ├── en + │ ├── epub + │ ├── hashes + │ ├── html + │ │ └── viral_spiral.david_bollier + │ ├── manifest + │ │ └── qrcode + │ ├── odt + │ ├── pdf + │ ├── sitemaps + │ ├── txt + │ ├── xhtml + │ └── xml + ├── po4a + │ └── live-manual + │ ├── po + │ │ └── fr + │ └── pot + └── _sisu + ├── css + ├── image + ├── image_sys -> ../../_sisu/image_sys + └── xml + ├── rnc + ├── rng + └── xsd + +}code + +#by: language +subject_dir/en/manifest/filename.html + +3~ By Filetype + +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. + +Its selection is configured in sisurc.yml + +output_dir_structure_by: filetype + +% works for html epub odf, pdf, sortof for info NOT for man pages + +code{ + + ├── epub + ├── hashes + ├── html + │ └── viral_spiral.david_bollier + ├── manifest + │ └── qrcode + ├── odt + ├── pdf + ├── po4a + │ └── live-manual + │ ├── po + │ │ └── fr + │ └── pot + ├── _sisu + │ ├── css + │ ├── image + │ ├── image_sys -> ../../_sisu/image_sys + │ └── xml + │ ├── rnc + │ ├── rng + │ └── xsd + ├── sitemaps + ├── txt + ├── xhtml + └── xml + +}code + +#by: filetype +subject_dir/html/filename/manifest.en.html + +3~ By Filename + +The by filename directory structure places most output of a particular file (the different filetypes) in a common directory. + +Its selection is configured in sisurc.yml + +output_dir_structure_by: filename + +% works for html epub odf, pdf, sortof for info NOT for man pages + +code{ + + ├── epub + ├── po4a + │ └── live-manual + │ ├── po + │ │ └── fr + │ └── pot + ├── _sisu + │ ├── css + │ ├── image + │ ├── image_sys -> ../../_sisu/image_sys + │ └── xml + │ ├── rnc + │ ├── rng + │ └── xsd + ├── sitemaps + ├── src + │ └── pod + └── viral_spiral.david_bollier + +}code + +#by: filename +subject_dir/filename/manifest.en.html + 3~ Remote Directories code{ |