/usr/share/doc/gnat-gps/html/Adding-documentation.html is in gnat-gps-doc 5.0-16.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 | <!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 documentation</title>
<meta name="description" content="Using the GNAT Programming Studio: Adding documentation">
<meta name="keywords" content="Using the GNAT Programming Studio: Adding documentation">
<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="Customizing-through-XML-and-Python-files.html#Customizing-through-XML-and-Python-files" rel="up" title="Customizing through XML and Python files">
<link href="Adding-stock-icons.html#Adding-stock-icons" rel="next" title="Adding stock icons">
<link href="Adding-casing-exceptions.html#Adding-casing-exceptions" rel="previous" title="Adding casing exceptions">
<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-documentation"></a>
<div class="header">
<p>
Next: <a href="Adding-stock-icons.html#Adding-stock-icons" accesskey="n" rel="next">Adding stock icons</a>, Previous: <a href="Adding-casing-exceptions.html#Adding-casing-exceptions" accesskey="p" rel="previous">Adding casing exceptions</a>, Up: <a href="Customizing-through-XML-and-Python-files.html#Customizing-through-XML-and-Python-files" accesskey="u" rel="up">Customizing through XML and Python files</a> [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Adding-documentation-1"></a>
<h4 class="subsection">16.5.17 Adding documentation</h4>
<a name="index-_003cdocumentation_005ffile_003e"></a>
<p>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>
<p>The first possibility is to create a new menu, through a <code><menu></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>
<p>However, this will not show the documentation in the <code>Help->Contents</code>
menu, which you also might want to do.
</p>
<p>To have both results, you should use the <code><documentation_file></code> tag
in an XML file. These tags are generally found in the <samp>gps_index.xml</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>
<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
</p>
<div class="smallexample">
<pre class="smallexample"><a href="%shell:Editor.editor g-os_lib.ads">Open runtime file</a>
</pre></div>
<p>The first word after ’%’ is the name of the language, and the command to
execute is found after the ’:’ character.
</p>
<p>The <code><documentation_file></code> accepts a number of child nodes:
</p>
<dl compact="compact">
<dt><b>name</b></dt>
<dd><p>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><shell></code> child.
</p>
<p>This name can contain a reference to a specific anchor in the html
file, using the standard HTML syntax.
</p>
<div class="smallexample">
<pre class="smallexample"> <name>file#anchor</name>
</pre></div>
</dd>
<dt><b>shell</b></dt>
<dd><p>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
</p>
</dd>
<dt><b>descr</b></dt>
<dd><p>This is the description for this help file. It appears in a tool tip
for the menu item.
</p>
</dd>
<dt><b>category</b></dt>
<dd><p>This is used in the <code>Help->Contents</code> menu to organize all the
documentation files.
</p>
</dd>
<dt><b>menu</b></dt>
<dd><p>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->Contents</code> menu
</p>
<p>The <code><menu></code> child tag accepts two attributes.
</p>
<dl compact="compact">
<dt><b>before (optional, default="")</b></dt>
<dd>
<p>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><menu></code> tag.
</p>
</dd>
<dt><b>after (optional, default="")</b></dt>
<dd>
<p>The name of the menu after which the new entry should be inserted.
</p></dd>
</dl>
</dd>
</dl>
<p>The following example shows how to create a new entry "item" in the Help
menu, that will display <samp>file.html</samp>. The latter is searched in the
<code>GPS_DOC_PATH</code> list of directories.
</p>
<div class="smallexample">
<pre class="smallexample"><?xml version="1.0"?>
<index>
<documentation_file>
<name>file.html</name>
<descr>Tooltip text</descr>
<category>name</category>
<menu>/Help/item</menu>
</documentation_file>
</index>
</pre></div>
<a name="index-_003cdoc_005fpath_003e"></a>
<p>As mentioned above, HTML files are looked for through the <code>GPS_DOC_PATH</code>
environment variable. However, you can also use the <code><doc_path></code> XML
node to defined additional directories to be searched.
</p>
<p>Such a directory is relative to the installation directory of GPS.
</p>
<div class="smallexample">
<pre class="smallexample"><?xml version="1.0"?>
<GPS>
<doc_path>doc/application/</doc_path>
</GPS>
</pre></div>
<p>will add the directory <samp><prefix>/doc/application</samp> to the search path
for the documentation.
</p>
<p>Such a directory can also be added through Python, as in:
</p>
<div class="smallexample">
<pre class="smallexample">GPS.HTML.add_doc_directory ('doc/application')
</pre></div>
<hr>
<div class="header">
<p>
Next: <a href="Adding-stock-icons.html#Adding-stock-icons" accesskey="n" rel="next">Adding stock icons</a>, Previous: <a href="Adding-casing-exceptions.html#Adding-casing-exceptions" accesskey="p" rel="previous">Adding casing exceptions</a>, Up: <a href="Customizing-through-XML-and-Python-files.html#Customizing-through-XML-and-Python-files" accesskey="u" rel="up">Customizing through XML and Python files</a> [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|