跳轉到內容

華夏公益教科書:維基專案 OpenRewi - 開放法律科學/寫作

來自華夏公益教科書

在本頁面,您將找到在華夏公益教科書中開始寫作章節的技術指南。如果您有任何問題,請隨時聯絡您的編輯。

一般說明

[編輯原始碼]

您不能在 Microsoft Word(或其他文字處理器)中編寫您的文字,然後將其複製到華夏公益教科書。相反,您必須使用下面描述的三種編輯選項之一。

您有三種不同的寫作選項

  1. 使用華夏公益教科書的視覺化編輯器線上寫作
  2. 使用華夏公益教科書的原始碼編輯器線上寫作
  3. 使用Atom 編輯器離線寫作

無論您選擇哪種技術,在華夏公益教科書中工作都有四個基本規則

  1. 在編輯您的章節之前,您需要註冊並登入華夏公益教科書。
  2. 不要一次又一次地釋出許多小的更改,而應該在您的編輯結束時同時釋出所有更改(這樣,其他人更容易跟蹤更改)。
  3. 在釋出您的編輯之前,您應該仔細檢查您的更改。您可以透過點選頁面底部的“顯示預覽”來做到這一點。
  4. 每個編輯都應該在“編輯摘要”下進行總結。

華夏公益教科書寫作文字編輯器

[編輯原始碼]

視覺化編輯器

[編輯原始碼]

在華夏公益教科書中編寫、釋出和修改文字的最簡單方法是使用視覺化編輯器。您可以透過點選章節頂部選單欄中的“編輯”來選擇視覺化編輯器。

使用視覺化編輯器寫作非常類似於在 Microsoft Word 中寫作。在頂部選單欄中,您可以應用簡單的格式化(例如,斜體粗體下劃線),選擇樣式表(例如,標題、段落),插入列表或表格,並引用某些內容。這些元素大多是不言自明的。

透過點選頂部選單欄中的“插入”,然後點選“模板”,您可以選擇我們用於高階內容和示例的統一設計

例如,要將一個用於高階內容的方框整合到您的文字中,您需要

  1. 點選“插入”,
  2. 點選“模板”,
  3. 搜尋模板(“OpenRewi/Advanced”),
  4. 點選“新增模板”,
  5. 在“引用”下輸入您的標題,在“內容”下輸入您的文字,並
  6. 透過點選“插入”將方框新增到您的文字中。

如果您要插入一個示例,您需要在第三步中選擇“OpenRewi/Example”模板,而不是“OpenRewi/Advanced”模板。

請確保不要更改我們的設計主題(例如,資訊框),並遵循我們的樣式指南(尤其是標題)。

原始碼編輯器

[編輯原始碼]

您也可以使用原始碼編輯器來編輯您的章節。您可以透過點選章節頂部選單欄中的“編輯原始碼”來選擇原始碼編輯器。

對於原始碼編輯器,您必須使用所謂的維基語法。維基語法是 HTML 的簡化標記語言。語法非常簡單,因此您可以快速學習。有關在原始碼編輯器中工作的詳細說明,請點選此處檢視。您可以在以下備忘單中找到 OpenRewi 最重要的維基語法命令列表。只需複製程式碼並將其貼上到您的章節中即可。您只需要調整章節的內容。我們的樣式指南詳細描述了各個部分的使用目的。

備忘單:複製貼上原始碼
標題 程式碼 視覺化
基本格式化 '''This is a bold text''', this is an ''italic text'', <u>this is an underlined text</u> and <s>this is a strikethrough text</s>. This is a bold text, this is an italic text, this is an underlined text and this is a strikethrough text.
標題 ==A. Heading ==

===I. Sub-heading I===
====1. Sub-heading II====
===2. Sub-heading I===
====a) Sub-sub-heading I====
=====aa) Sub-sub-sub-heading I=====
==B. Heading ==

列表 *This is a bulleted list

#This is a numbered list

  • This is a bulleted list
  1. This is a numbered list
腳註 在科孚海峽案中,國際法院認定阿爾巴尼亞負有國家責任。<ref>[https://www.icj-cij.org/public/files/case-related/1/001-19490409-JUD-01-00-EN.pdf 科孚海峽案(英國訴阿爾巴尼亞)(案情)(1949)國際法院報告 4].</ref> 在科孚海峽案中,國際法院認定阿爾巴尼亞負有國家責任。[1]
連結到其他章節 [[您的書籍/章節標題|連結到其他章節的顯示文字]] 連結到其他章節的顯示文字
使用錨點連結到其他章節 [[您的書籍/章節標題#錨點:您的錨點名稱|連結到錨點的顯示文字]] 連結到錨點的顯示文字
連結文字中的錨點 {{anchor|您的錨點名稱}}
連結到華夏公益教科書外部的資源 [https://openrewi.org/en/english/ 連結到華夏公益教科書外部資源的顯示文字] 連結到華夏公益教科書外部資源的顯示文字
提供示例 {{Template:OpenRewi/Example|Content=This is your example.|Reference= example topic}}

示例主題示例: This is your example.

提供高階內容 {{Template:OpenRewi/Advanced|Content=This is your advanced content.|Reference=Heading for your advanced content}}
高階:Heading for your advanced content

This is your advanced content.


嵌入互動式元素 {{Template:OpenRewi/Test|Link=Link to H5P element#your_anchor}}
測試您的知識 在我們的學習區.
原始碼中的註釋 <!--This is a comment.-->

Atom 編輯器

[編輯原始碼]

如果您更喜歡首先離線編寫您的文字(而不是立即在視覺化編輯器中編寫,在那裡每次中間儲存也意味著釋出),我們推薦您使用Atom程式。如果您想首先離線編寫您的文字,您必須使用所謂的“維基語法”。這並不難,而且學起來很快(如上一節關於原始碼編輯器的描述)。您可以在這個備忘單中找到 OpenRewi 最重要的命令概述。只需複製程式碼並將其貼上到 Atom 編輯器中即可。您只需要調整章節的內容。有關在原始碼編輯器中工作的詳細說明,請點選此處檢視。

要使用 Atom 離線編寫文字,您需要按照以下步驟操作

  1. 下載Atom並安裝該程式
  2. 根據以下步驟在 Atom 中安裝 Mediawiki 包
    1. 開啟 Atom 的首選項視窗
    2. 點選“安裝”
    3. 搜尋“language-mediawiki”並點選“安裝”
  3. 在右下角 UTF-8 和 Github 之間將格式設定為“Mediawiki”,而不是“純文字”。
  4. 開始在 Atom 中編寫,不要忘記不時將您的文件儲存到您的計算機上。
  5. 一旦您使用維基語法在 Atom 中完成了章節的部分內容,您就可以將其複製貼上到華夏公益教科書的章節中,使用原始碼編輯器進行操作。

嵌入互動式練習

[編輯原始碼]

歡迎您將互動式練習的連結嵌入到您的章節中。除其他事項外,您還可以建立單項選擇題或多項選擇題,以及填空文字。為此,您需要使用 H5P 框架。如何做到這一點將在下面描述。

要建立互動式練習,您需要按照以下步驟操作

  1. 點選此[連結],並使用編輯人員與您共享的資料登入。對於 PIL 團隊,登入資料可以在[Nextcloud]中的此連結下找到。
  2. 點選左側邊欄中的“H5P 內容”->“新增新內容”,並選擇練習型別(例如,多項選擇題、填空題等)。
  3. 填寫您所選練習型別所需的欄位。
  4. 向下滾動到“標籤和標題”(德語:“Bezeichnungen und Beschriftungen”),並將語言從德語更改為英語。
  5. 點選右上角的“建立”。
  6. 複製右上角的短程式碼。
    [h5p id="your_number"]
  7. 仔細檢查您的練習。
  8. 搜尋您書籍中的“練習頁面”,該頁面由編輯建立。對於 PIL 團隊,您可以在[此處]找到練習頁面。
  9. 在您的練習頁面(歷史、理論和方法;一般國際法;專門領域)上建立一段文字和一個標題(例如,“國家責任練習”)。
  10. 將短程式碼複製到練習頁面上的目標位置。
  11. 設定錨點:點選您的短程式碼,在右側邊欄中選擇“塊”,然後在“高階”下的“HTML 錨點”中選擇一個合適的描述,該描述末尾沒有空格。
  12. 將模板“OpenRewi/Test”新增到您的 Wikibooks 章,並輸入您的書籍練習頁面(第 8 點)的連結,並在連結後新增 "#" 和您的錨點名稱。
    {{Template:OpenRewi/Test|Link=Link to H5P element#your_anchor}}
  13. 釋出您在 Wikibooks 上的更改,並檢查您的練習連結是否有效。
    Note: Sometimes it can take a while until your exercise is displayed. It is best to simply restart the browser, clear the cache or make a test with another device.
  1. 科孚海峽案(英國訴阿爾巴尼亞)(案情)(1949)ICJ Rep 4.
華夏公益教科書