跳轉到內容

Oberon/ETH Oberon/Tutorial/教程

來自華夏公益教科書,一個開放世界的開放書籍

這些教程頁面由 André Fischer (afi) 編寫,並得到了 Hannes Marais 的編輯協助,託管在 ETHZ,並保留在 ETH 許可證 下。相關內容可以透過 Book.Tool 在系統中找到。擴充套件內容也可以在 紙質版 中找到。一些教程頁面位於 WayBack 檔案 中。

HTML 教程開發者指南

學習建立可以機械地轉換為 HTML 文件的文件的規則,該文件將用作線上 Oberon 教程。

預計時間:< 10 分鐘。

轉換器的理由

[編輯 | 編輯原始碼]

原則上,傳統的文字編輯器,即使是非常簡單的文字編輯器,也是您在標準 ASCII 格式下編輯 HTML 頁面所需的一切。但是,如果您想要更多的舒適度,或者想要重複使用已經存在的文字,您必須尋找另一種解決方案。第一個願望的答案已經存在於眾多商業和免費 HTML 編輯器中。目前,Oberon 中還沒有這樣的編輯器。第二個願望的答案開發成本較低,並在此提供。轉換器的原始材料是可呈現的、大致格式化的文字,具有最終文件的外觀。 轉換器的職責是實現描述完整文件的 HTML 標籤(<HTML>、<HEAD>、<TITLE> 等)以及文字結構標籤,如 <Hn>、<P> 和 <BR>。原始文字也可以用許多 HTML 標籤中的任何一個進行裝飾。

透過提供特殊標籤,轉換器還提供自動構建目錄和索引的功能。

教程編寫命令

[編輯 | 編輯原始碼]

編寫命令的形式為

\command[option]"{"argument 1"}" ... "{"argument n"}"

某些命令沒有 [option] 部分。

有不同型別的引數

docuname:任何合法的檔名
label:字母 {字母 | 數字}
title、string:任何不包含 } 的文字,使用 "\}" 在字串中包含 }

對於格式良好的文件文字,請遵循以下規則

  1. - 第一個命令必須是 "\Book"。
  2. - 在文件中,標籤必須是唯一的。

\Book{docuname}{title}

[編輯 | 編輯原始碼]

docuname:文件檔名(僅允許檔名中允許的字元)。副檔名 ".html" 將自動附加。
title:文件標題。它將在最終的 HTML 文件中出現兩次,即一次在文件標題中作為標題:<TITLE> 標題 </TITLE>,另一次在文件正文中作為 <H1> 標題 </H1>。根據 HTML 的規則,標題不能包含嵌入的標籤。此外,多個系統會自動分析 Web 文件的標題以建立索引。因此,標題應該具有表現力且比較簡短(建議最大長度為 64 個字元)。

任何文件規範中的第一個命令必須是 "\Book"。

示例

\Book{Sample}{我的第一個文件}

此命令將生成一個名為 "Sample.html" 的檔案。標題將為 "我的第一個文件"。

\Chapter[option]{title}

[編輯 | 編輯原始碼]

option:預設值為 [0]

章節級別的絕對編號
0:章節
1:小節
...
章節級別的相對編號
=:與當前章節相同的級別
+:當前章節級別 + 1
-:當前章節級別 - 1

title:章節標題

開始一個新的章節。目錄將使用文件中出現的 \Chapter 命令提供的資訊構建。

示例

絕對編號
\Book{Sample}{我的第一個文件}
\Chapter[0]{關於}
\Chapter[1]{關於 A}
\Chapter[2]{關於 AA}
\Chapter[1]{關於 B}
相對編號
\Book{Sample}{我的第一個文件}
\Chapter{關於}
\Chapter[+]{關於 A}
\Chapter[+]{關於 AA}
\Chapter[-]{關於 B}

\Label{label}

[編輯 | 編輯原始碼]

label:稍後引用文字中該點的標籤。在文件中,標籤必須是唯一的。

示例: \Label{label1}

\Link{docuname.label}{string}

[編輯 | 編輯原始碼]

label:在 Link{Label}{\Label} 命令中使用的標籤,用於引用當前位置。要引用在另一個文件中定義的標籤,請在標籤前面加上該文件的名稱。
string:要在文件文字中顯示的字串(藍色)。

示例
假設在文件 "DocumentXY" 中定義了一個標籤 "thispoint"。注意以下行為的區別:

\Link{thispoint}{敏感文字} 和
\Link{DocumentXY.thispoint}{敏感文字}

在第一個示例中,您將保留在 DocumentXY 中。在第二個示例中,將再次開啟 DocumentXY。[後退] 可用於回溯。

\Index[-]{string}

[編輯 | 編輯原始碼]

- : 當此選項存在時,string 將插入索引,但不顯示在文件中 - 用於放置相對於字串在文字中出現的位置偏移的錨點。

string:要新增到索引的字串。索引將使用該命令提供的資訊構建。索引是一個超文字文件,其中包含指向替換 \Index 命令的錨點的連結。

示例

\Index{這在索引和文字中}
\Index[-]{這僅在索引中}

\Call{string1} ... {stringN}

[編輯 | 編輯原始碼]

string1 ... stringN-1:Oberon 命令序列 stringN:要在文件文字中顯示的字串

如果指定單個字串,它將用作命令和文字。單擊以紅色顯示的文字將執行 Oberon 命令序列。

示例

\Call{System.Time}
\Call{Backup.ReadFiles My.Tool}{Edit.Open My.Tool}{從磁碟讀取 "My.Tool" 並開啟它。}

反斜槓字元 "\" 由編譯器用作跳脫字元,以識別命令的開始,如 \Chapter ... 。要在書籍中生成單個 "\",請在文字中寫入兩個 "\"。

示例: \\Label - 將生成:\Label

HTML 標籤

[編輯 | 編輯原始碼]

HTML 標籤可以根據標準 HTML 語法規則散佈在文字中。每個標籤前面必須有 "\"。

編譯文件 - Text2HTML.Compile

[編輯 | 編輯原始碼]

Text2HTML.Compile [\I=indexName] [\M=modelName] ( {fileName}~ | * ) 將列表中命名的帶標籤的文字檔案轉換為 HTML 文件。對於每個源文字檔案,編譯器都會建立

  • 一個主要的 HTML 文件
  • 一個 GIF 檔案,用於每個浮動在源文字中的視覺小工具
  • 一個公共庫,其中包含所有視覺小工具
  • 一個目錄 HTML 文件
  • 一個索引 HTML 文件(包括開頭的一個快速索引)

如果使用了 \I 選項,也會建立一個主索引 HTML 文件。它包含在同一個編譯過程中處理的所有文件。

最後,將建立一個 FTP 工具 FTPCommands.Tool,其中包含用於將這些檔案上傳到 Web 伺服器的一組 FTPTool 命令。除了編譯標記文字時,還會包含一個用於上傳(備份)源文字檔案的 FTP 傳輸命令。該工具還包含用於從本地 PC 刪除 GIF 檔案的系統命令。然後可以透過執行單個命令來啟動大量檔案的傳輸:Configuration.Do FTPCommands.Tool ~

所有這些檔案都儲存在當前目錄中。具有相同名稱的現有檔案將被覆蓋。

假設 Sample 是文件名稱(使用 \Book{Sample} 指定),則 HTML 檔案將命名為 Sample.html。目錄表是使用章節標題 \Chapter{...} 中提供的資訊自動構建的。該檔案將命名為 Sample.Contents.html。索引也是使用 \Index{...} 命令提供的資訊自動構建的。它儲存在一個名為 Sample.Index.html 的檔案中。

H

HTML 標籤

T

Text2HTML.Compile
教程創作命令

\

\Book
\Call
\Chapter
\Index
\Label
\Link
\\


修改日期:1996 年 12 月 2 日,afi
安裝日期:1997 年 5 月 30 日


華夏公益教科書