这是可以使用我们的多个免费在线工作站之一(例如 Ubuntu Online、Fedora Online、Windows 在线模拟器或 MAC OS 在线模拟器)在 OnWorks 免费托管服务提供商中运行的命令 sisu
程序:
您的姓名
sisu - 文档:标记、结构化、以多种标准格式发布和搜索
概要
sisu [-short-options|--long-options] [文件名/通配符]
sisu [-abCcDdeFGghIikLMmNnoPpQqRrSsTtUuVvWwXxYyZ_0-9] [文件名/通配符]
sisu --txt --html --epub --odt --pdf --wordmap --sqlite --manpage --texinfo --sisupod
--source --qrcode [文件名/通配符]
sisu [-Ddcv] [指令] [文件名/通配符]
sisu --pg (--createdb|update [文件名/通配符]|--dropall)
sisu [操作]
西苏 [-CcFLSVvW]
sisu (--configure|--webrick|--sample-search-form)
SISU - 手动的,
拉尔夫·阿米萨
什么是 IS 西苏?
引言 - 什么是 IS 西苏?
上海外国语大学 是一个基于轻量级标记的文档创建和发布框架
从命令行控制。 准备文件 上海外国语大学 使用您的文本编辑器
选择,然后使用 上海外国语大学 生成各种输出文档格式。
从一个简单准备的文档(纯文本 UTF-8 ) sisu 自定义构建了几个
共享通用(文本对象)引用编号系统的标准输出格式
文档中的内容(也对搜索有影响)。 西苏引擎
使用文档结构和内容的抽象
可以生成文档的不同表示形式。 上海外国语大学 生产:
纯文本, HTML, XHTML, XML, 电子版, ODF: ODT (开放文档), 乳胶, PDF, 并填充一个
SQL 数据库( PostgreSQL的 or SQLite ) 带有文本对象,大致是段落大小的块
以便在此粒度级别上完成文档搜索。
输出共享一个通用的引文编号系统,与文本对象和任何
提供关于文档的语义元数据。
上海外国语大学 还提供一致性文件、文件内容证书和清单
生成的输出。 可以制作书籍索引。
sisu -markup-samples 包中提供了一些文档标记示例。
主页:
*http://www.sisudoc.org/>
*http://www.jus.uio.no/sisu>
指令 概要
商品描述
上海外国语大学 是一个文档发布系统,从一个简单的单个标记文档,
产生多种输出格式,包括: 纯文本, HTML, XHTML, XML, 电子版, ODT (
OpenDocument格式 ( ODF ) 文本), 乳胶, PDF, 信息,和 SQL ( PostgreSQL的 和 SQLite ) , 哪一个
共享文本对象编号(“对象引用编号”)和相同的文档结构
信息。 更多请见:http://sisudoc.org>或http://www.jus.uio.no/sisu>
文件 处理 指挥 旗帜
-[0-9] [文件名/通配符]
见 --act
--ao [文件名/通配符/网址]
假设大多数其他标志,创建新的中间文件进行处理
(抽象对象,文档抽象),用于所有后续处理
的其他输出。 大多数处理标志都假定此步骤。 要跳过它,请参见 -n。
别名 -m。
--行为[s0-9] [文件名/通配符]
--act0 到 --act9 多个标志的可配置快捷方式,-0 到 -9 同义词,
在sisurc.yml中配置; sisu 对没有标志的指定文件的默认操作
提供的是--act0; --act 或 --acts 获取有关归因于的当前操作的信息
--act0 到 --act9
--asciidoc [文件名/通配符]
asciidoc,智能文本(不可用)
-b [文件名/通配符]
见--xhtml
- 经过-* 见 --output-by-*
-C 配置/初始化共享输出目录文件初始化共享输出
目录(配置文件,如 css 和 dtd 文件,如果它们已经
存在除非使用修饰符)。 -C --init-site 配置/初始化站点更多
比 -C 本身更广泛,共享输出目录文件/强制更新,现有
如果此修饰符,则共享输出配置文件(例如 css 和 dtd 文件)将更新
用来。
-c [文件名/通配符]
见 --color-toggle
- 颜色
见 --color-on
--颜色关闭
关闭输出到终端的颜色
--上色
打开输出到终端的颜色
--颜色切换 [文件名/通配符]
屏幕切换 ansi 屏幕颜色取决于默认设置(除非 -c 标志
使用:如果 sisurc 颜色默认设置为“true”,则输出到屏幕将与
颜色,如果 sisurc 颜色默认设置为 'false' 或未定义的屏幕输出
将没有颜色)。 别名 -c
- 配置
配置/初始化共享输出目录文件初始化共享输出
目录(配置文件,如 css 和 dtd 文件,如果它们已经
存在除非使用修饰符)。 相当于:-C --init-site
配置/初始化站点,比 -C 更广泛,共享输出
目录文件/强制更新,现有的共享输出配置文件,例如 css 和
如果使用 -CC,则更新 dtd 文件。
--一致性 [文件名/通配符]
产生一致性(wordmap)文档中所有单词的基本索引。
(除非超过 260,000 字的文档,否则不会生成索引文件
此限制在文件 sisurc.yml 中增加)。 别名 -w
-d [文件名/通配符/网址]
见--docbook
--达尔 [文件名/通配符/网址]
(抽象对象,文档抽象在sisu5中重命名为抽象对象)见--ao
- 删除 [文件名/通配符]
见--zap
--文摘 [文件名/通配符/网址]
文档摘要或文档内容证书 (DCC) 作为 sha 摘要树
文档:文档的摘要,以及其中包含的每个对象的摘要
文档(连同有关生成它的软件版本的信息)
(摘要.txt)。 --digests -V 用于将详细摘要输出到屏幕。
--文档 [文件名/通配符/网址]
文档 xml
--dom [文件名/通配符/网址]
见--xml-dom
--dump[=目录路径] [文件名/通配符]
将输出放在指定的目录中,如果在当前目录中没有指定
(密码)。 与使用默认设置不同 HTML 文件已经嵌入了 css。 相比
--重定向
-e [文件名/通配符]
见--epub
--epub [文件名/通配符]
生成一个 epub 文档,[sisu version >=2] (filename.epub)。 别名 -e
--错误警告
覆盖错误时停止处理。 别名 --no-stop
--排除-*
排除输出功能,覆盖配置设置--exc-numbering,见
--exc-ocn; --exc-ocn,(排除“对象引用编号”,(关闭对象
引文编号),影响 html(seg、scroll)、epub、xhtml、xml、pdf); --ex-toc,
(排除目录,影响 html(滚动)、epub、pdf); --ex-links-to-
清单,--exc-manifest-links,(排除清单的链接,影响 html(seg,
滚动)); --exc-search-form, (排除搜索表单, 影响 html (seg, scroll),
显现); --exc-minitoc, (排除迷你目录, 影响 html (seg),
一致性,清单); --exc-manifest-minitoc,(不包括迷你目录,
影响清单); --exc-html-minitoc,(不包括迷你目录,影响
html (seg), 索引); --exc-html-navigation,(排除导航,影响 html
(段)); --exc-html-navigation-bar,(排除导航栏,影响html(seg));
--exc-html-search-form,(排除搜索表单,影响html(seg,scroll)); --除外-
html-右窗格,(不包括右窗格/列,影响 html(段,滚动)); --除外-
html-top-band,(排除top band,影响html(seg,scroll),concordance(minitoc)
被迫提供分段导航)); --exc-segsubtoc(排除子表
内容,影响 html (seg), epub) ; 另见--inc-*
-F [--webserv=webrick]
见--sample-search-form
-f [可选的 绳子 部分 of 文档名称]
见 --find
--小说书 [文件名/通配符/网址]
小说书 xml(不可用)
- 找 [可选的 绳子 部分 of 文档名称]
见--glob
-G [可选的 绳子 部分 of 文档名称]
见--glob
-g [文件名/通配符]
见--git
--git [文件名/通配符]
在 git repo 中生成或更新标记源文件结构(实验和
可调整的)。 别名 -g
--glob [可选的 绳子 部分 of 文档名称]
没有匹配字符串,glob 目录中的所有 .sst .ssm 文件(包括语言
子目录)。 使用匹配字符串,在目录中查找与给定字符串匹配的文件
(包括语言子目录)。 别名 -G, -f, --find
-h [文件名/通配符]
见--html
- 收成 *.ss[tm]
根据目录中的 sisu 标记文档制作两个 sisu 输出列表:
作者和作者作品列表(年份和标题),以及; 按主题和标题列出
和作者。 利用标题元数据字段(作者、标题、日期、
topic_register)。 可与维护 (-M) 和远程放置 (-R) 标志一起使用。
--html [文件名/通配符]
以两种形式生成 html 输出 (i) 带有目录的分段文本
(toc.html 和 index.html) 和 (ii) 单个文件 (scroll.html) 中的文档。
别名 -h
--html-滚动 [文件名/通配符]
生成 html 输出,该文档仅在单个文件 (scroll.html) 中。 相比
--html-seg 和 --html
--html 段 [文件名/通配符]
产生 html 输出,带有目录的分段文本(toc.html 和
index.html)。 比较 --html-scroll 和 --html
--html-严格 [文件名/通配符]
使用 --strict 选项生成 html。 见--严格
-I [文件名/通配符]
见--texinfo
-i [文件名/通配符]
见--手册页
--i18n-*
这些标志通过文件类型和文件名影响输出):--i18n-mono(--monolingual)
输出文件名没有默认语言的语言代码(“en”或设置);
--i18n-multi (--multilingual) 语言代码作为输出的一部分提供
文件名,这是默认值。 如果输出是一种语言,只有语言
可能不需要代码。 另见 --output-by-*
--公司-*
包括输出功能,覆盖配置设置,(通常是默认值,如果
未设置),优先于 --exc-* (排除输出功能)。 一些细节
在 --exc-* 下提供,请参阅 --exc-*
-j [文件名/通配符]
复制与文件关联的图像以供 html、xhtml 和 xml 输出使用
(由 --dump 和重定向自动调用)。
-k 见 --color-off
--保持处理文件 [文件名/通配符/网址]
见--维护
-M [文件名/通配符/网址]
见--维护
-m [文件名/通配符/网址]
参见--dal(文档抽象级别/层)
- 机器 [文件名/通配符/网址]
参见--dal(文档抽象级别/层)
- 维护 [文件名/通配符/网址]
维护模式,保留临时处理文件及其位置
表明的。 (另见-V)。 别名 -M 和 --keep-processing-files。
- 显现 [文件名/通配符]
生成生成的输出(超链接到内容)和文档的 html 摘要
特定的元数据 (sisu_manifest.html)。 大多数处理都假定此步骤
标志。
--手册页 [文件名/通配符]
生成文件的手册页,不适用于所有输出。 别名 -i
--降价 [文件名/通配符/网址]
降价智能文本(不可用)
--单语
见--i18n-*
- 多种语言
见--i18n-*
-N [文件名/通配符/网址]
见 --digests
-n [文件名/通配符/网址]
跳过创建中间处理文件(文档抽象),如果它们
已经存在,这会跳过 -m 的等价物,否则大多数人会假设
处理标志。
- 不-* 见--exc-*
- 不停
覆盖错误时停止处理。 别名 --erros-as-warnings
--编号
打开“对象引用编号”。 参见 --inc-ocn 和 --exc-ocn
-o [文件名/通配符/网址]
见--odt
--ocn “对象引用编号”。 参见 --inc-ocn 和 --exc-ocn
--odf [文件名/通配符/网址]
见--odt
--odt [文件名/通配符/网址]
以 opendocument 文件格式 (opendocument.odt) 输出基本文档。 别名 -o
--输出-*
从 3 个选项中选择输出目录结构:--output-by-language,
(具有文件类型(html、epub、pdf 等)的语言目录(基于语言代码)
子目录); --output-by-filetype, (带有语言代码的文件类型目录为
文件名的一部分); --output-by-filename, (带有语言代码的文件名目录
作为文件名的一部分)。 这是可配置的。 别名 --by-*
-P [语言目录/文件名 语言目录]
见--po4a
-p [文件名/通配符]
见--pdf
--papersize-(a4|a5|b5|字母|合法)
结合--pdf set pdf papersize,覆盖任何配置设置,
要设置多个纸张尺寸,请重复选项 --pdf --papersize-a4 --papersize-
信。 另见--papersize=*
--papersize=a4,a5,b5,信件,法律 结合--pdf set pdf papersize,
覆盖任何配置设置,在之后设置多个纸张尺寸列表
带逗号分隔符的等号 --papersize=a4,letter。 另见--papersize-*
--pdf [文件名/通配符]
产生 胶乳 pdf (portrait.pdf & Landscape.pdf)。 方向和纸张尺寸可能是
在命令行中设置。 默认纸张大小在配置文件或文档中设置
标头,或提供额外的命令行参数,例如 --papersize-a4
预设尺寸包括:“A4”、美国“letter”和“legal”以及书籍尺寸“A5”和“B5”
(系统默认为A4),以及; --landscape 或 --portrait,所以:例如“sisu --pdf-a4
--pdf-letter --landscape --verbose [文件名/通配符]”或“sisu --pdf --landscape
--a4 --letter --verbose [文件名/通配符]"。--pdf 默认为横向和
纵向输出,如果没有配置其他纸张尺寸,则为 a4。 相关选项
--pdf-landscape --pdf-portrait --pdf-papersize-* --pdf-papersize=[列表]。 别名 -p
--pdf-l [文件名/通配符]
见--pdf-风景
--pdf-风景 [文件名/通配符]
设定方向,产生 胶乳 pdf 风景.pdf。 默认纸张尺寸设置在
配置文件,或文档标题,或提供额外的命令行
参数,例如 --papersize-a4 预设尺寸包括:'A4'、US 'letter' 和
'legal' 和书本尺寸 'A5' 和 --papersize-* 或 --papersize=[list]。 别名 --pdf-l
或结合 --pdf --landscape
--pdf-p [文件名/通配符]
见--pdf-肖像
--pdf-肖像 [文件名/通配符]
设定方向,产生 胶乳 pdf 肖像.pdf.pdf。 默认纸张尺寸设置在
配置文件,或文档标题,或提供额外的命令行
参数,例如 --papersize-a4 预设尺寸包括:'A4'、US 'letter' 和
'legal' 和书本尺寸 'A5' 和 --papersize-* 或 --papersize=[list]。 别名 --pdf-p
或结合 --pdf --portrait
--pg-[说明] [文档名称]
数据库 PostgreSQL的 (可以使用 --pgsql 代替)可能的指令,包括:
--pg-createdb; --pg-创建; --pg-dropall; --pg-import [文件名]; --pg-更新
[文档名称]; --pg-remove [文件名]; 请参阅下面的数据库部分。
--po [语言目录/文件名 语言目录]
见--po4a
--po4a [语言目录/文件名 语言目录]
以语言指定的语言为文件生成 .pot 和 po 文件
目录。 上海外国语大学 标记放置在以语言代码命名的子目录中,
例如 en/ fr/ es/。 sisu 配置文件必须将输出目录结构设置为
多种语言。 v3,实验
-Q [文件名/通配符]
见--qrcode
-q [文件名/通配符]
见--安静
- 二维码 [文件名/通配符]
生成元数据的二维码图像(在清单中使用)。
- 安静的 [文件名/通配符]
安静的少输出到屏幕。
-R [文件名/通配符]
见--rsync
-r [文件名/通配符]
见--scp
--redirect[=目录路径] [文件名/通配符]
将输出放在指定目录下的子目录中,子目录使用
文件名(不带后缀)。 如果未指定输出目录,则放置
当前目录下的子目录 (pwd)。 与使用默认设置不同 HTML
文件已经嵌入了 css。 比较 --dump
--首先 [文件名/通配符/网址]
ReST(rST 重组文本)智能文本(不可用)
--rsync [文件名/通配符]
使用 rsync 将 sisu 输出文件复制到远程主机。 这需要 sisurc.yml
已获得有关主机名和用户名的信息,并且您拥有
“密钥”和 ssh 代理就位。 请注意,如果使用 -R,则 rsync 的行为会有所不同
与其他标志如果单独使用。 单独发送 rsync --delete 参数,
用于清理远程目录(当 -R 与其他
标志,它不是)。 另见--scp。 别名 -R
-S 见--sisupod
-S [文件名/通配符]
见--sisupod
-s [文件名/通配符]
见 --source
--样本搜索表单 [--db-(pg|sqlite)]
生成 (naive) cgi 搜索表单的示例 SQLite 或 PgSQL 取决于您的
已经使用 sisu 来填充 SQLite 或 PgSQL 数据库,( SQLite
version 扫描现有 sisu_sqlite 数据库的输出目录,所以它是
在生成搜索表单之前首先需要创建它们)参见--sqlite &
--pg 和下面的数据库部分。 可选的附加参数:--db-
用户 =“www-数据”。 样本被转储到当前的工作目录中,该目录必须是
可写,(根据屏幕说明将它们复制到 cgi-bin
目录)。 别名 -F
--萨克斯 [文件名/通配符/网址]
见--xml-sax
--scp [文件名/通配符]
使用 scp 将 sisu 输出文件复制到远程主机。 这需要 sisurc.yml
已获得有关主机名和用户名的信息,并且您拥有
“密钥”和 ssh 代理就位。 另请参阅--rsync。 别名 -r
--sha256
设置哈希摘要用于 sha256
--sha512
设置哈希摘要用于 sha512
--sqlite-[说明] [文档名称]
数据库类型设置为 SQLite, 这将生成两个可能的数据库之一,而无需
附加的数据库相关指令它产生一个谨慎的 SQLite 文件为
已处理的文件; 加上额外的指令,它会产生一个共同的 SQLite
所有处理过的文件的数据库(来自同一个文件准备
目录,因此)共享相同的输出目录基本路径(可能
指令包括:--sqlite-createdb; --sqlite-创建; --sqlite-dropall;
--sqlite-import [文件名]; --sqlite-update [文件名]; --sqlite-删除
[文档名称]); 请参阅下面的数据库部分。
--西苏波德
生成一个 sisupod 一个包含 sisu 标记的标记文件的压缩 sisu 目录
源文件和目录本地配置文件、图像和皮肤。 笔记:
这仅包括仅包含在测试中的配置文件或皮肤
与 zsh)。 别名 -S
--西苏波德 [文件名/通配符]
生成指定的准备文档的压缩文件以及相关的
图像,默认情况下命名为 sisupod.zip 它们也可以使用
文件扩展名 .ssp 这提供了一种快速收集相关部分的方法
然后可以通过电子邮件发送 sisu 文件。 sisupod 包括 sisu
标记源文件,(连同相关的文档,如果主文件,或可用
在多语言版本中),以及相关的图像和皮肤。 上海外国语大学 命令
可以直接针对包含在本地目录中的 sisupod 运行,或者提供
作为远程站点上的 url。 由于提供的皮肤存在安全问题
其他用户,除非将标志 --trust 或 --trusted 添加到
命令指令,建议非自己的文件
视为不受信任。 解压文件的目录结构是这样理解的
sisu,并且可以在其中运行 sisu 命令。 注意:如果您想发送多个
文件,压缩 sisu 标记目录很快就会变得更节省空间,
而不是要发送的单个文件)。 查看 -S 选项,不带
[文件名/通配符]。 别名 -S
- 来源 [文件名/通配符]
将 sisu 标记文件复制到输出目录。 别名 -s
- 严格的
与 --html 一起产生更多符合 w3c 的 html,例如没有
文本的纯数字标识符,位置对象 url#33 变为 url#o33
-T [文件名/通配符 (*.termsheet.rb)]
标准表单文档生成器,预处理功能
-t [文件名/通配符]
见--txt
--texinfo [文件名/通配符]
产生 texinfo 和 info 文件,(用 pinfo 查看)。 别名 -I
- 纺织品 [文件名/通配符/网址]
纺织智能文本(不可用)
- 文本 [文件名/通配符]
产生 纯文本 带有 Unix 换行符且不带标记,(对象编号是
省略),在包含它们的每个段落末尾都有脚注 [ -A 表示
等效的 dos(换行)输出文件] [尾注见 -e]。 (选项包括:
--endnotes 用于尾注 --footnotes 用于每段末尾的脚注
--unix 用于 unix 换行(默认)--msdos 用于 msdos 换行)。 别名 -t
--txt-asciidoc [文件名/通配符]
见--asciidoc
--txt-降价 [文件名/通配符]
见 --markdown
--txt-第一 [文件名/通配符]
见--rst
--txt-纺织 [文件名/通配符]
见--纺织
-U [文件名/通配符]
见--urls
-u [文件名/通配符]
为请求处理的标志提供输出文件的 url 映射,也
再见
--网址 [文件名/通配符]
为可用的处理标志选项打印 url 输出列表/映射并生成
可以请求的文件,(可用于获取处理选项列表
与文件的关系,以及有关输出的信息
生产),-u 为那些请求处理的标志提供 url 输出映射。
默认假设 sisu_webrick 正在运行并提供 webrick url 映射,其中
适当,但这些可以切换到 sisurc.yml 中的文件系统路径。 别名 -U
-V 它自己,提供 上海外国语大学 版本和环境信息(sisu --help env)
-V [文件名/通配符]
甚至比 -v 标志更冗长。
-v 它自己,提供 上海外国语大学 版本信息
-v [文件名/通配符]
见--详细
--详细 [文件名/通配符]
提供正在生成的内容的详细输出,输出放置的位置(和
错误消息(如果有),与 -u 标志一样,提供为以下文件创建的文件的 url 映射
每个处理标志请求。 别名 -v
--非常详细 [文件名/通配符]
提供正在生成的内容的更详细的输出。 见--详细。 别名 -V
- 版
西苏版
-W 见--webrick
-w [文件名/通配符]
见 --concordance
--webrick
启动 ruby 的 webrick 网络服务器指向 sisu 输出目录,默认
端口设置为 8081,可以在资源配置文件中更改。 [提示:
webrick 服务器需要链接后缀,因此应使用创建 html 输出
-h 选项而不是 -H ; 另外,请注意 -F webrick ]。 别名 -W
--字图 [文件名/通配符]
见 --concordance
--xhtml [文件名/通配符]
产生 xhtml/ XML 用于浏览器查看的输出(sax 解析)。 别名 -b
--xml-dom [文件名/通配符]
产生 XML 具有深度文档结构的输出,具有 dom 的性质。 别名 -X
--xml-sax [文件名/通配符]
产生 XML 输出浅层结构(sax 解析)。 别名 -x
-X [文件名/通配符]
见--xml-dom
-x [文件名/通配符]
见--xml-sax
-Y [文件名/通配符]
根据 html 输出和
sisu_manifest。 --sitemaps 生成/更新现有站点地图的站点地图索引。
(实验性的,[g,y,m 本周公告])
-y [文件名/通配符]
见--清单
-Z [文件名/通配符]
见--zap
--扎普 [文件名/通配符]
Zap,如果与其他处理标志一起使用,将删除类型的输出文件
在处理之前进行处理。 如果 -Z 用作单独处理相关
标志(或与 -[mMvVq] 结合使用),将删除相关的
文档输出目录。 别名 -Z
指挥 LINE 修饰语
--no-ocn
[使用 --html --pdf 或 --epub] 关闭 对象 引用 编号。 生产
输出不识别 html 边距中的数字或 胶乳 /pdf 输出。
--无注释
删除由星号或匕首/加号表示的编辑器尾注 [^*1] 的输出文本
--无星号
删除由星号表示的编辑器尾注 [^*2] 的输出文本
--没有匕首
删除由匕首/加号表示的编辑器尾注 [^+1] 的输出文本
数据库 指令
分贝 - 数据库 接口
--pg or --pgsql 为 PostgreSQL的 --sqlite 默认设置为 SQLite -d 可以修改
--db=[数据库类型(PgSQL 或 SQLite )]
--pg -v --创建全部
第一步,在现有的关系中创建所需的关系(表、索引) PostgreSQL的
数据库(应该手动创建一个数据库并赋予与工作相同的名称
目录,根据要求)(rb.dbi)[ -dv --createall SQLite 等效]它可能是
最初需要运行 sisu -Dv --createdb 注意:目前对于
PostgreSQL的 可能需要手动创建数据库。 该命令将
是目录名(不带路径)]。 请仅使用字母数字和下划线。
--pg -v - 进口
[文件名/通配符] 导入指定的数据 PostgreSQL的 db (rb.dbi) [-dv --import
SQLite 相等的]
--pg -v - 更新
[文件名/通配符] 将指定的数据更新/导入到 PostgreSQL的 分贝(rb.dbi)[-dv
- 更新 SQLite 相等的]
--pg - 消除
[filename/wildcard] 删除指定的数据到 PostgreSQL的 db (rb.dbi) [ -d --删除
SQLite 相等的]
--pg --dropall
杀死数据”并丢弃( PostgreSQL的 or SQLite ) 数据库、表和索引 [ -d --dropall
SQLite 相等的]
-v 用于详细输出。
指挥 LINE 与 旗帜 - 批量 处理
在数据目录中运行 sisu -mh 文件名或通配符,例如。 "sisu -h cisg.sst" 或 "sisu
-h *.{sst,ssm}" 生成所有文档的 html 版本。
运行 sisu(单独运行,没有任何标志、文件名或通配符)会显示交互式
帮助,以及任何未被识别的 sisu 命令。 进入逃生。
帮助
SISU 说明书
有关 sisu 的最新信息应包含在 sisu_manual 中,可用
可以在:
<http://sisudoc.org/sisu/sisu_manual/>
该手册可以从源代码生成,分别在 上海外国语大学
tarball 或本地安装在:
./data/doc/sisu/标记样本/sisu_manual
/usr/share/doc/sisu/标记样本/sisu_manual
移动到相应的目录并键入例如:
西苏西苏_手册.ssm
SISU 男装 PAGES
If 上海外国语大学 安装在您的系统上通常的 man 命令应该可用,请尝试:
男人西苏
桥梁 上海外国语大学 手册页直接从用于准备的 sisu 文档中生成
sisu 手册,其源文件位于 上海外国语大学 tarball 在:
./data/doc/sisu/标记样本/sisu_manual
安装后,目录相当于:
/usr/share/doc/sisu/标记样本/sisu_manual
可用的手册页使用 man2html 转换回 html:
/usr/share/doc/sisu/html/
./data/doc/sisu/html
可以在此处获得 sisu 手册页的在线版本:
* 各种 sisu 手册页http://www.jus.uio.no/sisu/man/> [^1]
* sisu.1http://www.jus.uio.no/sisu/man/sisu.1.html> [^2]
SISU 内置 互动 帮助, [已停产]
这已经过时并已停止使用。
引言 TO SISU 标记[^3]
概要
上海外国语大学 源文件是 纯文本 ( UTF-8 )[^4] 文件
所有段落都由一个空行分隔。
标记包括:
* 在文档的顶部,文档标题由关于文档的语义元数据组成
文件,如果需要,附加处理说明(如
自动编号从特定级别向下的标题)
* 其次是准备好的实质性文本,其中最重要的单
特征是不同标题级别的标记,它定义了主要轮廓
的文档结构。 实质性文本的标记包括:
* 标题级别定义文档结构
* 文本基本属性,斜体,粗体等。
* 分组文本(对象),要区别对待,例如代码
积木或诗歌。
* 脚注/尾注
* 链接的文本和图像
* 段落操作,例如缩进、项目符号、编号列表等。
标记 规则, 文件 结构 AND 元数据 参赛要件
最低内容/结构要求:
[元数据]
A~(A级【标题】)
1~(至少一级[段/(章)])
结构规则(文档层次结构,标题级别):
有两组标题级别 ABCD(标题和部分,如果有)和 123(段和
子分段(如果有)
sisu 有以下流动级别:
A~[标题]。
必需 (== 1) 后跟 B~ 或 1~
B~ [部分] *
后跟 C~ 或 1~
C~ [子部分] *
后跟 D~ 或 1~
D~ [子部分] *
其次是1~
1~【段(章)】+
必需 (>= 1) 后跟文本或 2~
文本 *
后跟更多文字或 1~, 2~
或相关部分 *()
2~ [细分] *
后跟文字或3~
文本 *
后跟更多文字或 1~、2~ 或 3~
或相关部分,见*()
3~ [子细分] *
后跟文字
文本 *
后跟更多文字或 1~、2~ 或 3~ 或相关部分,见 *()
*(B~如果没有其他使用;
如果最后使用 C~:C~ 或 B~;
如果使用 D~:D~、C~ 或 B~)
* A级~是瓷砖,是必填的
* A 级只能有一个~
* 标题级别 BCD,是可选的,每个可能有几个
(所有三个都使用对应于例如书籍部分部分)
* 使用的子级别必须按顺序相互跟随
(按字母顺序),
* 标题级别 A~ B~ C~ D~ 后面是其他标题级别而不是
而非实质性文本
这可能是随后的顺序(字母)标题部分级别
或标题(段)级别 1~
* 必须至少有一个标题(段)级别 1~
(文本分割的级别,在一本书中将对应
到章节级别)
* 附加标题级别 1~2~3~ 是可选的,可能有几个
每个
* 标题级别 1~2~3~ 后跟文本(后面可能跟
相同的标题级别)
和/或下一个较低的数字标题级别(后跟文本)
或者确实返回到相关部分级别
(作为上述实质性文本/内容规则的必然结果
必须以 1~(2~ 或 3~)级标题开头)
标记 示例
ONLINE
在线标记示例与相应的输出一起提供
<http://www.jus.uio.no/sisu/SiSU/examples.html> 或来自
<http://www.jus.uio.no/sisu/sisu_examples/>
当然有这个文档,它提供了 sisu 标记的粗略概述和
产生的相应输出:http://www.jus.uio.no/sisu/sisu_markup/>
标记语法的另一种表示:/usr/share/doc/sisu/on_markup.txt.gz
已安装
在 上海外国语大学 安装的样本皮肤可以在:/usr/share/doc/sisu/markup-samples(或
等效目录),如果 sisu -markup-samples 也安装在:
/usr/share/doc/sisu/markup-samples-non-free
标记 OF 标题
标题包含:关于文档的语义元数据,可以被任何人使用
程序的输出模块,或; 处理指令。
注意:文档的第一行可能包含有关所用标记版本的信息
评论的形式。 注释是段落开头的百分比标记(并且作为
一行文本中的第一个字符)后跟一个空格和注释:
% 这将是一个评论
样品 HEADER
此当前文档由具有与此类似的标题的主文档加载
一:
% SiSU 大师 4.0
@title:西苏
:subtitle: 手册
@创作者:
:作者:阿米萨,拉尔夫
@publisher:[出版商名称]
@rights:版权所有 (C) Ralph Amissah 2007,SiSU 文档的一部分,许可 GPL 3
@分类:
:topic_register: SiSU:manual;电子文档:SiSU:manual
:subject: 电子书, epublishing, 电子书, 电子出版,
电子文档、电子引文、数据结构、
引文系统,搜索
% used_by: 手册
@日期:
: 发表: 2008-05-22
:创建:2002-08-28
: 发布: 2002-08-28
: 可用: 2002-08-28
:修改:2010-03-03
@制作:
:num_top:1
:breaks: new=C; 中断=1
:粗体: /Gnu|Debian|Ruby|SiSU/
:home_button_text: {SiSU}http://sisudoc.org; {混帐}http://git.sisudoc.org
:页脚: {SiSU}http://sisudoc.org; {混帐}http://git.sisudoc.org
:manpage: name=sisu - 文档:标记、结构化、以多种标准格式发布和搜索;
概要=sisu [-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [文件名/通配符]
. sisu [-Ddcv] [说明]
. 西苏 [-CcFLSVvW]
@链接:
{ SiSU 主页}http://www.sisudoc.org/
{ SiSU 手册 }http://www.sisudoc.org/sisu/sisu_manual/
{ 书籍样本和标记示例}http://www.jus.uio.no/sisu/SiSU/examples.html
{ SiSU 下载}http://www.jus.uio.no/sisu/SiSU/download.html
{ SiSU 更新日志 }http://www.jus.uio.no/sisu/SiSU/changelog.html
{ SiSU Git 仓库}http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=摘要
{ SiSU 列表档案}http://lists.sisudoc.org/pipermail/sisu/
{ SiSU @Debian }http://packages.qa.debian.org/s/sisu.html
{ SiSU 项目 @ Debian }http://qa.debian.org/developer.php?登录=[电子邮件保护]
{ SiSU@维基百科}http://en.wikipedia.org/wiki/SiSU
可用 标题
标题标签出现在文档的开头并提供有关文档的元信息
文件(如 都柏林 核心 ) ,或有关整个文档如何的信息
待处理。 所有标题指令都采用@headername: 或下一行的形式
并缩进一次空格 :subheadername: All 都柏林 核心 元标记可用
@标识符: 信息或说明
其中“标识符”是程序识别的标签,“信息”或
“指令”属于指定的标签/标识符
注意:使用的标头只能使用一次; 除了@title: 之外的所有标题都是
可选的; @structure: header 用于描述文档结构,很有用
知道。
这是一个示例标题
% SiSU 2.0 [带有标记版本的声明文件类型标识符]
@title: [title text] [这个标题是唯一的必填项]
:subtitle: [如果有字幕]
:英语语言
@创作者:
:作者: [姓氏,名字]
:illustrator: [姓氏,名字]
:translator: [姓氏,名字]
:prepared_by: [姓氏,名字]
@日期:
:published: [年或 yyyy-mm-dd]
:created: [年或 yyyy-mm-dd]
:issued: [年或 yyyy-mm-dd]
:available: [年或 yyyy-mm-dd]
:修改:[年或yyyy-mm-dd]
:valid: [年或 yyyy-mm-dd]
: added_to_site: [年或 yyyy-mm-dd]
:translated: [年或 yyyy-mm-dd]
@权利:
:copyright: 版权所有 (C) [年份和持有人]
:license: [授予使用许可]
:text: [年份和持有人]
:translation: [姓名,年份]
:插图: [姓名,年份]
@分类:
:topic_register: SiSU:标记示例:书;书:小说:幻想
:类型:
:主题:
:描述:
:关键词:
:抽象的:
:loc: [国会图书馆分类]
:dewey: [杜威分类
@确认:
:isbn: [国际标准书号]
:oclc:
@链接:{西苏}http://www.sisudoc.org
{FSF}http://www.fsf.org
@制作:
:num_top:1
:headings: [文本匹配每个级别
(例如部分;章节;部分;文章;或其他:无;书|第一|第二;无;章节;)
:breaks: new=:C; 中断=1
:promo: sisu, ruby, sisu_search_libre, open_society
:bold: [要加粗的单词/短语的正则表达式]
:italics: [单词/短语的正则表达式斜体]
:home_button_text: {SiSU}http://sisudoc.org; {混帐}http://git.sisudoc.org
:页脚: {SiSU}http://sisudoc.org; {混帐}http://git.sisudoc.org
@原来的:
:语言: [语言]
@笔记:
:评论:
:prefix: [前缀放在目录之后]
标记 OF 实质性 文字
标题 各级
标题级别是 :A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ ... :A - :C 是部分/部分标题,
后跟其他标题级别,1 -6 是标题后跟实质性文本或
小标题。 :A~ 通常是标题 :A~? 有条件的 1 级标题(用于
单独的文件可以导入到另一个文件中)
:啊~ [标题 文本] 顶级标题 [这通常与标题具有相似的内容
@title: ] 注意:此处描述的标题级别采用 0.38 表示法,请参阅标题
:B~ [标题 文本] 二级标题[这是一个标题级别分隔符]
:C~ [标题 文本] 第三级标题[这是一个标题级别分隔符]
1~ [标题 文本] 文件或副标题的实质性文本之前的顶级标题
2、通常会在文档中标记为 1. 或 2. 或 3. 等的标题级别,以及
默认情况下 sisu 将 html 输出分成命名段的级别,名称是
如果没有给出(数字),则自动提供,否则采用形式
1~这个段的我的文件名
2~ [标题 文本] 文件或子文件实质性文本之前的二级标题
标题 3 ,通常标记为 1.1 或 1.2 或 1.3 或 2.1 等的标题级别。
在一份文件中。
3~ [标题 文本] 文件实质性文本之前的三级标题,即
通常在文件中标记 1.1.1 或 1.1.2 或 1.2.1 或 2.1.1 等
1~文件名一级标题,
% 主要部分,例如后面是实质性文本的章节,并且可以进一步细分(这是默认情况下制作 html 段的级别)
字体 ATTRIBUTES
标记 例:
普通文本,*{强调}*,!{粗体}!,/{斜体}/,_{下划线}_,“{引文}”,
^{上标}^, ,{下标},, +{插入文本}+, -{删除线}-, #{等宽}#
普通文本
*{强调}* [注:可以配置为粗体、斜体或下划线表示]
!{粗体}!
/{斜体}/
_{下划线}_
“{引文}”
^{上标}^
,{下标},
+{插入的文字}+
-{删除线}-
#{等宽}#
导致 输出:
普通文字, 重点, 无所畏惧 文本 , 斜体, 下划线, "引用", ^上标^,
[下标], ++插入文本++, --strikethrough--, 等宽
普通文本
重点 [注:可配置为粗体、斜体或下划线表示]
无所畏惧 文本
斜体
下划线
“引用”
^上标^
【下标】
++插入文本++
--删除线--
等宽字体
缩进 AND 子弹头
标记 例:
普通段落
_1 段落缩进一步
_2 段落缩进两步
_9 缩进段落九步
导致 输出:
普通段落
缩进一段
缩进段落两步
缩进段落九步
标记 例:
_* 项目符号文本
_1* 项目符号文本,第一个缩进
_2* 项目符号文本,两步缩进
导致 输出:
* 项目符号文本
* 项目符号文本,第一个缩进
* 项目符号文本,两步缩进
编号列表(不要与标题/标题混淆,(文档结构))
标记 例:
# 编号列表编号列表 1., 2., 3, 等等。
_# 编号列表 编号列表缩进 a.、b.、c.、d. 等。
挂着 缩进
标记 例:
_0_1 第一行没有缩进,
其余段落缩进一级
_1_0 首行缩进,
其余段落没有缩进
在每种情况下级别可能是 0-9
导致 输出:
第一行不缩进,其余段落缩进一步; 第一行没有
缩进,其余段落缩进一级; 第一行不缩进,其余部分
段落缩进一级; 第一行不缩进,其余段落缩进
一步; 第一行不缩进,其余段落缩进一步; 第一的
行不缩进,其余段落缩进一级; 第一行没有缩进,
其余段落缩进一级; 第一行不缩进,其余段落
缩进一步; 第一行不缩进,其余段落缩进一步;
一个普通的段落。
首行缩进,其余段落不缩进 首行缩进,其余段落
不缩进 首行缩进,其余段落不缩进 首行缩进,其余部分
段落不缩进首行缩进,段落的其余部分不缩进首行缩进,
其余段落不缩进首行缩进,其余段落不缩进首行
缩进,其余段落不缩进 首行缩进,其余段落不缩进
首行缩进,其余段落不缩进 首行缩进,其余段落不缩进
缩进
在每种情况下级别可能是 0-9
现场建造
用于构建自定义的脚本集合 Debian
生命系统。
.我现场建造
以前称为live-helper,更早的时候称为live-package。
现场建造
用于构建自定义的脚本集合 Debian
生命系统。 现场建造
以前称为live-helper,更早的时候称为live-package。
脚注 / 尾注
脚注和尾注标记在它们将在其中指示的位置
一个文本。 它们会自动编号。 输出类型决定是脚注还是
将产生尾注
标记 例:
~{ 脚注或尾注 }~
导致 输出:
[^5]
标记 例:
普通文本~{自包含尾注标记和尾注合二为一}~继续
导致 输出:
普通文本[^6] 继续
标记 例:
普通文本 ~{* 未编号的星号脚注/尾注,如果需要,插入多个星号 }~ 继续
普通文本 ~{** 另一个未编号的星号脚注/尾注 }~ 继续
导致 输出:
普通文本 [^*] 继续
普通文本 [^**] 继续
标记 例:
普通文本 ~[* 编辑注释,编号为星号的脚注/尾注系列 ]~ 继续
普通文本~[+ 编辑注释,编号加符号脚注/尾注系列]~ 继续
导致 输出:
普通文本 [^*3] 继续
普通文本 [^+2] 继续
可再生 尾注 对 符号 脚注/尾注:
% 注意尾注标记“~^”
普通文字~^继续
^~ 尾注文本出现在标记所在的段落之后
标准和配对符号不能在同一文档中混合使用
裸 网址 中 文本, 交易 与 网址
在文本中找到的 url 会自动标记。 文本中的 url 是自动的
超链接到自身,默认情况下用尖括号装饰,除非它们是
包含在代码块中(在这种情况下,它们作为普通文本传递),或转义
通过前面的下划线(在这种情况下,装饰被省略)。
标记 例:
普通文本 http://www.sisudoc.org/ 继续
导致 输出:
普通文本http://www.sisudoc.org/> 继续
一个没有装饰的转义网址
标记 例:
普通文本_http://www.sisudoc.org/ 继续
黛布_http://www.jus.uio.no/sisu/archive 不稳定主非自由
导致 输出:
普通文本<_http://www.sisudoc.org/> 继续
deb <_http://www.jus.uio.no/sisu/archive> 不稳定主非自由
使用代码块的地方既没有装饰也没有超链接,代码块是
本文档稍后讨论
导致 输出:
DEB http://www.jus.uio.no/sisu/archive 不稳定主非自由
deb-src http://www.jus.uio.no/sisu/archive 不稳定主非自由
链接 文字
要将文本或图像链接到 url,标记如下
标记 例:
关于{ SiSU }http://url.org 标记
导致 输出:
关于西苏http://www.sisudoc.org/> 标记
可以使用快捷方式表示法,因此也可以自动提供 url 链接作为
脚注
标记 例:
关于 {~^ SiSU }http://url.org 标记
导致 输出:
关于西苏http://www.sisudoc.org/> [^7] 标记
指向标记位置的内部文档链接,包括 ocn
标记 例:
关于{文本链接}#link_text
导致 输出:
关于⌠文本链接⌡⌈link_text⌋
共享文档集合链接
标记 例:
关于{ SiSU书签示例}:SiSU/examples.html
导致 输出:
关于⌠ 上海外国语大学 书籍标记示例⌡⌈:SiSU/examples.html⌋
链接 图片
标记 例:
{ tux.png 64x80 }图像
% 各种 url 链接图像
{tux.png 64x80“更好的方法”}http://www.sisudoc.org/
{GnuDebianLinuxRubyBetterWay.png 100x101“更好的方式 - 使用 Gnu/Linux、Debian 和 Ruby”}http://www.sisudoc.org/
{~^ ruby_logo.png "红宝石" }http://www.ruby-lang.org/en/
导致 输出:
[礼服.png]
tux.png 64x80 "Gnu/Linux - 更好的方式"http://www.sisudoc.org/>
GnuDebianLinuxRubyBetterWay.png 100x101“更好的方式 - 使用 Gnu/Linux、Debian 和 Ruby”
<http://www.sisudoc.org/>
ruby_logo.png 70x90 "红宝石"http://www.ruby-lang.org/en/> [^8]
链接 网址 脚注 捷径
{~^ [链接文本] }http://url.org
% 映射到:{ [文本链接] }http://url.org ~{ http://url.org }~
% 在文档/段落中生成超链接文本,尾注提供超链接中使用的文本位置的 url
文本标记 *~name
注意在标题级别,通过为标题提供名称可以自动实现相同的功能
1, 2 和 3 即 2~[name] 和 3~[name] 或在自动标题编号的情况下,没有
进一步干预。
友情链接 快捷方式 用于 多 版本 OF A SISU 文件 IN “ SAME 目录
树
标记 例:
!_ /{"病毒螺旋"}/, 大卫·博利尔
{“病毒螺旋”,大卫·波利尔 [3sS]}viral_spiral.david_bollier.sst
病毒 螺旋 , 大卫·波利尔《病毒式螺旋》,大卫·波利尔
<http://corundum/sisu_manual/en/manifest/viral_spiral.david_bollier.html>
文件清单
<http://corundum/sisu_manual/en/manifest/viral_spiral.david_bollier.html>
⌠html,分段
文字⌡「http://corundum/sisu_manual/en/html/viral_spiral.david_bollier.html」
⌠html,滚动,文档输入
一⌡「http://corundum/sisu_manual/en/html/viral_spiral.david_bollier.html」
⌠epub⌡「http://corundum/sisu_manual/en/epub/viral_spiral.david_bollier.epub」
⌠pdf,
风景⌡「http://corundum/sisu_manual/en/pdf/viral_spiral.david_bollier.pdf」
⌠pdf, 肖像⌡「http://corundum/sisu_manual/en/pdf/viral_spiral.david_bollier.pdf」
⌠odf: odt, 打开文档
文字⌡「http://corundum/sisu_manual/en/odt/viral_spiral.david_bollier.odt」
⌠xhtml
滚动⌡「http://corundum/sisu_manual/en/xhtml/viral_spiral.david_bollier.xhtml」
⌠xml,萨克斯⌡「http://corundum/sisu_manual/en/xml/viral_spiral.david_bollier.xml」
⌠xml,dom⌡「http://corundum/sisu_manual/en/xml/viral_spiral.david_bollier.xml」
⌠索引⌡「http://corundum/sisu_manual/en/html/viral_spiral.david_bollier.html」
⌠dcc,文件内容证明
(摘要)⌡「http://corundum/sisu_manual/en/digest/viral_spiral.david_bollier.txt」
⌠标记源
文字⌡「http://corundum/sisu_manual/en/src/viral_spiral.david_bollier.sst」
⌠标记源(压缩)
豆荚⌡「http://corundum/sisu_manual/en/pod/viral_spiral.david_bollier.sst.zip」
分组 文字 / BLOCKED 文字
阻止文本有两种标记语法,使用花括号或使用 tic
BLOCKED 文字 卷曲 支撑 句法
在一行的开始,用一个左花括号自己使用的块类型名称,
跟随块的内容,并用右花括号和名称结束
块类型,例如
代码{
这是一个代码块
}代码
诗{
这是一首诗
}诗
BLOCKED 文字 信息和通信技术 句法
``` 代码
这是一个代码块
````
```诗
这是一首诗
````
以三个反引号开始一行,一个空格后跟块类型的名称,
跟随块的内容,并在它们的一行上用三个反勾号关闭
自己的,例如
TABLES
表格可以以两种形式中的两种形式准备
标记 例:
表{ c3; 40; 30; 30;
这是一张桌子
这将成为第一行的第二列
第一行的第三列在这里
这里开始另一行
第二行的第二列
第二行第三列,以此类推
}桌子
导致 输出: 这是一个表格|这将成为第一行的第二列|第三列
第一行在这里』这里开始另一行|第二行的第二列|行的第三列
二等』
在没有太多信息的情况下,第二种形式可能更容易使用
每列
标记 例: [^9]
!_ 表 3.1:维基百科的贡献者,2001 年 2005 月 - XNUMX 年 XNUMX 月
{表~h 24; 12; 12; 12; 12; 12; 12;}
|一月。 2001|一月2002|一月2003|一月2004|2004 年 2006 月|XNUMX 年 XNUMX 月
贡献者* | 10| 第472话2,188| 9,653| 25,011| 48,721
活跃贡献者** | 9| 212| 第846话3,228| 8,442| 16,945
非常活跃的贡献者*** | 0| 31| 190| 第692话1,639| 3,016
英文文章数量| 25| 16,000| 101,000| 190,000| 320,000 | 630,000
文章数量,所有语言 | 25| 19,000| 138,000| 490,000| 862,000|1,600,000
* 贡献至少十次; ** 上个月至少 5 次; *** 上个月超过 100 次。
导致 输出:
表 3.1年: 合作者 至 维基百科, 一月 2001 - 六月 2005 |一月。 2001|一月2002|一月
2003|Jan. 2004|July 2004|June 2006』Contributors*|10|472|2,188|9,653|25,011|48,721』Active
contributors**|9|212|846|3,228|8,442|16,945』Very active
贡献者***|0|31|190|692|1,639|3,016』没有。 英语语言
文章|25|16,000|101,000|190,000|320,000|630,000』没有。 的文章,所有
languages|25|19,000|138,000|490,000|862,000|1,600,000』
* 贡献至少十次; ** 上个月至少 5 次; *** 超过 100
上个月的次数。
诗
基本包 标记:
诗{
你的诗在这里
}诗
一首诗中的每一节都有一个对象编号。
标记 例:
诗{
`Fury 对一个人说
老鼠,那他
遇见了
屋,
“让我们
都去
法律:我会
起诉
你。 - 来,
我不接受
否认; 我们
必须有一个
试用:对于
真的这个
早上我
没什么
去做。”
说
鼠标到
cur, "这样的
一次审判,
亲爱的先生,
在
没有陪审团
或判断,
将
浪费
我们的
呼吸。”
“我将会
判断,我会
做陪审团,”
说
狡猾
老愤怒:
“患病的
尝试
全
原因
和
谴责
至
死亡。”'
}诗
导致 输出:
`Fury 对一个人说
老鼠,那他
遇见了
屋,
“让我们
都去
法律:我会
起诉
你。 - 来,
我不接受
否认; 我们
必须有一个
试用:对于
真的这个
早上我
没什么
去做。”
说
鼠标到
cur, "这样的
一次审判,
亲爱的先生,
在
没有陪审团
或判断,
将
浪费
我们的
呼吸。”
“我将会
判断,我会
做陪审团,”
说
狡猾
老愤怒:
“患病的
尝试
全
原因
和
谴责
至
死亡。”'
公司
基本包 标记:
团体{
您在此处分组的文本
}团体
一个组被视为一个对象并被赋予一个对象编号。
标记 例:
团体{
`Fury 对一个人说
老鼠,那他
遇见了
屋,
“让我们
都去
法律:我会
起诉
你。 - 来,
我不接受
否认; 我们
必须有一个
试用:对于
真的这个
早上我
没什么
去做。”
说
鼠标到
cur, "这样的
一次审判,
亲爱的先生,
在
没有陪审团
或判断,
将
浪费
我们的
呼吸。”
“我将会
判断,我会
做陪审团,”
说
狡猾
老愤怒:
“患病的
尝试
全
原因
和
谴责
至
死亡。”'
}团体
导致 输出:
`Fury 对一个人说
老鼠,那他
遇见了
屋,
“让我们
都去
法律:我会
起诉
你。 - 来,
我不接受
否认; 我们
必须有一个
试用:对于
真的这个
早上我
没什么
去做。”
说
鼠标到
cur, "这样的
一次审判,
亲爱的先生,
在
没有陪审团
或判断,
将
浪费
我们的
呼吸。”
“我将会
判断,我会
做陪审团,”
说
狡猾
老愤怒:
“患病的
尝试
全
原因
和
谴责
至
死亡。”'
守则
代码标签 code{ ... }code(与上述其他组标签一起使用)用于
转义常规 sisu 标记,并在本文档中广泛使用以提供
示例 上海外国语大学 标记。 但是,您不能使用代码标签来转义代码标签。 他们是
但是与组或诗歌标签的使用方式相同。
代码块被视为一个对象并被赋予一个对象编号。 [一个选项
编号每行代码可能会在以后考虑]
使用 of 码 标签 代替 of 诗 比较的, 导致 输出:
`Fury 对一个人说
老鼠,那他
遇见了
屋,
“让我们
都去
法律:我会
起诉
你。 - 来,
我不接受
否认; 我们
必须有一个
试用:对于
真的这个
早上我
没什么
去做。”
说
鼠标到
cur, "这样的
一次审判,
亲爱的先生,
在
没有陪审团
或判断,
将
浪费
我们的
呼吸。”
“我将会
判断,我会
做陪审团,”
说
狡猾
老愤怒:
“患病的
尝试
全
原因
和
谴责
至
死亡。”'
从 上海外国语大学 2.7.7 你可以通过在开始代码标签后放置一个散列来给代码块编号
代码{#如这里所示:
1 | `Fury 对一个人说
2 | 老鼠,那他
3 | 在遇见
4 | 房子,
5 | “让我们
6 | 都去
7 | 法律:我会
8 | 起诉
9 | 你。 - 来,
10 | 我不接受
11 | 否认; 我们
12 | 必须有
13 | 试用:对于
14 | 真的这个
15 | 早上我
16 | 没有
17 | 去做。”
18 | 说
19 | 鼠标到
20 | cur, "这样的
21 | 一次审判,
22 | 尊敬的先生,
23 | 和
24 | 没有陪审团
25 | 或判断,
26 | 将是
27 | 浪费
28 | 我们的
29 | 呼吸。”
30 | “我将会
31 | 判断,我会
32 | 做陪审团,”
33 | 说过
34 | 狡猾
35 | 老愤怒:
36 | “患病的
37 | 试试
38 | 所有的
39 | 原因,
40 | 和
41 | 谴责
42 | 你
43 | 到
44 | 死亡。”'
附加 休息时间 - 换行 中 对象, COLUMN AND 分页符
换行符
要在“段落对象”中换行,两个反斜杠 \\ 前面有一个空格,一个
可以在它们之后使用空格或换行符。
要在“段落对象”中换行,
两个反斜杠 \\ 前面有一个空格
和他们后面的空格或换行符 \\
可能用过了。
包含在尖括号中的 html break br(虽然未记录)可在
3.0.13 和 2.9.7 之前的版本(它暂时仍然可用,但
贬值)。
要绘制分割段落的分割线,请参阅分页符部分。
页 休息时间
分页符仅适用于某些输出格式。 分页符或新的
可以在一行中使用以下标记手动插入页面:
page new =\= 中断页面,开始一个新页面。
分页符 -- 中断一列,开始一个新列,如果使用列,否则会中断
页,开始一个新的页面。
跨页分页线 -..- 画一条分割线,分割段落
分页符:
-\\-
页(中断)新:
=\\=
分页(分页)跨页行(分隔段落):
-..-
参考书目 / 参考文献:
使用 sisu 可以通过三种方式来准备参考书目(它们是相互排斥的):
(i) 在 sisu 中手动准备和标记作为常规文本的参考文献列表,这
被视为常规文档段(如果有的话,放在尾注之前); (二)
准备参考书目,标记标题级别 1~!biblio(注意感叹号)
并使用各种元数据标签准备参考书目,包括作者:标题:
年份:以下提供的列表,或; (iii) 作为协助准备
参考书目,标记标题级别 1~!biblio 并在脚注中标记引文
包含,识别引文并让解析器尝试提取它们并构建一个
提供的引文的参考书目。
对于标题/章节顺序:尾注、参考书目然后书籍索引出现,
名称 biblio 或 bibliography 必须提供给参考书目部分,如下所示:
1~!biblio~ [注意:标题标记::所需标题丢失]
A 标记 标记 元数据 参考书目 部分
在这里,每次您有新的引文时,不要直接在脚注中写下完整的引文
要引用的材料,您将其添加到参考书目部分(如果尚未添加)
根据可用的标签列表(下面提供)提供您需要的信息。
所需的标签是 au: ti: 和 year: [^10] 一个简短的示例可能如下所示:
1~!biblio~ [注意:标题标记::所需标题丢失]
au:冯·希佩尔,E.
ti: 视角:用户创新工具包
lng:(语言)
jo:产品创新管理杂志
语音:18
ed:(编辑)
年份:2001
注意事项:
sn: Hippel, /{用户工具包}/ (2001)
编号:vHippel_2001
% 形式:
au: 本克勒、洋柴
ti:网络的财富
st:社会生产如何改变市场和自由
lng:(语言)
pb:哈佛大学出版社
edn:(版)
年份:2006
pl: 美国
网址: http://cyber.law.harvard.edu/wealth_of_networks/Main_Page
注意事项:
SN:本克勒,/{网络财富}/(2006 年)
编号:Benkler2006
au:堂吉诃德; 潘萨,桑乔
ti: 驯服风车,保持真实
jo:虚构日记
年份:1605
网址:https://en.wikipedia.org/wiki/Don_Quixote
注意:为提供两个作者的文章的作者标记示例而制作
sn: Quixote & Panza, /{驯服风车}/ (1605)
编号: quixote1605
请注意,参考书目需要部分名称 !biblio(或 !bibliography)
被特殊对待,并放置在自动生成的尾注部分之后。
使用这种方法,可以准备参考书目、标签作者或编辑,
年份和标题是必需的,将用于对放置在下面的参考书目进行排序
参考书目部分
元数据标签可能包括短名称 (sn:) 和 id(如果提供),用于
文本中的替换。 每次在文本中找到给定的 id 时,它将是
替换为作品的给定短标题(因此短标题有
sisu 标记以斜体标题),它应该适用于要添加的任何页码,
短标题应该是一个可以很容易地用于在
参考书目。
以下脚注~{ quixote1605, pp 1000 - 1001, also Benkler2006 p 1. }~
将呈现为:
堂吉诃德和潘萨, 驯服 风车 (1605), pp 1000 - 1001 也是, Benkler, 财富 of
网络, (2006) p 1 或更确切地说 [^11]
au:作者姓氏,名字(如果有多个分号分隔符)
(除非要使用编辑器,否则是必需的)
ti:标题(必填)
st:副标题
jo:日记
vo:音量
ed:编辑器(如果未提供作者,则为必需)
tr:翻译
src: 来源(其他人不合适的通用字段)
在:在(如src)
pl:地点/地点(州、国家)
pb:出版商
edn:版本
年:年(yyyy 或 yyyy-mm 或 yyyy-mm-dd)(必需)
pg:页面
网址: http://url
注意:注意
id: create_short_identifier 例如 authorSurnameYear
(用于替换:在文本中找到时将是
替换为提供的简称)
sn:简称,例如作者、/{短标题}/、年份
(用于替换:当在文本中找到 id 时
短名称将用于替换它)
标记 QUOTES 用于 包容 IN “ 参考书目
每当您引用希望包含在参考书目中的引文时,您都可以在此处标记
使用特殊分隔符(随后从
最终文本由sisu制作)
在这里,您可以在常规文本或脚注中编写如下内容
见。:堂吉诃德; Panza, Sancho /{驯服风车,保持真实}/ (1605) :.
上海外国语大学 将解析分隔符中的许多模式以尝试找出
作者、标题、日期等,并从中创建参考书目。 这比
前面描述的准备带标签的参考书目的方法,并在其中使用 id
文本来识别作品,这也有助于提高一致性。
使用部分名称 1~!glossary 会导致 Glossary 被特殊处理为
这样,并放置在自动生成的尾注部分之后(在参考书目/列表之前
有参考文献)。
词汇表是以适合该目的的方式标记的普通文本。
例如,该术语以粗体显示,可能带有悬挂缩进。
1~!词汇表~ [注意:标题标记::所需标题丢失]
_0_1 *{GPL}* 代表“通用许可证”的缩写。 ...
_0_1 [提供您的术语和定义列表]
在给定的例子中,第一行没有缩进,后续行是一个级别,
待定义的术语以粗体显示。
立即预订 指数
要将索引附加到与图书索引术语相关的段落,请使用相等的
符号和花括号。
目前提供了两个级别,一个主术语和一个子术语(如果需要)。 子条款是
用冒号与主词分开。
包含主项和子项的段落。
={主术语:子术语}
索引语法从新行开始,但中间不应有空行
段落和索引标记。
结果索引的结构将是:
主项,1
子项,1
几个术语可能与一个段落相关,它们用分号分隔。 如果术语
指多于一个段落,注明段落数。
包含主项、第二项和子项的段落。
={第一项; 第二学期:子学期}
结果索引的结构将是:
第一学期,1,
第二学期,1,
子项,1
如果一个段落下出现多个子术语,它们在主术语下分开
由管道符号彼此分开。
包含主项、第二项和子项的段落。
={主项:
子项+2|第二个子项;
另一个术语
}
继续讨论第一个子项的段落
提供的示例中的加号表示第一个子项跨越一个额外的
段落。 结果索引的逻辑结构将是:
主项, 1,
子项,1-3,
第二个子项,1,
另一个术语,1
综合 DOCUMENTS 标记
可以通过创建需要其他文件的主文档来构建文档
文件。 所需的文件可能是可以生成的完整文件
独立的,或者它们可以是标记片段,准备好以便于
放在另一个文本中。 如果调用文档是主文档(从
其他文件),应以后缀命名 .ssm 在本文档中,您将
提供有关应包含在文本中的其他文件的信息。 这些
可能是以常规方式处理的其他文档,或准备好的标记位
仅用于包含在主文档中 .sst 常规标记文件,或 .ssi
(插入/信息)复合文档的辅助文件是在
处理相同的前缀和后缀 ._sst
用于将文档导入主文档的基本标记
<< 文件名1.sst
<< 文件名2.ssi
应依赖上述表格。 内 Vim的 编辑它导致
这样链接的文本变成超链接到它正在调用的文档,这很方便
进行编辑。
替代品
标记 例:
当前的 Debian 是 ${debian_stable} 下一个 debian 将是 ${debian_testing}
在 _sisu/sisu_document_make 中配置替换
@制作:
:substitute: /${debian_stable}/,'*{Wheezy}*' /${debian_testing}/,'*{Jessie}*'
导致 输出:
目前的 Debian is 杰西 下一个 debian 将是 Stretch
在 _sisu/sisu_document_make 中配置替换
SISU 文件类型
上海外国语大学 具有 纯文本 和二进制文件类型,并且可以处理任一类型的文档。
.海温 .SSM .SSI 标记 UP 平原 文字
上海外国语大学 文档准备为纯文本 (utf-8) 文件,其中包含 上海外国语大学 标记。 他们可能会让
引用并包含图像(例如),这些图像存储在目录中
在他们下面_sisu/image。 〔b¤西苏 纯文本 标记文件分为三种类型
可以通过使用的文件扩展名来区分:常规文本 .sst; 掌握
文档,包含其他文本的复合文档,可以是任何
常规文本或文本插入; 并插入其中的内容就像常规
除了这些文本被标记为 .ssi 并且不被处理。
上海外国语大学 可以直接针对sisu文件进行处理; 可能位于
本地或在提供 url 的远程服务器上。
上海外国语大学 可以使用以下命令共享源标记:
sisu -s [文件名]
SISU 文字 - 定期 FILES (.海温)
最常见的文件形式 西苏, 请参阅有关部分 上海外国语大学 标记。
SISU 主 FILES (.SSM)
包含其他内容的复合文件 上海外国语大学 可以是常规文件
上海外国语大学 可以独立生成的文本 .sst,或专门为
合并到一份或多份主文件中的目的。
主文件合并其他文件的机制被描述为
下面的标题 上海外国语大学 中的标记 上海外国语大学 手册。
注意:主文件可以按照与常规文件类似的方式准备,并且
如果 .sst 文件重命名为 .ssm 而不需要任何其他
文件; .ssm 标记标记文档可能包含其他文档。
注意:复合文档的辅助文件是在使用
相同的前缀和后缀 ._sst [^12]
SISU 插入 FILES (.SSI)
插入文件是专门为纳入一个或多个文件而准备的文件。
更多主文档。 他们像普通的 上海外国语大学 文本文件 (.sst)。 自西苏 -5.5.0
(6.1.0) .ssi 文件可以像 .ssm 文件一样包含其他 .sst 或 .ssm 文件。 .ssi 文件不能
由sisu处理器直接调用,只能合并到其他文件中。
将文件设为 .ssi 文件是一种快速方便的分解文档的方法。
包含在主文档中,并标记要合并的文件 .ssi 是
不打算自行处理文件。
西普德, 压缩包 BINARY 集装箱 (SISUPOD.ZIP, .SSP)
sisupod 是一个带拉链的 上海外国语大学 文本文件或一组 上海外国语大学 文本文件和任何相关图像
它们包含(这将扩展到包括声音和多媒体文件)
上海外国语大学 纯文本 文件依赖于公认的目录结构来查找内容,例如
与文档相关联的图像,但例如所有文档的所有图像
包含在目录中的文件位于子目录 _sisu/image 中。 没有
创建 sisupod 的能力 手动识别所有其他
与文档相关联的文件。 sisupod 自动捆绑所有关联的
带有变成 pod 的文档的文件。
sisupod 的结构是这样的,例如它可能包含一个
文档及其相关图像; 主文件及其相关文件
以及其他任何东西; 或者准备好的整个目录的压缩内容 上海外国语大学
文档。
创建 sisupod 的命令是:
sisu -S [文件名]
或者,制作一个包含整个目录内容的 pod:
西苏-S
上海外国语大学 可以直接针对 sisupod 进行处理; 可能位于
本地或在提供 url 的远程服务器上。
<http://www.sisudoc.org/sisu/sisu_commands>
<http://www.sisudoc.org/sisu/sisu_manual>
配置
配置 FILES
配置文件
上海外国语大学 在配置文件中调整配置参数,可用于
覆盖默认设置。 这包括诸如哪个目录临时处理之类的事情
应该在生成的输出放置的位置和位置完成。
这款 上海外国语大学 配置文件是一个 yaml 文件,这意味着缩进很重要。
上海外国语大学 资源配置是通过查看以下文件(如果存在)来确定的:
./_sisu/v7/sisurc.yml
./_sisu/sisurc.yml
〜/.sisu/v7/sisurc.yml
〜/.sisu/sisurc.yml
/etc/sisu/v7/sisurc.yml
/etc/sisu/sisurc.yml
搜索按列出的顺序进行,并使用找到的第一个。
在没有任何这些指令的情况下,它会退回到内部程序
默认值。
配置确定输出和处理目录以及数据库访问
细节。
If 上海外国语大学 安装了一个示例 sisurc.yml 可以在 /etc/sisu/sisurc.yml 中找到
SISU_DOCUMENT_MAKE
大多数 sisu 文档标题都与元数据有关,但 @make: 标题除外,它
提供加工相关信息。 @make 标头的默认内容可能是
通过将它们放在文件 sisu_document_make 中来设置。
搜索顺序与资源配置相同:
./_sisu/v7/sisu_document_make
./_sisu/sisu_document_make
〜/.sisu/v7/sisu_document_make
〜/.sisu/sisu_document_make
/etc/sisu/v7/sisu_document_make
/etc/sisu/sisu_document_make
可以在 _sisu/ 目录下找到示例 sisu_document_make 以及
提供sisu标记样本。
的CSS - 级联 风格 SHEETS (对于 HTML, 的XHTML AND XML)
用于修改外观的 CSS 文件 上海外国语大学 html, 的XHTML or XML 可以放在
配置目录:./_sisu/css; 〜/.sisu/css 或者; /etc/sisu/css 这些将是
使用命令 sisu -CC 复制到输出目录。
html 输出的基本 CSS 文件是 html。 css,在目录中放置一个具有该名称的文件
_sisu/css 或等效文件将导致该名称的默认文件被覆盖。
HTML: html。 css
XML DOM:dom.css
XML SAX:sax.css
XHTML: html.html css
默认主页可以使用 homepage.css 或 html。 css
正在考虑允许放置具有不同名称的 CSS 文件
目录 _sisu/css 目录或等效目录。[^13]
组织 内容 - 目录 结构 AND MAPPING
上海外国语大学 v3 为源目录树和输出目录结构提供了新选项
其中有 3 种选择。
文件 源 目录
文档源目录是sisu处理命令所在的目录
给。 它包含 sisu 源文件 (.sst .ssm .ssi),或(对于 sisu v3 可能包含)
带有包含sisu源文件的语言代码的子目录,所以所有英文
文件将在子目录 en/ 中,法语在 fr/ 中,西班牙语在 es/ 中等等。 ISO 639-1
使用代码(因 po4a 而异)。 可用语言列表(以及可能的子
目录名)可以通过命令“sisu --help lang”获得语言列表
仅限于 XeTeX polyglosia 支持的语言。
一般 目录
./主题名称/
% 存储在此级别的文件,例如 sisu_manual.sst 或
sisu v3 的 % 可能位于语言子目录下
% 例如
./主题名称/en
./主题名称/fr
./主题名称/es
./subject_name/_sisu
./subject_name/_sisu/css
./subject_name/_sisu/图像
文件 OUTPUT 目录 结构
OUTPUT 目录 根
输出目录根可以在sisurc.yml 文件中设置。 在根下,
为文档集所在的每个目录创建子目录。 如果你有一个
名为诗歌或约定的目录,该目录将在输出下创建
目录根和包含在特定目录中的所有文档的输出
名称将生成到该目录下的子目录(诗歌或约定)。 一种
文档将被放置在与具有相同名称的文档同名的子目录中
文件类型标识符被剥离 (.sst .ssm)
目录路径的最后一部分,表示文档集所在的子目录
驻留,是将用于输出目录的目录名称。 这有
对文件集合的组织的影响,因为它可能是有意义的
特定主题的文档,或在识别它们的目录中键入。 这个
建议的分组可以按主题(sales_law,english_literature); 或者就像
方便地按其他一些分类(X 大学)。 映射意味着它也是
可以放置在用于组织的相同输出目录文档中
目的分开保存,例如关于两个不同主题的文件
机构可能保存在两个不同的同名目录中,在一个目录下
以每个机构命名,这些将输出到相同的输出目录。
皮肤可以在目录的基础上与每个机构相关联,并由此产生
文档将呈现相应的不同外观。
备选 OUTPUT 结构
有 3 种可能的输出结构,按语言、文件类型或
通过文件名,选择在 sisurc.yml 中进行
#% output_dir_structure_by:语言; 文件类型; 或文件名
output_dir_structure_by:语言#(语言和文件类型,首选?)
#output_dir_structure_by:文件类型
#output_dir_structure_by: 文件名 #(默认,最接近原始 v1 & v2)
BY 语言
按语言目录结构放置输出文件
按语言目录结构按语言代码分隔输出文件(所有文件
给定的语言),并按文件类型在语言目录中。
它的选择在sisurc.yml中配置
output_dir_structure_by:语言
|-- zh
|-- 电子版
|-- 哈希
|-- 网页
| |--virus_spiral.david_bollier
| |-- 清单
| |-- 二维码
| |-- 异端
| |-- 站点地图
| |-- 文本文件
| |-- xhtml
| `--xml
|-- po4a
| `-- 现场手册
| |-- 宝
| |-- 法语
| `--锅
`--_sisu
|-- CSS
|-- 图片
|-- image_sys -> ../../_sisu/image_sys
`--xml
|-- RNC
|-- 随机数
`--xsd
#by:语言subject_dir/en/manifest/filename.html
BY 文件类型
by filetype 目录结构按文件类型分隔输出文件,所有 html 文件在
一个目录 pdfs 在另一个目录中,依此类推。 文件名具有语言扩展名。
它的选择在sisurc.yml中配置
output_dir_structure_by:文件类型
|-- 电子版
|-- 哈希
|-- 网页
|--virus_spiral.david_bollier
|-- 清单
|-- 二维码
|-- 异端
|-- po4a
|-- 现场手册
| |-- 宝
| |-- 法语
| `--锅
|-- _西苏
| |-- CSS
| |-- 图片
| |-- image_sys -> ../../_sisu/image_sys
| `--xml
| |-- RNC
| |-- 随机数
| `--xsd
|-- 站点地图
|-- 文本文件
|-- xhtml
`--xml
#by: 文件类型 subject_dir/html/filename/manifest.en.html
BY 文件名
按文件名目录结构放置特定文件的大部分输出(
不同的文件类型)在一个公共目录中。
它的选择在sisurc.yml中配置
output_dir_structure_by:文件名
|-- 电子版
|-- po4a
|-- 现场手册
| |-- 宝
| |-- 法语
| `--锅
|-- _西苏
| |-- CSS
| |-- 图片
| |-- image_sys -> ../../_sisu/image_sys
| `--xml
| |-- RNC
| |-- 随机数
| `--xsd
|-- 站点地图
|-- 源代码
|-- 豆荚
`--virus_spiral.david_bollier
#by: 文件名 subject_dir/filename/manifest.en.html
遥控 目录
./主题名称/
% 包含以生成的文件命名的子目录
./主题名称/src
% 包含共享源文件文本和二进制文件,例如 sisu_manual.sst 和 sisu_manual.sst.zip
./subject_name/_sisu
% 配置文件,例如 sisurc.yml
./subject_name/_sisu/皮肤
% 各种皮肤目录 doc、dir、site、yml 中的皮肤
./subject_name/_sisu/css
./subject_name/_sisu/图像
此目录中包含的文档的 % 图像
./受试者名称/_sisu/mm
西普德
./西苏波德/
% 存储在此级别的文件,例如 sisu_manual.sst
./sisupod/_sisu
% 配置文件,例如 sisurc.yml
./sisupod/_sisu/皮肤
% 各种皮肤目录 doc、dir、site、yml 中的皮肤
./sisupod/_sisu/css
./sisupod/_sisu/图像
此目录中包含的文档的 % 图像
./sisupod/_sisu/mm
主页
上海外国语大学 是关于自动生成文档的能力。 首页被视为自定义
构建的项目,而不是由 西苏。 更精确地, 上海外国语大学 有一个默认主页,
不适用于其他网站,以及提供您自己的网站的方法
主页而不是作为站点配置的一部分的两种方式之一,它们是:
1.通过将您的主页和其他自定义构建的文档放在子目录中
_sisu/home/(这可能是更简单方便的选项)
2.通过在皮肤中提供您想要的主页,
文档集包含在目录中,通常按站点或主题组织。 每个
目录可以/应该有自己的主页。 请参阅目录结构部分和
内容的组织。
主页 页 AND 其他 定制 建立 PAGES IN A 子目录
自定义构建的页面,包括主页 index.html 可以放在
配置目录 _sisu/home/ 在任何搜索到的位置
配置目录,即 ./_sisu ; 〜/_sisu ; /etc/sisu 从那里复制它们
使用以下命令到输出目录的根目录:
西苏-CC
标记 AND OUTPUT 示例
标记 示例
当前标记示例和文档输出示例已关闭http://sisudoc.org>
或者http://www.jus.uio.no/sisu> 并且在 sisu -markup-sample 包中可用
<http://git.sisudoc.org>
对于某些文档,除了标题之外几乎不需要任何标记,并且
表明程序在生成其时要考虑的级别
输出是。
SISU 标记 样品
一些额外的样本书作为 sisu 标记样本准备,输出格式为
使用生成 上海外国语大学 包含在单独的包 sisu -markup-samples 中。 西苏
-markup-samples 包含由他们发布的书籍(使用 sisu 标记准备)
作者 各种许可证 大部分不同的知识共享许可证不允许
纳入 Debian 项目,因为他们的要求不符合 Debian 免费
出于各种原因软件指南,最常见的是他们要求原始
实质性文本保持不变,有时作品仅用于非
商业上。
加速器, 查尔斯·斯特罗斯 (2005) Accelerando.charles_stross.sst
爱丽丝的 探险 in 仙境, 刘易斯·卡罗尔 (1865)
alices_adventures_in_wonderland.lewis_carroll.sst
内容, 科里·多克托罗 (2008) content.cory_doctorow.sst
民主化 创新, 埃里克·冯·希佩尔 (2005)
民主化创新.eric_von_hippel.sst
Down 和 输出 in 此 魔术 美国, 科里·多克托罗 (2003)
down_and_out_in_the_magic_kingdom.cory_doctorow.sst
对于 此 赢了, 科里·多克托罗 (2010) for_the_win.cory_doctorow.sst
免费 as in Freedom - 理查德 斯托曼的 圣战 免费 软件, 山姆·威廉姆斯 (2002)
free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst
免费 as in Freedom 2.0 - 理查德 斯托曼 和 此 免费 软件 革命, 山姆威廉斯
(2002), 理查德·M·斯托曼 (2010)
free_as_in_freedom_2.richard_stallman_and_the_free_software_revolution.sam_williams.richard_stallman.sst
免费 企业文化 - 创新中心 大 媒体管理 使用 技术 和 此 法律 至 锁 Down 文化与控制
创造力,劳伦斯·莱西格 (2004) free_culture.lawrence_lessig.sst
免费 对于 All / 全部 - 创新中心 Linux 和 此 免费 软件 机芯 底切 此 高 科技泰坦,
彼得·韦纳 (2002) free_for_all.peter_wayner.sst
GNU 一般 PUBLIC 许可 v2, 自由软件基金会 (1991) gpl2.fsf.sst
GNU 一般 PUBLIC 许可 v3, 自由软件基金会 (2007) gpl3.fsf.sst
格列佛 旅行, 乔纳森·斯威夫特 (1726 / 1735) gullivers_travels.jonathan_swift.sst
小 兄弟, 科里·多克托罗 (2008) little_brother.cory_doctorow.sst
这款 大教堂 和 此 市场, 埃里克·雷蒙德 (2000)
the_cathedral_and_the_bazaar.eric_s_raymond.sst
这款 公共 域名 - 封闭 此 共享 of 此 头脑, 詹姆斯·博伊尔 (2008)
the_public_domain.james_boyle.sst
这款 财富 of 网络 - 创新中心 社交媒体 生产 变换 市场 和 自由,Yochai
本克勒 (2006) the_wealth_of_networks.yochai_benkler.sst
通过 此 展望 玻璃, 刘易斯·卡罗尔 (1871)
through_the_looking_glass.lewis_carroll.sst
二 位 - 这款 文化 意义 of 免费 软件, 克里斯托弗·凯尔蒂 (2008)
Two_bits.christopher_kelty.sst
UN 合约 国际的 促销 of 商品, 联合国 (1980)
un_contracts_international_sale_of_goods_convention_1980.sst
病毒 螺旋, David Bollier (2008)virus_spiral.david_bollier.sst
SISU 搜索 - 引言
因为创建的站点的文档结构是明确定义的,并且文本 对象
引用 系统 至少假设可用,对于所有形式的输出,它是
可以搜索 sql 数据库,然后从该数据库读取结果,或映射
结果到 html 或其他输出,具有更丰富的文本标记。
上海外国语大学 可以使用对象级别的文档填充关系 sql 类型数据库,
包括在不同输出类型之间共享的对象编号。 制作文件
语料库可以以这种程度的粒度进行搜索。 基本上,您的匹配条件已满足
通过这些文档以及在每个文档中的这些位置,可以在
直接或以各种输出格式访问数据库。
上海外国语大学 可以使用由它们组成的文档填充 sql 数据库(sqlite3 或 postgresql)
对象。 它还可以生成可用于查询数据库的 cgi 搜索表单。
为了使用内置搜索功能,您需要执行以下步骤。
* 使用 sisu 用 sisu 标记内容填充 sql 数据库
* sqlite3 应该开箱即用
* postgresql 可能需要一些初始数据库配置
* 提供查询数据库的方法,sisu 可以协助
* 生成示例 ruby cgi 搜索表单,需要(sisu 配置)
推荐的)
* 为这个搜索表单添加一个查询字段,以添加到所有 html 文件中
(需要sisu配置)
SQL
人口 “ 数据库
要填充 sql 数据库,请使用以下命令之一针对 sisu 标记文件运行 sisu
以下标志集
sisu --sqlite 文件名.sst
创建一个只包含 sisu 标记的可搜索内容的 sqlite3 数据库
选择的文件
sisu --sqlite --update 文件名.sst
创建一个包含标记文档的可搜索内容的 sqlite3 数据库
由用户从公共目录中选择
sisu --pg --update 文件名.sst
用选定的标记文档的可搜索内容填充 postgresql 数据库
来自公共目录的用户
对于 postgresql,第一次在给定目录中运行命令时,用户将是
提示创建必要的数据库,在编写时提示sisu提供
如下:
未建立与 pg 数据库的连接,您可能需要运行:
createdb "SiSU.7a.current"
之后不要忘记运行:
西苏 --pg --createall
在尝试填充数据库之前
sisu 期望找到的命名数据库必须存在,如有必要,使用
postgresql 工具。 如果数据库存在但数据库表不存在,sisu 将尝试
创建它需要的表,相当于请求的 sisu --pg --createall
命令。
完成此操作后,将填充 sql 数据库并准备好进行查询。
SQL 型 资料库
上海外国语大学 将 sisu 标记文档输入 sql 类型数据库 PostgreSQL的 [^14] 和/或 SQLite
[^15] 数据库以及与文档结构相关的信息。
这是更有趣的输出形式之一,因为所有的结构数据
文档被保留(尽管数据库用户可以忽略它们,如果他们这样做的话)
选择)。 所有站点文本/文档(当前)都流式传输到四个表中:
* 一个包含语义(和其他)标题,包括标题、作者、
主题,(
.我都柏林核心。
..);
* 另一个实体文本按个别“段落”(或对象) - 沿
带有结构信息,每个段落都可以通过其识别
段落编号(如果它有一个几乎所有人都这样做的),以及
每个段落的实质性文本很自然地可以搜索(无论是在
用于搜索的格式化和干净的文本版本); 和
* 第三个包含交叉引用的尾注从
它们被引用(在格式化和干净的文本版本中
搜索)。
* 与标题表具有一对一关系的第四个表包含
输出的全文版本,例如。 pdf、html、xml 和
.I ASCII。
当然还有可能添加更多的结构。
在这个级别 上海外国语大学 加载一个关系数据库,其中包含分块成对象的文档,它们的
最小的逻辑结构组成部分,作为文本对象,及其对象
引文编号和构建文档所需的所有其他结构信息。
文本存储(在此文本对象级别)带有和不带有基本标记标记,
精简版以便于搜索。
能够在对象级别搜索关系数据库 上海外国语大学 引用
系统是定位由生成的内容的有效方法 西苏。 作为单独的文本
文档的对象与对象编号以及所有版本一起存储(和索引)
的文档具有相同的编号,可以定制复杂的搜索以仅返回
与所有可用输出格式相关的搜索结果的位置,带有实时
链接到数据库或 html/xml 文档中的精确位置; 或者
所提供的结构信息使搜索完整内容成为可能
数据库并具有显示搜索内容的标题,或仅搜索标题
等(作为 都柏林 核心 也很容易使用它)。
PostgreSQL
您的姓名
上海外国语大学 - 结构化信息,序列化单元 - 一个文档发布系统,postgresql
依赖包
商品描述
与在 sisu 中使用 postgresql 相关的信息(以及与 sisu_postgresql 相关的信息)
依赖包,这是一个虚拟包,用于安装所需的依赖项 上海外国语大学 至
填充 postgresql 数据库,这是的一部分 上海外国语大学 - 男人西苏)。
概要
sisu -D [说明] [文件名/通配符(如果需要)]
sisu -D --pg --[指令] [文件名/通配符如果需要]
指令
默认提供了两个数据库的映射,postgresql和sqlite,相同
命令在 sisu 中用于构建和填充数据库,但是 -d(小写)
表示 sqlite 和 -D(大写)表示 postgresql,或者 --sqlite 或 --pgsql
可能用过了
-D or --pgsql 可以互换使用。
CREATE AND 破坏 数据库
--pgsql --创建全部
第一步,在现有(postgresql)中创建所需的关系(表、索引)
数据库(应该手动创建一个数据库并赋予与工作相同的名称
目录,根据要求)(rb.dbi)
SISU -D --创建数据库
创建以前不存在数据库的数据库
SISU -D - 创建
创建以前不存在数据库表的数据库表
SISU -D --滴滴
破坏数据库(包括其所有内容)! 杀死数据并删除表、索引
和与给定目录(和同名目录)关联的数据库。
SISU -D --重新创建
销毁现有数据库并建立一个新的空数据库结构
进口 AND 删除 DOCUMENTS
SISU -D - 进口 -v [文件名/通配符]
用文件的内容填充数据库。 进口指定的文件
postgresql 数据库(在对象级别)。
SISU -D - 更新 -v [文件名/通配符]
更新数据库中的文件内容
SISU -D - 消除 -v [文件名/通配符]
从 postgresql 数据库中删除指定的文档。
SQLITE
您的姓名
上海外国语大学 - 结构化信息,序列化单元 - 文档发布系统。
商品描述
与将 sqlite 与 sisu 一起使用的相关信息(以及与 sisu_sqlite 依赖项相关的信息)
包,这是一个虚拟包,用于安装所需的依赖项 上海外国语大学 填充一个
sqlite 数据库,这是其中的一部分 上海外国语大学 - 男人西苏)。
概要
sisu -d [说明] [文件名/通配符(如果需要)]
sisu -d --(sqlite|pg) --[说明] [文件名/通配符,如果需要]
指令
默认提供了两个数据库的映射,postgresql和sqlite,相同
命令在 sisu 中用于构建和填充数据库,但是 -d(小写)
表示 sqlite 和 -D(大写)表示 postgresql,或者 --sqlite 或 --pgsql
可能用过了
-d or --sqlite 可以互换使用。
CREATE AND 破坏 数据库
--sqlite --创建全部
第一步,在现有(sqlite)中创建所需的关系(表、索引)
数据库(应该手动创建一个数据库并赋予与工作相同的名称
目录,根据要求)(rb.dbi)
SISU -d --创建数据库
创建以前不存在数据库的数据库
SISU -d - 创建
创建以前不存在数据库表的数据库表
SISU -d --dropall
破坏数据库(包括其所有内容)! 杀死数据并删除表、索引
和与给定目录(和同名目录)关联的数据库。
SISU -d --重新创建
销毁现有数据库并建立一个新的空数据库结构
进口 AND 删除 DOCUMENTS
SISU -d - 进口 -v [文件名/通配符]
用文件的内容填充数据库。 进口指定的文件
一个 sqlite 数据库(在对象级别)。
SISU -d - 更新 -v [文件名/通配符]
更新数据库中的文件内容
SISU -d - 消除 -v [文件名/通配符]
从 sqlite 数据库中删除指定的文档。
CGI 搜索 造台
对于搜索表单,这是一个单一的搜索页面
* 配置搜索表单
* 使用 sisu 命令生成示例搜索表单,(这将基于
配置设置和现有的已找到的 sisu 数据库)
对于 postgresql 网页内容,您可能需要编辑搜索 cgi 脚本。 看两件事
原因是用户是根据需要设置的,以及您设置的任何不同的数据库
希望能查询的都列出来了。
正确,您可能需要 www-data 而不是您的用户名。
@user='www-data'
* 检查搜索表单,将其复制到相应的cgi目录并设置正确
权限
要在每个 html 页面上显示搜索表单,您需要:
* 依赖上面提到的搜索表单配置
* 将 html 搜索表单配置为开启
* 运行 html 命令
设置 搜索 造台
您将需要一个 Web 服务器、启用 cgi 的 httpd 和一个 postgresql 数据库,
您可以创建数据库。
设置 postgresql,确保您能够创建和写入数据库,例如:
须藤苏postgres
createuser -d -a 拉尔夫
然后你需要创建sisu将使用的数据库,目录中的sisu手册
例如,手册/en,(当您尝试填充不存在的数据库时 sisu
提示是否存在):
createdb SiSU.7a.manual
上海外国语大学 然后能够创建允许您填充数据库的所需表
与创建它的目录中的文档:
sisu --pg --createall -v
然后,您可以开始填充数据库,在此示例中使用单个文档:
sisu --pg --update -v en/sisu_manual.ssm
要创建示例搜索表单,请从同一目录中运行:
sisu --样本搜索表单 --db-pg
并将生成的 cgi 表单复制到您的 cgi-bin 目录中
提供了 nginx 的示例设置,假设数据将存储在 /srv/www 和
/srv/cgi 下的 cgi 脚本
搜索 - 数据库 FRONTEND 样本, 利用 数据库 AND SISU 特征,
包括对象引用编号(后端当前为 POSTGRESQL)
示例搜索前端http://search.sisudoc.org> [^16] 一个小数据库和样本
使用引文系统的查询前端(搜索自),.I 对象引文
编号以演示功能。[^17]
上海外国语大学 可以提供有关哪些文档匹配以及在哪些位置匹配的信息
找到匹配的每个文档。 这些结果与所有输出相关,使用
对象 引用 编号, 其中包括 html, XML, 电子版, 乳胶, PDF 事实上 SQL
数据库。 然后,您可以参考其他输出之一或在 SQL 数据库 展开
匹配文档中匹配对象(段落)中的文本。
请注意,您可以为匹配的文档和对象编号位置设置结果
每个符合搜索条件的匹配文档; 或显示文件的名称
与符合搜索条件的对象(段落)一起匹配。[^18]
SISU -F --webserv-webrick
为创建的数据库构建一个 cgi 网络搜索前端
以下是help命令提供的机器上设置的反馈:
sisu——帮助sql
PostgreSQL的
用户:拉尔夫
当前数据库集:SiSU_sisu
端口:5432
dbi 连接:DBI:Pg:database=SiSU_sisu;port=5432
轻石
当前数据库集:/home/ralph/sisu_www/sisu/sisu_sqlite.db
dbi 连接 DBI:SQLite:/home/ralph/sisu_www/sisu/sisu_sqlite.db
建立数据库的注意事项
默认情况下,[除非另有说明] 数据库是建立在目录基础上的,
来自该目录中的文档集合。 您所在目录的名称
选择工作从用作数据库名称,即如果您正在工作
名为 /home/ralph/ebook 的目录使用数据库 SiSU_ebook。 [否则一个
需要手动映射集合]
搜索 造台
SISU -F
生成一个示例搜索表单,必须将其复制到网络服务器 cgi
目录
SISU -F --webserv-webrick
生成与 webrick 服务器一起使用的示例搜索表单,该表单必须是
复制到 web-server cgi 目录
SISU -W
启动 webrick 服务器,它应该在 sisu 正确的地方可用
安装
生成的搜索表单必须手动复制到网络服务器目录中
责成
SISU_网砖
您的姓名
上海外国语大学 - 结构化信息、序列化单元 - 文件发布系统
概要
sisu_webrick [端口]
or
sisu -W [端口]
商品描述
sisu_webrick 是 上海外国语大学 (man sisu) sisu_webrick 开始 红宝石 上海外国语大学 输出被写入,
提供这些目录的列表(假设 上海外国语大学 正在使用中并且它们存在)。
sisu_webrick 的默认端口设置为 8081,这可以在 yaml 文件中修改:
〜/.sisu/sisurc.yml 其样本作为 /etc/sisu/sisurc.yml(或在
系统上的等效目录)。
概要 OF 男装 页
sisu_webrick,可以使用以下命令自行启动:sisu_webrick [port] 或使用
带有 -W 标志的 sisu 命令:sisu -W [端口]
在没有给出端口且设置不变的情况下,默认端口为 8081
文件 处理 指挥 旗帜
sisu -W [端口] 开始 红宝石 Webrick 网络服务器,服务 上海外国语大学 输出目录,在
提供端口,或者如果未提供端口且默认值未更改
〜/.sisu/sisurc.yaml 然后在端口 8081
概要 OF 功能
* 稀疏/最小标记(干净的 utf-8 源文本)。 文件是在一个单一的
UTF-8 文件使用简约的助记符语法。 典型的文学、文献,如《战争
and Peace”几乎不需要任何标记,而且大多数标题都是可选的。
* 标记很容易被人眼阅读/解析,(基本标记更简单,更多
比最基本的还要稀疏 HTML ) , [这也可以转换为 XML 的表示
相同的输入/源文件]。
* 标记定义文档结构(这可以在标题模式匹配中完成一次
描述,或单独用于标题级别); 基本文本属性(粗体、斜体、
下划线、删除线等)根据需要; 和相关的语义信息
文档(标题信息,扩展到都柏林核心之外并且很容易进一步扩展
按要求); 标头也可能包含处理指令。 上海外国语大学 标记为
主要是文档结构和文档元数据的抽象,以允许获取
利用现有替代实用标准方式的基本优势
表示文档[是浏览器查看、论文发表、sql 搜索等]
(html、epub、xml、odf、乳胶、pdf、sql)
* 用于输出已建立行业的合理优雅的输出和
机构接受的开放标准格式。 [3] 利用不同的
在输出中代表文档的各种标准格式的优势
目前支持的格式有:
* HTML - 作为单个可滚动文本和分段文档
* 的XHTML
* EPUB
* XML - sax 和 dom 样式的 xml 结构,以便根据需要进一步开发
* ODT - 开放文档格式文本,文档存储的iso标准
* 胶乳 - 用于生成pdf
* PDF (通过 胶乳 )
* SQL - sql 数据库的人口( PostgreSQL的 or SQLite ) , (在同一个对象
用于引用文档中文本的级别)
还产生:一致性文件; 文档内容证书(md5 或 sha256 摘要
标题、段落、图像等)和 html 清单(以及内容的站点地图)。 (b) 需要
利用这些非常不同的输出类型中隐含的优势,(例如 PDF
使用排版制作 乳胶, 数据库填充了个人的文档
对象/段落级别,使 粒状 搜索、 (和相关的可能性))
* 确保无论选择何种输出格式,都能以有意义的方式引用内容。
在线发布(以及以多种文档格式发布)缺乏一种有用的方式
在文件内部引用文本(对一般学者和律师很重要)
因为页码在浏览器和格式中毫无意义。 sisu 旨在提供一个
查明文档中文本的常用方法,(可用于引用和
通过搜索引擎)。 输出共享一个有意义的公共编号系统(以
人和机器)跨越所有数字输出,无论是面向纸张、屏幕还是面向数据库的,
(PDF, HTML, 电子版, xml, sqlite, postgresql) ,这个编号系统可用于
参考内容。
* 在文档中进行粒度搜索。 SQL 数据库在对象级别填充
(粗略的标题、段落、诗句、表格),并以这种程度变得可搜索
粒度,输出信息提供对象/段落编号,它们是
与所有生成的输出相关; 也可以只看匹配
数据库中文件的段落; [输出索引也适用于搜索
索引工具,如 hyperestraier]。
* 在格式不断变化的世界中文档集合的长期可维护性,
具有非常稀疏标记的源文档库。 有相当程度的
面向未来,输出表示是“可升级的”,并且新的文档格式可能是
添加。 例如,在 2006 年添加了 odf(开放文档文本)模块,在 2009 年添加了 epub,在
未来某个时候的未来 html5 输出,无需修改现有的准备文本
* SQL 除了搜索之外,文档是根据需要生成的,一旦生成就是静态的。
* 生成的文件是静态文件,可能是批量处理的,这个需要做
仅一次,但可以根据需要出于各种原因重复(更新内容,添加
新的输出格式,更新的技术文件演示/表示)
* 文件来源( 纯文本 utf-8) 如果在网络上共享可以用作输入和
在本地处理以产生不同的文档输出
* 文件源可以(自动)与相关文件捆绑在一起
(多语言版本或包含内容的主文档)和图像并作为
名为 sisupod 的 zip 文件,如果在网络上共享,这些也可以在本地处理以
生成所需的文档输出
* 生成的文档输出可能会自动发布到远程站点。
* 对于基本文档生成,唯一的软件依赖是 红宝石, 和一些标准
Unix 工具(包括 纯文本, HTML, 电子版, XML, 外径, 胶乳 )。 要使用数据库,您
当然需要,并转换 胶乳 生成为 pdf,乳胶处理器,如
tetex 或 texlive。
* 作为开发者工具,它灵活且可扩展
语法高亮 上海外国语大学 标记可用于许多文本编辑器。
上海外国语大学 与其说是关于文档布局,不如说是找到一种几乎没有标记的方法
构造一个文档的抽象表示,从而可以生成
它的多种表示形式可能彼此相当不同并用于
不同的目的,无论是布局和发布,还是搜索内容
即能够利用一些从这个最小的准备起点
不同的既定方式代表不同文件的优势
目的,无论是用于搜索(关系数据库,还是为
无论是完整的文档,还是由对象组成的文件),在线
查看(例如 html、xml、pdf)或纸质出版物(例如 pdf)...
得到的解决方案是通过提取有关文档的结构信息(大约
文档中的标题)并通过跟踪对象(序列化并给出
哈希值)以描述的方式。 它使相当多的表示成为可能
与目前提供的不同。 例如对象可以单独保存
并由它们的哈希值标识,并带有对象如何相互关联的索引
形成文件。
* 1。 方括号
* 2。 方括号
+ 1。 方括号
1. <http://www.jus.uio.no/sisu/man/>
2. <http://www.jus.uio.no/sisu/man/sisu.1.html>
3. 从 SiSU 0.58 之后的某个时间开始,应该可以使用
SiSU,虽然不是原始设计目标,但很有用。
4. 文件应使用 UTF-8 字符编码准备
5. 脚注或尾注
6. 自包含尾注标记和尾注合二为一
*. 未编号的星号脚注/尾注,如果需要,插入多个星号
。** 另一个未编号的星号脚注/尾注
* 3。 编者注,编号星号脚注/尾注系列
+ 2。 编者注,编号加符号脚注/尾注系列
7. <http://www.sisudoc.org/>
8. <http://www.ruby-lang.org/en/>
9. Yochai Benkler 的网络财富表
<http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler>
10. 您也可以使用完整的表单作者:标题:和年份:
11. Quixote 和 Panza,《驯服风车》(1605),第 1000 - 1001 页,还有 Benkler,财富
网络 (2006),第 1 页
12. 不是要处理的常规文件,因此人们不太可能拥有
“事故”,处理被后续处理覆盖的 .ssc 文件。
然而,当结果文件被共享时,.ssc 可能是合适的
后缀使用。
13. SiSU 过去曾以这种方式工作过,尽管人们认为这是
复杂性超过了灵活性,但是,平衡性很好,并且
这种行为可以恢复。
14. <http://www.postgresql.org/>http://advocacy.postgresql.org/>
<http://en.wikipedia.org/wiki/Postgresql>
15. <http://www.hwaci.com/sw/sqlite/>http://en.wikipedia.org/wiki/Sqlite>
16. <http://search.sisudoc.org>
17. (可以使用当前的后端进一步扩展)。 关于缩放比例
数据库,它的可扩展性与数据库(此处为 Postgresql)和硬件允许的一样。
18. 在 2004 年向 IBM 软件创新评估员展示此功能时
他转述说:这可能是我们感兴趣的。 我们有大文件
管理系统,您可以搜索数十万份文件,我们可以
告诉您哪些文件符合您的搜索条件,但我们无法判断
您无需打开在每个匹配项中找到的每个文档。
SEE ALSO
SISU(1)
西苏电子版(1)
西苏收获(1)
sisu-html(1)
西苏-odf(1)
西苏-pdf(1)
西苏-PG(1)
sisu-sqlite(1)
西苏-txt(1)。
西苏vim(7)
首页
有关 SiSU 的更多信息,请访问http://www.sisudoc.org/>或
<http://www.jus.uio.no/sisu/>
源
<http://git.sisudoc.org/>
著者
SiSU 由拉尔夫·阿米萨 (Ralph Amissah) 撰写[电子邮件保护]>
使用 onworks.net 服务在线使用 sisu