Git commit fdf2a13c87584e707f94c9340b6423b9d7b3a89d by George Florea Bănuș. Committed on 14/08/2022 at 15:34. Pushed by georgefb into branch 'master'.
improve documentation M +50 -6 doc/index.docbook M +2 -0 help/CustomCommandsSettings.html M +16 -0 help/GeneralSettings.html M +35 -2 help/PlaybackSettings.html https://invent.kde.org/multimedia/haruna/commit/fdf2a13c87584e707f94c9340b6423b9d7b3a89d diff --git a/doc/index.docbook b/doc/index.docbook index c1118b9..17b4e95 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -29,13 +29,13 @@ </authorgroup> <copyright> - <year>2019-2021</year> + <year>2019-2022</year> <holder>George Florea Bănuș</holder> </copyright> <legalnotice>&CCBYSA4Notice;</legalnotice> <date>2021-06-12</date> - <releaseinfo>Haruna 0.6.3</releaseinfo> + <releaseinfo>Haruna 0.8.0</releaseinfo> <abstract> <para>Haruna is an open source video player built with Qt/QML and libmpv.</para> @@ -57,6 +57,22 @@ <section id="GeneralSettings"> <title>General</title> + <section> + <title>File dialog location</title> + <para>The folder the file dialog will load when used to open a file. + If empty it will remember the last folder from which a file was opened.</para> + </section> + + <section> + <title>Maximum recent files</title> + <para>How many recent files to save and display in the recent files menu.</para> + </section> + + <section> + <title>Remember window size and position</title> + <para>Restores the size and position the window had when it was closed. On <emphasis>Wayland</emphasis> only size is restored.</para> + </section> + <section> <title>Breeze icon theme</title> <para>When checked the application uses the Breeze icon theme.</para> @@ -73,21 +89,49 @@ <section id="PlaybackSettings"> <title>Playback</title> + <section> + <title>Seek steps</title> + <para>How much to seek when triggering the coresponding action. Seek mode is <emphasis>exact</emphasis> <ulink url="https://mpv.io/manual/stable/#command-interface-seek-<target>-[<flags>]";> + https://mpv.io/manual/stable/#command-interface-seek-<target>-[<flags>]</ulink>.</para> + </section> + + <section> + <title>Open last played file on startup</title> + <para>On startup it opens the file that was playing when the application was closed.</para> + </section> + + <section> + <title>Seek to last playback position</title> + <para>When opening a file that was played before it will seek to the position it was when playback stopped.</para> + </section> + + <section> + <title>Start playing</title> + <para>This applies only when resuming playback (seeking to last playback position) of a file that was played before.</para> + </section> + + <section> + <title>Pause on minimize</title> + <para>Pauses the player while the window is minimized, playback resumes when restored.</para> + </section> + <section> <title>Hardware decoding</title> - <para>It's recommended leave hardware decoding disabled.</para> - <para>If you want to enable it read <ulink url="https://mpv.io/manual/stable/#options-hwdec";>https://mpv.io/manual/stable/#options-hwdec</ulink> - to understand which option is best for you.</para> + <para>If you enable hardware decoding it's recommended to use the auto-safe or auto options.</para> + <para>You can read more about each option here: <ulink url="https://mpv.io/manual/stable/#options-hwdec";>https://mpv.io/manual/stable/#options-hwdec</ulink>.</para> + <para>If you want to use vaapi on X11, you must set the environment variable <emphasis>QT_XCB_GL_INTEGRATION</emphasis> to <emphasis>xcb_egl</emphasis>.</para> </section> <section> <title>Remember time position</title> <para>Determines when to save and restore the position of previously played files.</para> + <para>First field controls for which files to save the position:</para> <itemizedlist> <listitem><para>-1: feature is disabled</para></listitem> <listitem><para>0: save for all files</para></listitem> <listitem><para>1-9999: save for files longer than the set value, in minutes</para></listitem> </itemizedlist> + <para>Second field controls how often to save the position.</para> </section> <section> @@ -238,7 +282,7 @@ </section> <section> <title>Run at startup</title> - <para>The command will be run at application startup.</para> + <para>The command will be run at application startup. Startup commands can be toggled, meaning you can choose whether they are set on startup or not, this is available after saving.</para> </section> </section> </chapter> diff --git a/help/CustomCommandsSettings.html b/help/CustomCommandsSettings.html index c4a5a39..ee4e4c8 100644 --- a/help/CustomCommandsSettings.html +++ b/help/CustomCommandsSettings.html @@ -32,4 +32,6 @@ SPDX-License-Identifier: CC-BY-4.0 <h2>Run at startup</h2> <div> The command will be run at application startup. + Startup commands can be toggled, meaning you can choose whether they are set on startup or not, + this is available after saving. </div> diff --git a/help/GeneralSettings.html b/help/GeneralSettings.html index eac7ef8..cfa651f 100644 --- a/help/GeneralSettings.html +++ b/help/GeneralSettings.html @@ -4,6 +4,22 @@ SPDX-FileCopyrightText: 2020 George Florea Bănuș <[email protected]> SPDX-License-Identifier: CC-BY-4.0 --> +<h2>File dialog location</h2> +<div> + <p>The folder the file dialog will load when used to open a file. + If empty it will remember the last folder from which a file was opened.</p> +</div> + +<h2>Maximum recent files</h2> +<div> + <p>How many recent files to save and display in the recent files menu.</p> +</div> + +<h2>Remember window size and position</h2> +<div> + <p>Restores the size and position the window had when it was closed. On <b>Wayland</b> only size is restored.</p> +</div> + <h2>Breeze icon theme</h2> <div> When checked the application uses the Breeze icon theme.<br> diff --git a/help/PlaybackSettings.html b/help/PlaybackSettings.html index e5d0484..a009318 100644 --- a/help/PlaybackSettings.html +++ b/help/PlaybackSettings.html @@ -4,20 +4,53 @@ SPDX-FileCopyrightText: 2020 George Florea Bănuș <[email protected]> SPDX-License-Identifier: CC-BY-4.0 --> +<h2>Seek steps</h2> +<div> + <p>How much to seek when triggering the coresponding action. Seek mode is <b>exact</b> + <a href="https://mpv.io/manual/stable/#command-interface-seek-<target>-[<flags>]"> + https://mpv.io/manual/stable/#command-interface-seek-<target>-[<flags>]</a></p> +</div> + +<h2>Open last played file on startup</h2> +<div> + <p>On startup it opens the file that was playing when the application was closed.</p> +</div> + +<h2>Seek to last playback position</h2> +<div> + <p>When opening a file that was played before it will seek to the position it was when playback stopped.</p> +</div> + +<h2>Start playing</h2> +<div> + <p>This applies only when resuming playback (seeking to last playback position) + of a file that was played before.</p> +</div> + +<h2>Pause on minimize</h2> +<div> + <p>Pauses the player while the window is minimized, playback resumes when restored.</p> +</div> + <h2>Hardware decoding</h2> <div> - <p>It's recommended leave hardware decoding disabled.</p> - <p>If you want to enable it read <a href="https://mpv.io/manual/stable/#options-hwdec";>https://mpv.io/manual/stable/#options-hwdec</a> to understand which option is best for you.</p> + <p>If you enable hardware decoding it's recommended to use the auto-safe or auto options.</p> + <p>You can read more about each option here: + <a href="https://mpv.io/manual/stable/#options-hwdec";>https://mpv.io/manual/stable/#options-hwdec</a>.</p> + <p>If you want to use vaapi on X11, you must set the + environment variable <b>QT_XCB_GL_INTEGRATION</b> to <b>xcb_egl</b>.</p> </div> <h2>Remember time position</h2> <div> <p>Determines when to save and restore the position of previously played files.</p> + <p>First field controls for which files to save the position:</p> <ul> <li>-1: feature is disabled</li> <li>0: save for all files</li> <li>1-9999: save for files longer than the set value, in minutes</li> </ul> + <p>Second field controls how often to save the position.</p> </div> <h2>Skip chapters</h2>
