AsciiDoc

Abstraktus

Tai ściągawka už AsciiDoc - “Tekstas paremtas dokumentas karta” scenarijus. Ściągawka galima įvairių AsciiDoc versijų (nes kai kurių žymėjimo sintaksės pokyčius) ir naudojant skirtingus css stilius. Čia yra sąrašas visų turimų cheatsheets skirtingo AsciiDoc versiją ir naudojant skirtingus css stilių (GitHub įskaičiuoti).

Jo ściągawka yra AsciiDoc 8.6.9, naudojant default css.

Dokumento antraštė

Main Header
===========
Optional Author Name <optional@author.email>
Optional version, optional date
:Author:    AlternativeWayToSetOptional Author Name
:Email:     <AlternativeWayToSetOptional@author.email>
:Date:      AlternativeWayToSetOptional date
:Revision:  AlternativeWayToSetOptional version

Atributai

Yra daug iš anksto atributų AsciiDoc daug, taip pat galite pridėti savo. Norėdami gauti atributo reikšmė naudoti {attributename} sintaksė.

Author is {author}
Version is {revision}

Autorius Alex Efros

Versija yra 2.2.2

:My name: Alex Efros
My name is {myname}

Mano vardas yra Alex Efros

Line
with bad attribute {qwe} will be
deleted

Linija ištrintas

Escaped: \{qwe} and +++{qwe}+++

Pabėgo: {qwe} ir {qwe}

Antraštės

Level 1
-------
Text.

Level 2
~~~~~~~
Text.

Level 3
^^^^^^^
Text.

Level 4
+++++++
Text.

Lygis 1

Tekstas.

Lygis 2

Tekstas.

Lygis 3

Tekstas.

Lygis 4

Tekstas.

== Level 1
Text.

=== Level 2
Text.

==== Level 3
Text.

===== Level 4
Text.

Lygis 1

Tekstas.

Lygis 2

Tekstas.

Lygis 3

Tekstas.

Lygis 4

Tekstas.

Paragrafai

.Optional Title

Usual
paragraph.
Neprivaloma Pavadinimas

Įprasta paragrafas.

.Optional Title

 Literal paragraph.
  Must be indented.
Neprivaloma Pavadinimas
Literatūrinė paragrafas.
 Turi būti atitrauktas.
.Optional Title

[source,perl]
die 'connect: '.$dbh->errstr;

Not a code in next paragraph.
Neprivaloma Pavadinimas
die 'connect: '.$dbh->errstr;

Ne kodas kitą paragrafas.

.Optional Title
NOTE: This is an example
      single-paragraph note.
Note
Neprivaloma Pavadinimas
Tai yra pavyzdys pastaba vieno paragrafas.
.Optional Title
[NOTE]
This is an example
single-paragraph note.
Note
Neprivaloma Pavadinimas
Tai yra pavyzdys pastaba vieno paragrafas.
TIP: Tip.
Tip Galiukas.
IMPORTANT: Important.
Important Svarbus.
WARNING: Warning.
Warning Įspėjimas.
CAUTION: Caution.
Caution Dėmesio.

Blokai

.Optional Title
----
*Listing* Block

Use: code or file listings
----
Neprivaloma Pavadinimas
*Sąrašo* Blokuoti
Naudojimas: kodas arba failų objektų
.Optional Title
[source,perl]
----
# *Source* block
# Use: highlight code listings
# (require `source-highlight` or `pygmentize`)
use DBI;
my $dbh = DBI->connect('...',$u,$p)
    or die "connect: $dbh->errstr";
----
Neprivaloma Pavadinimas
# *Šaltinis* blokas
# Naudojimas: paryškinti kodą objektų
# (reikalauti "šaltinio highlight` arba `pygmentize`)
use DBI;
my $dbh = DBI->connect('...',$u,$p)
    or die "connect: $dbh->errstr";
.Optional Title
****
*Sidebar* Block

Use: sidebar notes :)
****
Neprivaloma Pavadinimas

Parankinės Blokas

Naudojimas: parankinės užrašus :)

.Optional Title
==========================
*Example* Block

Use: examples :)

Default caption "Example:"
can be changed using

 [caption="Custom: "]

before example block.
==========================
Pavyzdys 1. Neprivaloma Pavadinimas

Pavyzdys Blokas

Naudojimas: pavyzdžiai :)

Numatytoji antraštė "Pavyzdys:" gali būti pakeista naudojant

[caption="Custom: "]

prieš pavyzdžiui blokas.

.Optional Title
[NOTE]
===============================
*NOTE* Block

Use: multi-paragraph notes.
===============================
Note
Neprivaloma Pavadinimas

PASTABA Blokas

Naudojimas: kelių punkte pažymima.

////
*Comment* block

Use: hide comments
////
++++
*Passthrough* Block
<p>
Use: backend-specific markup like
<table border="1">
<tr><td>1<td>2
</table>
++++
*Tapatybės* Blokas

Naudojimas: posistemės konkrečių žymėjimas kaip

12
 .Optional Title
 ....
 *Literal* Block

 Use: workaround when literal
 paragraph (indented) like
   1. First.
   2. Second.
 incorrectly processed as list.
 ....
Neprivaloma Pavadinimas
*Pažodinis* Blokas

Naudojimas: problemos, kai pažodinis
paragrafas (įspaudžiami) pavyzdžiui
  1. Pirmas.
  2. Antra.
neteisingai tvarkomi kaip sąrašą.
.Optional Title
[quote, cite author, cite source]
____
*Quote* Block

Use: cite somebody
____
Neprivaloma Pavadinimas

Citata Blokas

Naudojimas: pacituoti ką nors

paminėti šaltinį
— paminėti autorius

Tekstas

forced +
line break

priverstas
linijos trūkis

normal, _italic_, *bold*, +mono+.

``double quoted'', `single quoted'.

normal, ^super^, ~sub~.

normalus, kursyvinis, drąsus, mono.

“dvigubų kabučių”, ‘vieno cituojamas’.

normalus, super, sub.

Command: `ls -al`

+mono *bold*+

`passthru *bold*`

Komanda: ls -al

mono drąsus

passthru *drąsus*

Kelias: '/some/filez.txt', '.b'

Path: /some/filez.txt, .b

[red]#red text# [yellow-background]#on yellow#
[big]#large# [red yellow-background big]*all bold*

raudonas tekstas geltonas didelis visi drąsūs

Chars: n__i__**b**++m++[red]##r##

Simbolių: nibmr

// Comment
(C) (R) (TM) -- ... -> <- => <= &#182;

© ® ™ — … → ← ⇒ ⇐ ¶

''''

Escaped:
\_italic_, +++_italic_+++,
t\__e__st, +++t__e__st+++,
+++<b>bold</b>+++, $$<b>normal</b>$$
\&#182;
\`not single quoted'
\`\`not double quoted''

Pabėgęs: _kursyvinis_, _kursyvinis_, t__e__st, t__e__st, drąsus, <b>normalus</b> &#182; `ne vieno cituojamas' ``nėra dvigubų kabučių''

Jei reikės naudoti erdvę url/keliu turėtumėte pakeisti jį su %20.

[[anchor-1]]
Paragraph or block 1.

anchor:anchor-2[]
Paragraph or block 2.

<<anchor-1>>,
<<anchor-1,First anchor>>,
xref:anchor-2[],
xref:anchor-2[Second anchor].

Paragrafas arba blokas 1.

Paragrafas arba blokas 2.

link:asciidoc[This document]
link:asciidoc.html[]
link:/index.html[This site root]
http://google.com
http://google.com[Google Search]
mailto:root@localhost[email admin]
First home
image:images/icons/home.png[]
, second home
image:images/icons/home.png[Alt text]
.

.Block image
image::images/icons/home.png[]
image::images/icons/home.png[Alt text]

.Thumbnail linked to full image
image:/images/font/640-screen2.gif[
"My screenshot",width=128,
link="/images/font/640-screen2.gif"]

Pirmas namų images/home.png , antrieji namai Alt text .

images/home.png
Paveikslas 1. Blokuoti vaizdas
Alt text
Miniatiūra susijęs su visą vaizdą

My screenshot

This is example how files
can be included.
It's commented because
there no such files. :)

// include::footer.txt[]

// [source,perl]
// ----
// include::script.pl[]
// ----

Tai pavyzdys, kaip failai gali būti įtraukti. Jis komentavo, nes ten nėra tokių failų :)

Sąrašai

.Bulleted
* bullet
* bullet
  - bullet
  - bullet
* bullet
** bullet
** bullet
*** bullet
*** bullet
**** bullet
**** bullet
***** bullet
***** bullet
**** bullet
*** bullet
** bullet
* bullet
Ženkleliais
  • kulka

  • kulka

    • kulka

    • kulka

  • kulka

    • kulka

    • kulka

      • kulka

      • kulka

        • kulka

        • kulka

          • kulka

          • kulka

        • kulka

      • kulka

    • kulka

  • kulka

.Bulleted 2
- bullet
  * bullet
Ženkleliais 2
  • kulka

    • kulka

.Ordered
. number
. number
  .. letter
  .. letter
. number
.. loweralpha
.. loweralpha
... lowerroman
... lowerroman
.... upperalpha
.... upperalpha
..... upperroman
..... upperroman
.... upperalpha
... lowerroman
.. loweralpha
. number
Užsisakyti
  1. skaičius

  2. skaičius

    1. laiškas

    2. laiškas

  3. skaičius

    1. loweralpha

    2. loweralpha

      1. lowerroman

      2. lowerroman

        1. upperalpha

        2. upperalpha

          1. upperroman

          2. upperroman

        3. upperalpha

      3. lowerroman

    3. loweralpha

  4. skaičius

.Ordered 2
a. letter
b. letter
   .. letter2
   .. letter2
       .  number
       .  number
           1. number2
           2. number2
           3. number2
           4. number2
       .  number
   .. letter2
c. letter
Užsisakyti 2
  1. laiškas

  2. laiškas

    1. laiškas2

    2. laiškas2

      1. skaičius

      2. skaičius

        1. skaičius2

        2. skaičius2

        3. skaičius2

        4. skaičius2

      3. skaičius

    3. laiškas2

  3. laiškas

.Labeled
Term 1::
    Definition 1
Term 2::
    Definition 2
    Term 2.1;;
        Definition 2.1
    Term 2.2;;
        Definition 2.2
Term 3::
    Definition 3
Term 4:: Definition 4
Term 4.1::: Definition 4.1
Term 4.2::: Definition 4.2
Term 4.2.1:::: Definition 4.2.1
Term 4.2.2:::: Definition 4.2.2
Term 4.3::: Definition 4.3
Term 5:: Definition 5
Ženklinami
Terminas 1

Apibrėžimas 1

Terminas 2

Apibrėžimas 2

Terminas 2.1

Apibrėžimas 2.1

Terminas 2.2

Apibrėžimas 2.2

Terminas 3

Apibrėžimas 3

Terminas 4

Apibrėžimas 4

Terminas 4.1

Apibrėžimas 4.1

Terminas 4.2

Apibrėžimas 4.2

Terminas 4.2.1

Apibrėžimas 4.2.1

Terminas 4.2.2

Apibrėžimas 4.2.2

Terminas 4.3

Apibrėžimas 4.3

Terminas 5

Apibrėžimas 5

.Labeled 2
Term 1;;
    Definition 1
    Term 1.1::
        Definition 1.1
Ženklinami 2
Terminas 1

Apibrėžimas 1

Terminas 1.1

Apibrėžimas 1.1

[horizontal]
.Labeled horizontal
Term 1:: Definition 1
Term 2:: Definition 2
[horizontal]
    Term 2.1;;
        Definition 2.1
    Term 2.2;;
        Definition 2.2
Term 3::
    Definition 3
Term 4:: Definition 4
[horizontal]
Term 4.1::: Definition 4.1
Term 4.2::: Definition 4.2
[horizontal]
Term 4.2.1:::: Definition 4.2.1
Term 4.2.2:::: Definition 4.2.2
Term 4.3::: Definition 4.3
Term 5:: Definition 5
Ženklinami horizontalus
Terminas 1

Apibrėžimas 1

Terminas 2

Apibrėžimas 2

Terminas 2.1

Apibrėžimas 2.1

Terminas 2.2

Apibrėžimas 2.2

Terminas 3

Apibrėžimas 3

Terminas 4

Apibrėžimas 4

Terminas 4.1

Apibrėžimas 4.1

Terminas 4.2

Apibrėžimas 4.2

Terminas 4.2.1

Apibrėžimas 4.2.1

Terminas 4.2.2

Apibrėžimas 4.2.2

Terminas 4.3

Apibrėžimas 4.3

Terminas 5

Apibrėžimas 5

[qanda]
.Q&A
Question 1::
    Answer 1
Question 2:: Answer 2
K&A
  1. Klausimas 1

    Atsakymas 1

  2. Klausimas 2

    Atsakymas 2

.Indent is optional
- bullet
    * another bullet
        1. number
        .  again number
            a. letter
            .. again letter

.. letter
. number

* bullet
- bullet
Įtrauka yra neprivalomas
  • kulka

    • kitas kulka

      1. skaičius

        1. vėl skaičius

          1. laiškas

            1. vėl laiškas

            2. laiškas

        2. skaičius

    • kulka

  • kulka

.Break two lists
. number
. number

Independent paragraph break list.

. number

.Header break list too
. number

--
. List block define list boundary too
. number
. number
--

--
. number
. number
--
Pertrauka du sąrašus
  1. skaičius

  2. skaičius

Independent paragraph break list.

  1. skaičius

Antraštė pertrauka sąrašas per
  1. skaičius

  1. Sąrašas blokas apibrėžti sąrašas riba per

  2. skaičius

  3. skaičius

  1. skaičius

  2. skaičius

.Continuation
- bullet
continuation
. number
  continuation
* bullet

  literal continuation

.. letter
+
Non-literal continuation.
+
----
any block can be

included in list
----
+
Last continuation.
Tęsinys
  • kulka tęsinys

    1. number tęsinys

      • kulka

        pažodinis tęsinys
        1. letter

          Ne pažodinis tęsinys.

          bet blokas gali būti
          
          įtraukti į sąrašą

          Paskutinis tęsinys.

.List block allow sublist inclusion
- bullet
  * bullet
+
--
    - bullet
      * bullet
--
  * bullet
- bullet
  . number
    .. letter
+
--
      . number
        .. letter
--
    .. letter
  . number
Sąrašas blokas leidžia sublist įtraukimą
  • kulka

    • kulka

      • kulka

      • kulka

    • kulka

  • kulka

    1. skaičius

      1. laiškas

        1. skaičius

        1. laiškas

      2. laiškas

    2. skaičius

Stalai

Jūs galite užpildyti lentelę iš CSV failo naudojant include:: makrokomandas viduje stalo.

.An example table
[options="header,footer"]
|=======================
|Col 1|Col 2      |Col 3
|1    |Item 1     |a
|2    |Item 2     |b
|3    |Item 3     |c
|6    |Three items|d
|=======================
Lentelė 1. Pavyzdys lentelė
Kol 1 Kol 2 Kol 3

6

Trys daiktai

d

1

Punktas 1

a

2

Punktas 2

b

3

Punktas 3

c

.CSV data, 15% each column
[format="csv",width="60%",cols="4"]
[frame="topbot",grid="none"]
|======
1,2,3,4
a,b,c,d
A,B,C,D
|======
Lentelė 2. CSV duomenys, 15% kiekviename stulpelyje

1

2

3

4

a

b

c

d

A

B

C

D

[grid="rows",format="csv"]
[options="header",cols="^,<,<s,<,>m"]
|===========================
ID,FName,LName,Address,Phone
1,Vasya,Pupkin,London,+123
2,X,Y,"A,B",45678
|===========================
ID Vardas Pavardė Adresas Telefonas

1

Vasya

Pupkin

London

+123

2

X

Y

A,B

45678

.Multiline cells, row/col span
|====
|Date |Duration |Avg HR |Notes

|22-Aug-08 .2+^.^|10:24 | 157 |
Worked out MSHR (max sustainable
heart rate) by going hard
for this interval.

|22-Aug-08 | 152 |
Back-to-back with previous interval.

|24-Aug-08 3+^|none

|====
Lentelė 3. Multiline ląstelių, eilutė/stulpelis span

Data

Trukmė

Vid HR

Pastabos

22-Aug-08

10:24

157

Dirbo MSHR (maks tvarus širdies ritmo), eikite sunku šiame intervale.

22-Aug-08

152

Grįžti į nugaros ankstesnį intervalu.

24-Aug-08

nė vienas

Originalus anglų kalba http://powerman.name/doc/asciidoc