跳至內容

維基百科:格式手冊/電腦

出自Taiwan Tongues 台語維基
這是此頁批准,以及是最近的修訂。

本頁的目的,是為電腦科學、軟體、網際網路佮資訊科技等等領域之條目提供基本的格式指引。咧遵循這指引的同時,嘛應該愛遵循格式手冊的其他方針佮指引。

咧編輯佮電腦科學相關公司、產品抑是服務之商標名稱的時陣,請遵照維基百科的商標相關方針佮指引。

你若咧維基百科毋是字典。使用者應該盡量將仝性質之科技相關術語抑是產品整合為較完善、優質的文章,毋是建立大量的細件。

產品 kha-tá-lok-guh

任何介紹產品的條目攏應該包括其開發背景佮版本迵天。猶毋過,你若咧維基百科毋是 kha-tá-lok-guh 嘛毋是資訊的收集處,所以無應該共產品每一改愈新抑是版本現現場全部列出。基本上,只要包括一定程度的資訊,會當予讀者通做了解這个產品的演進歷程就會當。如果需要列出產品的所有的版本,會當佇維基數據處編輯對應資料的「軟體版本」屬性。

同時,嘛毋好直接共產品諸多特色以列表形式呈現,因為表列的資訊可能會過期,抑是因為協助廣告抑是宣傳嫌疑若拄著徙掉;另外咧,算盡量莫使用兩交含兩可的時間詞,如「最近幾年」佮「今仔日」等。

產品的號名

為產品條目號名的時陣,彼應建立其上捷用名稱之重新導向頁面。

大多數的軟體供應商會使用兩種方式為產品系列中的某一特定版本號名:

一 . 以版本號號名,如iOS 十一iOS 十二等。 二 . 以特定名稱號名,如Windows XPWindows Vista等。

毋過電子遊戲的業界是無仝款。大部份的電子遊戲標題中帶有的數字,是用來表達前作佮紲作之間的關係,而且毋是單純的版本號。比如講,《超級瑪利歐兄弟三》佮《超級瑪利歐兄弟二》為前後作關係,是兩款無仝款的遊戲。毋過有一寡時陣電子遊戲發行商猶是會當使用版本號以區別特定更新版本,比如講《終極動員令:紅色警戒二v . 一孵空空八就單純只是《終極動員令:紅色警戒二》的更新補丁爾。

佇咧講產品的時陣就盡量使用上捷使用的名,如應使用Windows XP毋是 Windows 五榖一抑是講 Windows NT 五孵一。另外咧,毋通混用版本號佮特定名稱,如應避免使用 Windows v 六鼻空抑是 Windows 六指代Windows Vista。同時,維基百科嘛禁止自創縮寫。

服務包

服務包是程式的更新、修復佮補丁的合輯,基本上以獨立安裝套件之形式發布。使用者咧編輯相關條目的時,應清楚區分服務包佮產品用詞。

咧講服務包本身的時陣,應該列出該服務包之全名,比如講:

  • Windows XP Service Pack 二
  • WinZip 九 Service Release 一

咧講已經安裝服務包的產品的時陣,建議使用「(已經)安裝『服務包名稱』的『產品名稱』」,比如講:

  • (已經)安裝 Service Pack 二的 Windows XP
  • (已經)安裝 Service Release 一的 WinZip 九

此外,佇咧有需要的時陣,會當將軟體版本的簡寫,比如講:

  • Windows XP SP 二
  • WinZip 九 SR 影一

請我量只使用上述其中一種方式編寫條目。若過度透使用,共致使無熟似科技術語的讀者無法度分服務包及產品兩个之間的差別。若參照來源內底同時使用濟種描述方式的時陣,請盡量減少文章中的用詞精差,並詳細共每一用詞所指的物件。

x 八十六佮 IA 鋪三十二

佇編寫電腦相關條目時,請謹慎使用「x 八十六」一詞,因為其定義可能根據文章性質來有所不同。廣義的 x 八十六是指由英特爾首先推出,其他的廠商綴尾手佮進研發的一款中央處理器指令集架構。x 八十六閣根據所使用的位元組字長無仝,分做採用三十二位元架構的 IA 鋪三十二佮採用六十四位元架構的 x 八十六陵六十四,其中 IA 鋪三十二因其高普及率成做「x 八十六」的代名詞。猶毋過,佇編寫條目時,猶是應該共用詞區分予清楚。

三十二位元與六十四位元

你莫使用任何關於著位元組字長,如「三十二位元」、「 六十四位元」等等的用詞描述特定軟硬體架構。因為遮的用詞之定義傷過霧袂清,若使用容易造成讀者誤解。

佇多數的情形下,三十二位元和六十四位元分別是指採用該長度位元組之中央處理器架構內上捷用者,即 IA 鋪三十二佮 x 八十六陵六十四(閣稱 x 六十四)。 但是因為兩个攏毋是唯一採用三十二佮六十四位元的架構,所以袂當用代稱「三十二位元」佮「六十四位元」中央處理器。佇編寫條目時,應清楚列明特定架構名稱。

正確的用法舉例:

  • 「現此程式支援x 六十四架構之中央處理器。」
  • 「抑若產品的IA 被六十四版本 ⋯ ⋯」
  • 「⋯ ⋯專為 Zilog Z 八十佮其相容的中央處理器設計的 . z 八十格式 ⋯ ⋯」

錯誤用法舉例:

  • 「現此程式支援 _ 六十四位元 _ 架構之中央處理器。」
  • 「抑若產品的 _ 三十二位元 _ 版本 ⋯ ⋯」

Linux 佮 GNU / Linux

請使用「Linux」毋是「GNU / Linux」來講乎 Linux 核心為基礎的作業系統。GNU / Linux 一下詞應干焦用佇咧描述特定作業系統佮部份 Linux 發行版。

就算自由軟體基金會建議使用 GNU / Linux 為 Linux 的標準譯名,但維基社群是對主人的原則,佇參考添外可靠來源及長時間的多方討論了後,決定否決自由軟體基金會之主張,選擇以 Linux 做維基百科內的通用譯名。

任何主張攏愛有來源佐證

佇咧維基百科,任何主張攏著愛有可靠來源佐證,包括軟體的發售時間、大細、支援語言佮開發的時陣所使用的程式語言等等。有的主張看起來敢若「毋免證明」,因為容易予人編輯者所雄雄,包括講「支援多種語言」、「以 C + + 語言編寫」佮「佇咧 Windows 環境內底來開發」等。

用詞的配搭

請毋通刁工佇條目中使用話屎抑是深澀難捌的字。維基百科的目標是予讀者閱讀資訊的時陣感覺四序,而且毋是呢成做線頂權威學術期刊。若無必要,你就莫使用罕得或者是違和感的同義詞,因為乎無必要

常見情形如下:

  • 已經予人開發者抑是著作權所有的人無閒,所以無閣再進行銷售抑是提供技術支援的電腦軟體應該號做「已經予廢棄的軟體」(abandonware), 毋免使用「_ 已經予人放袂記得的軟體 _」(forgottenware)等具毋免文學意涵的用詞。
  • 是咧講「產品的性命周期結束的時陣,供應商停止行銷、賣了後服務等行為」的術語應該號做「停止支援」(discontinuation)毋是「_ 挕捒 _」(abandonment)。
  • 電腦的程式「運行佇咧作業系統內面」(run under), 毋是「_ 運行佇咧作業系統頂面 _」(run up)抑是「_ 運行佇咧作業系統之下 _」(run down)。
  • 電腦的程式「自使用者數字中」(in / within the context of a user account)儉取資料,毋是「_ 自使用者數號上 _」(on)、「_ 自使用者數號下 _」(under)、「_ 自使用者數字內 _」(inside)抑是「_ 自使用者數號外 _」(over)儉取資料。就算講遮的詞類佇口語抑是非正式的場所使用是無問題的,但典範條目標準建議使用較精準的詞。
  • 就算講攏是「碟仔」,猶毋過「光碟」(disc)佮「磁碟」(disk)採用的讀結構完全無仝款,前者使用光學雷射掃描,後者是使用磁性媒介讀寫寫,請加注意。

描述氣口

請避免使用過去式咧講有用事實的物件。

錯誤用法舉例: System Software 六 _ 曾經是 _ 由蘋果電腦開發,並 _ 捌 _ 發行佇麥金塔平台頂面的作業系統。

述用法會予讀者認為 System Software 六這个作業的系統這馬已經「毋是由蘋果電腦開發」、「 毋是發行佇咧麥金塔上」了;事實上作為已經發售的作業系統,其開發者佮發行平台攏已經成做既定事實,並袂綴時間經過而改變。若必須愛表達這个事實已經發生矣,愛用適當的年代表述。

正確的用法舉例: System Software 六由蘋果電腦開發,並佇一九八八年四月發行佇咧麥金塔平台頂面的作業系統。

命令列範例指出來是一段程式或者是 shell 命令的具體用法,使用者會當共其輸入電腦終端抑是命令提示符執行。本章節描述遮的範例,佮其他命令列內容的格式規範。

通用指引

做提供命令列範例的時應當愛做保持清楚佮簡單。這毋但會顯得閣較專業,仝一个時陣也防止讀者產生憢疑。下跤的指南界定了啥物是有清楚,簡單的範例。

  • 命令列的例應當採用等闊字型。對著行內的代碼,應該愛使用 ` < code > `(有時愛配合 ` < nowiki > `)。 對著加行的代碼箍,應該愛使用 mediawiki 語法,行前加一空格;抑是講嘛會使用 ` < pre > ` 生做無愛紮維基文字支援的代碼箍。對於 Unix shell,嘛會使用 ` < syntaxhighlight > ` 的 ` lang=" shell-session " ` 突顯。
  • 維基百科毋是一个展示作者的個人偏好的媒介。除非有必要,若無無應該包括任何環境變數,日期,做工課 kha-tá-lok-guh,使用者名稱抑是主機名稱。
  • 術語:_ 選項 ( option ) _ 是一種開關(一寡修改一般行為的命令)。 _ 參數 ( parameter ) _ 是一个特定值,如檔案抑是主機名稱。_ 參照 ( argument ) _ 這个詞是用來指任何空格分隔的字串按照號令的名,其中就包括選項佮參數。
  • 列舉參照的時,應注意保持簡單。無加解說地定義參照會去濫份讀者。
  • 維基百科袂當取代手冊頁。條目無應該列出佮命令相關的規个選項列表,除非講這款的選項非常的少,抑是按呢的描述方式是絕對必要的。
  • 當指定參數的時陣,應當使用合理的名稱來指代𪜶。遮的名應該是使用趨的,無應包含空格(空格通常用來分隔命令列的濟个參照,使用空格會去致使這个濫份)。 以下是一寡例:

` ` ` ( 提示符 ) command _ parameter-name _ ` ` `

` ` ` ( 提示符 ) command _ parameterName _ ` ` `

` ` ` ( 提示符 ) command _ parameter \ _ name _ ` ` `

` ` ` ( 提示符 ) command _ parametername _ ` ` `

  • 一致性是足重要的。莫佇仝一个條目里同時使用描述四種方法來號名參數,以免去𨑨迌讀者。
  • 非必須並且會使完全省略的參照應該囥佇方括號 [ ] 中。
  • 有誠濟方法指定重複的參數。以下兩个是上定看著的:

` ` ` ( 提示符 ) command _ parameter 零 _ [. . _ parameterN _] ` ` `

` ` ` ( 提示符 ) command [_ parameter _ . . .] ` ` `

具體平台指引

DOS、Windows、OS / 二

目前上捷看著的 DOS 平台是 Windows 平台跤的 MS-DOS。所以,干焦佇咧 MS-DOS 會當用的例一般無需要特別說明。猶毋過,若該實例干焦針對某一个特定版本的 MS-DOS,按呢應當標明相關的資訊。就已經其他 DOS 平台跤該範例有無仝的效果,嘛應當加就是講。 適用佇咧 DOS 命令列的例應該愛循下列額外的指導方針:

  • 程式抑是號令名應全部大寫。
  • 標準的 MS-DOS 風格的選項(比如講 / C,其中 C 可能是其他字元)嘛應該愛大寫,除非𪜶是區分大細寫的。
  • 程式名稱應當附加適當的檔案副檔名,以佮內建的號令名稱相區別。若某一寡版本的 MS-DOS 中無包含某一个特定的程式(如 MOVE . EXE 抑是 EDIT . COM), 按呢應當註明包含遮的程式的版本。

類 Unix 系統

  • 大部份類 Unix 系統的命令實際上攏是會當執行檔。Shell 內起的命令(如 cd 和 history)嘛佇咧咱討論的範圍內底。
  • 類 Unix 系統當中捷看著的 Shell 互相之間有一定的精差。所以,佮特定的 Shell 相關的命令抑是實用程式(如 for 迴圈抑是流特性)應當趕緊避免。
  • 若為著正確的所在作出說明著愛使用一捾佮特定 Shell 類型相關的命令,若按呢你應該當時提供類 ALGOL 的 sh,ksh 和 bash 代碼,以及 C 語言風格的 csh 和 tcsh 代碼。兩个人的語法無啥差別時無需要按呢做。
  • 類 Unix 系統中的大部份命令攏是全部使用小寫字母的。毋過,因為 shell 佮操作環境區分大細寫的特性,應注意大細寫格式和命令抑是檔名匹配。若有必要,建議使用標題錯誤模板。
  • 通常情形下需要權限的命令佮無需要權限的遐的應當加以區別。若某一个命令確實需要特定權限,才應當予出一份免責聲明指出佇無限制的權限下執行命令所具有的風險。
  • 佇某一寡狀況下,命令列參數真可能包含一寡 shell 元字元(如萬用字箍等)。 佇這个情形下,明智的做法是佇例中使用引號,以防止使用者收著予𪜶感覺著奇怪或者是攏無來由的錯誤。

提供範例輸出

為一个命令提供輸出範例是一種保守的做法。這款情況下應當予出佇終端中實際鍵入的完整的命令和所有的參數。命令的輸出因此只依賴佇執行環境佮其他的變數。照順序使用標籤 ` pre ` ` nowiki ` 會當確保輸出文字的格式正確。

使用範例

DOS

  • DOS 預設命令 DIR,這用於列出檔案佮資料鋏 :

` ` ` > DIR [_ options _] [_ pattern _ . .] ` ` `

  • MS-DOS(其實行為類比起來進前版本 DOS 的功能)上的程式 MOVE . EXE:

` ` ` > MOVE . EXE _ source _ _ target _ ` ` `

定規 Unix

  • 用 Unix 風格系統上的 ls 命令列出檔案佮 kha-tá-lok-guh:

` ` ` $ ls [_ options _] [_ file _ . .] ` ` `

  • 用 mkfs 命令建立新的檔案系統,通常需要一定的權限:

` ` `

  1. mkfs [-t _ fstype _ ] [_ fs-options _] _ device _

` ` `

  • wget 程式,GNU 實用工具之一,根據予出的 URI 取得檔案。URI 會當包括 shell 元字元,所以參數需要加引號以防止出錯。

` ` ` $ wget [_ options _]'_ URI _' ` ` `

Shell 特性

  • sh / ksh / bash 中內起 if 結構的語法異同:

` ` ` $ if _ command _   ; then _ command _   ; . .   ; fi ` ` `

佇咧 csh / tcsh 中 :

` ` ` % if ( _ expression _ ) then _ command _   ; . .   ; endif ` ` `

輸出舉例

  • df 命令的輸出舉例,列出了掛載的檔案系統吸碟空間使用情況:

` ` ` $ df-P Filesystem 五百十二-blocks Used Available Capacity Mounted on / dev / hda 二三千九百三十三鋪一千七百六十七百三十九石八千九百空四兩千九百八十三石四千七百六十八百分之二十 / ` ` `

按照方針,維基百科毋是教程,嘛毋是未經篩選的例收集處。編者應該將頁面上已經有的趁錢全部攏徙動到維基教科冊的相關頁面。

  • 佇演算法類條目(如快速排序)中不應用幾種類似的語言重複舉例,欲使用單個語法簡單的流行語言抑是虛擬碼書寫範例。按照無仝程式的設計範式實現演算法、分開舉例是一般是會當接受的。編者會使佇維基教科書 b : 演算法實現內羅列各種語言的實現。如 b : 演算法實現 / 排序 / 快速排序。避免使用特定的語言、計算平台抑是編譯器的代碼最佳化了後損失會當讀性的代碼片段(如 ` p [+ + i]=xxx ; `), 請佇維基教科書中詳細介紹這類類代碼片段。
  • 佇命令列程式的條目中的例(csh、bash、cmd…)無仝定定是 Shell 命令語言的無仝。這無屬於程式本身的功能,嘛愛節制加入。
  • 佇咧電腦語言條目(如 Python)著無應該使用大段代碼來介紹應該語言的語法。上好干焦保留該語言的 helloworld 程式範例,並使用文字抑是列表來說明該語言所支援的語法特性(如迴箍、函式的物件等), 並添加內部連結指向彼語法特性。
  • 行動程式碼段的時陣愛做以下幾件代誌:
  • 佇維基教科書的討論頁貼來源橫幅。
  • 條目的外部連結部份攏使用 { { wikibook } } 模板來指出代碼的位置。
  • 編輯維基數據項,添加跨語言的連結,共教科書內的頁面佮維基百科的條目關聯。

公開的 URL

HTTP 和 HTTPS

一个網站可能同時支援超文字傳輸協定(HTTP)佮超文字傳輸安全協定(HTTPS)傳輸協定,即網址以 ` http : / / `/` https : / / ` 一開頭。咱建議使用者參照以下的模式加入連結:

  • 做網站干焦使用 HTTPS,抑是同時來支援 HTTP 和 HTTPS 時,使用 ` https : / / `。
  • 做網站干焦使用 HTTP 時,使用 ` http : / / `。