Reference-tw 是一個以繁體中文存放Arduino語法的語言參考文件。 所有的參考用詞皆是以AsciiDoc格式表達。
感謝您貢獻時間修訂Arduino文件,這對Arduino社群有很大的幫助。如果您想進一步了解如何對這個專案做出貢獻,可以參考 this step by step tutorial。
如果您要新增一段內容,只要新增一個檔案(用任何文字或是程式編輯器)並儲存成副檔名為.adoc的文件即可。
檔名內請不要包含括號或任何特殊字元。
您可以在 reference-en/AsciiDoc_sample/AsciiDoc_Dictionary中找到AsciiDoc的語法。包含標題、文字、連結、圖���、表格、程式片段和多種內嵌(視頻、投影片、音軌與程式)的用法。 這裡可以看到各種語法的應用範例。
如果你想貢獻或編輯已存在的內,可以在reference-tw/AsciiDoc_sample/Reference_Terms裡找到兩個範本:
-
如果內容類似 analogWrite,請使用
AsciiDoc_Template-Single_Entity.adoc(此頁為實際文件頁面)做為範本。 -
如果內容類似 Serial,請使用
AsciiDoc_Template-Parent_Of_Entities.adoc(此頁為實際文件頁面)做為範本。
請注意每個文件檔都要包含至少一段敘述、一些範例程式以及相關資訊的連結(參閱)。
如果您要在Asciidoc中加入圖像,請在同一個目錄下新增一個名稱為attachments的資料夾。圖像支援的格式有SVG和PNG,檔案不得超過200KB。
如果您對Git不熟悉,也可以直接透過GitHub的線上功能直接貢獻內容。以下有個簡短的導覽說明如果進行, 請看此!
你也可以參考這個網頁 (由GitHub團隊撰寫)學習如何編輯.adoc檔案,將檔案編修提供給Arduino團隊。 提供建議的改動時,請遵循參考範本中說明的原則。
我們非常高興您能貢獻內容到Arduino參考文件:這是幫助這個社群最棒的方式。
貢獻如果是新增/修改程式範例或是整個敘述時,請務必指明所連結的issue或是新增一個issue給這個編修內容。
reference-tw ├─ AsciiDoc_sample │ ├── AsciiDoc_Dictionary │ │ ├── AsciiDoc_Template-Dictionary.adoc │ │ └── attachments │ └── Reference_Terms │ ├── AsciiDoc_Template-Parent_Of_Entities.adoc │ ├── AsciiDoc_Template-Single_Entity.adoc │ └── attachments ├── Language │ ├── Functions │ ├── Structure │ └── Variables ├── LICENCE.md └── README.adoc
在Language資料夾中,檔案結構跟 Arduino Reference webpage 一致。
Please note that your contribution to the Arduino Reference is licensed under a Creative Commons Attribution-Share Alike 3.0 License. see https://creativecommons.org/licenses/by-sa/3.0/
