5.5 Marcas en línea

Las macros descritas en esta sección se usan para casi cualquier cosa dentro del texto del documento. Se pueden usar tanto en las cabeceras (aunque se debería evitar cualquier cosa relativa a hiperenlaces) como en el cuerpo del texto.

\bfcode {texto}: Como \code, más negrita.

\cdata {nombre}: El nombre de una variable de C.

\cfunction {nombre}: El nombre de una función C. nombre debe incluir el nombre de la función y los paréntesis finales.

\character {carácter}: Un carácter considerado como tal, más que como una cadena de un solo byte. El carácter se presentará como con \samp.

\citetitle [url]{título}: El título de una publicación a la que se hace referencia. Si se especifica url, el título será un hiperenlace en el formato HTML.

\class {nombre}: Un nombre de clase. Puede incluir puntos.

\code {texto}: Un breve fragmento de código o valor de constante literal. Típicamente, no debe incluir espacios, porque no se añaden comillas.

\constant {nombre}: El nombre de una constante ``definida''. Puede ser un #define de C o una variable de Python cuyo valor no debe cambiar.

\ctype {nombre}: El nombre de un typedef o estructura de C. Utiliza \ctype{struct struct_tag} para estructuras definidas sin typedef para dejar claro que se requiere struct.

\deprecated {versión}{qué hacer}: Declara lo que sea como obsoleto a partir de la versión versión. El texto incluido en qué hacer debe recomendar alternativas.

\dfn {término}: Marca la aparición en el texto de término que define el término. No se genera una entrada en el índice.

\e: Produce una barra invertida. Viene bien en \code y macros similares, y sólo se define allí. Para crear una barra invertida en texto normal (como el contenido de una macro \file), se debe usar la macro estándar \textbackslash.

\email {dirección}: Una dirección de correo electrónico. Observa que no se genera un hiperenlace en ninguno de los formatos de salida posibles. La parte del dominio debe aparecer en minúsculas.

\emph {texto}: Texto resaltado. Se presentará en tipo de letra cursiva.

\envvar {nombre}: Una variable de entorno. Se genera una entrada en el índice.

\exception {nombre}: El nombre de una excepción. Puede incluir puntos.

\file {fichero o directorio}: El nombre de un fichero o directorio. En la salida a PDF o a PostScript, se utilizan comillas simples y un cambio de tipo de letra. En HTML no se incluyen comillas. Ojo: La macro \file no se puede usar en el contenido de un título de sección por limitaciones de proceso.

\filenq {fichero o directorio}: Como \file, pero nunca se usan comillas simples. Se puede usar en tablas si una columna sólo ha de contener nombre de ficheros o directorios. Ojo: La macro \filenq no se puede usar en el contenido de un título de sección por limitaciones de proceso.

\function {nombre}: El nombre de una función Python. Puede incluir puntos.

\kbd {secuencia de teclas}: Marca una secuencia de pulsaciones de teclas. La forma de secuencia de teclas puede depender de convenciones especificas de la plataforma o de la aplicación. Por ejemplo, una secuencia de teclas de xemacs puede marcarse como \kbd{C-x C-f}.

\keyword {nombre}: El nombre de una palabra clave de un lenguaje de programación

\makevar {nombre}: El nombre de una variable de make.

\manpage {nombre}{seccion}: Una referencia a una pagina de manual Unix.

\member {nombre}: El nombre de un atributo de un objeto.

\method {nombre}: El nombre de un método de un objeto. nombre debe incluir el nombre del método y los paréntesis finales. Puede incluir puntos.

\mimetype {nombre}: El nombre de un tipo MIME.

\module {nombre}: El nombre de un módulo o paquete . Puede incluir puntos.

\newsgroup {nombre}: El nombre de un grupo de noticias de USENET.

\program {nombre}: El nombre de un programa ejecutable. Puede ser diferente del nombre del fichero en alguna plataforma. En particular, la extensión .exe (u otra) debe omitirse en los programas de DOS y Windows.

\programopt {opción}: Una opción de línea de órdenes de un programa ejecutable. Debe usarse sólo para opciones de ``disparo'' e incluir el guion inicial.

\longprogramopt {opción}: Una opción larga de línea de órdenes de un programa ejecutable. Debe usarse sólo para nombres de opción largos que serán prefijados por dos guiones. No se deben proporcionar los guiones como parte de la opción.

\pep {número}: Referencia a una Propuesta de mejora de Python (PEP). Genera los elementos de índice apropiados. Se genera el texto "PEP número". En la salida a HTML, el texto es un hipervínculo a la copia electrónica de la PEP especificada.

\refmodule [clave]{nombre}: Como \module, pero genera un hipervínculo a la documentación del módulo nombrado. Observa que el \declaremodule correspondiente debe estar en el mismo documento. Si el \declaremodule define una clave de un módulo diferente del nombre del módulo, se debe proporcionar también como clave a la macro \refmodule.

\regexp {string}: Marca una expresión regular.

\rfc {número}: Una referencia a una Petición de comentarios (en inglés, RFC). Genera entradas apropiadas en el índice. Se genera el texto "RFC número". En la salida HTML, este texto es un hipervínculo a una copia electrónica de la RFC especificada.

\samp {texto}: Un breve ejemplo de código, mayor que el que de daría mediante \code. Como se añaden comillas, se aceptan espacios.

\shortversion: El número de versión ``corto'' del software documentado, especificado mediante la macro \setshortversion en el preámbulo. En Python, el número corto de versión lo forman los primeros tres caracteres del valor de sys.version. Por ejemplo, las versiones 2.0b1 y 2.0.1 tienen el mismo número de versión, 2.0. Puede que esto no sea aplicable a todos los paquetes. Si no se usa \setshortversion, produce una expansión vacía. Vea también la macro \version.

\strong {texto}: Texto muy resaltado. Se presentará mediante un tipo de letra en negrita.

\url {url}: Una URL (o URN). La URL se presentará como texto. En la salida HTML y PDF, la URL será también un hipervínculo. Se puede usar para referencias externas. Observa que muchos caracteres son especiales para L^ATEX y esta macro no hace siempre lo esperado. En particular, el carácter ("~") no se trata de la manera adecuada. Funciona si se codifica hexadecimalmente, es decir, como "%7e".

\var {nombre}: El nombre de una variable o parámetro formal dentro de una frase.

\versión: El número de versión del software descrito, especificado con \release en el preámbulo. Consultar la macro \shortversion.

\versionadded {versión}: La versión de Python en que se agregó la característica descrita a la biblioteca o API. Se añade típicamente al final del primer párrafo de la descripción, antes de las notas de disponibilidad. Se debe elegir la ubicación para que la explicación tenga sentido, por lo que variará según los casos.

\versionchanged [explicación]{versión}: La versión de Python en que se cambió la característica mencionada (nuevos parámetros, cambio de efectos secundarios...). explicación debería ser una breve explicación del cambio, de un solo fragmento de frase, sin poner en mayúscula la primera letra. El proceso de formato agregará un punto al final. Se añade típicamente al final del primer párrafo de la descripción antes de las notas de disponibilidad y después de \versionadded. Se debe escoger la ubicación para que la explicación tenga sentido.

Ver Sobre este documento... para obtener información sobre sugerencias.