gnat-gps-doc 5.0-6 / usr / share / doc / gnat-gps / html / Adding-project-templates.html

This file is indexed.

/usr/share/doc/gnat-gps/html/Adding-project-templates.html is in gnat-gps-doc 5.0-6.

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
<html lang="en">
<head>
<title>Adding project templates - 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-and-Extending-GPS.html#Customizing-and-Extending-GPS" title="Customizing and Extending GPS">
<link rel="prev" href="The-Server-Mode.html#The-Server-Mode" title="The Server Mode">
<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-project-templates"></a>
<p>
Previous:&nbsp;<a rel="previous" accesskey="p" href="The-Server-Mode.html#The-Server-Mode">The Server Mode</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Customizing-and-Extending-GPS.html#Customizing-and-Extending-GPS">Customizing and Extending GPS</a>
<hr>
</div>

<h3 class="section">16.11 Adding project templates</h3>

<p><a name="index-project-templates-912"></a><!--  -->

<p class="noindent">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>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>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>A template description file is a text file with the <code>.gpt</code> extension,
with the following syntax:

<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>
   <p>Where the following should be defined:

     <ul>
<li>&lt;name&gt;
The name of the template as it will appear in the template tree in the project
template wizard.

     <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>&lt;variable_1&gt;
A name which will be substituted in the template files when deploying the
template, see below.

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

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

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

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

<!--  -->
   </body></html>

APT Browse - Built by Thomas Orozco.