格式手冊

本站文本以語義化HTML記錄,記錄時亦盡可能兼顧人機在各種情況下的檢索。

通用格式

元資料

範例:

<header>
<h1>本經疏證</h1>
</header>

<header>下的<h1>定義此頁面的主標題。

其他格式

<ol class="階層列表">:將以下的巢狀<ol><li>輸出如「1.」、「1.1.」、「1.1.1.」、「1.2.」、「2.」……的格式。

class="直立":直書時將英數字直立排版。

範例:

<span class="直立">2020年是不好的一年</span>

輸出:

2020年是不好的一年

class="橫向":直書時將一段文字橫向排版於一格內。

範例:

<span class="橫向">12.</span>今天天氣真好

輸出:

12.今天天氣真好

典籍專用格式

元資料

範例:

<header data-type="book">
<h1>黃帝內經素問(王冰注)</h1>
<dl class="元資料">
<div><dt>書名</dt><dd>黃帝內經素問</dd></div>
<div><dt>作者</dt><dd><data value="佚名">作者不詳</data>,唐·<data>王冰</data>編注</dd></div>
<div><dt>朝代</dt><dd>戰國至西漢</dd></div>
<div><dt>年份</dt><dd><data value="-0474/0009">公元前475年至公元9年</data></dd></div>
<div><dt>品質</dt><dd>90%</dd></div>
<div><dt>字元替換</dt><dd>{"内": {"古": "内", "今": "內"}}</dd></div>
<div hidden><dt>版式</dt><dd>今版</dd></div>
</dl>
</header>

<header data-type="book">標示此頁面規格為「book」(典籍),以支援各種典籍專用格式。

<dl class="元資料">...</dl>定義此典籍的元資料(後設資料),其中以<dt>定義元資料名稱,<dd>定義該名稱對應的元資料值。為排版美觀,原則上會用<div>分組包覆<dt><dd>

<dt><dd>中可用<data>...</data><data value="...">...</data>定義一或多個值。如此例中「作者」的機器解析值為「佚名」、「王冰」。若無<data>則取<dt><dd>的文字內容為值,如此例中「書名」的機器解析值為「黃帝內經素問」。

次要的元資料可用<div hidden>隱藏,隱藏的值不會顯示,但不影響機器解析值及實際作用。如此例中的「版式」。

元資料中的「書名」定義此典籍名稱(若不是書可用「篇名」、「名稱」、「標題」定義),若未定義則取<h1>定義的頁面主標題為名。

元資料中的「作者」定義此典籍的作者姓名。機器解析值原則上記錄姓名而不取字號(除非前者失考),例如取「張機」而不取「張仲景」,顯示值可視情況補充字號等常見稱謂。若此書有作者、整理者、校注者等,亦可記錄在此欄。

元資料中的「年份」定義此典籍的年份。機器解析值為ISO 8601年份格式,須為4位數以避免與小時數混淆,可為單值如0275或區間如0173/0990。公元前n年記為1-n,例如0000表示公元前一年。原則上記錄成書年份,若年份失考,可取初刊或作者署名年份代之。

元資料中的「朝代」定義此典籍的朝代。注意朝代須考慮國籍,例如日本人的著作應記錄為日本的朝代,而非中國的朝代。

元資料中的「品質」定義此典籍的品質

元資料中的「字元替換」使用JSON值。可用非物件值(如null)取消預設值,例如{",": null}表示取消「,」的預設字元替換;{",": {"今": null}}表示把「,」設為在今版不顯示(若用""仍會產生空HTML標籤)。

大綱、段落、縮排

<h1><h2><h3><h4><h5><h6>:標題,用於產生章節大綱,供瀏覽時產生目錄表及檢索時分割章節。預設今版會格式化,獨立成段且放大、加粗;古版為無格式效果的區塊。

<p><div data-sec="p">:段落,供檢索時分割段落。須巢狀嵌套(如古今版本不同分段方式)時可用<div data-sec="p">取代<p>,檢索時只分割到最外層段落。預設今版會格式化並與前後段產生適當間距;古版為無格式效果的區塊。

<br>:強制換行(例如詩歌)。

class="行首對齊"

class="置中對齊"

class="行尾對齊"

class="行首懸浮"

class="行尾懸浮":用於在靠上對齊正文的同一行後面有靠下對齊的文字。

範例:

<div><!--
--><h2 data-rev="今版-元素">鄒潤安先生傳</h2><!--
--><div class="行尾懸浮 首行縮進4字 行尾縮進2字">同里周儀顥撰</div><!--
--><div class="中止懸浮"></div><!--
--></div>

class="中止懸浮"

class="行寬#字"

class="縮進#字"

class="行尾縮進#字"

class="首行縮進#字"

class="首行凸出#字"

字元及標點符號

圓圈狀的漢字「零」用「」(U+3007)。

古文漢字間的圓圈斷句,較小的圓圈(約半個字大)用「」(U+25CB),較大的圓圈(約一個字大)用「」(U+25EF)。

古文旁注式句讀直接用現代標點「」(U+3001)、「」(U+FF0C)、「」(U+FF0E)、「」(U+3002)。並修改元資料「字元替換」以免自動將這些標點標示為今版。

古文用於列舉項目的「一」字型符號,使用漢字的「一」記錄,一般可加上頓號並設定縮進1字及首行凸出1字。

範例:

<p class="首行凸出1字 縮進1字">一、XXXXXXXXXXXXXXXXXXXX</p>
<p class="首行凸出1字 縮進1字">一、XXXXXXXXXXXXXXXXXXXXXXXXX</p>

現代用於區分外國人姓名的「間隔號」用「·」(U+00B7)。

現代中文破折號用連續兩個「」(U+2014);西文破折號(em dash)用一個「」(U+2014)。

表示數字、日期、時間等連續範圍用連接號(en dash)「」(U+2013)。

西文連字號(hyphen)用「」(U+2010)或用連字暨減號(hyphen-minus)「-」(U+002D)替代。中譯的全形連字暨減號用「」(U+FF0D)。

現代書名號原則上用「」、「」表示書名,「」、「」表示章節名,例如「《素問》〈上古天真論〉」。可暫時接受用「」、「」及間隔號表示書名及章節名,例如「《素問·上古天真論》」。特別講究排版的場合,可用「<cite>」,例如「素問·上古天真論」。

現代專名號一般省略,如有特別需要使用時,用「<u>」,例如「張仲景」。

常見特殊格式

<small class="雙行夾注">:以一半大小分割為左右兩行書寫的文字,多用於附注或提供次要訊息,日文稱為「分注」或「割注」。

<small class="組排小字">:以一半大小分割為左右兩行並寫兩則訊息的文字。

<small class="靠右小字">:以一半大小寫於右半行的文字。

<small class="靠左小字">:以一半大小寫於左半行的文字。

<small class="略小字">:較正文略小的文字。

<small class="腳注">:集中顯示在章節末或全書末的腳注。目前暫時呈現為淡藍色方盒並自動加上六角括號。可暫時用六角括號〔〕記錄。

<small class="旁注">:寫在正文旁邊的注文。目前暫時呈現為小字並自動加上白六角括號。可暫時用白六角括號〘〙記錄。

<aside class="眉批">:寫在頁邊空白處的注文。目前暫時呈現為淡藍色方盒。可暫時用白方括號〚〛記錄。

<b class="陰文">:黑底白字。可暫時用黑方頭括號【】記錄。

<b class="圓角陰文">:黑底白字,邊緣為圖弧形。可暫時用黑方頭括號【】記錄。

<b class="方外框">:文字外框。可暫時用白方頭括號〖〗記錄。

<b class="圓外框">:文字外框,邊緣為圖弧形。可暫時用白方頭括號〖〗記錄。

<b class="圓圈">:在一個字外面加上圓圈。可暫時用白方頭括號〖〗記錄。

<b class="圓括號">:字與字之間不佔格的括號。可暫時用白方頭括號〖〗記錄。

古版與今版處理

<* data-rev="今版"><ins>:今版元素,於呈現古版時隱藏。

<* data-rev="古版"><del>:古版元素,於呈現今版時隱藏。

<* data-rev="今版-元素">:今版才有作用的元素,呈現古版時忽略此元素(但內容仍會顯示)。

<* data-rev="古版-元素">:古版才有作用的元素,呈現今版時忽略此元素(但內容仍會顯示)。

此例表示古版時標題「XXX」縮排兩個字,今版時不縮排:

<div class="縮進2字" data-rev="古版-元素">
<h2>XXX</h2>
</div>

此例表示在古版時「XXX……」、「YYY……」、「ZZZ……」排在同一段落中,在今版時則分成標題及二個段落:

<div data-sec="p" data-rev="古版-元素"><!--
--><h2 data-rev="今版-元素">XXXXXX</h2><!--
--><p data-rev="今版-元素">YYYYYYYYYYYYYYY</p><!--
--><p data-rev="今版-元素">ZZZZZZZZZZZZZZZ</p><!--
--></div>

盡可能使用符合底本原貌的異體字記錄。本站會透過轉換表將形似無字義爭議的字在今版轉為現代常用字。例如「虚」轉「虛」、「脚」轉「腳」、「衆」轉「眾」等。若個別書籍有特殊需要在今版保留原用字,可在元資料設定「字元替換」調整轉換方式。

原文用字顯非現今通用字且容易產生一字多義,可統一用現代字記錄,並透過字元替換使古版呈現原貌。

例如原文一律用「山查」,可記錄為「山楂」並在元資料設定字元替換:{"楂": {"古": "查", "今": "楂"}}

注文、疏文、校文

<span data-rev="注">:注文是注家對原文的注解,例如王冰注《素問》的文字。

<span data-rev="疏">:疏文是第二注家對原文或注文的注解,例如林億、高保衡校注《素問王冰注》的文字。

<span data-rev="校">:校文是原典本無,由現代整理者加入的注釋或校訂說明。

訂文

<span data-rev="訂">:訂文是現代整理者對原典所做的修訂,或不同版本的文字。

古版、今版標示用於排版變動,如標點、異體字、縮排、分段之調整。訂文則是在考證基礎上對原文所做的語意變動,如修訂文字,調整章節標題等。

項目列表

<ul class="隱式列表">:以每層縮排一字的方式顯示多層 ul, li。

範例:

<ul class="隱式列表">
<li>項目一
  <ul>
  <li>項目一之一</li>
  <li>項目一之二</li>
  </ul>
</li>
<li>項目二
  <ul>
  <li>項目二之一</li>
  <li>項目二之二</li>
  </ul>
</li>
</ul>

<ul class="行內列表">:以每項固定字數的方式排列,寬度不足時整項移至下一行。

範例:

<ul class="行內列表 項寬8字"><li>項目一內容 <li>項目二內容文 <li>...</ul>

表格

<table class="標準框線">:輸出有標準框線的表格。