Personal tools
gvSIG Desktop
gvSIG Desktop

Cached time 11/21/13 16:20:44 Clear cache and reload

 
Las principales directivas usadas en *gvsig.org* son:

* **contents**. Permiten insertar una tabla de contenidos en el 
  documento. Su uso seria::
  
    .. contents:: Titulo de la tabla de contenidos.
    
  Aunque es muy útil esta directiva, en el contexto de la generación de
  documentación en *gvsig.org*, hay que llevar especial cuidado con ella, 
  ya que es normal que luego un documento pase a formar parte de otro
  documento mayor, y si este tiene insertada alguna tabla de contenidos
  nos la encontraremos en medio del documento que lo contenga.
  
* **figure**. Permite insertar imágenes dentro del documento.

  Una figura consiste en datos de imagen (archivo de imagen), 
  un pie de imagen (un párrafo), y opcionalmente una leyenda 

  La sintaxis para insertar una imagen sería

  ::

     .. figure:: imagenes_src/picture.png
       :align: center
       
       Este es el pie de la imagen (sólo un párrafo).

       La leyenda consiste en los elementos posteriores al pie. en este caso,
       la leyenda es este párrafo.
   
  y el resultado sería

  .. figure:: imagenes_src/picture.png
    :align: center

    Este es el pie de la imagen (sólo un párrafo).

    La leyenda consiste en los elementos posteriores al pie. en este caso,
    la leyenda es este párrafo.

  Es recomendable dejar una línea en blanco por encima y por debajo de la 
  figure que se quiere insertar y no indentar la línea.

  ::

    Correcto

    Párrafo anterior a la figure

    ..figure:: images_src/picture.png

    Párrafo posterior a la figure

    No recomendado

    Párrafo anterior a la figure
    ..figure:: images_src/picture.png

    Párrafo anterior a la figure

      ..figure:: images_src/picture.png

* **list-table**. Nos permite insertar una tabla definiéndola como
  una lista de dos niveles, donde el primer nivel define las lineas y
  el segundo los valores de las celdas de la linea.
  
  Veamos un ejemplo:

  ::

    .. list-table:: Frozen Delights!
       :widths: 15 10 30
       :header-rows: 1

       * - Treat
         - Quantity
         - Description
       * - Albatross
         - 2.99
         - On a stick!
       * -  Crunchy Frog
         - 1.49
         - If we took the bones out, it wouldn't be
           crunchy, now would it?
       * - Gannet Ripple
         - 1.99
         - On a stick!

  Donde cada '\*' indica el comienzo de una fila y cada '-' el comienzo de una celda.

  El resultado sería

  .. list-table:: Frozen Delights!
     :widths: 15 10 30
     :header-rows: 1

     * - Treat
       - Quantity
       - Description
     * - Albatross
       - 2.99
       - On a stick!
     * - Crunchy Frog
       - 1.49
       - If we took the bones out, it wouldn't be
         crunchy, now would it?
     * - Gannet Ripple
       - 1.99
       - On a stick!

View source document


Powered by Plone CMS, the Open Source Content Management System

This site conforms to the following standards: