XML - 資料交換管理/作者指南

編輯章節

您只需點選任何要編輯頁面的頂部“編輯此頁面”選項卡。您也可以只編輯一個部分或子部分 - 任何您在行上方看到一個小的“編輯”的地方，點選它來編輯該部分。章節編輯過程背後的想法將在每個章節的“討論”選項卡中記錄 - 在那裡記錄您分配的章節的意圖。

如果您想對編委會提出任何建議，我們歡迎您。在 XML: 資料交換管理內容頁面頂部有一個“討論”選項卡，請點選該連結並使用您的評論編輯頁面，確保按照條目說明進行操作。

• 在編輯頁面時，使用維基程式碼，而不是 HTML 程式碼。

• 如何製作連結：[[XML: 資料交換管理/NameOfThePage(頁面上)|NameOfThePage(顯示為連結)]]

• 不要剽竊：請引用並參考幫助您為本書做出貢獻的書籍、文章和網站。

• 所有圖片和圖形應該以“xml”為字首，以避免意外覆蓋其他檔案（例如，xmldmcity 定義了城市的資料模型）。

• 在可能的情況下，使用 可移植網路圖形 (PNG) 作為圖形，因為它優於 GIF 和 JPEG。此外，PNG 是開源的。OpenOffice.org Draw 可用於建立 PNG 檔案。

一致性指南

- 開發用於為書籍建立一致的外觀和感覺

版式

• 需要章節摘要

每個章節的底部應該包含一個章節摘要，突出顯示章節的要點。請按照本頁後面詳細介紹的格式指南進行操作。

• 加粗新詞

在每個章節中介紹新的概念和術語時，請確保在使用它們之前先對其進行定義；以便讀者理解這些詞和想法代表什麼。加粗單詞的首次出現（或在定義之前）。

• 使用句子格式作為標題

標題的首字母大寫，其餘字母小寫，就像這個標題一樣。

• 避免使用下劃線和全大寫單詞

• 表格、圖形和程式碼引用

為了一致性，將所有表格、圖形（例如圖表和照片）和程式碼示例標記為“展品”。將展品標籤放在展品的頂部，左對齊，並對展品進行編號，後面跟著簡短的標題。示例：“展品 1：XML 資料型別”和“展品 2：模式程式碼示例”。

• 概念膠囊和呼吸空間

將您的章節看作資料模型或一塊大牛排。一個有用的資料模型被分解成它最小的屬性，這些屬性需要記錄和維護以供將來分析。一塊大牛排最好分成一口大小的塊來吃，以防止窒息並促進良好消化。當您修改您的章節時，考慮您主題的基本要素；將您的主題分解，並在一個部分中呈現每個要素 - 以便讀者能夠輕鬆地跟蹤和理解每個部分。您可以隨意使用專案符號來表示列表。

繼續使用牛排的類比，慢慢吃也很不錯，在每口之間都要呼吸。在每個小節之間留出空格，在每個部分之間留出更大的空格。這將開啟文字，使其不會顯得過於密集和緊湊 - 從而顯得令人望而生畏。

• NetBeans（或其他 XML 編輯器）示例

向下滾動內容頁面到“附錄”。您將看到一個指向“使用 XML 編輯器”章節的連結。當您開啟此連結時 - 轉到“編輯此頁面”選項卡，並在 NetBeans 標題下插入一個連結，其中包含您章節的名稱。這是連結的格式：[[XML: 資料交換管理/ChapterName(NetBeans)|ChapterName]] 儲存您的編輯後，XML 編輯器頁面將包含一個指向您的新 NetBeans 頁面的連結。它將顯示為紅色，因為尚未向該頁面釋出任何資訊。點選連結並將您章節中的所有 NetBeans 資訊貼上到編輯框中。在您分配的章節中，在您剛剪下並貼上到 XML 編輯器頁面中的 NetBeans 資訊所在的位置 - 放置一個指向 XML 編輯器 - 您的章節頁面的連結。

• 幫助：華夏公益教科書 <= 此連結將提供幾個維基指南 - 此頁面也可以從左側欄中每個華夏公益教科書頁面的導航框中的“幫助”連結訪問。它包含有關插入圖片、使用維基語言（比編寫和閱讀容易得多）建立表格的資訊。

此幫助頁面還包含一個指向“沙盒”的連結。這是一個空白頁面，允許您在不影響真實頁面的情況下嘗試維基。

程式碼示例

• 使所有程式碼示例都使用統一的顏色（黑色）——有些是全黑的；有些是多色的。請將那些多色的程式碼示例改為全黑色。

• HTML 程式碼為小寫。

• 保留程式碼中的註釋，但在每個註釋之上和之下留出空格。

• 在註釋標籤中包含程式碼的檔名。如果您是程式碼的作者，請在註釋中包含您的姓名和您創作程式碼的日期。請參見示例

    <!--
         Document   : city.xsd
         Created on : March 1, 2005
         Author     : Tim Jones
    -->

• 將章節中所有關於同一主題的示例程式碼都放在 TOURGUIDE 中。如果您的章節中有偏離此主題的示例，請更改它們以顯示 TOURGUIDE 中的示例。

• 如果您的程式碼包含 HTML 或 XML 宣告，則您需要新增 <pre> ... </pre> 標籤。

• 為了使那些“pre”標籤顯示出來，我必須使用 <nowiki> ... </nowiki> 標籤。

如果您在插入程式碼時遇到麻煩，上面提到的兩個標籤中的一個可能能夠幫助您解決問題。

• 您無需在程式碼示例周圍建立表格；通常只需在每行前面新增幾個空格就會建立帶有藍色虛線的框

拼寫

• 使用“stylesheet”的拼寫，而不是“style sheet”。

• 使用“opening tag”的拼寫，而不是“opening-tag”。

• 使用拼寫檢查器檢查您的維基文字（例如，複製並貼上到支援拼寫檢查的文字編輯器中）。

練習和答案

在您章節的底部建立兩個連結，一個指向練習頁面，另一個指向已建立的答案頁面（您可以在內容頁面的底部找到此答案頁面連結）。

在練習頁面中，將您的章節練習剪下並貼上到一個新頁面中。建立新頁面的一個簡單方法是，只需轉到您的主章節頁面，在 URL 的末尾鍵入“exercises”，然後按回車鍵。如果頁面不存在，維基百科將要求您透過轉到“編輯此頁面”來建立頁面。

在練習頁面的頂部和底部，提供一個指向章節和答案頁面的連結 - 反之亦然，答案頁面也是如此。

風格要素 - 構圖原則

摘自風格要素 - 威廉·斯特朗克和 E.B.懷特著

• 使段落成為構成的單位 - 主題需要分解成主題，主題需要分解成概念和子概念。每個概念都應該在自己的段落中進行探索。

• 以肯定形式陳述 - “做出明確的斷言。避免使用溫和、猶豫、模稜兩可的語言。使用“not”一詞作為否定手段或用於對立，切勿將其作為逃避手段”。

• 使用明確、具體、具體的語言 - “偏好具體而非一般，明確而非模糊，具體而非抽象”。

• 省略不必要的詞 - “一個句子不應該包含不必要的詞，一段不應該包含不必要的句子...許多表達違反了這一原則：‘the fact that’，他是一個男人... - 他...”。

• 避免使用一系列鬆散的句子

• 用類似的形式表達協調的思想

• 將相關詞語放在一起

• 將句子的強調詞語放在句末

原始碼

為了在書中插入原始碼（例如，XML 或 Java），請使用以下格式

  <country>
      <code>au</code>
      <country>Australia</country>
      <flag>au.gif</flag>
  </country>

使用以下維基程式碼

<pre><nowiki>
  <country>
      <code>au</code>
      <country>Australia</country>
      <flag>au.gif</flag>
  </country>
</nowiki></pre>

章節摘要

章節摘要應以以下格式出現

章節摘要

使用以下維基程式碼

{| style="background:linen; border: 1px solid black; padding: 1em; width: 100%;"
|- 
| A chapter summary
|-
|}

故事

故事/案例研究應以以下格式出現

一個故事

使用以下維基程式碼

{| style="background: lightyellow; border: 1px solid black; padding: 1em; width: 100%;"
|- 
| A story
|-
|}

參考文獻

• 線上有一個 維基編輯指南
• 可以使用 線上工具 將 HTML 表格轉換為維基格式。