/usr/share/doc/gnat-gps/html/Adding-documentation.html

<html lang="en">
<head>
<title>Adding documentation - Using the GNAT Programming Studio</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Using the GNAT Programming Studio">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Customizing-through-XML-and-Python-files.html#Customizing-through-XML-and-Python-files" title="Customizing through XML and Python files">
<link rel="prev" href="Adding-casing-exceptions.html#Adding-casing-exceptions" title="Adding casing exceptions">
<link rel="next" href="Adding-stock-icons.html#Adding-stock-icons" title="Adding stock icons">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 2002-2010 AdaCore.

This document is free; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.

This document is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, see `http://www.gnu.org/licenses/'.-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
  pre.display { font-family:inherit }
  pre.format  { font-family:inherit }
  pre.smalldisplay { font-family:inherit; font-size:smaller }
  pre.smallformat  { font-family:inherit; font-size:smaller }
  pre.smallexample { font-size:smaller }
  pre.smalllisp    { font-size:smaller }
  span.sc    { font-variant:small-caps }
  span.roman { font-family:serif; font-weight:normal; } 
  span.sansserif { font-family:sans-serif; font-weight:normal; } 
pre.smallexample {background-color:rgb(240,240,240);
                     font-family: courier new,courier,fixed;
                     font-size: 14px;
                     margin: 0px 40px 0px 40px;
                     border-width: 1px 2px 2px 1px;
                     border-top-style: dotted;
                     border-left-style: dotted;
                     border-right-style: solid;
                     border-bottom-style: solid;
                     border-color: black;}
   code             {color:black;
                     font-family: courier new,courier,fixed;
                     font-size: 14px;}
   body             {font-family: arial,helvetica,sans-serif;
                     font-size: 16px;
                     max-width: 800px;
                     text-align: justify}
   samp             {font-family: courier new,courier,fixed;
                     font-size: 14px}
                    
--></style>
</head>
<body>
<div class="node">
<a name="Adding-documentation"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Adding-stock-icons.html#Adding-stock-icons">Adding stock icons</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Adding-casing-exceptions.html#Adding-casing-exceptions">Adding casing exceptions</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Customizing-through-XML-and-Python-files.html#Customizing-through-XML-and-Python-files">Customizing through XML and Python files</a>
<hr>
</div>

<h4 class="subsection">16.5.17 Adding documentation</h4>

<p><a name="index-g_t_003cdocumentation_005ffile_003e-839"></a><!--  -->

<p class="noindent">New documentation can be added in GPS in various ways. This is useful if you
want to point to your own project documentation for instance.

   <p>The first possibility is to create a new menu, through a <code>&lt;menu&gt;</code> tag
in an XML file, associated with an action that either spawn an external
web browser or calls the internal <code>GPS.Help.browse()</code> shell command.

   <p>However, this will not show the documentation in the <code>Help-&gt;Contents</code>
menu, which you also might want to do.

   <p>To have both results, you should use the <code>&lt;documentation_file&gt;</code> tag
in an XML file. These tags are generally found in the <samp><span class="file">gps_index.xml</span></samp>
files, as documented in see <a href="Adding-New-Help-Files.html#Adding-New-Help-Files">Adding New Help Files</a>, but you can in fact
add them in any of your customization files.

   <p>The documentation files you display can contain the usual type of html links. 
In addition, GPS will treat specially links starting with '%', and consider
them as script commands to execute instead of file to display. The following
example show how to insert a link that will in effect open a file in GPS when
clicked by the user

<pre class="smallexample">     &lt;a href="%shell:Editor.editor g-os_lib.ads"&gt;Open runtime file&lt;/a&gt;
</pre>
   <p>The first word after '%' is the name of the language, and the command to
execute is found after the ':' character.

   <p>The <code>&lt;documentation_file&gt;</code> accepts a number of child nodes:

     <dl>
<dt><b>name</b><dd>This is the name of the file. It can be either an absolute file name,
or a file name relative to one of the directories in <code>GPS_DOC_PATH</code>. 
If this child is omitted, you must specify a <code>&lt;shell&gt;</code> child.

     <p>This name can contain a reference to a specific anchor in the html
file, using the standard HTML syntax.

     <pre class="smallexample">            &lt;name&gt;file#anchor&lt;/name&gt;
</pre>
     <br><dt><b>shell</b><dd>This child specifies the name of a shell command to execute to get the
name of the HTML file. This command can for instance create the HTML file
dynamically, or download it locally using some special mechanism. 
This child accepts one attribute, <code>"lang"</code>, which is the name of the
language in which the command is written

     <br><dt><b>descr</b><dd>This is the description for this help file. It appears in a tool tip
for the menu item.

     <br><dt><b>category</b><dd>This is used in the <code>Help-&gt;Contents</code> menu to organize all the
documentation files.

     <br><dt><b>menu</b><dd>This is the full path to the menu. It behaves like a UNIX path, except
it reference the various menus, starting from the menu bar itself. The
first character of this path must be <code>"/"</code>. The last part of the
path is the name of the new menu item. If not set, no menu is
displayed for this file, although it will still appear in the
<code>Help-&gt;Contents</code> menu

     <p>The <code>&lt;menu&gt;</code> child tag accepts two attributes.

          <dl>
<dt><b>before (optional, default="")</b><dd>
The name of the menu before which the new entry should be inserted. If the
new menu is inserted in some submenus, this tag controls the deeper nesting. 
Parent menus are created as needed, but if you wish to control their specific
order, you should create them first with a <code>&lt;menu&gt;</code> tag.

          <br><dt><b>after (optional, default="")</b><dd>
The name of the menu after which the new entry should be inserted. 
</dl>

   </dl>

   <p>The following example shows how to create a new entry "item" in the Help
menu, that will display <samp><span class="file">file.html</span></samp>. The latter is searched in the
<code>GPS_DOC_PATH</code> list of directories.

<pre class="smallexample">     &lt;?xml version="1.0"?&gt;
     &lt;index&gt;
        &lt;documentation_file&gt;
           &lt;name&gt;file.html&lt;/name&gt;
           &lt;descr&gt;Tooltip text&lt;/descr&gt;
           &lt;category&gt;name&lt;/category&gt;
           &lt;menu&gt;/Help/item&lt;/menu&gt;
        &lt;/documentation_file&gt;
     &lt;/index&gt;
</pre>
   <p><a name="index-g_t_003cdoc_005fpath_003e-840"></a>As mentioned above, HTML files are looked for through the <code>GPS_DOC_PATH</code>
environment variable. However, you can also use the <code>&lt;doc_path&gt;</code> XML
node to defined additional directories to be searched.

   <p>Such a directory is relative to the installation directory of GPS.

<pre class="smallexample">     &lt;?xml version="1.0"?&gt;
     &lt;GPS&gt;
        &lt;doc_path&gt;doc/application/&lt;/doc_path&gt;
     &lt;/GPS&gt;
</pre>
   <p>will add the directory <samp><span class="file">&lt;prefix&gt;/doc/application</span></samp> to the search path
for the documentation.

   <p>Such a directory can also be added through Python, as in:

<pre class="smallexample">     GPS.HTML.add_doc_directory ('doc/application')
</pre>
   <!--  -->
   </body></html>
gnat-gps-doc 5.0-6 / usr / share / doc / gnat-gps / html / Adding-documentation.html
