pensarencpp/DOCBOOK at master · CRySoL/pensarencpp · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
-*- coding: utf-8 -*-

==listados de código==

Los listados que van en su propio párrafo utilizan <programlisting> y NO
necesitan y no NO DEBEN ser incluidos en un elemento <para>. Cuando
aparezca un listado largo (normalemente un fichero completo) basta con
poner la primera línea que contiene el nombre del fichero. Algo como:

//: C03:Ejemplo.cpp

Se DEBE dejar una línea en blanco encima y otra debajo y respetar el
formato del ejemplo. En la compilación del documento, un script
reemplazará esa línea por el contenido del fichero.

Para los fragmentos de código que aparecen en mitad de una frase,
utiliza el elemento estándar DB 4.3 "<code>"


==etiquetas para las palabras reservadas y operadores==

DEBES etiquetarlas como sigue:

palabras reservadas -> <kw> </kw>
operadores    	    -> <oper> </oper>

Estos elementos no existen en DocBook, pero al compilar el documento, un
script los substituye por el elemento DocBook más adecuado.

Norman Walsh dice respecto a las palabras reservadas:

http://sourceware.org/ml/docbook/2000-10/msg00012.html
/ Ian Moor <iwm@doc.ic.ac.uk> was heard to say:
| >I am trying to mark-up a document that is about a computer language.
|
| I have wondered about language keywords, for example in chapter 2 of the
| definitive guide "the most frequently used keywords are PUBLIC, SYSTEM, ..."
| However the docbook element keyword  is meant for describing a document.
| The nearest element seems to be token.

Yes, "keyword" describes the metadata that is a keyword, not computer
language keywords. I'd likely use <literal>, <symbol>, or <token> with
a role attribute.


Norman Walsh dice respecto a los operadores:

http://sourceware.org/ml/docbook/2003-02/msg00096.html

/ Joachim Ziegler <ziegler@mpi-sb.mpg.de> was heard to say:
| How do I markup an operator like "++"?
|
| Is something like
|
| "The operator <function>++</function> increments its operand."
|
| ok? (Every operator can be seen as a function.)

That seems reasonable to me. I might use <function role="operator">,
if I was being really precise.


== Etiqueta para símbolos ==
Cuando el autor se refiere a un caracter de forma literal utiliza
comillas simples, con en '*'. En esos casos utiliza <token> para marcar
el caracter.


== Etiquetas para elementos habituales ==
Comprobar que se usan cuando la revisión esté terminada

- cout, cin son <varname>
- <function>endla</funciton>
- <classname>iostream</classname>
- En los "descriptions" utilizar <formalpara>


== Etiquetas por determinar ==

- Los namespaces, como "std"