File: simplyhtml.sgml

package info (click to toggle)
simplyhtml 0.13.1-1
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 2,632 kB
  • ctags: 2,105
  • sloc: java: 14,833; xml: 1,082; sh: 140; haskell: 34; makefile: 28
file content (231 lines) | stat: -rw-r--r-- 7,925 bytes parent folder | download | duplicates (3)
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
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@

    
	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Eric</firstname>">
  <!ENTITY dhsurname   "<surname>Lavarde</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>2006-11-17</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>deb@zorglub.s.bawue.de</email>">
  <!ENTITY dhusername  "Eric Lavarde">
  <!ENTITY dhucpackage "<refentrytitle>SIMPLYHTML</refentrytitle>">
  <!ENTITY dhpackage   "simplyhtml">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2006</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>A Java editor based on HTML and CSS.</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>

      <arg>no_options</arg>

    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents briefly the
      <command>&dhpackage;</command> command.</para>

    <para>This manual page was written for the &debian; distribution
      because the original program does not have a manual page.
      Instead, it has online documentation (see Help menu in
      SimplyHTML).</para>

    <refsect2>
      <title>Project Description</title>

      <para>With project SimplyHTML an application is built for working with text documents. Text documents are stored in HTML and CSS format, but the application is meant as a word processor rather than a code editor or web site builder.</para>

    </refsect2>
    <refsect2>
      <title>Open to the maximum</title>

      <para>SimplyHTML is built with the aim to document as much of its functionality and usage as possible. The application is written in Java and distributed with full source codes.</para>

      <para>By using Java, HTML, CSS and PDF all parts of the project are 100% platform independent and can be used on almost any machine.</para>

    </refsect2>
    <refsect2>
      <title>Extensive documentation</title>

      <para>Source codes are commented in Javadoc format and additional inline comments. The sources are created with good legibility and structure in mind.</para>

      <para>In addition, an extensive tutorial is delivered covering both usage of the application and its internals. The tutorial is available in JavaHelp format and can be used as online help out of SimplyHTML. Or it can be read with a plain web browser. A PDF version of the tutorial is avalable too.</para>

    </refsect2>
    <refsect2>
      <title>Why another HTML editor?</title>

      <para>SimplyHTML is not an HTML editor in first place. It is a text processing application being based on HTML and CSS files.</para>

      <para>Although it has a simple HTML editor built in as well, the application focuses on text processing rather than web page creation.</para>

      <para>SimplyHTML tries to distinguish from comparable applications by combining simplicity, ease of use and transparency for both users and developers.</para>

    </refsect2>
  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <para>This program does not have any option. Just start it!</para>

  </refsect1>
  <refsect1>
    <title>ENVIRONMENT VARIABLES</title>
    <variablelist>
      <varlistentry>
        <term><option>DEBUG</option>
        </term>
        <listitem>
          <para>If  this environment variable is set, SimplyHTML gives more
	  information on how it finds its different elements, as well as some
	      other information.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>JAVACMD</option>
        </term>
        <listitem>
          <para>Default value for the java virtual machine (the java command).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>JAVA_BINDIR</option>
        </term>
        <listitem>
          <para>If $JAVACMD is not set, the java virtual machine is searched
              under $JAVA_BINDIR/java.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>JAVA_HOME</option>
        </term>
        <listitem>
          <para>If $JAVACMD and $JAVA_BINDIR are not set, the java virtual
              machine is searched under $JAVA_HOME/bin/java.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>PATH</option>
        </term>
        <listitem>
          <para>If all $JAVA... environment variables fail, the java virtual
              machine command (java) is searched in the $PATH (with which).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>CLASSPATH</option>
	  <option>ADD_JARS</option>
        </term>
        <listitem>
          <para>The $CLASSPATH variable also lets one specify additional jars,
              which is good, if you want to add a new Look&amp;Feel jar (the motif
              one is so ugly...). Alternatively, the content of $ADD_JARS will
              be prepended to $CLASSPATH.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>FILES</title>
    <variablelist>
      <varlistentry>
        <term><option>/usr/bin/java</option>
        </term>
        <listitem>
           <para>If all searches through environment variables fail, the
	   java virtual machine is expected to be /usr/bin/java; if not,
	   simplyhtml exits with an error.
	      </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>
    <para>The online documentation under http://simplyhtml.sf.net/,
    especially the Linux related one under the Wiki page link
    http://simplyhtml.sourceforge.net/wiki/index.php/SimplyHTML_on_Linux.</para>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &dhemail; for
      the &debian; system (but may be used by others).  Permission is
      granted to copy, distribute and/or modify this document under
      the terms of the &gnu; General Public License, Version 2 any 
	  later version published by the Free Software Foundation.
    </para>
	<para>
	  On Debian systems, the complete text of the GNU General Public
	  License can be found in /usr/share/common-licenses/GPL.
	</para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->