path: root/data/doc/sisu/markup-samples/manual/en/sisu_content_directories.ssi
diff options
Diffstat (limited to 'data/doc/sisu/markup-samples/manual/en/sisu_content_directories.ssi')
1 files changed, 9 insertions, 3 deletions
diff --git a/data/doc/sisu/markup-samples/manual/en/sisu_content_directories.ssi b/data/doc/sisu/markup-samples/manual/en/sisu_content_directories.ssi
index 182b176..4d3980a 100644
--- a/data/doc/sisu/markup-samples/manual/en/sisu_content_directories.ssi
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_content_directories.ssi
@@ -22,10 +22,12 @@
:B~? Content Directories
1~organising_content Organising Content - Directory Structure and Mapping
+={ SiSU:directories;directories;content directories }
SiSU v3 has new options for the source directory tree, and output directory structures of which there are 3 alternatives.
2~ Document Source Directory
+={ SiSU:directories document source;directories:document source;content directories:document source }
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.
@@ -54,6 +56,7 @@ code{
2~ Document Output Directory Structures
+={ SiSU:directories output;directories:output;output directories:document output|structure }
3~ Output Directory Root
@@ -62,6 +65,7 @@ The output directory root can be set in the sisurc.yml file. Under the root, sub
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
+={ output directories:structure }
There are 3 possibile output structures described as being, by language, by filetype or by filename, the selection is made in sisurc.yml
@@ -75,6 +79,7 @@ output_dir_structure_by: language #(language & filetype, preferred?)
3~ By Language
+={ output directories:by language }
The by language directory structure places output files
@@ -121,6 +126,7 @@ code{
3~ By Filetype
+={ output directories: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.
@@ -164,6 +170,7 @@ code{
3~ By Filename
+={ output directories:by filename }
The by filename directory structure places most output of a particular file (the different filetypes) in a common directory.
@@ -230,6 +237,7 @@ code{
3~ Sisupod
+={ output directories:sisupod }
@@ -255,9 +263,7 @@ code{
-2~ Organising Content
+% 2~ Organising Content
% .SH "SKINS \- document, directory and site skins"