Skip to content

HELP.DIV

Vii edited this page Mar 11, 2022 · 3 revisions

HELP.DIV es el fichero que contiene el sistema de ayuda electrónica incluido en DIV. Está en un formato de texto plano y usa un sistema de marcado muy simple al estilo de HTML, TROFF o MarkDown. El formato está documentado al inicio del propio archivo HELP.DIV.

Véase también: HELP.IDX

Sintaxis

Los saltos de línea simples son ignorados:

Ejemplo Resultado
Esto se verá
en una sola línea.
Esto se verá en una sola línea.

Los saltos de dos o más líneas se interpretan como saltos de párrafo:

Ejemplo Resultado
Esto es
un párrafo.

Esto es otro
párrafo.

Esto es un párrafo.

Esto es otro párrafo.

Las líneas con un símbolo # en la primera columna se consideran comentarios y se ignoran:

Ejemplo Resultado
Esta línea será visible.

# Esto no se mostrará.

Esta línea también será visible.

Esta línea será visible.

Esta línea también será visible.

Comandos disponibles

Texto en negrita

{texto a resaltar}

Muestra parte de una línea en un color más claro para resaltarlo.

Definición de un término

{.N,título}

Marca el inicio de un artículo de la ayuda. La línea anterior debe estar en blanco. N es un número único asignado al artículo (no es necesario que estén en orden).

Referencia a un término

{#N,texto}

Genera un enlace de hipertexto al artículo numerado N con el texto texto.

Imagen

{+N,C}{-} o {+N,C}Párrafo de texto{-}

La imagen se obtiene del fichero HELP.FIG, que en realidad es un FPG.

  • N es el código de la imagen dentro del FPG.
  • C es un código de centrado:
    • 0: izquierda
    • 1: centrado
    • 2: derecha
  • Opcionalmente la imagen puede estar asociada a un párrafo de texto. Se mostrará el texto como un párrafo con la imagen flotando a su izquierda. Sólo tiene sentido usarlo con el código de centrado 0 (izquierda), ya que el 1 mostrará la imagen centrada y el párrafo debajo (igual que si fuera una imagen independiente, aunque puede tener sentido para figuras con texto al pie), y el 2 bloqueará DIV.
  • La etiqueta final {-} es obligatoria aunque no pongamos texto, así que no hay que olvidarla.

Caracteres '{' y '}'

  • {{} para mostrar un carácter {
  • {}} para mostrar un carácter }

Línea separatoria

{/}

Se mostrará una línea divisoria horizontal.

Salto de línea simple

· (shift+3 en el teclado español)

Permite introducir saltos de línea sin separar en párrafos. Se usa para listas, tablas, trozos de código, etc.

Ejemplo Resultado
Esto se verá·
en dos líneas!
Esto se verá
en dos líneas!

Texto de LENGUAJE.DIV

{@N}

Insertará uno de los textos traducibles de lenguaje.div, identificado por su número N. Útil para asegurar la consistencia entre lo que se muestra en la ayuda y lo que se muestra en el entorno, aunque en el fichero de ayuda original de DIV 2 no se utiliza.