File: dev-help-write.page

package info (click to toggle)
gnome-devel-docs 40.3-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 79,188 kB
  • sloc: javascript: 2,514; xml: 2,407; ansic: 2,229; python: 1,854; makefile: 805; sh: 499; cpp: 131
file content (110 lines) | stat: -rw-r--r-- 3,495 bytes parent folder | download 
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
<?xml version="1.0" encoding="utf-8"?>
<page xmlns="http://projectmallard.org/1.0/" xmlns:its="http://www.w3.org/2005/11/its" type="topic" style="task" id="dev-help-write" xml:lang="es">

  <info>
    <link type="next" xref="dev-help-build"/>
    <revision version="0.1" date="2013-06-19" status="review"/>

    <credit type="author">
      <name>Ekaterina Gerasimova</name>
      <email its:translate="no">kittykat3756@gmail.com</email>
      <years>2013</years>
    </credit>

    <include xmlns="http://www.w3.org/2001/XInclude" href="cc-by-sa-3-0.xml"/>

  
    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
      <mal:name>Daniel Mustieles</mal:name>
      <mal:email>daniel.mustieles@gmail.com</mal:email>
      <mal:years>2011-2019</mal:years>
    </mal:credit>
  
    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
      <mal:name>Jorge González</mal:name>
      <mal:email>jorgegonz@svn.gnome.org</mal:email>
      <mal:years>2007-2010</mal:years>
    </mal:credit>
  
    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
      <mal:name>Mario Carrión</mal:name>
      <mal:email>mario@monouml.org</mal:email>
      <mal:years>2006</mal:years>
    </mal:credit>
  </info>

  <title>Escribir algo de ayuda</title>

  <links type="series" style="floatend">
    <title>Configurar la ayuda</title>
  </links>

  <p>Escribir algunas páginas en <link href="http://www.projectmallard.org/">Mallard</link> y añadirlas a <file>help/C/</file>.</p>

  <p>La mayoría de los proyectos deben tener un archivo <file>index.page</file> y algunas páginas con contenido, aunque puede no necesitar el archivo <file>index.page</file> si está escribiendo ayuda sobre los complementos de otro proyecto.</p>

  <example>
    <listing>
      <title><file>help/C/index.page</file></title>
<code>
&lt;page xmlns="http://projectmallard.org/1.0/"
      xmlns:its="http://www.w3.org/2005/11/its"
      type="guide"
      id="index"&gt;

  &lt;info&gt;
    &lt;revision pkgversion="3.9" date="2013-06-19" status="stub"/&gt;

    &lt;include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/&gt;
  &lt;/info&gt;

  &lt;title&gt;
    &lt;media type="image" mime="image/png" its:translate="no" src="figures/icon.png" /&gt;
    Application name
  &lt;/title&gt;

  &lt;section id="features" style="2column"&gt;
    &lt;title&gt;Features&lt;/title&gt;
  &lt;/section&gt;

&lt;/page&gt;
</code>
    </listing>

    <listing>
      <title><file>help/C/introduction.page</file></title>
<code>
&lt;page xmlns="http://projectmallard.org/1.0/"
      xmlns:its="http://www.w3.org/2005/11/its"
      type="topic"
      id="introduction"&gt;

  &lt;info&gt;
    &lt;link type="guide" xref="index"/&gt;
&lt;!--
    &lt;link type="guide" xref="index#features"/&gt;
    &lt;link type="seealso" xref="anotherpageid"/&gt;
--&gt;
    &lt;revision pkgversion="3.9" date="2013-06-19" status="stub"/&gt;

    &lt;credit type="author"&gt;
      &lt;name&gt;Your Name&lt;/name&gt;
      &lt;email its:translate="no"&gt;mail@example.com&lt;/email&gt;
      &lt;years&gt;2013&lt;/years&gt;
    &lt;/credit&gt;

    &lt;include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/&gt;

    &lt;desc&gt;Welcome to _Application name_&lt;/desc&gt;
  &lt;/info&gt;

  &lt;title&gt;Introduction&lt;/title&gt;

  &lt;p&gt;This application is awesome!&lt;/p&gt;

&lt;/page&gt;
</code>
    </listing>
  </example>

</page>