Blame platform-overview/sl/dev-help-write.page

Packit 1470ea
Packit 1470ea
<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="sl">
Packit 1470ea
Packit 1470ea
  <info>
Packit 1470ea
    <link type="next" xref="dev-help-build"/>
Packit 1470ea
    <revision version="0.1" date="2013-06-19" status="review"/>
Packit 1470ea
Packit 1470ea
    <credit type="author">
Packit 1470ea
      <name>Ekaterina Gerasimova</name>
Packit 1470ea
      <email its:translate="no">kittykat3756@gmail.com</email>
Packit 1470ea
      <years>2013</years>
Packit 1470ea
    </credit>
Packit 1470ea
Packit 1470ea
    <include xmlns="http://www.w3.org/2001/XInclude" href="cc-by-sa-3-0.xml"/>
Packit 1470ea
Packit 1470ea
  </info>
Packit 1470ea
Packit 1470ea
  <title>Write some help</title>
Packit 1470ea
Packit 1470ea
  <links type="series" style="floatend">
Packit 1470ea
    <title>Set up help</title>
Packit 1470ea
  </links>
Packit 1470ea
Packit 1470ea
  

Write some <link href="http://www.projectmallard.org/">Mallard</link>

Packit 1470ea
  pages and add them to <file>help/C/</file>.

Packit 1470ea
  
Packit 1470ea
  

Most projects should have an <file>index.page</file> and some content

Packit 1470ea
  pages, although you may not need an <file>index.page</file> if you are
Packit 1470ea
  dropping plugin help into another project.

Packit 1470ea
  
Packit 1470ea
  <example>
Packit 1470ea
    <listing>
Packit 1470ea
      <title><file>help/C/index.page</file></title>
Packit 1470ea
Packit 1470ea
Packit 1470ea
      xmlns:its="http://www.w3.org/2005/11/its"
Packit 1470ea
      type="guide"
Packit 1470ea
      id="index">
Packit 1470ea
Packit 1470ea
  <info>
Packit 1470ea
    <revision pkgversion="3.9" date="2013-06-19" status="stub"/>
Packit 1470ea
Packit 1470ea
    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
Packit 1470ea
  </info>
Packit 1470ea
Packit 1470ea
  <title>
Packit 1470ea
    <media type="image" mime="image/png" its:translate="no" src="figures/icon.png" />
Packit 1470ea
    Application name
Packit 1470ea
  </title>
Packit 1470ea
Packit 1470ea
  <section id="features" style="2column">
Packit 1470ea
    <title>Features</title>
Packit 1470ea
  </section>
Packit 1470ea
Packit 1470ea
</page>
Packit 1470ea
]]>
Packit 1470ea
    </listing>
Packit 1470ea
  
Packit 1470ea
    <listing>
Packit 1470ea
      <title><file>help/C/introduction.page</file></title>
Packit 1470ea
Packit 1470ea
Packit 1470ea
      xmlns:its="http://www.w3.org/2005/11/its"
Packit 1470ea
      type="topic"
Packit 1470ea
      id="introduction">
Packit 1470ea
Packit 1470ea
  <info>
Packit 1470ea
    <link type="guide" xref="index"/>
Packit 1470ea
Packit 1470ea
    <link type="guide" xref="index#features"/>
Packit 1470ea
    <link type="seealso" xref="anotherpageid"/>
Packit 1470ea
-->
Packit 1470ea
    <revision pkgversion="3.9" date="2013-06-19" status="stub"/>
Packit 1470ea
 
Packit 1470ea
    <credit type="author">
Packit 1470ea
      <name>Your Name</name>
Packit 1470ea
      <email its:translate="no">mail@example.com</email>
Packit 1470ea
      <years>2013</years>
Packit 1470ea
    </credit>
Packit 1470ea
 
Packit 1470ea
    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
Packit 1470ea
Packit 1470ea
    <desc>Welcome to _Application name_</desc>
Packit 1470ea
  </info>
Packit 1470ea
Packit 1470ea
  <title>Introduction</title>
Packit 1470ea
Packit 1470ea
  

This application is awesome!

Packit 1470ea
Packit 1470ea
</page>
Packit 1470ea
]]>
Packit 1470ea
    </listing>
Packit 1470ea
  </example>
Packit 1470ea
 
Packit 1470ea
</page>