[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-commits
Subject: branches/work/kviewshell-0.7/doc/kviewshell
From: Stefan Kebekus <kebekus () kde ! org>
Date: 2006-09-07 6:37:13
Message-ID: 1157611033.317567.22588.nullmailer () svn ! kde ! org
[Download RAW message or body]
SVN commit 581687 by kebekus:
rewrote intro, chapter on starting
M +108 -76 index.docbook
--- branches/work/kviewshell-0.7/doc/kviewshell/index.docbook #581686:581687
@@ -9,7 +9,7 @@
<book lang="&language;">
<bookinfo>
- <title>The &kdvi; Handbook</title>
+ <title>The &kviewshell; Handbook</title>
<authorgroup>
<author>
<firstname>Stefan</firstname>
@@ -46,100 +46,132 @@
<chapter id="introduction">
<title>Introduction</title>
- <para>&kdvi; is a plugin for the &kviewshell; program which allows
- &kviewshell; to display &DVI;-files (<literal
- role="extension">.dvi</literal>) which are produced by the TeX
- typesetting system. &kdvi; supports many extensions of the &DVI;
- standard, for instance the inclusion of &PostScript; graphics or
- hyperlinks. More details, examples and all the technical
- specifications can be found in the file
- <filename>KDVI-features.dvi</filename> (or see
- <filename>KDVI-features.tex</filename> for the TeX source of that
- file).</para>
-
- <para>For up-to-date information, consult <ulink
- url="http://devel-home.kde.org/~kdvi">&kdvi;'s home page</ulink>.
+ <para>
+ &kviewshell; is a generic document viewing application that allows to \
conveniently view documents in a large number of file formats --currently files in \
PDF, DJVU, DVI, EPS, PS, and Multipage-Tiff are supported. </para>
- <para>TeX is a high-end typesetting system geared towards
- scientific, and in particular mathematical typesetting. More
- information about TeX and &DVI; can be found on the <ulink
- url="http://www.tug.org">homepage of the TeX user group</ulink> or
- the German <ulink url="http://www.dante.de">German DANTE
- e.V.</ulink>.
+ <para>
+ The various file formats are supported by plugins, i.e. sub-programs that \
&kviewshell; uses internally. Plugins can later be added to extend &kviewshell;. Many \
plugins support extra features. For instance, the PDF-plugin allows to assemble \
documents and edit the author information contained in a file. The &DVI; plugin \
supports features such as forward and inverse search. </para>
- </chapter>
+ </chapter>
<chapter id="starting">
- <title>Starting &kdvi;</title>
+ <title>Starting &kviewshell;</title>
- <para>Most of the time, &kdvi; will be started by just clicking
- onto a <literal role="extension">.dvi</literal> file in the file
- manager. For convenience there exists a command
- <command>kdvi</command> which calls &kviewshell; with the &kdvi;
- plugin preloaded. The viewer may thus be started using the command
- <userinput><command>kdvi</command>
- <parameter>somepath/paper.dvi</parameter></userinput>. The command
- lines <userinput><command>kdvi</command>
- <parameter>somepath/paper</parameter></userinput> or
- <userinput><command>kdvi</command>
- <parameter>somepath/paper.</parameter></userinput> will also
- work. If you are connected to the internet, you can access files
- which reside on other computers by giving a &URL; as a parameter,
- like this: <userinput><command>kdvi</command>
- <parameter>http://somepath/paper.dvi</parameter></userinput>
+ <para>
+ Most of the time, &kviewshell; will be started by just clicking onto a document \
file in the file manager. The viewer may also be started using the command </para>
+ <para>
+ <userinput><command>kviewshell</command> \
<parameter>somepath/paper.dvi</parameter></userinput> + </para>
+ <para>
+ The command lines
+ </para>
+ <para>
+ <userinput><command>kviewshell</command> \
<parameter>somepath/paper</parameter></userinput> + </para>
+ <para>
+ or
+ </para>
+ <para>
+ <userinput><command>kviewshell</command> \
<parameter>somepath/paper.</parameter></userinput> + </para>
+ <para>
+ will also work. If you are connected to the internet, you can access files which \
reside on other computers by giving a &URL; as a parameter, like this: + </para>
+ <para>
+ <userinput><command>kviewshell</command> \
<parameter>http://somepath/paper.dvi</parameter></userinput> + </para>
- <para>If you give a &URL; as a parameter, you can tell &kdvi; to
- jump directly to certain place of the &DVI; file.
- For example, <userinput><command>kdvi</command>
- <parameter>file:paper.dvi#43</parameter></userinput> will make
- &kdvi; to open page 43. If you have included source file
- information, a command like <userinput><command>kdvi</command>
- <parameter>file:paper.dvi#src:43paper.tex</parameter></userinput>
- will make &kdvi; search for the place in the &DVI; file which
- corresponds to line 43 in the TeX file
- <parameter>paper.tex</parameter>. You will hardly use this option
- yourself — read the section on <link
- linkend="forward-search">forward search</link> to learn how to
- set up your editor to start &kdvi; automatically.
+ <para>If you give a &URL; as a parameter, you can tell &kviewshell; to jump \
directly to certain place of the &DVI; file. + For example,
</para>
-
- <warning><para>Don't forget the <userinput>file:</userinput>
- prefix or it will give unexpected results. For example, the command
- <userinput><command>kdvi</command>
- <parameter>file:paper.dvi#43</parameter></userinput> will open
- page 43 of the file <filename>paper.dvi</filename>. The command
- <userinput><command>kdvi</command>
- <parameter>paper.dvi#43</parameter></userinput> will try to open
- the file <filename>paper.dvi#43</filename>.</para>
- </warning>
-
- <para>There is another option which you will most likely not need
- to specify yourself. If you type
- <userinput><command>kdvi</command> <parameter>--unique</parameter>
- <parameter>somepath/paper.dvi</parameter></userinput>, &kdvi; will
- load the file if there is no other instance running which has the
- file already loaded. If there is, this instance of &kdvi; will pop
- to the front. A command like <userinput><command>kdvi</command>
- <parameter>--unique</parameter>
- <parameter>file:paper.dvi#43</parameter></userinput> can be used
- in shell scripts to make a running instance of &kdvi; to jump to
- page 43.</para>
-
- <para>The usual parameters handled by &Qt; and &kde; applications
- also work: <userinput><command>kdvi</command>
+ <para>
+ <userinput><command>kviewshell</command> \
<parameter>file:paper.dvi#43</parameter></userinput> + </para>
+ <para>
+ will make &kviewshell; to open page 43.
+ </para>
+ <para>
+ The usual parameters handled by &Qt; and &kde; applications also work:
+ </para>
+ <para>
+ <userinput><command>kviewshell</command>
<option>-style</option> <parameter>windows</parameter>
<option>-display</option> <parameter>:0</parameter>
<option>-geometry</option> <parameter>400x400+0+0</parameter>
<option>-caption</option> <parameter>"DVI"</parameter></userinput>
</para>
+
+ <para>
+ There is another option which you will most likely not need
+ to specify yourself. If you type
+ </para>
+ <para>
+ <userinput><command>kviewshell</command> <parameter>--unique</parameter> \
<parameter>somepath/paper.dvi</parameter></userinput>, + </para>
+ <para>
+ &kviewshell; will load the file if there is no other instance running which has \
the file already loaded. If there is, this instance of &kviewshell; will pop to the \
front. A command like + </para>
+ <para>
+ <userinput><command>kviewshell</command>
+ <parameter>--unique</parameter>
+ <parameter>file:paper.dvi#43</parameter></userinput>
+ </para>
+ <para>
+ can be used in shell scripts to make a running instance of &kdvi; to jump to \
page 43. + </para>
+
+<section id="dvi-options">
+ <title>Options when opening DVI files</title>
+ <para>
+ If you open a DVI file, and TeX source file informationis included in the file, \
then a command like + </para>
+ <para>
+ <userinput><command>kviewshell</command> \
<parameter>file:paper.dvi#src:43paper.tex</parameter></userinput> + </para>
+ <para>
+ will make &kviewshell; search for the place in the &DVI; file which corresponds \
to line 43 in the TeX source file <parameter>paper.tex</parameter>. You will hardly \
use this option yourself — read the section on <link \
linkend="forward-search">forward search</link> to learn how to set up your editor to \
start &kviewshell; automatically. + </para>
+
+ <warning>
+ <para>
+ Don't forget the <userinput>file:</userinput> prefix or it will give unexpected \
results. For example, the command + </para>
+ <para>
+ <userinput><command>kviewshell</command>
+ <parameter>file:paper.dvi#43</parameter></userinput>
+ </para>
+ <para>
+ will open page 43 of the file <filename>paper.dvi</filename>. The command
+ </para>
+
+ <para>
+ <userinput><command>kviewshell</command>
+ <parameter>paper.dvi#43</parameter></userinput>
+ </para>
+ <para>
+ will try to open the file <filename>paper.dvi#43</filename>.
+ </para>
+ </warning>
+</section>
</chapter>
<chapter id="DVI">
<title>The &DVI; Plugin</title>
+<section id="dvi-intro">
+ <title>Introduction</title>
+ <para>The &DVI; plugin allows &kviewshell; to display &DVI;-files (<literal \
role="extension">.dvi</literal>) which are produced by the TeX typesetting system. \
&kdvi; supports many extensions of the &DVI; standard, for instance the inclusion of \
&PostScript; graphics or hyperlinks. More details, examples and all the technical \
specifications can be found in the file <filename>KDVI-features.dvi</filename> (or \
see <filename>KDVI-features.tex</filename> for the TeX source of that file).</para> +
+ <para>For up-to-date information, consult <ulink \
url="http://devel-home.kde.org/~kdvi">&kdvi;'s home page</ulink>. + </para>
+
+ <para>TeX is a high-end typesetting system geared towards scientific, and in \
particular mathematical typesetting. More information about TeX and &DVI; can be \
found on the <ulink url="http://www.tug.org">homepage of the TeX user group</ulink> \
or the German <ulink url="http://www.dante.de">German DANTE e.V.</ulink>. + \
</para> + </section>
+
<section id="print">
<title>Printing &DVI; Files</title>
@@ -1023,7 +1055,7 @@
</section>
</chapter>
- <chapter id="credits-and-license">
+<chapter id="credits-and-license">
<title>Credits and Licenses</title>
<para>&kdvi;</para>
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic