asciidoc: Rozdiel medzi revíziami

Z bur.sk
Skočit na navigaci Skočit na vyhledávání
(Vytvorená stránka „{{DISPLAYTITLE:AsciiDoc}} '''AsciiDoc''' je formát na písanie článkov na kníh. Spracováva sa pomocou programu "asciidoctor". Možno z neho generovať e-booky, dok…“)
 
 
(7 medziľahlých úprav od rovnakého používateľa nie je zobrazených.)
Riadok 3: Riadok 3:
 
'''AsciiDoc''' je formát na písanie článkov na kníh.
 
'''AsciiDoc''' je formát na písanie článkov na kníh.
 
Spracováva sa pomocou programu "asciidoctor".
 
Spracováva sa pomocou programu "asciidoctor".
−
Možno z neho generovať e-booky, dokumenty PDF, atď.
+
Možno z neho generovať e-booky, dokumenty PDF, stránky HTML, atď.
 
Funkcionalitou sa podobá na DocBook; dá sa z neho generovať DocBook.
 
Funkcionalitou sa podobá na DocBook; dá sa z neho generovať DocBook.
  
 +
Odporúčaná prípona je ".adoc".
  
−
== Formát textu v odseku ==
+
== Syntax==
  
−
  *tučné* písmo
+
Obyčajný text väčšinou netreba nijako špeciálne označiť.
−
  _šikmé_ písmo
+
Jeden enter medzi riadkami textu sa ignoruje; môžeme odseky písať tak, že každú vetu dáme na osobitný riadok.
 +
Dva entery znamenajú nový odsek, alebo nový blok.
 +
 
 +
Tieto značky možno použiť uprostred odseku:
 +
 
 +
  *tučné* písmo, uprostred sl**o**va
 +
  _šikmé_ písmo, uprostred sl__o__va
 +
*_tučné a šikmé_* písmo, uprostred sl**__o__**va
 +
`monospace` písmo, uprostred sl``o``va
 +
^horný^ index, ~dolný~ index
 
  <nowiki>http://bur.sk[odkaz]</nowiki>
 
  <nowiki>http://bur.sk[odkaz]</nowiki>
  
 +
Na vypnutie syntaxe možno použiť:
 +
 +
....
 +
Môžem používať hocijaké značky.
 +
....
 +
 +
=== Komentár ===
 +
 +
// komentár
 +
 +
=== Atribút ===
 +
 +
Môžeme definovať atribúty, ktoré neskôr použijeme:
 +
 +
:example: Toto je príklad.
 +
 +
Atribút použitý v texte vyzerá takto: "{example}"
 +
 +
Odporúča sa mať nejaký systém na atribúty, napríklad že všetk odkazy začínajú "url-..." alebo všetky obrázky začínajú "img-...".
 +
 +
Takto nastavíme atribút na prázdny reťazec:
 +
 +
:example:
 +
 +
Takto atribút zrušíme:
 +
 +
:example!:
  
−
== Bloky ==
+
Riadky odkazujúce na neexistujúce atribúty sa preskočia.
 +
 
 +
=== Nadpis ===
  
 
  = Nadpis
 
  = Nadpis
Riadok 20: Riadok 59:
 
  === Nadpis podčasti
 
  === Nadpis podčasti
  
 +
.Lokálny nadpis
 +
Text odseku.
 +
 +
=== Zoznam ===
 +
 +
Iný prefix začína novú úroveň zoznamu.
 +
 +
* jar
 +
** Apríl
 +
** Máj
 +
** Jún
 +
* leto
 +
* jeseň
 +
* zima
 +
 +
. prvé
 +
. druhé
 +
. tretie
 +
 +
=== Formátovaný text ===
 +
 +
[quote, autor citátu, zdroj]
 +
____
 +
Citovaný text.
 +
____
 +
 +
[source,python]
 +
print("hello world")
 +
 +
=== Obrázok ===
 +
 +
V hlavičke dokumentu atribút "imagedir" určuje adresár s obrázkami (relatívne voči dokumentu).
 +
 +
:imagedir: images/
 +
 +
image::example.png[Príklad]
  
 +
Uprostred image:example.png[príklad] textu.
  
 
== Odkazy ==
 
== Odkazy ==
  
 
* [https://en.wikipedia.org/wiki/AsciiDoc AsciiDoc] na Wikipédii
 
* [https://en.wikipedia.org/wiki/AsciiDoc AsciiDoc] na Wikipédii
 +
* rýchle prehľady:
 +
** Asciidoctor: [https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/ quick reference], [https://asciidoctor.org/docs/asciidoc-writers-guide/ writer's guide]
 +
** [https://github.com/SUSE/doc-susemanager/wiki/Asciidoc-getting-started SUSE]
 +
** [https://powerman.name/doc/asciidoc powerman]
 +
* [https://asciidoctor.org/docs/asciidoc-recommended-practices/ odporúčania]
 +
* [https://asciidoc.org/#try preview]
 +
* [https://github.com/asciidoctor/docbookrx docbookrx] - konverzia z DocBook do AsciiDoc, s [https://github.com/asciidoctor/docbookrx/blob/main/spec/lib/docbookrx/docbookrx_spec.rb príkladmi]

Aktuálna revízia z 13:18, 23. apríl 2025


AsciiDoc je formát na písanie článkov na kníh. Spracováva sa pomocou programu "asciidoctor". Možno z neho generovať e-booky, dokumenty PDF, stránky HTML, atď. Funkcionalitou sa podobá na DocBook; dá sa z neho generovať DocBook.

Odporúčaná prípona je ".adoc".

Syntax

Obyčajný text väčšinou netreba nijako špeciálne označiť. Jeden enter medzi riadkami textu sa ignoruje; môžeme odseky písať tak, že každú vetu dáme na osobitný riadok. Dva entery znamenajú nový odsek, alebo nový blok.

Tieto značky možno použiť uprostred odseku: 

*tučné* písmo, uprostred sl**o**va
_šikmé_ písmo, uprostred sl__o__va
*_tučné a šikmé_* písmo, uprostred sl**__o__**va
`monospace` písmo, uprostred sl``o``va
^horný^ index, ~dolný~ index
http://bur.sk[odkaz]

Na vypnutie syntaxe možno použiť: 

....
Môžem používať hocijaké značky.
....

Komentár

// komentár

Atribút

Môžeme definovať atribúty, ktoré neskôr použijeme: 

:example: Toto je príklad.

Atribút použitý v texte vyzerá takto: "{example}"

Odporúča sa mať nejaký systém na atribúty, napríklad že všetk odkazy začínajú "url-..." alebo všetky obrázky začínajú "img-...".

Takto nastavíme atribút na prázdny reťazec: 

:example:

Takto atribút zrušíme: 

:example!:

Riadky odkazujúce na neexistujúce atribúty sa preskočia.

Nadpis

= Nadpis
== Nadpis časti
=== Nadpis podčasti

.Lokálny nadpis
Text odseku.

Zoznam

Iný prefix začína novú úroveň zoznamu. 

* jar
** Apríl
** Máj
** Jún
* leto
* jeseň
* zima

. prvé
. druhé
. tretie

Formátovaný text

[quote, autor citátu, zdroj]
____
Citovaný text.
____

[source,python]
print("hello world")

Obrázok

V hlavičke dokumentu atribút "imagedir" určuje adresár s obrázkami (relatívne voči dokumentu). 

:imagedir: images/

image::example.png[Príklad]

Uprostred image:example.png[príklad] textu.

Odkazy

Zdroj: „http://bur.sk/sk_bur/_mediawiki/sk/index.php?title=asciidoc&oldid=159“