aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_content_directories.ssi
diff options
context:
space:
mode:
Diffstat (limited to 'data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_content_directories.ssi')
-rw-r--r--data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_content_directories.ssi141
1 files changed, 141 insertions, 0 deletions
diff --git a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_content_directories.ssi b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_content_directories.ssi
new file mode 100644
index 00000000..11590de2
--- /dev/null
+++ b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_content_directories.ssi
@@ -0,0 +1,141 @@
+% SiSU insert 2.0
+
+@title: SiSU
+ :subtitle: Content Directories, Organising Content
+
+@creator: :author: Amissah, Ralph
+
+@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
+
+% used_by: sisu_manual
+
+@classify:
+ :type: information
+ :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
+
+@date:
+ :created: 2002-08-28
+ :issued: 2002-08-28
+ :available: 2007-08-28
+ :published: 2007-09-16
+ :modified: 2009-12-16
+
+@make:
+ :num_top: 1
+ :breaks: new=C; break=1
+ :skin: skin_sisu_manual
+ :bold: /Gnu|Debian|Ruby|SiSU/
+
+@links:
+ { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/
+ { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html
+ { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU
+ { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/
+ { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/
+ { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html
+ { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html
+ { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html
+ { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/
+ { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/
+
+:A~? Organisation of Content
+
+:B~? Content Directories
+
+1~organising_content Organising Content
+
+2~ Directory Structure and Mapping
+
+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~ General Directories
+
+code{
+
+./subject_name/
+
+% files stored at this level e.g. sisu_manual.sst
+
+./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
+
+}code
+
+3~ Remote Directories
+
+code{
+
+./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
+
+}code
+
+3~ Sisupod
+
+code{
+
+./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
+
+}code
+
+2~ Organising Content
+
+
+
+% .SH "SKINS \- document, directory and site skins"
+
+