MDN’s new design is in Beta! A sneak peek: https://blog.mozilla.org/opendesign/mdns-new-design-beta/

幾乎每位MDN的貢獻者在MDN中都會做的兩件基本工作,即為編輯一個已存在的頁面或者是新增一個頁面。這篇文章將介紹如何編輯文件的基本技能。

編輯一個已存在的頁面

想要編輯十分的簡單:

  • 只要按下畫面右上角的 Edit 按鈕。
  • 頁面會重新載入各種選項,這樣一來你就能直接在頁面新增或刪除資訊。
  • 你可以增加文件段落、刪除文字、插入標題、以及做各式各樣的基本撰寫與編輯。

預覽修改

若是要檢視您所做出的變更:

  • 點選「預覽修改」按鈕(在編輯模式之中)位於文章標題上方。
  • 會以開啟一個新分頁或是新視窗來顯示一個您所做的所有變更。
  • 每當您按下此按鈕,此預覽頁會顯示您最新的更動狀態

請注意!預覽變更並不等同儲存您的修改,請小心不要太快關閉您的文章編輯頁面。

版本註解

在您預覽您的編輯過後,您總會希望送出您的修訂版本。在您送出之前,請在頁面文章下方找版本註解的輸入框,並且留下您於此次所做的變更註解以讓其他貢獻者能了解您做了那些變更。 舉例來說,您可能新增了一個段落,改變一些詞彙使其更符合原意,重新編寫段落以更在地化,或是移除了一些多餘的資訊。

Tags

您可以於文章編輯區塊下增加或移除用以描述文章內容以及用途的 tags。請詳見 How to properly tag pages 以了解 tags 如何來提供資訊。

審核是必要的嗎?

在您送出您的變更之前,您可以藉由勾選技術審核(針對 code、APIs或是技術內容),編輯審查(針對篇章結構、文法或內容),或是模板審查(針對 KumaScript code ),來讓專家或是經驗豐富的貢獻者審核您的變更。

附件

若您想要讓文章更易於理解或是加上插圖,而希望在頁面上夾帶檔案,您可在文章編輯頁面下方找到此功能。{OptimizeImagesNote(1)}}

儲存、放棄、以及繼續修改

當您修改完成,以及滿懷希望的預覽修改之後,您可以填寫註解並且透過點擊於文章標題右手邊的「儲存修改」綠色按鈕。若您改變您的心意,您可以透過點擊於文章標題右手邊的「放棄修改」紅色按鈕。

於版本註解輸入 Enter 和點選「儲存並繼續修改」具有同等的效果。

新增一個新頁面

若您不知道能夠在哪裡新增文章,別擔心!您可以隨意存放,我們會找到文章並且移到文章到它所屬的地方,或者與現有內容合併比較合理。您可以不需要為了使其完美而花費太多心力。 我們有快樂的地精幫手可以來為您的內容保持乾淨以及充滿價值。

以下是一些創造新頁面的方法:

「缺失頁面」連結

就像大部分的wiki,在MDN上當然可能在頁面上新增還未存在的頁面連結。舉例來說,作者可以在新增API所屬頁面前,新增所有API的成員清單。在MDN上,連結至還未存在的頁面會顯示為紅色。

要在頁面新增「缺失頁面」連結:

  1. 請先確認您已經登入MDN(如果您還未登入,點繫「缺失頁」連結會出現404(找不到頁面)錯誤)。
  2. 點擊「缺失頁面」連結,將開啟MDN Editor UI,讓您新增缺失頁面。
  3. 撰寫頁面內容,並且儲存。

非基於連結而建立的新頁面

為了建立一個非基於連結而建立的新頁面,您需要於 URL 區塊後輸入一個獨一無二的頁面名稱。舉例來說,若您輸入:

https://developer.mozilla.org/en-US/docs/FooBar

MDN 會心建立一個標題為「FooBar」而且會於開啟編輯器讓您能夠編輯此新頁面。請參考 Editing an existing page section of this article for how to use the editor mode.

從現有的頁面新增子頁面

為您在現有的頁面架構下新增一個子頁面:

  1. 在「父」頁面,點選進階目錄 ( 於列表上呈現齒輪圖樣 ),並點選新增子頁面。接著便會出現一個可以編輯新頁面的模式。
  2. Title 欄位輸入文章標題。
  3. 若有必要,改變 Slug 欄位 ( 舉例來說,若文章標題非常長而您又希望有個較短的 URL)。此欄位會由編輯器自動地來填入, by substituting underscores for spaces in the title. 在此種狀況下,您只能改變 URL 的最後一部分。
  4. TOC欄位,選擇您想要自動生成顯示在目錄的標題層級,或者這一頁不需要目錄也可以選擇「不需要目錄」選項。
  5. 於編輯器中增添內容並且儲存,請參考 Editing an existing page 文章來了解如何運用編輯模式。

複製現有的頁面

若您想於您的新頁面上套用某個現存頁面的格式,您可以點選「複製此頁」並於稍後改變該複製頁的內容。

  1. 於原始的頁面上,點選進階目錄 ( 於列表上呈現齒輪圖樣 ),並且點選複製此頁。接著便可編輯一個以該原始文件為樣本的複製頁面。
  2. 您可根據您文章的內容適當地訂下標題Slug 會根據您文章標題如何訂定而自動變換。
  3. 如有必要,可以改變 Slug 的部分內容以呈現出新文件於原始架構下的不同。(在大多數的狀況下,此舉是多餘的。因為複製後的頁面對於原始頁面具有相似的內容,因此就必須放在相似的架構之下。)
  4. TOC欄位,選擇您想要自動生成顯示在目錄的標題層級,或者這一頁不需要目錄也可以選擇「不需要目錄」選項。
  5. 在頁面編輯欄位編寫內容,並且儲存您的變更。請參考 Editing an existing page 文章來了解如何運用編輯模式。

從現有頁面連結

這種方法算是混合形式,您可以在其他頁面產生連結,接著點擊剛加上去的連結,就會產生新的頁面了。

  1. 從現有頁面任何地方輸入新頁面的名稱(需合理)。
  2. 反白該名子並且於編輯器中點選連結圖樣()。「連結」的訊息框會出現並且詢問該段反白文字需要被導向哪個頁面
  3. 「/zh-TW/docs/」 是預設的 URL 欄位內容。您可於「/zh-TW/docs/」之後輸入新頁面的名子(該頁面的名字並不需要和被連結的文字內容相同)。
  4. 點擊「確定」來創造和插入新的連結。

當連結呈現紅色時,代表著該頁面尚未存在。當連結呈現藍色時,代表著該頁面已經存在。若您想要建立一個新頁面但他的編題已經存在時,首先去檢查並改善現存的頁面,否則為您的新頁面想個不同的標題名稱並以此產生連結。請參考 page naming guide 以幫助您命名。

您可點擊您新建立的紅色連結(在您儲存以及關閉編輯器之後),來為您的新頁面增添內容。新頁面將在編輯模式下開啟,此時您就可以編寫內容了。請參考 Editing an existing page 文章來了解如何運用編輯模式。

重新整理頁面內容

MDN支援KumaScript巨集和嵌入其他頁面內容插入頁面,有時候因效能因素需要為生成的頁面用快取,而略為延遲內容更新。頁面從原始碼生成,產生的頁面會先產生快取以便未來存取使用。從現在起,所有的巨集(模版)或是嵌入(在該頁使用Page巨集)並不會馬上就會反應更動後的巨集變動,巨集生成頁面,或者嵌入頁面的內容。

  • 要手動更新頁面,您可以在您的瀏覽器強制更新。MDN偵測到強制更新,將會重新生成頁面,更新的巨集生成頁面,以及嵌入頁面內容。
  • 您可以週期性設定自動重新生成頁面。不過除非該頁面常常更新,不然請不要這麼做。請參考 Page regeneration 一文獲得更多資訊。

參見

文件標籤與貢獻者

 此頁面的貢獻者: Shiyou, Supaplex, darksnidget, SecondSpirit, coby777
 最近更新: Shiyou,