ReStructuredText
reStructuredText (RST, ReST, или reST) је текстуални формат датотеке првобитно коришћен у програмском језику Пајтон у сврху техничке документације.
RST је део пројекта Docutils чији је циљ био креирање сета алата за Пајтон, слично оном што Javadoc јесте за Јаву. Помоћу Docutils-а могуће је издвојити неки део кода написаног у Пајтону и затим га обликовати у разне форме програмске документације.[1]
У том смислу, reStructuredText је једноставан језик за означавање (енгл. lightweight markup language) који је осмишљен да истовремено буде
(а) обрадив од стране софтвера за документацију попут Docutils-а и (б) разумљив програмерима који читају и пишу кодове у Пајтону
Историја
[уреди | уреди извор]Раније је постојало доста проблема са StructuredText језиком за означавање, те је reST развијен да би их решио.[2]
Прва значајнија примена reStructuredText-а у Пајтон заједници се могла видети 2002.године.
Референтна имплементација
[уреди | уреди извор]Референтна имплементација саме reST синтаксне анализе је саставни део Docutils оквира за обраду текста у Пајтону.
Још увек не постоји званичан усвојен миме тип reStructuredText-а, али незваничан који се користи јесте text/x-rst
.[3]
Примена
[уреди | уреди извор]reStructuredText се обично користи за техничку документацију, на пример у документацији Пајтон библиотека[4], али то не мора бити једина примена јер је reST погодан за широк спектар текстова.
Од 2008. године reST представља главну компоненту Sphinx генератора документације, написаног у Пајтону. Овај формат такође подржавају GitHub и Bitbucket, као и Trac.[5]
У 2011. години, лектори који су припремали текстове за Пројекат Гутенберг разматрали су усвајање reST-а као основног формата из којег би могли да се генеришу други формати е-књига.[6]
Такође, CМake алат је са CMS(енгл. custom markup language) прешао на reStructuredText у верзији 3.0 за своју документацију.[7]
Примери reStructuredText означавања
[уреди | уреди извор]Заглавља
Section Header
==============
Subsection Header
-----------------
Листе
- Прва ставка неуређене листе
- Друга ставка
- Подставка
- Размак између ставки раздваја ставке листе
* Различити симболи стварају одвојене листе
- Трећа ставка
Уређене листе(нумерисане)
1) Прва ставка
2) Друга ставка
а) Подставка. Обратите пажњу да одељак мора да се
подудара са почетком текста, а не са
пописивач.
и) Ставке листе могу чак да садрже
одвајање параграфа.
3) Трећа ставка
#) Још једна набројана ставка
#) Друга ставка
Слике
.. image:: /path/to/image.jpg
Именовани линкови
Линкови до `Wikipedia`_ и до `Linux kernel archive`_.
.. _Wikipedia: https://www.wikipedia.org/
.. _Linux kernel archive: https://www.kernel.org/
Анонимни линкови
Још једна реченица са `анонимним линком до Python вебсајта`__.
__ https://www.python.org/
Напомена: ови линкови затворени су помоћу (`), а не апострофима ('). Литерални блокови
::
неки текст
Ово се такође може употребити на крају параграфа, овако ::
још неки текст
.. код :: пајтон
print("Текстуални блок означен као пајтон код")
Види још
[уреди | уреди извор]- Језик за обележавање
- Sphinx (генератор документације)
- Објекти прве класе
Референце
[уреди | уреди извор]- ^ 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, стр. 303—307, ISBN 978-1-4302-2757-1, Приступљено 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, Приступљено 2020-08-25