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

« back to all changes in this revision

Viewing changes to kdeui/doc/en/data-realbdry-filter.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
* 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:
1
 
 
2
 
<!-- Regina data file format documentation.
3
 
     See ../regina.sgml for further details. -->
4
 
 
5
 
<refentry id="data-realbdry-filter">
6
 
 <refmeta>
7
 
  <refentrytitle>realbdry (filter)</refentrytitle>
8
 
  <manvolnum>5reg</manvolnum>
9
 
 </refmeta>
10
 
 
11
 
 <refnamediv>
12
 
  <refname>realbdry (filter)</refname>
13
 
  <refpurpose>A constraint on real boundary</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
 
realbdry ::=</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>CDATA</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-realbdry-filter; element represents a constraint on the
49
 
   boundary of a normal surface.  A surface with real boundary
50
 
   is one that meets one or more boundary faces of the underlying
51
 
   triangulation.
52
 
  </para>
53
 
 
54
 
  <refsect2>
55
 
   <title>Parents</title>
56
 
   <para>
57
 
    The following elements contain <sgmltag>realbdry</sgmltag> (in the
58
 
    context of a constraint on surface properties):
59
 
    <simplelist type="inline">
60
 
     <member>&xml-filter-properties;</member>
61
 
    </simplelist>.
62
 
   </para>
63
 
  </refsect2>
64
 
 
65
 
  <refsect2>
66
 
   <title>Children</title>
67
 
   <para>
68
 
    Element <sgmltag>realbdry</sgmltag> (in the context of a
69
 
    constraint on surface properties) has no children.
70
 
   </para>
71
 
  </refsect2>
72
 
 </refsect1>
73
 
 
74
 
 <refsect1>
75
 
  <title>Attributes</title>
76
 
  <variablelist>
77
 
   <varlistentry>
78
 
    <term><sgmltag>value</sgmltag></term>
79
 
    <listitem>
80
 
     <para>
81
 
      Contains the specific constraint upon the boundary of a surface.
82
 
      The following values are allowed.
83
 
      <itemizedlist>
84
 
       <listitem><para>
85
 
        <literal>TF</literal> signifies that the surface may either
86
 
        have real boundary or may not, i.e., no constraint is imposed.
87
 
       </para></listitem>
88
 
       <listitem><para>
89
 
        <literal>T-</literal> signifies that the surface must have real
90
 
        boundary.
91
 
       </para></listitem>
92
 
       <listitem><para>
93
 
        <literal>-F</literal> signifies that the surface must not have
94
 
        real boundary.
95
 
       </para></listitem>
96
 
       <listitem><para>
97
 
        <literal>--</literal> signifies that the surface must neither
98
 
        have real boundary nor not have real boundary, i.e., no surfaces
99
 
        are accepted.
100
 
       </para></listitem>
101
 
      </itemizedlist>
102
 
     </para>
103
 
    </listitem>
104
 
   </varlistentry>
105
 
  </variablelist>
106
 
 </refsect1>
107
 
</refentry>