← Back to branch summary

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

« back to all changes in this revision

Viewing changes to kdeui/doc/regina-xml/data-flags.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/regina-xml/data-flags.docbook
 
1
 
 
2
<!-- Regina data file format documentation.
 
3
     See ../regina.sgml for further details. -->
 
4
 
 
5
<refentry id="data-flags">
 
6
 <refmeta>
 
7
  <refentrytitle>flags</refentrytitle>
 
8
  <manvolnum>5reg</manvolnum>
 
9
 </refmeta>
 
10
 
 
11
 <refnamediv>
 
12
  <refname>flags</refname>
 
13
  <refpurpose>An arbitrary set of flags</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
flags ::=</synopsis>
 
28
     </entry></row>
 
29
     <row><entry namest="c1" nameend="c2">
 
30
      <emphasis role="bold">Attributes</emphasis>
 
31
     </entry></row>
 
32
     <row>
 
33
      <entry><emphasis role="bold">Name</emphasis></entry>
 
34
      <entry><emphasis role="bold">Type</emphasis></entry>
 
35
     </row>
 
36
     <row>
 
37
      <entry><sgmltag>value</sgmltag></entry>
 
38
      <entry><type>NUMBER</type> (required)</entry>
 
39
     </row>
 
40
    </tbody>
 
41
   </tgroup>
 
42
  </informaltable>
 
43
 </refsynopsisdiv>
 
44
 
 
45
 <refsect1>
 
46
  <title>Description</title>
 
47
  <para>
 
48
   A &xml-flags; element stores an arbitrary set of flags combined into
 
49
   a single integer.
 
50
  </para>
 
51
 
 
52
  <refsect2>
 
53
   <title>Parents</title>
 
54
   <para>
 
55
    The following elements contain <sgmltag>flags</sgmltag>:
 
56
    <simplelist type="inline">
 
57
     <member>&xml-struct;</member>
 
58
    </simplelist>.
 
59
   </para>
 
60
  </refsect2>
 
61
 
 
62
  <refsect2>
 
63
   <title>Children</title>
 
64
   <para>
 
65
    Element <sgmltag>flags</sgmltag> has no children.
 
66
   </para>
 
67
  </refsect2>
 
68
 </refsect1>
 
69
 
 
70
 <refsect1>
 
71
  <title>Attributes</title>
 
72
  <variablelist>
 
73
   <varlistentry>
 
74
    <term><sgmltag>value</sgmltag></term>
 
75
    <listitem>
 
76
     <para>
 
77
      A single integer containing the values of all the flags under
 
78
      consideration.  Generally these flags take boolean values (or
 
79
      belong to very small enumerations) and are thus stored as
 
80
      individual bits (or small clumps of bits) in this integer's binary
 
81
      representation.
 
82
     </para>
 
83
    </listitem>
 
84
   </varlistentry>
 
85
  </variablelist>
 
86
 </refsect1>
 
87
</refentry>