Difference between revisions of "Help:Editing (正體中文)"

From ArchWiki
Jump to: navigation, search
m (update link)
m (Remove from how to category.)
Line 1: Line 1:
 
[[Category:正體中文]]
 
[[Category:正體中文]]
[[Category:HOWTOs (正體中文)]]
+
[[Category:Help (正體中文)]]
 
[[cs:Help:Editing]]
 
[[cs:Help:Editing]]
 
[[en:Help:Editing]]
 
[[en:Help:Editing]]

Revision as of 11:33, 4 January 2014

ArchWiki 是由 MediaWiki 所構成。MediaWiki 是一個以 PHP 所寫成的自由軟體,起先是設計給 Wikipedia 使用。這篇簡短的教程是有關於編輯 ArchWiki。更深入的文件可在Help:Contents on MediaWikiHelp:Contents on Wikipedia 找到。

如果你只想瀏覽 Wiki 網頁的內容,你不需要註冊或是登錄。請點選 Special:UserLogin 建立一個帳號或是登錄。如果你希望測試一下這篇教學裡面關於編輯 wiki 的語法,請使用 sandbox 這一頁來練習。如果想看一下 wiki 的語法,請見 ArchWiki Cheatsheet。 有關 wiki 的任務,請看 ArchWiki:Tasks.

在編輯或創造頁面前,使用者應該讓自己熟悉現存文章的語氣、格式和風格。應該努力地去保持整個 wiki 內文章的一致性。對於通用的風格慣例請看 Help:Reading。對於更多的細節,請看 Help:Style

頁面佈局

儘管Wiki上的內容不同的主題都各不相同,但仍建議所有的文章都能采用一個總體佈局規劃,以便看上去比較協調。那么如何組織你的文章呢?下面是一個挺不錯的例子:

  • 導言 -- 對文中所述的內容作一個概要
  • 安裝 -- 指導如何安裝軟體,如果有寫的話
  • 配置 -- 軟體安裝後是如何配置的,如果有寫的話
  • 排錯 -- 關於此軟體的常見問題
  • 提示與竅門 -- 關於使用此軟體的進一步的提示或例示,如果有寫的話
  • 更多資源 -- 一個列出其它參考資料的好地方

當然,單獨的子標題可以並應當 被使用,並應列示於各主標題之下。參看下文中的 #主標題與子標題

編輯頁面

就像所有的共筆系統一般,你可以編輯所有不在保護模式下的網頁。所有的改變都可以在更新後馬上呈現。要編輯一個頁面,請直接點選每個頁面上方的 "edit" 這個連結(正體中文頁面請點選『編輯』連結)。如果要編輯一篇文章中的某些段落,請點選該段落標題欄右邊的 "edit" 。在編輯頁會出現以下數項:

  • 工具列 (optional)
  • 文字框
  • 摘要框
  • 儲存頁面, 顯示預覽, 顯示差異取消 的連結

文字框包括伺服器會產生 wiki 頁面的文字。如果要編輯文字的話:

  1. 按照需求修改 wiki 文字 (有關細節,請見底下的 #文字顯示格式 ).
  2. 請使用在編輯視窗和儲存與預覽按鈕之間的 "Summary" 來註明你對網頁作了哪些更動。例如 : "錯字更正" 或是 "新增關於 xyz 的資訊"
    注意: 所有的編輯應該包括摘要描述。摘要讓系統管理者和其他 wiki 編輯者容易認出有爭論的內容和人為的破壞。
  3. 使用 顯示預覽 在儲存前先行校對和核對格式。
  4. 選取 這是一個小修改 來標示這次的編輯只是個小改變 minor (例如錯別字,格式排列的改變),讓其他人知道你並沒有對整篇頁面的內容作任何大更動。
  5. 按下 儲存頁面 來儲存文章。如果不滿意的話,按下 取消 (重覆這個流程直到對文章感到滿意).

現在輪到你試著來練習一下如何編輯 wiki 頁面了。使用網頁瀏覽器,在新的分頁打開 沙箱 (沙箱就是用來讓你可以任意測試 wiki 語法),然後點選頁面上方的 "edit" 這個連接。在編輯視窗內加入一些東西,然後點選 save 這個按鈕。

注意: 如果你沒有要使用像是 Vim 等外部編輯器的話,可以考慮使用 wikEd,有支援語法高亮、常規表示式搜尋和替代以及其他不錯的特色等。Greasemonkey script 可以和 ArchWiki 良好地合作
注意: 文章不應該署名,因為這些文章是共享的成果,沒有某個編輯者比其他編輯者更突出。

添加新頁面

在添加新頁面前,請考慮以下事項:

  1. 這個主題和 Arch Linux 相關嗎? 不相關或沒有幫助的文章將被刪去。
  2. 這個主題對對他人有益嗎? 不只是考慮你希望寫些什麼,同時也要考慮別人想讀什麼內容。個人的註記應該在 使用者 頁面上。
  3. 這個主題值得添加新頁面嗎? 先在 wiki 內搜尋類似的文章。如果確實有找到類似的文章,考慮先改善該篇文章或者是在該篇文章內新增章節吧。
  4. 你的貢獻是否顯著? 避免創造一個不完整的頁面,除非你有記畫在短期內會修訂該頁面。

創造新頁面需要選定具描述性的標題和適當的分類

對於文章命名的建議,請閱讀 Article Naming GuidelinesWriting Short Article Names

要將一個新頁面添加到某一分類中去(也就是將"你自己名下新建的頁面"加入 "一個特的分類"),你需要:

  1. 開啟網頁 "https://wiki.archlinux.org/index.php/My_New_Page" 用一個新標題來編輯一個頁面。比方說,我們想要編輯一個新頁面:Mutt (正體中文),那么就去打開"https://wiki.archlinux.org/index.php/Mutt (正體中文)"這個頁面,然後點擊編輯來編輯你的新頁面。
  2. 在你頁面的最頂端放上:[[Category:Some Category]]
注意: 不要添加未分類的頁面! 所有的頁面應該至少屬於某一分類。如果真的不能找到適當的分類,那麼考慮創造新的分類。

文字顯示格式

大部分的文字顯示格式都可以用 wiki 內建的 markup 語法來實現,你不需要特別學習怎麼使用 HTML.

主標題與子標題

妥善使用主標題和子標題可以讓你的文章的架構看起來更為完整與清楚。如果你的頁面的內容可以整理出兩個或更多個比較大的主題,你可以在你的文章內插入一些主標題來分出段落和增加文章的可讀性。

標題可以用下面的語法來表現 :

==主標題==
===子標題===
====第三層標題====
=====第四層標題=====

標題層次不應該跳過使用。也就是說,不要在還沒使用子標題(第二層之對前就使用第三層標題。

如果一篇文章有至少四個以上的標題就會自動產生目錄(table of contents - TOC)。 如果你不希望在頁面內使用目錄,你可以在頁面的最上方加上 __NOTOC__ 這個指示字。 你可以試著在 沙箱 內建立幾個標題,然後看看產生目錄的效果。

折行

空白行用來起始新的段落,單行折行對段落是沒有效果的。

<br> 這個 HTML 標籤可用來手動插入折行,但應該避免這麼使用。手動折行可以和其他的格式標籤一起使用。

wiki 文字 顯示效果
This sentence
is broken into
three lines.

This sentence is broken into three lines.

This is paragraph number one.

This is paragraph number two.

This is paragraph number one.

This is paragraph number two.

* This point <br> spans multiple lines
* This point
ends the list
  • This point
    spans multiple lines
  • This point

ends the list

對於使用空白行的資訊,請見 Help:Style#Blank_lines

粗體與斜體

你可以把文字放在數個單引號 (') 之間來表現出 Bold - 粗體italics - 斜體 的效果:

  • ''italics - 斜體'' 顯示為 italics - 斜體. (在文字的前後分別加上兩個單引號)
  • '''bold - 粗體''' 顯示為 bold - 粗體. (在文字的前後分別加上三個單引號)
  • '''''bolded italics - 粗體斜體字''''' 顯示為 bolded italics - 粗體斜體字. (在文字的前後分別加上 2 + 3 =  五個單引號)

刪去

使用刪去文字來顯示這段文字不再適用等。

例如:

<s>刪去的文字</s>

顯示為:

刪去的文字

縮排

注意: 縮排應該只用於討論頁,見 Wikipedia:Indentation

要縮排文字,請在每一行文字的第一個位置插入一個冒號 (:) 。如果你插入越多個冒號,這一行文字就會越往內縮排。新的一行 (按下 Enter 或是 Return 後) 將會結束整段文字的縮排。

例如 :

This is aligned all the way to the left.
:This is indented slightly.
::This is indented more.

顯示為 :
This is aligned all the way to the left.

This is indented slightly.
This is indented more.

條列

無序號條列

要插入一個新條列時,請使用星號 (*)。就如同在文字縮排時一樣,在每段文字前插入越多個星號,將可把整段文字依序往內縮排。

一個簡單的例子 :

*First list item
*Second list item
**Sub-list item under second
*Isn't this fun?

顯示出來為 :

  • First list item
  • Second list item
    • Sub-list item under second
  • Isn't this fun?

有序號條列

你也可以在 wiki 頁面上建立一個有序號的條列。要建立有序號條列時,請使用數字符號或是井字號 (#)。多個井字號 #s 可以共用,並表現出層次和縮排的效果。

例子:

#First item 
#Second item 
##Sub-item under second item 
#Third item 

顯示為:

  1. First item
  2. Second item
    1. Sub-item under second item
  3. Third item

定義條列

例子:

; 鍵盤: 輸入裝置,附有按鈕
; 滑鼠: 指向裝置,可二維輸入

或者是

; 鍵盤
: 輸入裝置,附有按鈕
; 滑鼠
: 指向裝置,可二維輸入

顯示為:

鍵盤
輸入裝置,附有按鈕
滑鼠
指向裝置,可二維輸入

如果某個項目有多個定義,可加入多個冒號。例如:

; 項目
: 定義一
: 定義二

顯示為:

項目
定義一
定義二

源碼

在 wiki 頁面設定源碼格式非常簡單 : 你只需要在每一行文字前加上一個空白。 不過請記得注意每一行的長度,文字會自動斷行符合螢幕寬度。

替代作法可用 <pre> 標籤,或是其中一種 code 格式化樣板

例如:

<pre>
#!/bin/bash

if true; then
    echo "Yes"
else
    echo "No"
fi
</pre>

...會顯示為:

#!/bin/bash

if true; then
    echo "Yes"
else
    echo "No"
fi

表格

進階的表格語法與格式見 Help:Table

例:

{| border="1"
|+ Tabular data
! Fruit !! Color
|-
| Apple || Red
|-
| Orange || Orange
|-
| Banana || Yellow
|}

...會顯示:

Tabular data
Fruit Color
Apple Red
Orange Orange
Banana Yellow

Links 連接

在 wiki 頁面內使用連接的主要目的是用來幫助使用者瀏覽你的網站。 通常編輯者應該確保每一篇文章含有向外的連接到其它文章 (避免 斷鏈頁面) 而且從其它文章被向內的連接所參考 (特殊頁面 鏈入頁面 可以被用來顯示向內的連接)

內部連接

你可以在一個頁面內使用內部連接來設定多個 cross-reference wiki pages。你可以加入連接到一些已經存在的主題 (頁面),或是設定連接到一些你認為之後應該會存在的主題 (頁面)。

在同一個 wiki 文件內,要設定頁面的連接時,你只需要把要連接的頁面的標題放到雙中括號內 (double square brackets) 即可。

例如,如果你想要設定個連接到 pacman 這個頁面,請使用下面這個格式 :

[[pacman]]

如果你希望使用頁面標題以外的文字作為連接的名字,你可以使用 "|" 這個 pipe divider 然後在後面加上你要使用的連接名字 (在英文鍵盤上,你可以使用 Shift + \ 的方式打出 "|")。

例如,如果你希望設定一個連接到 Arch Linux 這一頁,但是想用 "home page" 來代表這個連接,你可以使用下面這個格式 :

請參閱 [[Arch Linux|home page]]...

然後頁面內容就會顯示 :

請參閱 home page...

如果你希望為連接的頁面主題名稱加上複數 (或是加上任何後綴文字),你可以把要加上的文字直接放在包著連接頁面的中括號後面。

例如,你可以用 :

makepkg is used in conjunction with [[PKGBUILD]]s.

頁面內容的顯示將會是 :

makepkg is used in conjunction with PKGBUILDs.

連接到文章段落

產生文章段落的連接時,只要在段落標題後加上 #

例如:

[[ArchWiki Tutorial (正體中文)#連接到文章段落]]

...會顯示:

ArchWiki Tutorial (正體中文)#連接到文章段落
Tip: 如果是連接到同一文章內的段落時,文章名可省略 (如: [[#連接到文章段落]])。不要為了隱藏錨點符號而做不必要的格式化 (如: [[#連接到文章段落|連接到文章段落]])。

多國語言連接

有關ArchWiki國際化與本地化的詳細資訊請參考 Help:i18n

如果非英文頁面使用的標題和英文的相同,那非英文頁面的標題就該使用下面這種格式

標題名稱 (語言)

例如:

Gnome
Gnome (Deutsch)
Gnome (Fran?ais)
Gnome (繁體中文)

如果一篇文章有多國語言,那麼請在編輯時,在每篇翻譯加上相關連結。例如:

[[de:Title]]
[[en:Title]]
[[es:Title]]

Interwiki連接

所謂的Interwiki 連接可以很容易的用來連接到外部其他 wiki 的文件,像是Wikipedia。 這種連接的語法是在Wiki名稱後接著一個分號以及你想連接的頁面名稱,外面再用雙方括號包著。

如果你想連接到文章 Wikipedia:Arch Linux,你可以用語法:

[[Wikipedia:Arch Linux]]

或是你可以建立一個不同名稱的連接到 Arch Linux Wikipedia article

[[Wikipedia:Arch Linux|Arch Linux Wikipedia article]]
注意: 使用不同名稱連結的時機,應該只用在縮短較長的網址。

請參閱: Wikipedia:InterWikimedia links

站外連接

如果你希望在頁面內連接到 Wikicities (指的就是 wiki 站內的文章集合) 以外的網站,你只需要在頁面內鍵入完整的網站連接路徑 (URL) 即可。

http://www.google.com/

在很多時候,我們都會給予連接的 URL 一個比較含意比較清楚的文字名稱。你可以把連接的 URL 放在中括號內,然後在 URL 後加上一個 空白 (space) (不是 使用 pipe) 後,再鍵入你要使用的連接文字名稱。所以,如果你想要使用下面這個顯示, Google search engine ,你可以使用:

[http://www.google.com/ Google search engine]

這個格式。

Redirects - 頁面轉向

如果你需要自動把一個頁面轉向另一個,請使用 #REDIRECT 這個指令,同時把新轉過去的網頁名稱放在括號內。

例如,你可以設定把 "Cats" 這個頁面自動轉向 "Cat" 。這樣一來,不管使用者在搜尋裡面輸入的是上面兩個字的任一個,他們都會被轉到 "Cat" 這個頁面去。

Wiki 變數 (variables) 和樣版 (templates)

MediaWiki會識別出文章中特定的字串內容作為特殊用途。例如:在文章中任意處加入 __NOTOC__ 字串時,會防止產生目錄。同樣地, __NOTOC__ 也可以用來改變目錄預設出現的位罝。詳細內容請參閱 Help:Magic words

插入到文章中的樣板和變數可以用來格式化內容。

變數可用來顯示許多資訊有關目前頁面、wiki、日期等等。例如:使用 {{SITENAME}} 這個指令來檢視目前的Wiki網站名稱 (在ArchWiki裡就是: ArchWiki)。

你也可以建立你自己的樣版 (templates)。在建立一個新頁面 Template:XXX 後,請使用 {{XXX}} 這個指令來把你的樣版加入到你要修改的頁面內。所以,如果你有許多網頁需要加入相同的資料,試著使用樣版的方法可以幫你省去許多麻煩。

這裡以 Template:Note 為例,在編輯文章時使用下面的wikitext語法:

{{Note|This is a note.}}

...會顯示:

Note: This is a note.

更多資訊請參閱 Help:Template

討論頁面

討論 (Discussion) 或是 "talk - 留言" 的頁面主要是讓你可以跟其他 Arch Wiki 的使用者有個對話的空間。

要討論任何一個頁面的內容時,請先選擇你要的頁面,然後點選頁面上方的 "discussion" 這個分頁。把你的留言加在討論頁面的最後面,或著加在你要回應的留言之後。

請為你的留言簽個名,簽名的方式可以用 ~~~~ 來加入你的帳號名稱和時間標記。

請使用 indenting - 縮排 的功能來格式化你的討論頁面。比較標準的作法是,所有的回覆都會依序比回應的原文往內縮一層。

現在讓我們試著開始編輯 沙箱的留言頁面 吧。

使用者留言頁面

每個人都有個 user talk page (使用者留言頁面),在這個頁面上,每個人都可以寫下公開的留言。如果某人簽了個留言給你,你將會看到一個短訊,寫著 "You have new messages",並包含一個連接直接連到你的使用者留言頁面。

你可以選擇在留言者自己的使用者留言頁面上留言,或是在你自己的使用者留言頁面上,跟貼在對方的留言之後。如果你選擇留言在對方的留言頁面上,對方將會在收到相同的通知短訊。

請勿在未授權的情況下編輯其它使用者所擁有的頁面 (如: [[User:Name]]); 這些是保留給使用者用的個人空間。而“使用者對話頁面”才是用來溝通的地方(或寄送私人email,如果該使用者在偏好設定有勾選接受來自其他使用者的郵件)。

特別分類

還有一些特別分類,以幫助製作和完善ArchWiki。

文章尚未完成,不可用

是凡在文中寫入
{{stub}}
這個標記的,就表示文章尚未完成。Category Stub這個分類下面包含了所有打上此標記的文章。文中使用殘缺標記(stub)的原因可能是:
  • 太短了
  • 說明不夠充分
  • 含有未完成部分

文章待譯

是凡在文中寫入
{{translateme}}
這個標記的,就表示文章尚待翻譯。

Category "Translation Requested" 這個分類下面包含了所有打上此標記的文章。文章在這個特別分類下的原因可能是:

  • 文章的某些部分沒有此種語言。
  • 文章的內容完全沒有翻譯,而是直接從英語或其它語種復制過來的
  • 原語種的文章更新了,而在翻譯頁面中此類內容卻沒有。

文中有潛在錯誤或不明信息

Category "Accuracy Disputes"這個分類下的所有文章都打上了這樣的標記
{{accuracy}}

文章在這個特別分類下的原因可能是:

  • 用戶察覺了潛在錯誤或不明信息,正在會客室(Talk)中討論相關內容和如何修正它
  • 頁面內容不詳,或過時了,需要更新