Codex規範

Codex的文章主要是寫給讀者閱讀的,因此編輯過程中應站在讀者的角度編輯。代詞”I“應少用,而要使用”你可以點擊這裡“或”你應該打開模板檔案“。 Codex是用來幫助用戶解決問題的手冊,所以我們應該告訴他們如何操作才能使WordPress網站正常運行,而非談論自己或幫助你使用 WordPress的用戶是如何操作成功的。

基本介紹

  • 中文名:Codex規範
  • 闡述:幫助用戶解決問題的手冊
  • 分類:聲音,格式和讀者
  • 相關:WordPress
關於規則,標準規範,新頁面,標題,討論,

關於規則

1.正確拼寫WordPress——WordPress
2.保持友好態度-禁止進行個人攻擊或其它粗魯行為。請保持專業,禮貌和耐心。
3.保證發布內容正確,及時且要經常更新。
4.盡情編輯,合理編輯。
5.如果有疑問,請提出來解決,不要保持沉默。
6.玩得開心!

標準規範

新頁面

新頁面

我們鼓勵並歡迎大家創建新的文章和頁面。同時,請大家遵循以下規範。
*非註冊用戶,請首先查看以下說明:協助開發Codex
*文章編輯完成後,若需要把它作為新頁面發布,請查看:創建新頁面
*如果文章還有待進一步編輯,可把它作為用戶頁面的子頁面,請查看:創建用戶頁面
*請遵循Codex格式,詳情請查看:Codex樣式和編輯幫助
以下是協助開發Codex需要遵循的規範:
1.如果Codex中存在和你想編輯內容類似的文章,請直接修改已有文章。
2.請在沙盒頁面進行編輯試驗。
3.請在創建的新頁面上添加Codex其它文章連結。
4.請確保所創建的文章是完整的,其中的連結是含有有效內容的。
5.文章編輯完成後,發布到Codex文檔時,請給文章添加分目錄和其它相關文章連結。確保自己知道具體應該給哪部分文字添加分目錄連結。另外,只有在得到文檔團隊的#允許後才能把連結放在文檔的主頁面。
使用以下"stubs"以指明文章的狀態:
*{{Stub}}:Stub表明文章不完整,有待進一步編輯和擴展。
*{{Draft}}:確保把這個標記放在頁面頂端。由於搜尋引擎會搜尋所有添加頁面,Draft標記會提醒其它用戶這篇文章正在編輯中,其中的信息可能並不正確,同時也能提醒他人在你編輯完成前不要插手編輯。
*[[Category:Newpagecreated]]:用來指明頁面是新建頁面,它能吸引編輯者。但除非你已準備編輯或把它從用戶頁面移到文檔中,否則請不要使用這個標記。
*{{Copyedit}}:Copyedit表明文章已大體完成,但需要再次審核一下。對尚未完成的文章,請使用{{Stub}}。
標題 Ruby

標題

所有標題都應該使用標題字型。例如,對於標題,應該使用"UsingtheLinksManager",而非"Usingthelinksmanager"。而且,標題應該完整,不要縮寫,如,應使用"IntroductiontoBlogs",而非"IntroToBlogs"。
關於大小寫,還需要遵循Dr.Grammar規則,標題應大寫第一個單詞,最後一個單詞,及中間除冠詞(a,an,和the),五個字母以下的介詞(in,of,to)和連詞(and,but)之外的所有單詞。這個規則適用於所有標題。(Anson,Schwegler,andMuth.TheLongmanWriter'sCompanion240)
1.標題應以行為或任務為導向,它也是用戶查詢信息時可能會使用的搜尋關鍵字,因此,"UsingtheLinksManager"比"TheLinksManager"更能說明文章內容。
2.在標題的開頭或結尾部分,在單詞之間不要使用不必要的空格。儘量避免使用"-","#","?"和"+"等類似符號。
3.標題越短越好。
4.儘量避免在標題中使用介詞。
5.Codex是關於WordPress的wiki,因此,標題中應儘量包含"WordPress"。
6.若不確信標題是否合適,可發郵件給文檔團隊以徵詢意見。
7.標題不要使用CamelCase(駱駝拼寫法):Codex不使用CamelCase。所有的頁面標題和標題連結都使用常規的標題字型。例如,關於Codex的頁面標題應為"AboutCodex",它的連結格式為:[[AboutCodex]],而不是CamelCase[[AboutCodex]].
子頁面 在沒有和wp文檔團隊討論之前,請不要創建子頁面(用戶頁面除外)。常用函式頁面可以自主創建子頁面(每個子頁面描述了一種函式。)。

討論

使用 "Talk" 頁面 如果發現不正確或表達清晰的內容,可使用DISCUSSION提交留言。請不要在文章頁面直接添加評論。在每個頁面都有一個DISCUSSIONtab,你可以在此評論,提出建議或留言。謝謝合作!
使用 "Talk" 頁面
*給文章留言:可點擊文章的Discussion標籤,在上面留言然後署名提交。
*給用戶留言:可編輯用戶:談論頁面,並署名。用戶下次登入時就會收到留言提示。
*分離評論:在討論頁面,請在評論之間使用四個破折號----以把它和其它內容區分開。如果你準備討論新話題,可點擊編輯旁的"+"連結以創建新內容。
*記得署名:留言或評論後,請記得署名,並在評論末尾添加四個~。這會顯示你的用戶名,用戶頁面連結和時間戳——這對討論頁面非常有用。還可以點擊編輯視窗頂端的署名圖示,即右側第二個圖示。
Codex聲音,格式和讀者 WordPressCodex的"voice"是權威的聲音,同時也是一種友好的交流。Codex的格式提供了簡單,易於使用的說明和技術建議來指導大家編輯。
Codex聲音、格式和讀者
應使用圓形符號和列表以強調操作步驟,使其更加清晰明了。比較複雜的步驟應該分為多個小步驟,以方便新手或高級用戶快速解決所遇到的問題。
由於Codex文檔讀者對HTML,XHTML,CSS,和PHP的掌握程度參差不齊,我們也據此編寫了不同等級的文章。進階課題和開發人員文檔中的文章主要適用於高級用戶;而WordPress使用則適用於新手,其中的語言應該簡單明了,給人以技術支持人員就坐在用戶旁邊手把手給其指導的感覺;其它文章適用於中等水平的用戶,必要時應該連結WordPress辭彙彙編中的詞條。
慣用名稱 1.網站名稱:需要使用域名舉例時,請使用example.com,example.org或example.net。這是根據RFC2606所設的。
慣用名稱
2.Admin:主要的管理用戶通常有登入admin.
3.人名:編輯過程中需要使用普通人名(非管理人員名字)舉例時,使用"Harriet"作為名,"Smith"作為姓。
4.AdministrationPanels:WordPress界面稱為AdministrationPanels(管理面板),而非adminpanels或dashboard(控制台)。Dashboard(控制台)是AdministrationPanels(管理面板)上的其中一個面板。
5.WordPress應拼寫為WordPress:WordPress有兩個大寫字母:WordPress。

相關詞條

熱門詞條

聯絡我們