/usr/share/doc/gnat-gps/html/Adding-project-templates.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 project templates</title>

<meta name="description" content="Using the GNAT Programming Studio: Adding project templates">
<meta name="keywords" content="Using the GNAT Programming Studio: Adding project templates">
<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-and-Extending-GPS.html#Customizing-and-Extending-GPS" rel="up" title="Customizing and Extending GPS">
<link href="Environment.html#Environment" rel="next" title="Environment">
<link href="The-Server-Mode.html#The-Server-Mode" rel="previous" title="The Server Mode">
<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-project-templates"></a>
<div class="header">
<p>
Previous: <a href="The-Server-Mode.html#The-Server-Mode" accesskey="p" rel="previous">The Server Mode</a>, Up: <a href="Customizing-and-Extending-GPS.html#Customizing-and-Extending-GPS" accesskey="u" rel="up">Customizing and Extending GPS</a> &nbsp; [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Adding-project-templates-1"></a>
<h3 class="section">16.11 Adding project templates</h3>
<a name="index-project-templates"></a>

<p>The Project template wizard lists a selection of templates. The default
set is found automatically by GPS in the <code>share/gps/templates</code> directory
of your GPS installation.
</p>
<p>It is possible to register new directories in which GPS will look for
templates, by using the Shell/Python command
<code>GPS.ProjectTemplate.add_templates_dir</code>.
</p>
<p>To create a new project template, first create a subdirectory in the
<code>share/gps/templates/</code> directory, or in one of the directories which has
been registered through <code>GPS.ProjectTemplate.add_templates_dir</code>. Then, in
this directory, create one template description file.
</p>
<p>A template description file is a text file with the <code>.gpt</code> extension,
with the following syntax:
</p>
<div class="smallexample">
<pre class="smallexample">Name: &lt;name&gt;
Category: &lt;category&gt;
Project: &lt;project file&gt;
&lt;optional_hook_line&gt;

&lt;variable_1&gt;: &lt;variable_1_default_value&gt;: &lt;variable_1_description&gt;
&lt;variable_2&gt;: &lt;variable_2_default_value&gt;: &lt;variable_3_description&gt;
&lt;etc&gt;

[Description]
&lt;the description&gt;
</pre></div>

<p>Where the following should be defined:
</p>
<ul>
<li> &lt;name&gt;
The name of the template as it will appear in the template tree in the project
template wizard.

</li><li> &lt;category&gt;
The category in which the template will be inserted in the template tree. There
can be multiple levels of categories, separated with <code>/</code>.

</li><li> &lt;variable_1&gt;
A name which will be substituted in the template files when deploying the
template, see below.

</li><li> &lt;variable_1_default_value&gt;
The default value for variable 1, which will appear in the project template
wizard.

</li><li> &lt;variable_1_description&gt;
The description of variable 1.

</li><li> &lt;optional_hook_line&gt;
An optional line of the form <code>post_hook: &lt;python_file&gt;</code> where
<code>&lt;python_file&gt;</code> is the name of a Python file present in the same directory
as the template description file. This Python file will be run by GPS once,
right after the project template is deployed

</li><li> &lt;description&gt;
A short paragraph describing the project template. This paragraph will be
displayed in the project template wizard when the template is selected in the
tree.

</li></ul>

<p>When deploying templates, GPS will copy in the destination directory chosen
by the use all files and directories present in the directory that contains
the template description file, except the Python file indicated as post_hook,
and the template description file itself.
</p>
<p>As it deploys templates, GPS will replace strings of the form
<code>@_&lt;variable_name&gt;_@</code> with the value of the variable.
If <code>&lt;variable_name&gt;</code> is all lower case, the substitution will be
transformed to lower-case. If <code>&lt;variable_name&gt;</code> is in Mixed_Case, the
substitution will be transformed into Mixed_Case as well. If it is in upper
case, then the substitution will contain the original value specified by the
user.
</p>
<hr>
<div class="header">
<p>
Previous: <a href="The-Server-Mode.html#The-Server-Mode" accesskey="p" rel="previous">The Server Mode</a>, Up: <a href="Customizing-and-Extending-GPS.html#Customizing-and-Extending-GPS" accesskey="u" rel="up">Customizing and Extending GPS</a> &nbsp; [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>
gnat-gps-doc 5.0-16 / usr / share / doc / gnat-gps / html / Adding-project-templates.html
