← Back to branch summary

~ubuntu-branches/ubuntu/vivid/regina-normal/vivid-proposed

« back to all changes in this revision

Viewing changes to kdeui/doc/en/data-packet-script.docbook

  • Committer: Package Import Robot
  • Author(s): Ben Burton
  • Date: 2011-09-10 07:17:25 UTC
  • mfrom: (1.2.4 upstream)
  • Revision ID: package-import@ubuntu.com-20110910071725-97n90tywdq60w2cr
Tags: 4.90-1
http://bugs.debian.org/556318
http://bugs.debian.org/624882
* New upstream release!
* The user interface has been ported from KDE3 to KDE4 (closes: #556318).
  Re-enabled the GUI as a result.
* The build system has been ported from autotools to cmake.
* The new upstream release builds fine on amd64 (closes: #624882).
* Moved the users' handbook into regina-normal-doc.
* Upgraded several suggests/recommends.  Upgraded regina-normal-mpi to
  depend on mpi-default-bin, and regina-normal to depend on both graphviz
  and regina-normal-doc (which the GUI expends to be present).  Upgraded
  regina-normal to recommend gap.
* Bumped standards-version to 3.9.2.0 (no changes required).

Show diffs side-by-side

added added

removed removed

Lines of Context:
kdeui/doc/en/data-packet-script.docbook
1
 
 
2
 
<!-- Regina data file format documentation.
3
 
     See ../regina.sgml for further details. -->
4
 
 
5
 
<refentry id="data-packet-script">
6
 
 <refmeta>
7
 
  <refentrytitle>packet (script)</refentrytitle>
8
 
  <manvolnum>5reg</manvolnum>
9
 
 </refmeta>
10
 
 
11
 
 <refnamediv>
12
 
  <refname>packet (script)</refname>
13
 
  <refpurpose>A script packet</refpurpose>
14
 
 </refnamediv>
15
 
 
16
 
 <refsynopsisdiv>
17
 
  <informaltable frame="all">
18
 
   <tgroup cols="2">
19
 
    <colspec colname="c1"/>
20
 
    <colspec colname="c2"/>
21
 
    <tbody>
22
 
     <row><entry namest="c1" nameend="c2">
23
 
      <emphasis role="bold">Content Model</emphasis>
24
 
     </entry></row>
25
 
     <row><entry namest="c1" nameend="c2">
26
 
<synopsis>
27
 
packet ::= (&xml-var;*, &xml-line;*,
28
 
            &xml-tag;*, &xml-packet;*)</synopsis>
29
 
     </entry></row>
30
 
     <row><entry namest="c1" nameend="c2">
31
 
      <emphasis role="bold">Attributes</emphasis>
32
 
     </entry></row>
33
 
     <row><entry namest="c1" nameend="c2">
34
 
      See the general &xml-packet; element documentation.
35
 
     </entry></row>
36
 
    </tbody>
37
 
   </tgroup>
38
 
  </informaltable>
39
 
 </refsynopsisdiv>
40
 
 
41
 
 <refsect1>
42
 
  <title>Description</title>
43
 
  <para>
44
 
   A <link linkend="packet-script">script packet</link> stores a
45
 
   <link linkend="python">&python; script</link> offering direct
46
 
   low-level access to the &regina; calculation engine.
47
 
  </para>
48
 
  <para>
49
 
   A script may contain variables representing other packets in the same
50
 
   packet tree; these are described by the child &xml-var; elements.
51
 
  </para>
52
 
  <para>
53
 
   The &python; script itself is broken into individual lines; each line
54
 
   is stored as an individual &xml-line; element.
55
 
  </para>
56
 
  <para>
57
 
   The roles played by the child &xml-tag; and &xml-packet; elements are
58
 
   described in the general &xml-packet; element documentation.
59
 
  </para>
60
 
 
61
 
  <refsect2>
62
 
   <title>Parents</title>
63
 
   <para>
64
 
    The following elements contain <sgmltag>packet</sgmltag>:
65
 
    <simplelist type="inline">
66
 
     <member>&xml-packet;</member>
67
 
     <member>&xml-reginadata;</member>
68
 
    </simplelist>.
69
 
   </para>
70
 
  </refsect2>
71
 
 
72
 
  <refsect2>
73
 
   <title>Children</title>
74
 
   <para>
75
 
    The following elements occur in <sgmltag>packet</sgmltag> for
76
 
    a script packet:
77
 
    <simplelist type="inline">
78
 
     <member>&xml-line;</member>
79
 
     <member>&xml-packet;</member>
80
 
     <member>&xml-tag;</member>
81
 
     <member>&xml-var;</member>
82
 
    </simplelist>.
83
 
   </para>
84
 
  </refsect2>
85
 
 </refsect1>
86
 
</refentry>