Blog of Science





Original article: http://www.delphibasics.co.uk/Hints.html

AsciiDoc

Resumen

Esta es una pagina de trucos para AsciiDoc - script de "Generación de Texto basada en el documento". Los trucos son disponibles para diferentes versiones AsciiDoc (debido a algunos cambios en la sintaxis de marcado) y usando diferentes estilos css. Aquí está la lista con todos los Trucos disponibles para las diferentes versiones de AsciiDoc y utilizando diferentes estilo.

Esta página de trucos es para AsciiDoc 8.6.7, utilizando el estilo css default css.

Document header

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

Attributos

Hay una gran cantidad de atributos predefinidos en AsciiDoc, además puedes añadir los tuyos. Para obtener el valor del atributo use la sintaxis {nombreatributo}

Author is {author}

Version is {revision}

El autor es Alex Efros

La versión es 2.2.2

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

Mi nombre es Alex Efros

Line
with bad attribute {qwe} will be
deleted

línea eliminada

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

Escape: {qwe} y {qwe}

Encabezados

Level 1
-------
Text.

Level 2
~~~~~~~
Text.

Level 3
^^^^^^^
Text.

Level 4
+++++++
Text.

Nivel 1

Texto.

Nivel 2

Texto.

Nivel 3

Texto.

Nivel 4

Texto.

== Level 1
Text.

=== Level 2
Text.

==== Level 3
Text.

===== Level 4
Text.

Nivel 1

Texto.

Nivel 2

Texto.

Nivel 3

Texto.

Nivel 4

Texto.

Párrafos

.Optional Title

Usual
paragraph.
Título Opcional

Párrafo habitual.

.Optional Title

 Literal paragraph.
  Must be indented.
Título Opcional
Párrafo Literal
 Debe indentarse.
.Optional Title

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

Not a code in next paragraph.
Título Opcional

die 'connect: '.
$dbh->
errstr;

No hay código en el siguiente párrafo.

.Optional Title
NOTE: This is an example
      single-paragraph note.
Note
  • Note
  • Título Opcional
    Este es un ejemplo de una nota de párrafo único.
    .Optional Title
    [NOTE]
    This is an example
    single-paragraph note.
    Note
  • Note
  • Título Opcional
    TEste es un ejemplo de una nota de párrafo único.
    TIP: Tip.
    Tip
  • Tip
  • Consejo.
    IMPORTANT: Important.
    Important
  • Important
  • Importante.
    WARNING: Warning.
    Warning
  • Warning
  • Advertencia.
    CAUTION: Caution.
    Caution
  • Caution
  • Precaución.

    Bloques

    .Optional Title
    ----
    *Listing* Block
    
    Use: code or file listings
    ----
    Título Opcional
    Bloque *Listing* 
    Uso: listados de código o archivos
    .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";
    ----
    Título Opcional
    # Bloque *Source*
    # Uso: resaltar los listados de código
    # (requiere `source-highlight` o `pygmentize`)
    use DBI;
    my $dbh = DBI->connect('...',$u,$p)
        or die "connect: $dbh->errstr";
    
    .Optional Title
    ****
    *Sidebar* Block
    
    Use: sidebar notes :)
    ****
    Opcional Título

    BloqueSidebar

    Uso: notas de barra lateral :)

    .Optional Title
    ==========================
    *Example* Block
    
    Use: examples :)
    
    Default caption "Example:"
    can be changed using
    
     [caption="Custom: "]
    
    before example block.
    ==========================
    Ejemplo 1. Título Opcional

    BloqueExample

    Uso: ejemplos:)

    El título por defecto por defecto"Examples" se puede cambiar utilizando

    [caption="Custom: "]

    antes del bloque example.

    .Optional Title
    [NOTE]
    ===============================
    *NOTE* Block
    
    Use: multi-paragraph notes.
    ===============================
    Note
  • Note
  • Título Opcional

    Bloque NOTE

    Uso: Notas de múltiples párrafos.

    ////
    *Comment* block
    
    Use: hide comments
    ////
    ++++
    *Passthrough* Block
    <p>
    Use: backend-specific markup like
    <table border="1">
    <tr><td>1<td>2
    </table>
    ++++
    Bloque *Passthrough*

    Uso:marcado como específicamente para backend

    12
     .Optional Title
     ....
     *Literal* Block
    
     Use: workaround when literal
     paragraph (indented) like
       1. First.
       2. Second.
     incorrectly processed as list.
     ....
    Título Opcional
    Bloque *Literal*
    Uso: solución cuando un párrafo literal(indentado) similar a
      1. Primero.
      2. Segundo.
    es incorrectamente procesado ​​como  lista.
    .Optional Title
    [quote, cite author, cite source]
    ____
    *Quote* Block
    
    Use: cite somebody
    ____
    Título Opcional

    Bloque Quote

    Uso: citar a alguien

    citar fuente
    — citar autor

    Texto

    forced +
    line break

    forzado
    salto de línea

    normal, _italic_, *bold*, +mono+.
    
    ``double quoted'', `single quoted'.
    
    normal, ^super^, ~sub~.

    normal, cursiva, negrita, mono.

    "comillas dobles", 'comillas simples'.

    normal, super, sub.

    Command: `ls -al`
    
    +mono *bold*+
    
    `passthru *bold*`

    Comandos: ls -al

    mono negrita

    passthru *bold*

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

    Ruta: /some/filez.txt, .b

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

    texto rojo sobre amarillo grande todo negrita

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

    Caracteres: 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''

    Escaped: _italic_, _italic_, t__e__st, t__e__st, negrita, <b>normal</b> &#182; `sin comillas simples' ``sin comillas dobles''

    Si usted necesita usar un espacio en una url/ruta deberá reemplazarlo por un 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].

    Párrafo o bloque 1.

    Párrafo o bloque 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
    
    This is example how files
    can be included.
    It's commented because
    there no such files. :)
    
    // include::footer.txt[]
    
    // [source,perl]
    // ----
    // include::script.pl[]
    // ----

    Este es un ejemplo de cómo pueden incluirse archivos. Está comentado porque no hay archivos. :)

    Lists

    .Bulleted
    * bullet
    * bullet
      - bullet
      - bullet
    * bullet
    ** bullet
    ** bullet
    *** bullet
    *** bullet
    **** bullet
    **** bullet
    ***** bullet
    ***** bullet
    **** bullet
    *** bullet
    ** bullet
    * bullet
    Viñetas
    • viñetas

    • viñetas

      • viñetas

      • viñetas

    • viñetas

      • viñetas

      • viñetas

        • viñetas

        • viñetas

          • viñetas

          • viñetas

            • viñetas

            • viñetas

          • viñetas

        • viñetas

      • viñetas

    • viñetas

    .Bulleted 2
    - bullet
      * bullet
    Viñetas 2
    • viñetas

      • viñetas

    .Ordered
    . number
    . number
      .. letter
      .. letter
    . number
    .. loweralpha
    .. loweralpha
    ... lowerroman
    ... lowerroman
    .... upperalpha
    .... upperalpha
    ..... upperroman
    ..... upperroman
    .... upperalpha
    ... lowerroman
    .. loweralpha
    . number
    Orden
    1. número

    2. número

      1. letra

      2. letra

    3. número

      1. minúscula alfabética

      2. minúscula alfabética

        1. minúscula romano

        2. minúscula romano

          1. mayúscula alfabética

          2. mayúscula alfabética

            1. mayúscula romano

            2. mayúscula romano

          3. mayúscula alfabética

        3. minuscula romano

      3. minúscula alfabética

    4. número

    .Ordered 2
    a. letter
    b. letter
       .. letter2
       .. letter2
           .  number
           .  number
               1. number2
               2. number2
               3. number2
               4. number2
           .  number
       .. letter2
    c. letter
    Orden 2
    1. letra

    2. letra

      1. letra2

      2. letra2

        1. número

        2. número

          1. número2

          2. número2

          3. número2

          4. númeror2

        3. número

      3. letra2

    3. letra

    .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
    Etiquetad
    Término 1

    Definición 1

    Término 2

    Definición 2

    Término 2.1

    Definición 2.1

    Término 2.2

    Definición 2.2

    Término 3

    Definición 3

    Término 4

    Definición 4

    Término 4.1

    Definición 4.1

    Término 4.2

    Definición 4.2

    Término 4.2.1

    Definición 4.2.1

    Término 4.2.2

    Definición 4.2.2

    Término 4.3

    Definición 4.3

    Término 5

    Definición 5

    .Labeled 2
    Term 1;;
        Definition 1
        Term 1.1::
            Definition 1.1
    Etiquetado 2
    Término 1

    Definición 1

    Término 1.1

    Definición 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
    Etiquetado horizontal
    Término 1

    Definición 1

    Término 2

    Definición 2

    Término 2.1

    Definición 2.1

    Término 2.2

    Definición 2.2

    Término 3

    Definición 3

    Término 4

    Definición 4

    Término 4.1

    Definición 4.1

    Término 4.2

    Definición 4.2

    Término 4.2.1

    Definición 4.2.1

    Término 4.2.2

    Definición 4.2.2

    Término 4.3

    Definición 4.3

    Término 5

    Definición 5

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

      Respuesta 1

    2. Pregunta 2

      Respuesta 2

    .Indent is optional
    - bullet
        * another bullet
            1. number
            .  again number
                a. letter
                .. again letter
    
    .. letter
    . number
    
    * bullet
    - bullet
    El indentado es opcional
    • viñeta

      • otra viñeta

        1. número

          1. número de nuevo

            1. letra

              1. letra de nuevo

              2. letra

          2. número

      • viñeta

    • viñeta

    .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
    --
    Separar dos listas
    1. número

    2. número

    Separar lista de párrafo independiente.

    1. número

    Lista de separación de encabezados
    1. número

    1. El bloque de lista también define los límites de la lista

    2. número

    3. número

    1. número

    2. número

    .Continuación
    - viñeta
    continuación
    . número
      continuación
    * viñeta
    
      continuación literal
    ..letra
    +
    continuación no literal.
    +
    ----
    cualquier bloque puede ser
    
    incluido en la lista
    ----
    +
    Última continuación.
    Continuación
    • continuación de viñeta

      1. continuación de número

        • viñeta

          continuación literal
          1. letra

            Continuación no literal.

            cualquier bloque puede ser incluido en la lista

            Última continuación.

    .List block allow sublist inclusion
    - bullet
      * bullet
    +
    --
        - bullet
          * bullet
    --
      * bullet
    - bullet
      . number
        .. letter
    +
    --
          . number
            .. letter
    --
        .. letter
      . number
    El bloque de lista permite la inclusión de sublistas
    • viñeta

      • viñeta

        • viñeta

        • viñeta

      • viñeta

    • viñeta

      1. número

        1. letra

          1. número

          1. letra

        2. letra

      2. número

    Tables

    Puedes llenar una tabla desde un archivo CSV usando macros include:: en la tabla.

    .Una tabla ejemplo
    [options = "header, footer"]
    | == =====================
    | Col 1 | Col 2 | Col 3
    | 1 | Ítem 1 | a
    | 2 | Ítem 2 | b
    | 3 | Ítem 3 | c
    | 6 | Tres Ítems  | d
    | =======================
    
    Table 1.Una tabla ejemplo
    Col 1 Col 2 Col 3

    6

    Tres ítems

    d

    1

    Ítem 1

    a

    2

    Ítem 2

    b

    3

    Ítem 3

    c

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

    1

    2

    3

    4

    a

    b

    c

    d

    A

    B

    C

    D

    [grid="rows",format="csv"]
    [options="header",cols="^,<,<,>m"]
    |===========================
    ID,Nombre,Apellido,Dirección,Teléfono
    1,Vasya,Pupkin,London,+123
    2,X,Y,"A,B",45678
    |===========================
    ID Nombre Apellido Dirección Teléfono

    1

    Vasya

    Pupkin

    London

    +123

    2

    X

    Y

    A,B

    45678

    .Celdas multilínea, fila/col span
    |====
    |Fecha |Duración | HR Promedio |Notas
    
    |22-Aug-08 .2+^.^|10:24 | 157 |
    Ejercitó MSHR (máximo ritmo
    cardíaco sostenible) yendo a ritmo
    fuerte en este intervalo.
    
    |22-Aug-08 | 152 |
    A continuación del intervalo anterior.
    
    |24-Aug-08 3+^|none
    
    |====