/usr/share/doc/gnat-gps/html/Adding-New-Help-Files.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- 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 2 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/.

A copy of the license is included in the section entitled
"GNU General Public License". -->
<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Using the GNAT Programming Studio: Adding New Help Files</title>

<meta name="description" content="Using the GNAT Programming Studio: Adding New Help Files">
<meta name="keywords" content="Using the GNAT Programming Studio: Adding New Help Files">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Index-table.html#Index-table" rel="index" title="Index table">
<link href="Online-Help.html#Online-Help" rel="up" title="Online Help">
<link href="Multiple-Document-Interface.html#Multiple-Document-Interface" rel="next" title="Multiple Document Interface">
<link href="The-Help-Menu.html#The-Help-Menu" rel="previous" title="The Help Menu">
<style type="text/css">
<!--
   

a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
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 lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Adding-New-Help-Files"></a>
<div class="header">
<p>
Previous: <a href="The-Help-Menu.html#The-Help-Menu" accesskey="p" rel="previous">The Help Menu</a>, Up: <a href="Online-Help.html#Online-Help" accesskey="u" rel="up">Online Help</a> &nbsp; [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Adding-New-Help-Files-1"></a>
<h3 class="section">3.2 Adding New Help Files</h3>
<a name="index-gps_005findex_002exml"></a>
<p>GPS will search for the help files in the list of directories set in
the environment variable <code>GPS_DOC_PATH</code> (a colon-separated list
of directories on Unix systems, or semicolon-separated list of
directories on Windows systems). In addition, the
default directory <code>&lt;prefix&gt;/share/doc/gps/html</code> is also searched. If the
file cannot be found in any of these directories, the corresponding
menu item will be disabled.
</p>
<p>The environment variable <code>GPS_DOC_PATH</code> can either be set by each
user in his own environment, or can be set system-wide by modifying
the small wrapper script <samp>gps</samp> itself on Unix systems.
</p>
<p>It can also be set programmatically through the GPS shell or any of the
scripting languages. This is done with
</p>
<div class="smallexample">
<pre class="smallexample">GPS.add_doc_directory (&quot;/home/foo&quot;)
</pre></div>

<p>The specific list of files shown in the menus is set by reading the
index files in each of the directories in <code>GPS_DOC_PATH</code>. These
index files must be called <samp>gps_index.xml</samp>.
</p>
<p>The format of these index files is specified in see <a href="Adding-documentation.html#Adding-documentation">Adding documentation</a>.
</p>



</body>
</html>
gnat-gps-doc 5.0-16 / usr / share / doc / gnat-gps / html / Adding-New-Help-Files.html
