
什麼是 WordPress 自述文件產生器?
WordPress readme 產生器會建立 readme.txt 檔案,WordPress.org 外掛目錄會讀取這個檔案來產生外掛的公開頁面。你填好標頭欄位和各個區段,它就會以目錄解析的精確格式輸出檔案:`=== Plugin Name ===` 標題、以冒號分隔的標頭區塊,以及 `== Section ==` 內文,旁邊還有即時預覽,讓你看到頁面上架後的樣子。
這個格式很挑剔,而且在出問題之前完全看不出來。`Stable tag` 指定目錄實際提供下載的版本,所以標籤寫錯或漏寫,不論你提交了什麼,都不會發布任何東西。`Tested up to` 落後於核心版本時,頁面上就會出現 "untested with your version of WordPress" 警告。`Tags` 只會索引前五個,其餘的會被默默忽略。簡短說明在搜尋結果中會在 150 個字元處被截斷。這些問題在你撰寫檔案時都不會出現任何錯誤,而是在幾天後變成一個看起來不對的頁面,或一次沒有發生的下載。這個工具會把每項限制標示在對應的欄位旁邊,並在你下載之前列出目錄會如何處理你的檔案。
一切都運行客戶端。沒有上傳任何內容,沒有建立帳戶,草稿保存在您自己的瀏覽器中,因此重新載入不會丟失它。您還可以匯入現有的自述文件。txt - 貼上到您的插件已附帶的版本中,然後將其解析回表單,這是修復舊文件或使自述文件達到當前要求而無需重新輸入的最快方法它。以不尋常的順序排列的章節、該工具不建模的標題行以及不一致的間距都會被讀取而不是拒絕,因為這就是真正的自述文件的樣子。
文件本身無法攜帶的兩件事值得簡單地說。 Banner 和圖示圖像不是 readme。txt 的一部分:它們作為 `banner-1544x500.png` 和 `icon-256x256.png` 生活在插件的 `/assets/` folder 中,並且此處存在字段,因此預覽顯示您將實際獲得的列表。螢幕截圖的工作方式相同 - readme。txt 帶有編號的標題,並且匹配的 `screenshot-1.png` 檔案按該順序顯示 `/assets/`。預覽對此是誠實的,而不是假裝該表單中的圖像 URL 將出現在 WordPress。org 上。文件正確後,下載它,將其放入插件根中,並將其提交到 SVN 儲存庫的主幹。
如何使用 WordPress 自述文件產生器?
填寫標題
外掛程式名稱、貢獻者的 WordPress。org 使用者名稱、穩定標籤、您支援的 WordPress 和 PHP 版本以及最多五個標籤。這些成為目錄首先解析的標題區塊。
寫下描述
搜尋清單的一個短句,然後是 Markdown - ## 標題、**bold** 和 * 中的長描述,列出了插件頁面上的所有渲染。鍵入時,表單旁的預覽會更新。
新增常見問題、螢幕截圖和變更日誌
每個常見問題變成自己的 = 問題 = 區塊。螢幕截圖標題的編號與資產資料夾中的螢幕截圖 1.png 檔案相符。變更日誌每個版本採用一個 = 版本 = 區塊,首先是最新的。
檢查警告,然後下載
閱讀「目錄將如何處理此問題」 - 缺少穩定標籤、過長的簡短描述、第五條之後的標籤 - 然後下載 readme。txt 並將其提交到插件的中繼。
主要特點
即時目錄預覽
WordPress。org 清單的橫幅、圖示、選項卡和側邊欄,在您鍵入時從您的欄位呈現,因此您可以在發布頁面之前查看該頁面。
導入現有的自述文件。txt
解析您已發回表單的自述文件,包括以不尋常順序排列的部分以及該工具未建模的標題行。
目錄本身的限制,指出
五個索引標籤、一個 150 個字元的簡短描述、一個決定出貨內容的穩定標籤 - 每個標籤都顯示在其適用的欄位中,並在下載前進行總結。
目錄接受它的地方標記
標題、粗體、清單和連結在描述、安裝和變更日誌中的呈現方式與插件頁面上的效果完全相同。
常見問題
Comments
0 comments
No comments yet. Be the first to share your thoughts!


