office/okular
office/okular
1
0
Fork 0
mirror of https://invent.kde.org/graphics/okular synced 2024-08-25 10:55:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update/proofread Okular docbooks to kf5

Browse source 
remove entities kappname, package, PDF - unused or already defined in kdoctools
bum date + releaseinfo - is version 1.0 correct for 16.12?
add missing shortcuts
add 'Drawing Tool Configuration'
remove appendix installation
update man page - remove kde4 options + add qt5options+kf5options
REVIEW:129326
This commit is contained in:
Burkhard Lück 2016-11-11 15:26:07 +01:00
parent 3107e544b4
commit 3f8d9f760c
2 changed files with 29 additions and 130 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

86
doc/index.docbook
View file

@ -1,10 +1,7 @@
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
<!ENTITY kappname "&okular;">
<!ENTITY latex "L<superscript>A</superscript>T<subscript>E</subscript>X">
<!ENTITY package "kdegraphics">
<!ENTITY kpdf "<application>KPDF</application>">
<!ENTITY PDF "<acronym>PDF</acronym>">
<!ENTITY % English "INCLUDE">
<!ENTITY % addindex "IGNORE">
]>
@ -37,8 +34,8 @@ Context menu actions like Rename Bookmarks etc.)
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<legalnotice>&FDLNotice;</legalnotice>
<date>2016-07-26</date>
<releaseinfo>0.26 (Applications 16.08)</releaseinfo>
<date>2016-11-04</date>
<releaseinfo>1.0 (Applications 16.12)</releaseinfo>
<!-- Abstract about this handbook -->
<abstract>
<para>&okular; is a &kde; universal document viewer based on &kpdf; code.</para>
@ -889,42 +886,7 @@ Context menu actions like Rename Bookmarks etc.)
<variablelist>
<varlistentry>
<term><userinput><command>okular</command>
<option>--help</option></userinput></term>
<listitem><para>This lists the most basic options available at the command line.</para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>okular</command>
<option>--help-qt</option></userinput></term>
<listitem><para>This lists the options available for changing the way &okular; interacts with &Qt;.</para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>okular</command>
<option>--help-kde</option></userinput></term>
<listitem><para>This lists the options available for changing the way &okular; interacts with &kde;.</para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>okular</command>
<option>--help-all</option></userinput></term>
<listitem><para>This lists all of the command line options.</para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>okular</command>
<option>--author</option></userinput></term>
<listitem><para>Lists &okular;'s authors in the terminal window</para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>okular</command>
<option>-v, --version</option></userinput></term>
<listitem><para>Lists version information for &Qt;, &kde;, and &okular;. Also available through <userinput><command>okular</command> <option>-v</option></userinput> </para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>okular</command>
<option>--license</option></userinput></term>
<listitem><para>Shows license information.</para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>okular</command>
<option>--page <replaceable>number</replaceable></option></userinput></term>
<option>-p --page <replaceable>number</replaceable></option></userinput></term>
<listitem><para>Open a page with a given number in the document. Also available through <userinput><command>okular</command> <option>-p <replaceable>number</replaceable></option></userinput></para></listitem>
</varlistentry>
<varlistentry>
@ -946,12 +908,7 @@ Context menu actions like Rename Bookmarks etc.)
<term><userinput><command>okular</command>
<option>--noraise</option></userinput></term>
<listitem><para>Allows to prevent &okular; window raising after the start.</para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>okular</command>
<option>--</option></userinput></term>
<listitem><para>End of options.</para></listitem>
</varlistentry>
</varlistentry>
</variablelist>
</sect2>
</sect1>
@ -1037,6 +994,9 @@ Context menu actions like Rename Bookmarks etc.)
<varlistentry>
<term>
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Save As...</guimenuitem>
</menuchoice>
@ -1054,6 +1014,9 @@ Context menu actions like Rename Bookmarks etc.)
<varlistentry>
<term>
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;&Shift;<keycap>S</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Save Copy As...</guimenuitem>
</menuchoice>
@ -2272,12 +2235,6 @@ Context menu actions like Rename Bookmarks etc.)
<para>The color that will fill the part of the screen not covered by the page when on presentation mode.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Pencil color</guilabel></term>
<listitem>
<para>The color of the pencil used when drawing on the pages during the presentation mode.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Mouse cursor</guilabel></term>
<listitem>
@ -2319,6 +2276,12 @@ Context menu actions like Rename Bookmarks etc.)
<para><guilabel>Screen 0</guilabel>, <guilabel>Screen 1</guilabel> &etc; are the available screens.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Drawing Tool Configuration</guilabel></term>
<listitem>
<para>Manage the colors of the pencil used when drawing on the pages during the presentation mode.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="configannotations">
@ -2440,23 +2403,6 @@ Context menu actions like Rename Bookmarks etc.)
&underGPL;
</chapter>
<appendix id="installation">
<title>Installation</title>
<sect1 id="getting-kapp">
<title>How to obtain &okular;</title>
&install.intro.documentation;
</sect1>
<sect1 id="compilation">
<title>Compilation and Installation</title>
<note>
<para>
If you are reading this help in the &khelpcenter;, &okular; has already been
installed on this system and you do not need install it anymore.
</para>
</note>
&install.compile.documentation;
</sect1>
</appendix>
&documentation.index;
</book>

73
doc/man-okular.1.docbook
View file

@ -6,12 +6,13 @@
<!-- Please keep this man page content in sync with Command Line Options sections of Okular handbook -->
<refentry lang="&language;">
<refentryinfo>
<title>KDE User's Manual</title>
<title>Okular User's Manual</title>
<author><firstname>Yuri</firstname><surname>Chornoivan</surname>
<contrib>Okular man page.</contrib>
<email>yurchor@ukr.net</email></author>
<date>2013-03-09</date>
<productname>K Desktop Environment</productname>
<date>2016-11-04</date>
<releaseinfo>Okular 1.0</releaseinfo>
<productname>KDE Applications</productname>
</refentryinfo>
<refmeta>
@ -26,8 +27,7 @@
<!-- body begins here -->
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
<command>okular</command> <arg choice="opt"><replaceable>Qt-options</replaceable></arg>
<arg choice="opt"><replaceable>KDE-options</replaceable></arg>
<command>okular</command>
<arg choice="opt"><replaceable>Okular options</replaceable></arg>
<arg choice="opt"><replaceable>URL</replaceable></arg>
</cmdsynopsis>
@ -40,59 +40,6 @@ is aimed to show documents in different formats.</para>
</refsect1>
<refsect1 id="generic_options"><title>Generic Options</title>
<variablelist>
<varlistentry>
<term><option>--help</option></term>
<listitem>
<para>Show help about options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--help-qt</option></term>
<listitem>
<para>Show Qt specific options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--help-kde</option></term>
<listitem>
<para>Show KDE specific options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--help-all</option></term>
<listitem>
<para>Show all options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--author</option></term>
<listitem>
<para>Show author information.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-v, --version</option></term>
<listitem>
<para>Show version information.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--license</option></term>
<listitem>
<para>Show license information.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--</option></term>
<listitem>
<para>End of options.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="options"><title>Okular options</title>
<variablelist>
<varlistentry>
@ -145,11 +92,17 @@ is aimed to show documents in different formats.</para>
<refsect1>
<title>See Also</title>
<para>More detailed user documentation is available from <ulink
<simplelist>
<member>More detailed user documentation is available from <ulink
url="help:/okular">help:/okular</ulink>
(either enter this <acronym>URL</acronym> into &konqueror;, or run
<userinput><command>khelpcenter</command>
<parameter>help:/okular</parameter></userinput>).</para>
<parameter>help:/okular</parameter></userinput>).</member>
<member>kf5options(7)</member>
<member>qt5options(7)</member>
<member>There is also further information available at
<ulink url="http://okular.kde.org/">http://okular.kde.org/</ulink></member>
</simplelist>
</refsect1>
<refsect1 id="copyright"><title>Copyright</title>