[graphics/okular/release/26.08] doc: Update documentation
Sune Vuorela
null at kde.org
Tue Jul 7 09:48:31 BST 2026
Git commit 03ba98f067076dcda17747f3a5a90b7b02a11f10 by Sune Vuorela.
Committed on 07/07/2026 at 07:52.
Pushed by sune into branch 'release/26.08'.
Update documentation
(cherry picked from commit a0f8df459795a254760e25b6fe19cb757c9cf625)
D +- -- doc/configure-backends.png
M +- -- doc/configure.png
M +164 -189 doc/index.docbook
https://invent.kde.org/graphics/okular/-/commit/03ba98f067076dcda17747f3a5a90b7b02a11f10
diff --git a/doc/configure-backends.png b/doc/configure-backends.png
deleted file mode 100644
index fae37793d..000000000
Binary files a/doc/configure-backends.png and /dev/null differ
diff --git a/doc/configure.png b/doc/configure.png
index 83ed4eaf9..cda6d2d7f 100644
Binary files a/doc/configure.png and b/doc/configure.png differ
diff --git a/doc/index.docbook b/doc/index.docbook
index 5655e3be5..1bffbd933 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -486,7 +486,7 @@ Context menu actions like Rename Bookmarks etc.)
<listitem><para>The current user <filename>$HOME/.pki/nssdb</filename></para></listitem>
</itemizedlist>
<para>
- If you want to use a custom certificate store you can do so by setting it in the <link linkend="config-pdf-digital-signatures">&PDF; Backend Configuration</link> section of the <link linkend="configure-backends">Configure Backends...</link> dialog.
+ If you want to use a custom certificate store you can do so by setting it in the <link linkend="config-pdf-digital-signatures">&PDF; Backend Configuration</link> section of the <link linkend="configure-backends">Configure Okular...</link> dialog.
</para>
<note>
<para>
@@ -2285,194 +2285,10 @@ Context menu actions like Rename Bookmarks etc.)
<para><action>Toggle the page bar</action> at the bottom of document area on and off to save vertical place in &okular; window. Note that the page numbers will be shown on the default toolbar anyway.</para>
</listitem>
</varlistentry>
- <varlistentry>
- <term>
- <menuchoice>
- <guimenu>Settings</guimenu>
- <guimenuitem>Configure Backends...</guimenuitem>
- </menuchoice>
- </term>
- <listitem>
- <para>Opens the <link linkend="configure-backends">Backend Configuration</link>
- window.</para>
- </listitem>
- </varlistentry>
</variablelist>
</sect1>
</chapter>
- <chapter id="configure-backends">
- <title>Configuring &okular; Backends</title>
- <para>
- You can configure &okular; backends by choosing <menuchoice>
- <guimenu>Settings</guimenu>
- <guimenuitem>Configure Backends...</guimenuitem>
- </menuchoice>.
- Currently, configuration options are provided for EPub, &PostScript;, FictionBook, Txt, OpenDocument Text, and &PDF; backends only.
- </para>
- <screenshot>
- <screeninfo>The backends configuration dialog</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="configure-backends.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>The backends configuration dialog</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
- <para>
- Using backend configuration pages for EPub, FictionBook, Mobipocket, Markdown, TXT, and OpenDocument Text you can define the font to render documents in the corresponding formats. The <guibutton>Choose...</guibutton> button in these pages opens standard &kde; font configuration window. Please refer to the <ulink url="help:/fundamentals/fonts.html">&kde; Fundamentals documentation</ulink> for the details.
- </para>
- <para>
- The description of Markdown, &PostScript; and &PDF; backends configuration pages can be found below.
- </para>
- <sect1 id="config-markdown">
- <title>Markdown backend configuration</title>
- <para>
- You can configure &okular; Markdown rendering backend based on <ulink url="https://www.pell.portland.or.us/~orc/Code/markdown/">Discount</ulink> by choosing <guilabel>Markdown</guilabel> from the list on the left part of the configuration dialog. An additional configurable option is as follows.
- </para>
- <para>
- <variablelist>
- <varlistentry>
- <term>
- <guilabel>Enable SmartyPants formatting</guilabel>
- </term>
- <listitem>
- <para>When checked this option allows &okular; to process <ulink url="https://daringfireball.net/projects/smartypants/">SmartyPants</ulink> formatting. Such formatting can be troublesome in the technical texts because of unwanted substitutions (⪚, it replaces <literal>(C)</literal> with a copyright symbol). This option is checked by default.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </sect1>
- <sect1 id="config-ghostscript">
- <title>&PostScript; backend configuration</title>
- <para>
- You can configure &okular; &PostScript; rendering backend based on <ulink url="https://www.ghostscript.com/">Ghostscript</ulink> by choosing <guilabel>Ghostscript</guilabel> from the list on the left part of the configuration dialog. The only configurable option is as follows.
- </para>
- <para>
- <variablelist>
- <varlistentry>
- <term>
- <guilabel>Use platform fonts</guilabel>
- </term>
- <listitem>
- <para>This option determines whether Ghostscript should be allowed to use platform fonts, if unchecked only usage of fonts embedded in the document will be allowed. This option is checked by default.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </sect1>
- <sect1 id="config-pdf">
- <title>&PDF; backend configuration</title>
- <para>
- You can configure &okular; &PDF; rendering backend based on <ulink url="https://poppler.freedesktop.org/">Poppler</ulink> by choosing <guilabel>&PDF;</guilabel> from the list on the left part of the configuration dialog. The only configurable option is as follows.
- </para>
- <para>
- <variablelist>
- <varlistentry>
- <term>
- <guilabel>Enhance thin lines</guilabel>
- </term>
- <listitem>
- <para>
[suppressed due to size limit]
- </para>
- <informaltable>
- <tgroup cols="2">
- <tbody>
- <row>
- <entry>
- <para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="enhance-thinline.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </para>
- </entry>
- <entry>
- <para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="enhance-lowcontrast.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </para>
- </entry>
- </row>
- <row>
- <entry>Thin line (red), its clipping path (dashed line) and pixel boundaries (black solid lines)</entry>
- <entry>Thin line shown at a low contrast</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- <para>
- To enhance the look of the thin lines &okular; implements two options.
- </para>
- <para>
- The first option is <guimenuitem>Solid</guimenuitem>. With this option &okular; adjusts clipping path and line position so that clipping path and line are on the same pixel boundary, &ie; &okular; enlarges the thin lines to one pixel on the output device. This mode is similar to the <guilabel>Enhance thin lines</guilabel> in <trademark class="registered">Adobe</trademark>
- <trademark class="registered">Reader</trademark>. If this option is chosen, the thin lines are always enlarged.
- </para>
- <para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="enhance-solid.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase>Thin line with <guimenuitem>Solid</guimenuitem> enhancement</phrase>
- </textobject>
- <caption>
- <para>Thin line with <guimenuitem>Solid</guimenuitem> enhancement</para>
- </caption>
- </mediaobject>
- </screenshot>
- </para>
- <para>
- The second option is <guimenuitem>Shape</guimenuitem>. With this option the clipping path and line are adjusted to pixel boundary as well, but the line intensity is corrected according to its width.
- </para>
- <para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="enhance-shape.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase>Thin line with <guimenuitem>Shape</guimenuitem> enhancement</phrase>
- </textobject>
- <caption>
- <para>Thin line with <guimenuitem>Shape</guimenuitem> enhancement</para>
- </caption>
- </mediaobject>
- </screenshot>
- </para>
- <para>
- The thin lines are not enhanced by default (option <guimenuitem>No</guimenuitem>).
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- <sect2 id="config-pdf-digital-signatures">
- <title>&PDF; Digital Signature Certificates</title>
- <para>
- <screenshot><mediaobject><imageobject><imagedata fileref="config-pdf-digital-signatures.png" format="PNG"/></imageobject></mediaobject></screenshot>
- This section allows you to set a custom Certificate Database to use when adding Digital Signatures to &PDF; files.
- </para>
- <para>
- It also lists the certificates available in the current Certificate Database (if any).
- </para>
- </sect2>
- </sect1>
- </chapter>
<chapter id="configure">
<title>Configuring &okular;</title>
<sect1 id="configindex">
@@ -2515,10 +2331,8 @@ Context menu actions like Rename Bookmarks etc.)
</mediaobject>
</screenshot>
<para>
- Depending on the currently installed backends, the <menuchoice><guimenu>Settings</guimenu>
- <guimenuitem>Configure Backends...</guimenuitem></menuchoice> menu item could be enabled.
- This particular configuration dialog holds the configurations of the backends that can
- actually be configured.
+ Depending on the currently installed backends, the dialog also contains a list of the backends that
+ has configuration options.
</para>
</sect1>
<sect1 id="configgeneral">
@@ -3022,6 +2836,167 @@ Context menu actions like Rename Bookmarks etc.)
</varlistentry>
</variablelist>
</sect1>
+ <sect1 id="configure-backends">
+ <title>Configuring &okular; Backends</title>
+ <para>
+ You can configure &okular; backends by choosing <menuchoice>
+ <guimenu>Settings</guimenu>
+ <guimenuitem>Configure Okular...</guimenuitem>
+ </menuchoice>.
+ Currently, configuration options are provided for EPub, &PostScript;, FictionBook, Txt, OpenDocument Text, and &PDF; backends only.
+ </para>
+ <para>
+ Using backend configuration pages for EPub, FictionBook, Mobipocket, Markdown, TXT, and OpenDocument Text you can define the font to render documents in the corresponding formats. The <guibutton>Choose...</guibutton> button in these pages opens standard &kde; font configuration window. Please refer to the <ulink url="help:/fundamentals/fonts.html">&kde; Fundamentals documentation</ulink> for the details.
+ </para>
+ <para>
+ The description of Markdown, &PostScript; and &PDF; backends configuration pages can be found below.
+ </para>
+ <sect2 id="config-markdown">
+ <title>Markdown backend configuration</title>
+ <para>
+ You can configure &okular; Markdown rendering backend based on <ulink url="https://www.pell.portland.or.us/~orc/Code/markdown/">Discount</ulink> by choosing <guilabel>Markdown</guilabel> from the list on the left part of the configuration dialog. An additional configurable option is as follows.
+ </para>
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <guilabel>Enable SmartyPants formatting</guilabel>
+ </term>
+ <listitem>
+ <para>When checked this option allows &okular; to process <ulink url="https://daringfireball.net/projects/smartypants/">SmartyPants</ulink> formatting. Such formatting can be troublesome in the technical texts because of unwanted substitutions (⪚, it replaces <literal>(C)</literal> with a copyright symbol). This option is checked by default.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </sect2>
+ <sect2 id="config-ghostscript">
+ <title>&PostScript; backend configuration</title>
+ <para>
+ You can configure &okular; &PostScript; rendering backend based on <ulink url="https://www.ghostscript.com/">Ghostscript</ulink> by choosing <guilabel>Ghostscript</guilabel> from the list on the left part of the configuration dialog. The only configurable option is as follows.
+ </para>
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <guilabel>Use platform fonts</guilabel>
+ </term>
+ <listitem>
+ <para>This option determines whether Ghostscript should be allowed to use platform fonts, if unchecked only usage of fonts embedded in the document will be allowed. This option is checked by default.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </sect2>
+ <sect2 id="config-pdf">
+ <title>&PDF; backend configuration</title>
+ <para>
+ You can configure &okular; &PDF; rendering backend based on <ulink url="https://poppler.freedesktop.org/">Poppler</ulink> by choosing <guilabel>&PDF;</guilabel> from the list on the left part of the configuration dialog. The only configurable option is as follows.
+ </para>
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <guilabel>Enhance thin lines</guilabel>
+ </term>
+ <listitem>
+ <para>
[suppressed due to size limit]
+ </para>
+ <informaltable>
+ <tgroup cols="2">
+ <tbody>
+ <row>
+ <entry>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="enhance-thinline.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ </entry>
+ <entry>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="enhance-lowcontrast.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>Thin line (red), its clipping path (dashed line) and pixel boundaries (black solid lines)</entry>
+ <entry>Thin line shown at a low contrast</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>
+ To enhance the look of the thin lines &okular; implements two options.
+ </para>
+ <para>
+ The first option is <guimenuitem>Solid</guimenuitem>. With this option &okular; adjusts clipping path and line position so that clipping path and line are on the same pixel boundary, &ie; &okular; enlarges the thin lines to one pixel on the output device. This mode is similar to the <guilabel>Enhance thin lines</guilabel> in <trademark class="registered">Adobe</trademark>
+ <trademark class="registered">Reader</trademark>. If this option is chosen, the thin lines are always enlarged.
+ </para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="enhance-solid.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Thin line with <guimenuitem>Solid</guimenuitem> enhancement</phrase>
+ </textobject>
+ <caption>
+ <para>Thin line with <guimenuitem>Solid</guimenuitem> enhancement</para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ The second option is <guimenuitem>Shape</guimenuitem>. With this option the clipping path and line are adjusted to pixel boundary as well, but the line intensity is corrected according to its width.
+ </para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="enhance-shape.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Thin line with <guimenuitem>Shape</guimenuitem> enhancement</phrase>
+ </textobject>
+ <caption>
+ <para>Thin line with <guimenuitem>Shape</guimenuitem> enhancement</para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ The thin lines are not enhanced by default (option <guimenuitem>No</guimenuitem>).
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ <sect3 id="config-pdf-digital-signatures">
+ <title>&PDF; Digital Signature Certificates</title>
+ <para>
+ <screenshot><mediaobject><imageobject><imagedata fileref="config-pdf-digital-signatures.png" format="PNG"/></imageobject></mediaobject></screenshot>
+ This section allows you to set a custom Certificate Database to use when adding Digital Signatures to &PDF; files.
+ </para>
+ <para>
+ It also lists the certificates available in the current Certificate Database (if any).
+ </para>
+ </sect3>
+ </sect2>
+ </sect1>
</chapter>
<chapter id="credits">
<title>Credits and License</title>
More information about the kde-doc-english
mailing list