Formáid an Chomhaid RST - Comhad Téacs Athstruchtúrtha
Cad is comhad RST ann?
Is formáid comhaid doiciméadúcháin theicniúil é comhad RST, a úsáidtear go príomha i bpobal ríomhchlárúcháin Python. Is téacschomhad é atá scríofa sa teanga mharcála ReStructuredText a chuireann stíleanna agus formáidiú i bhfeidhm ar dhoiciméid gnáth-théacs chun doiciméadú a ghiniúint. Úsáideann comhaid RST na tuairimí agus faisnéis eile i gcód cláir Python chun doiciméadú teicniúil an fheidhmchláir a chruthú. Mar sin féin, is féidir téacs a bheith iontu freisin ar féidir é a thiontú go leathanaigh ghréasáin shimplí agus eBooks. Is féidir eagarthóirí téacs ar nós Github Atom, GNU Emacs (tras-ardán), Microsoft Notepad (Windows), Apple TextEdit (Mac) agus Vim (Linux) a úsáid chun comhaid RST a oscailt.
Formáid Chomhaid RST
Tá cód atá scríofa i dteanga mharcála ReStructuredText i gcomhaid RST. Tá sé mar chuid den tionscadal Docutils de Python Doc-SIG (Grúpa Sainleasa Doiciméadaithe) a sholáthraíonn sraith uirlisí do Python cosúil le Javadoc do Java. Tá an parsálaí le haghaidh formáid comhaid RST leabaithe sna Docutils agus is féidir faisnéis a bhaint as cláir Python chun iad a fhormáidiú i gcáipéisíocht cláir.
Sampla RST athstruchtúrtha
Glacaimid téacs samplach scríofa i bhformáid comhaid RST mar a leanas.
================
Document Heading
================
Heading
=======
Sub-heading
-----------
Paragraphs are separated
by a blank line.
Nuair a chuirtear an téacs seo isteach i bpróiseálaí rST mar Docutils, seo a leanas an t-aschur.
<h1>Document Heading</h1>
<h2>Heading</h2>
<h3>Sub-heading</h3>
<p>Paragraphs are separated
by a blank line.</p>