Zrestrukturyzowany tekst
| Zrestrukturyzowany tekst | |
|---|---|
 | |
| Rozbudowa |
.rst |
| MIME -typ | tekst/X-pierwszy [1] |
| Typ formatu | formaty tekstowe |
| Stronie internetowej | docutils.sourceforge.io/… ( angielski) |
reStructuredText (skrót: ReST , rozszerzenie pliku: .rst ) to lekki język znaczników . Sprawdza się przy tworzeniu prostych stron internetowych i innych dokumentów, a także jako język pomocniczy przy pisaniu komentarzy w kodzie programu. Używany przez system dokumentacji technicznej Docutils [2] , napisany głównie przez Davida Goodgera. reStructuredText można traktować jako potomka lekkich systemów znaczników StructuredText i Setext. Parser reStructuredText obsługuje wiele formatów wyjściowych, w tym PDF , HTML , ODT , LaTeX i format prezentacji S5 .
System dokumentacji Sphinx [3] , napisany na potrzeby dokumentowania języka programowania Python na stronie docs.python.org i zbudowany na bazie Docutils, jest już wykorzystywany w kilkudziesięciu projektach [4] . ReST jest jednym z języków znaczników używanych na githubie [5] , szczególnie dla plików README . Format jest eksperymentalny w Projekcie Gutenberg [6] [7] .
Historia
Jim Fulton, twórca Zope , wymyślił język znaczników StructuredText, który przypomina uproszczony znacznik WikiWikiWeb . Problemy StructuredText doprowadziły do stworzenia przez Davida Goodgera języka znaczników o nazwie ReStructuredText. Przy tworzeniu postawiono sobie następujące cele [8] :
- Czytelność
- dyskretność
- Jednoznaczność
- Bez niespodzianek
- Intuicyjność
- Prostota
- Skalowalność
- Ekspresyjna moc
- Neutralność językowa
- Możliwość rozbudowy
- Niezależność od formatu wyjściowego
W rezultacie PEP 287 ( propozycja ulepszenia Pythona ) pojawił się w 2002 roku z opisem ReStructuredText.
Przykład składni
==================== Nazwa dokumentu ==================== nagłówek --------- Trochę zwykłego tekstu, *tekst kursywą*, **tekst pogrubiony** i link_: * pozycja na liście punktowanej * pozycja na liście punktowanej 1. Pierwszy element uporządkowanej listy 2. Drugi element listy numerowanej .. rysunek:: http://upload.wikimedia.org/wikipedia/commons/f/f6/Wikipedia-logo-v2-ru.png Rosyjskie logo Wikipedii .. _link: http://ru.wikipedia.org
Znaczniki Docstring (w potrójnych cudzysłowach) w kodzie Pythona [1] :
Opiekun klasy ( magazynujący ):
"""
Zachowaj aktualność danych dłużej.
Rozszerz „Sklep”. Atrybut klasy `instances` śledzi
liczbę utworzonych instancji obiektów `Keeper`.
"""
instances = 0
"""Ile jest obiektów `Keeper`?"""
def __init__ ( self ):
"""
Rozszerz `Storer.__init__()`, aby śledzić
instancje. Przechowuj licznik w `self.instances` i dane
w `self.data`.
"""
Magazyn . __init__ ( self )
self . instancje += 1
ja . data = []
"""Przechowuj dane na liście, ostatnie ostatnie."""
...
Zobacz także
Notatki
- ↑ 1 2 PEP 287 - ReStructuredText Format Docstring . Pobrano 29 września 2012 r. Zarchiwizowane z oryginału 17 września 2012 r.
- ↑ Mertz, David XML Matters: reStructuredText (link niedostępny) . IBM developerWorks (1 lutego 2003). Pobrano 28 grudnia 2011 r. Zarchiwizowane z oryginału w dniu 26 października 2012 r.
- ↑ Generator dokumentacji Sphinx (łącze w dół) . Pobrano 29 września 2012 r. Zarchiwizowane z oryginału 20 maja 2012 r.
- ↑ Projekty z wykorzystaniem Sphinx (łącze w dół) . Pobrano 29 września 2012 r. Zarchiwizowane z oryginału 15 września 2012 r.
- ↑ Znaczniki GitHub . Pobrano 29 września 2012 r. Zarchiwizowane z oryginału 20 lipca 2012 r.
- ↑ Miesięczny biuletyn PG (07.03.2012) . Pobrano 29 września 2012 r. Zarchiwizowane z oryginału 5 września 2014 r.
- ↑ RST _ Pobrano 29 września 2012 r. Zarchiwizowane z oryginału 9 czerwca 2012 r.
- ↑ Thomas Bitterman. Opanowanie IPythona 4.0. — Wydawnictwo Pack, 2016.
