Skip to content

Commit

Permalink
Update the user help manual
Browse files Browse the repository at this point in the history
  • Loading branch information
maoschanz committed May 7, 2020
1 parent 8e5932a commit bb0c498
Show file tree
Hide file tree
Showing 10 changed files with 45 additions and 97 deletions.
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ or their durations, and save the modifications.

The list of pictures can conveniently be displayed as a list or as a grid.

### Set an XML file as a wallpaper
### Set an XML file as your wallpaper

An existing XML file (opened, or just created) can be set as your wallpaper (or
as your lock screen) from the app.
You can set an XML file (that you opened or newly created) as your wallpaper
from the app.

Adjustment options are available (mosaic, zoom, centered, etc.)

Expand All @@ -44,10 +44,6 @@ You can install it from flathub.org using the instructions on [this page](https:

[![Packaging status](https://repology.org/badge/vertical-allrepos/dynamic-wallpaper-editor.svg)](https://repology.org/project/dynamic-wallpaper-editor/versions)

- [Fedora (official repo)](https://apps.fedoraproject.org/packages/dynamic-wallpaper-editor) (29, 30 and Rawhide): `sudo dnf install dynamic-wallpaper-editor`
- [openSUSE (OBS)](https://software.opensuse.org//download.html?project=home%3ADead_Mozay&package=dynamic-wallpaper-editor)
- Arch and Manjaro ([AUR](https://aur.archlinux.org/packages/dynamic-wallpaper-editor))

----

![screenshot (grid view)](https://raw.githubusercontent.com/maoschanz/dynamic-wallpaper-editor/master/help/C/figures/screenshot_grid_popover.png)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
</screenshots>

<releases>
<release version="2.5" date="2020-05-09">
<release version="2.5" date="2020-05-07">
<description>
<p>
The images can now be easily sorted according to their filename.
Expand Down
10 changes: 5 additions & 5 deletions help/C/add_and_order.page
Original file line number Diff line number Diff line change
Expand Up @@ -41,16 +41,15 @@
</tr>
</table>
<p>With both layouts, pictures can be reordered using drag-and-drop.</p>
<p>Using a button in the toolbar, you can sort the pictures by their
filename.</p>
</section>

<section id="replace">
<title>Replace pictures</title>
<p>If one of your file has been moved or renamed, you can replace a picture
using its <gui style="menuitem">Replace with…</gui> menu item.</p>
<p>If a lot of picture changed, for example if you renamed their folder, you
can use the <gui style="button">Find and replace</gui> feature: search for
the part of the filename you want to replace, type what you want as a
replacement, and apply.</p>
using its <gui style="menuitem">Replace with…</gui> menu item, available in
the menu at the right of each picture.</p>
</section>

<section id="delete">
Expand All @@ -62,3 +61,4 @@
</section>

</page>

34 changes: 0 additions & 34 deletions help/C/apply.page

This file was deleted.

3 changes: 2 additions & 1 deletion help/C/durations.page
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
<item><p><gui style="menuitem">Fit the daylight</gui> (each picture has
its own duration, and the total duration is 24 hours)</p></item>
</list>
<p>When you <link xref="open_and_save">open an existing XML file</link>, the
<p>When you <link xref="index#open">open an existing XML file</link>, the
existing type is detected.</p>
</section>

Expand All @@ -52,3 +52,4 @@
</section>

</page>

38 changes: 31 additions & 7 deletions help/C/index.page
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title type="text">Dynamic Wallpaper Editor</title>
<credit type="author">
<name>Romain F. T.</name>
<years>2018-2019</years>
<years>2018-2020</years>
</credit>
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
</info>
Expand All @@ -19,15 +19,39 @@
<p>GNOME Shell natively allows the wallpaper to change automatically over
time, so your wallpaper can be for example a slideshow of your favorite
pictures, or an image adapting to the daylight.</p>
<p>Dynamic wallpapers are saved as XML files, and this utility helps you
creating, editing, and applying them.</p>

<section id="pictures" style="2column">
<title>Managing pictures</title>
<section id="wallpapers">
<title>XML dynamic wallpapers</title>
<p>Dynamic wallpapers are saved as XML files, and this utility helps you
creating, editing, saving, and applying them.</p>

<subsection id="open">
<title>Open an existing file</title>
<p>With the <gui style="button">Open</gui> button, you can open previously
saved dynamic wallpaper files (.xml), and <link xref="add_and_order">edit
them</link>.</p>
<p>From your file manager, you can also right-click on a dynamic wallpaper
XML file, click <gui style="menuitem">Open with an other application</gui>,
and select "Dynamic Wallpaper Editor".</p>
</subsection>

<subsection id="save">
<title>Save</title>
<p>Save your creation as an XML file with the <gui style="button">Save</gui>
button, or the <gui style="button">Save as…</gui> menu item.</p>
</subsection>

<subsection id="apply">
<title>Apply as your wallpaper</title>
<p>Once your XML file is saved, you can then apply it as your wallpaper
with the <gui style="button">Apply</gui> menu.</p>
<p>Adjustment options (zoom, centered, stretched, etc.) are available.</p>
</subsection>
</section>

<section id="wallpapers" style="2column">
<title>Wallpapers</title>
<section id="pictures" style="2column">
<title>Managing the pictures</title>
</section>

</page>

1 change: 1 addition & 0 deletions help/C/legal.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@
Attribution-ShareAlike 3.0 Unported License</link>.</p>

</license>

38 changes: 0 additions & 38 deletions help/C/open_and_save.page

This file was deleted.

2 changes: 0 additions & 2 deletions help/meson.build
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ gnome.yelp(meson.project_name(),
'index.page',
'add_and_order.page',
'durations.page',
'open_and_save.page',
'apply.page',
'legal.xml'
],
media: [
Expand Down
4 changes: 2 additions & 2 deletions src/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -106,10 +106,10 @@ def get_valid_file(self, app, path):
return f
else:
return None
except: # FIXME pas ouf
except:
err = _("Error opening this file. Did you mean %s ?")
command = "\n\tflatpak run --file-forwarding {0} @@ {1} @@\n"
command = command.format(APP_ID, path)
command = command.format(APP_ID, path) # FIXME pas ouf ^
print(err % command)
return None

Expand Down

0 comments on commit bb0c498

Please sign in to comment.