ReStructuredText
reStructuredText (RST, ReST, ili reST) je tekstualni format datoteke prvobitno korišćen u programskom jeziku Pajton u svrhu tehničke dokumentacije.
RST je deo projekta Docutils čiji je cilj bio kreiranje seta alata za Pajton, slično onom što Javadoc jeste za Javu. Pomoću Docutils-a moguće je izdvojiti neki deo koda napisanog u Pajtonu i zatim ga oblikovati u razne forme programske dokumentacije.[1]
U tom smislu, reStructuredText je jednostavan jezik za označavanje (engl. lightweight markup language) koji je osmišljen da istovremeno bude
(a) obradiv od strane softvera za dokumentaciju poput Docutils-a i (b) razumljiv programerima koji čitaju i pišu kodove u Pajtonu
Istorija
[uredi | uredi izvor]Ranije je postojalo dosta problema sa StructuredText jezikom za označavanje, te je reST razvijen da bi ih rešio.[2]
Prva značajnija primena reStructuredText-a u Pajton zajednici se mogla videti 2002.godine.
Referentna implementacija
[uredi | uredi izvor]Referentna implementacija same reST sintaksne analize je sastavni deo Docutils okvira za obradu teksta u Pajtonu.
Još uvek ne postoji zvaničan usvojen mime tip reStructuredText-a, ali nezvaničan koji se koristi jeste text/x-rst
.[3]
Primena
[uredi | uredi izvor]reStructuredText se obično koristi za tehničku dokumentaciju, na primer u dokumentaciji Pajton biblioteka[4], ali to ne mora biti jedina primena jer je reST pogodan za širok spektar tekstova.
Od 2008. godine reST predstavlja glavnu komponentu Sphinx generatora dokumentacije, napisanog u Pajtonu. Ovaj format takođe podržavaju GitHub i Bitbucket, kao i Trac.[5]
U 2011. godini, lektori koji su pripremali tekstove za Projekat Gutenberg razmatrali su usvajanje reST-a kao osnovnog formata iz kojeg bi mogli da se generišu drugi formati e-knjiga.[6]
Takođe, CMake alat je sa CMS(engl. custom markup language) prešao na reStructuredText u verziji 3.0 za svoju dokumentaciju.[7]
Primeri reStructuredText označavanja
[uredi | uredi izvor]Zaglavlja
Section Header
==============
Subsection Header
-----------------
Liste
- Прва ставка неуређене листе
- Друга ставка
- Подставка
- Размак између ставки раздваја ставке листе
* Различити симболи стварају одвојене листе
- Трећа ставка
Уређене листе(нумерисане)
1) Прва ставка
2) Друга ставка
а) Подставка. Обратите пажњу да одељак мора да се
подудара са почетком текста, а не са
пописивач.
и) Ставке листе могу чак да садрже
одвајање параграфа.
3) Трећа ставка
#) Још једна набројана ставка
#) Друга ставка
Slike
.. image:: /path/to/image.jpg
Imenovani linkovi
Линкови до `Wikipedia`_ и до `Linux kernel archive`_.
.. _Wikipedia: https://www.wikipedia.org/
.. _Linux kernel archive: https://www.kernel.org/
Anonimni linkovi
Још једна реченица са `анонимним линком до Python вебсајта`__.
__ https://www.python.org/
Napomena: ovi linkovi zatvoreni su pomoću (`), a ne apostrofima ('). Literalni blokovi
::
неки текст
Ово се такође може употребити на крају параграфа, овако ::
још неки текст
.. код :: пајтон
print("Текстуални блок означен као пајтон код")
Vidi još
[uredi | uredi izvor]- Jezik za obeležavanje
- Sphinx (generator dokumentacije)
- Objekti prve klase
Reference
[uredi | uredi izvor]- ^ Chawla, Jyotsana; Agrawa, Rachna; Sharma, Bhavna (2016-05-30). „FDI IN INDIAN RETAIL SECTOR: A REVIEW”. International Journal of BRIC Business Research. 05 (02): 01—10. ISSN 2201-4179. doi:10.14810/ijbbr.2016.5201.
- ^ Ge, Ruifang; Mooney, Raymond J. (2005). „A statistical semantic parser that integrates syntax and semantics”. Proceedings of the Ninth Conference on Computational Natural Language Learning - CONLL '05. Morristown, NJ, USA: Association for Computational Linguistics. doi:10.3115/1706543.1706546.
- ^ Castagno, R.; Singer, D. „MIME Type Registrations for 3rd Generation Partnership Project (3GPP) Multimedia files”.
- ^ Goodger, David; van Rossum, Guido (2010), Docstring Conventions, Apress, str. 303—307, ISBN 978-1-4302-2757-1, Pristupljeno 2020-08-25
- ^ Quevauviller, Philippe. „Preface”. TrAC Trends in Analytical Chemistry. 85: 1. ISSN 0165-9936. doi:10.1016/j.trac.2016.09.012.
- ^ Distributed Proofreaders. „Minutes of 2010 December 11 meeting”. Die Psychiatrie. 08 (01). ISSN 1614-4864. doi:10.1055/s-008-41359.
- ^ DIN EN 16603-10-06:2014-11, Raumfahrttechnik_- Teil_10-06: Spezifizierung technischer Anforderungen; Deutsche Fassung EN_16603-10-06:2014, Beuth Verlag GmbH, Pristupljeno 2020-08-25