<?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" lang="ja">

  <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>

    <license xmlns="http://projectmallard.org/1.0/" href="http://creativecommons.org/licenses/by-sa/3.0/us/">
<p>This work is licensed under a
<link href="http://creativecommons.org/licenses/by-sa/3.0/us/">Creative Commons
Attribution-Share Alike 3.0 United States License</link>.</p>
<p>As a special exception, the copyright holders give you permission to copy,
modify, and distribute the example code contained in this document under the
terms of your choosing, without restriction.</p>
</license>

  </info>

  <title>Write some help</title>

  <links type="series" style="floatend">
    <title>Set up help</title>
  </links>

  <p>Write some <link href="http://www.projectmallard.org/">Mallard</link>
  pages and add them to <file>help/C/</file>.</p>

  <p>Most projects should have an <file>index.page</file> and some content
  pages, although you may not need an <file>index.page</file> if you are
  dropping plugin help into another project.</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>
