/usr/share/doc/python-gtkmvc-doc/userman/progen.html is in python-gtkmvc-doc 1.99.1-1build1.
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 240 241 242 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>progen: A Project Generator — Model-View-Controller and Observer patterns for PyGTK 1.99.1 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.99.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Model-View-Controller and Observer patterns for PyGTK 1.99.1 documentation" href="index.html" />
<link rel="prev" title="Adapters" href="adapt.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="adapt.html" title="Adapters"
accesskey="P">previous</a> |</li>
<li><a href="index.html">Model-View-Controller and Observer patterns for PyGTK 1.99.1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="progen-a-project-generator">
<h1>progen: A Project Generator<a class="headerlink" href="#progen-a-project-generator" title="Permalink to this headline">ΒΆ</a></h1>
<p>Since version 1.2 a little application called <em>gtkmvc-progen</em>
is provided. Goal of <em>gtkmvc-progen</em> is to generate the skeleton
of a project that can be used when starting up a new application
based on gtkmvc.</p>
<p><em>gtkmvc-progen</em> creates a directory containing the skeleton of a
new project, called the top-level directory.</p>
<p>The newly created project is constituted by:</p>
<ul class="simple">
<li>A source directory containing all project source code</li>
<li>An empty application-level Model</li>
<li>A simple application-level Controller</li>
<li>The application main View containing the application main window.</li>
<li>A resources directory, containing for example the project
glade files, but also possibly images, styles, and other resources
loaded at runtime.</li>
<li>A launching script, localized in the top-level directory</li>
</ul>
<p><em>gtkmvc-progen</em> can be executed as a batch program to be
controlled from the command line, or as a simple GUI
application. <em>gtkmvc-progen</em> is of course based on <em>gtkmvc</em>. All
the work is performed by the model, and a view and a controller are
loaded when a GUI is required. Depending on the hosting platform,
<em>gtkmvc-progen</em> is launched by default either in batch or in GUI
mode. Unix users are more familiar with command-line programs, and
will find <em>gtkmvc-progen</em> to be executed in that modality by
default. Windows users will find the GUI presented by default
instead.</p>
<p>The way <em>gtkmvc-progen</em> can be customized is by setting some
properties inside the model, either by using the command line, or by
using the GUI that does not export the full set of properties,
though.</p>
<p>Here is the list of properties with a short description:</p>
<table border="1" class="docutils">
<colgroup>
<col width="16%" />
<col width="15%" />
<col width="49%" />
<col width="20%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property name</th>
<th class="head">Property type</th>
<th class="head">Description</th>
<th class="head">Default value</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>name</td>
<td>string</td>
<td>name of the project</td>
<td><strong>REQUIRED</strong></td>
</tr>
<tr class="row-odd"><td>author</td>
<td>string</td>
<td>Developer’s name</td>
<td><strong>REQUIRED</strong></td>
</tr>
<tr class="row-even"><td>email</td>
<td>string</td>
<td>Developer’s email address</td>
<td> </td>
</tr>
<tr class="row-odd"><td>copyright</td>
<td>string</td>
<td>Copyright string</td>
<td>A sensible string</td>
</tr>
<tr class="row-even"><td>destdir</td>
<td>string</td>
<td>name of destination directory</td>
<td>”.”</td>
</tr>
<tr class="row-odd"><td>complex</td>
<td>bool</td>
<td>Generates hierarchical MVC support</td>
<td>True</td>
</tr>
<tr class="row-even"><td>dist_gtkmvc</td>
<td>bool</td>
<td>If True, gtkmvc is embedded</td>
<td>True</td>
</tr>
<tr class="row-odd"><td>glade</td>
<td>bool</td>
<td>if glade files are going to be used or not</td>
<td>True</td>
</tr>
<tr class="row-even"><td>glade_fn</td>
<td>string</td>
<td>filename of generated glade file</td>
<td>application.glade</td>
</tr>
<tr class="row-odd"><td>src_header</td>
<td>string,None</td>
<td>Template for source header files.</td>
<td>None</td>
</tr>
<tr class="row-even"><td>other_comment</td>
<td>string</td>
<td>Additional comment pushed after headers</td>
<td> </td>
</tr>
<tr class="row-odd"><td>src_name</td>
<td>string</td>
<td>Name of the source directory</td>
<td>“src”</td>
</tr>
<tr class="row-even"><td>res_name</td>
<td>string</td>
<td>Name of the resources directory</td>
<td>“resources”</td>
</tr>
<tr class="row-odd"><td>top_widget</td>
<td>string</td>
<td>Name of the View’s top-level widget</td>
<td>“window_appl”</td>
</tr>
</tbody>
</table>
<p>Bottom part of the table contains less important properties. Python
module <tt class="docutils literal"><span class="pre">gtkmv.progen.templates</span></tt> contains default templates that
are used for headers, license, etc.</p>
<p>Boolean option <em>gui</em> can be used to select batch or gui
mode. Option <em>help</em> can be used to print out an helping message.</p>
<p><em>gtkmvc-progen</em> can be executed either locally (it is located
within the scripts directory), or can be executed as any other program
if <em>gtkmvc</em> has been properly installed on the hosting system.</p>
<p>From the local script directory:</p>
<div class="highlight-python"><pre>$> (...)/scripts/gtkmvc-progen param=val ...</pre>
</div>
<p>If <em>gtkmvc</em> was installed:</p>
<div class="highlight-python"><pre>$> gtkmvc-progen param=val ...</pre>
</div>
<p>Boolean properties can be specified in the form “param” or in the
form “param=[yes|no]”. Specifying boolean “param” or
“param=yes” is semantically equivalent.</p>
<p>For example:</p>
<div class="highlight-python"><pre>$> gtkmvc-progen name=hello author="Roberto Cavada" gui glade=no</pre>
</div>
<p>The result is the creation of the top-level directory whose name is
the project name. Inside a top-level script can be used to launch
the application.</p>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="adapt.html"
title="previous chapter">Adapters</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/progen.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="adapt.html" title="Adapters"
>previous</a> |</li>
<li><a href="index.html">Model-View-Controller and Observer patterns for PyGTK 1.99.1 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2010, Roberto Cavada.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
|