Skip to content

Commit

Permalink
Overhaul user manuals
Browse files Browse the repository at this point in the history
We fix some out-dated details, give examples of disabled functionality
(closes #32), and remove the out-dated D&D example images altogether,
because this is supposed to be pretty much self-explaining.
  • Loading branch information
cmb69 committed Apr 23, 2017
1 parent 2f1ad73 commit 664d7e0
Show file tree
Hide file tree
Showing 12 changed files with 20 additions and 54 deletions.
36 changes: 9 additions & 27 deletions help/help.htm
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ <h2>Usage</h2>
overview of even extensive websites. You can open or close those by clicking
on the small markers left to the page, or by double clicking their titles.
</p>
<img style="max-width:100%; margin:0 auto" src="pagemanager.png" alt="Pagemanager_XH screenshot">
<img style="max-width:100%; margin:0 auto" src="pagemanager.jpg" alt="Pagemanager_XH screenshot">
<p>
Above the tree view of your website's pages you find Pagemanager_XH's
<strong>toolbar</strong>. The toolbar is particularly useful, if your
Expand All @@ -125,41 +125,23 @@ <h2>Usage</h2>
where the page will be inserted when dropping it. If it is not possible to
drag to a certain page, because it would result in e.g. a recursive page
structure, or the resulting nesting level would be too high, this will be
shown by a red cross or you will simply be not allowed to drop there. <em>So
signalled by a cross or you will simply be not allowed to drop there. <em>So
carefully watch the markers,</em> until you get a feeling how the drag &amp;
drop works. If you hold down the CTRL key while dragging, the result will be
a copy instead of a move operation.
</p>
<table style="margin:auto">
<caption class="important">
Examples of drag &amp; drop move operations
</caption>
<tr><th>during move</th><th>after move</th></tr>
<tr>
<td><img src="move1.png" alt="Move 1"></td>
<td><img src="result1.png" alt="Result 1"></td>
</tr>
<tr>
<td><img src="move2.png" alt="Move 2"></td>
<td><img src="result2.png" alt="Result 2"></td>
</tr>
<tr>
<td><img src="move3.png" alt="Move 3"></td>
<td><img src="result3.png" alt="Result 3"></td>
</tr>
<tr>
<td><img src="move4.png" alt="Move 4"></td>
<td><img src="result4.png" alt="Result 4"></td>
</tr>
</table>
<p>
Additional functionality is available in the toolbar or through the
<strong>context menu</strong> (click the right mouse button on the page).
You can add new pages, rename or remove existing ones (<em>if you delete the
selected page, all it's subpages will be deleted as well.</em>), use the
common clipboard functions as an alternative to drag & drop, and navigate
directly to a page, either in <em>edit</em> or <em>view</em> mode. Note that
functionality that is currently unavailable is disabled.
functionality that is currently unavailable is disabled. For instance, most
of the functionality requires that a page is selected; if no page is
selected, these functions are disabled (greyed out). Another example is the
<em>paste</em><em>inside</em> function, which is not available if the
page in the clipboard should be pasted into itself.
</p>
<p>
The checkboxes to the left of the pages allow you to view and change their
Expand All @@ -170,9 +152,9 @@ <h2>Usage</h2>
<p>
<strong>Duplicate headings</strong> are marked by a warning icon. It's best
to fix these right away. <strong>Newly created pages</strong> will be shown
with a <em>NEW</em> icon until the next <em>save</em>, to better distinguish
with a filled folder icon until the next <em>save</em>, to better distinguish
them from old pages. <strong>Pages that can't be renamed</strong> because
their headings contain additional markup are marked with a <em>yellow
their headings contain additional markup are marked with a <em>
tag</em> icon; it is okay to have such pages, but if you want to remove the
additional markup you have to do this in the editor.
</p>
Expand Down
38 changes: 11 additions & 27 deletions help/help_de.htm
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ <h2>Verwendung</h2>
über die kleinen Markierungen links von der Seite, oder durch Doppel-Klicken
auf den Titel.
</p>
<img style="max-width:100%; margin:0 auto" src="pagemanager.png" alt="Pagemanager_XH Bildschirmfoto">
<img style="max-width:100%; margin:0 auto" src="pagemanager.jpg" alt="Pagemanager_XH Bildschirmfoto">
<p>
Oberhalb der Baumansich der Seiten Ihrer Homepage befindet sich
Pagemanager_XHs <strong>Werkzeugleiste</strong>. Die Werkzeugleiste ist
Expand All @@ -132,35 +132,13 @@ <h2>Verwendung</h2>
eingeblendet, damit Sie sehen können, wo die Seite beim Ablegen eingeordnet
wird. Sollte es nicht möglich sein auf eine bestimmte Seite zu ziehen, weil
das z.B. in einer rekursiven Seitenstruktur resultieren würde, oder die
resultierende Verschachtelungstiefe zu groß würde, wird das durch ein rotes
resultierende Verschachtelungstiefe zu groß würde, wird das durch ein
Kreuz angezeigt, oder es wird einfach nicht möglich sein, die Seite hier
abzulegen. <em>Also beachten sie genau die Markierungen</em>, bis Sie ein
Gefühl dafür bekommen, wie das Drag &amp; Drop funktioniert. Wenn Sie beim
Ziehen einer Seite STRG gedrückt halten, wird die Seite kopiert statt
verschoben.
</p>
<table style="margin:auto">
<caption class="important">
Beispiele von Drag &amp; Drop Verschiebe-Operationen
</caption>
<tr><th>während dessen</th><th>danach</th></tr>
<tr>
<td><img src="move1.png" alt="Verschieben 1"></td>
<td><img src="result1.png" alt="Ergebnis 1"></td>
</tr>
<tr>
<td><img src="move2.png" alt="Verschieben 2"></td>
<td><img src="result2.png" alt="Ergebnis 2"></td>
</tr>
<tr>
<td><img src="move3.png" alt="Verschieben 3"></td>
<td><img src="result3.png" alt="Ergebnis 3"></td>
</tr>
<tr>
<td><img src="move4.png" alt="Verschieben 4"></td>
<td><img src="result4.png" alt="Ergebnis 4"></td>
</tr>
</table>
<p>
Weitere Funktionen sind über die Werkzeugleiste und das
<strong>Kontextmenü</strong> (klicken Sie mit der rechten Maustaste auf eine
Expand All @@ -171,6 +149,11 @@ <h2>Verwendung</h2>
verwendet werden können, und es kann direkt zu einer Seite navigiert werden,
entweder im <em>Bearbeitungs-</em> oder <em>Ansichtsmodus</em>. Es ist zu
beachten, dass aktuell nicht verfügbare Funktionalität deaktiviert ist.
Beispielsweise erfordern die meisten Funktionen, dass eine Seite ausgewählt
ist; ist dies nicht der Fall, dann sind die entsprechenden Funktionen
deaktiviert (ausgegraut). Ein weiteres Beispiel ist die <em>Einfügen</em>
<em>hinein</em> Funktionalität, die nicht verfügbar ist, wenn die Seite im
Clipboard in sich selbst eingefügt werden soll.
</p>
<p>
Die Checkboxen links von den Seiten erlauben es, deren
Expand All @@ -180,12 +163,13 @@ <h2>Verwendung</h2>
(Voreinstellung), dann werden keine Checkboxen angezeigt.
</p>
<p>
<strong>Doppelte Überschriften</strong> werden mit einem Warn-Icon markiert.
<strong>Neu erstellte Seiten</strong> werden mit einem <em>NEW</em> Icon
<strong>Doppelte Überschriften</strong> werden mit einem Warn-Icon markiert,
und sollten am besten gleich umbenannt werden.
<strong>Neu erstellte Seiten</strong> werden mit einem ausgefüllten Ordner-Icon
angezeigt bis zum nächsten mal gespeichert wird, damit sie besser von
bereits bestehenden unterschieden werden können. <strong>Seiten, die nicht
umbenannt werden können</strong>, weil ihre Überschriften zusätzliches
Markup enthalten, werden mit einem <em>gelbe Marke</em>-Icon markiert;
Markup enthalten, werden mit einem <em>Marke</em>-Icon markiert;
solche Seiten sind erlaubt, aber wenn das zusätzliche Markup entfernt werden
soll, muss dies im Editor erfolgen.
</p>
Expand Down
Binary file removed help/move1.png
Binary file not shown.
Binary file removed help/move2.png
Binary file not shown.
Binary file removed help/move3.png
Binary file not shown.
Binary file removed help/move4.png
Binary file not shown.
Binary file added help/pagemanager.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed help/pagemanager.png
Binary file not shown.
Binary file removed help/result1.png
Binary file not shown.
Binary file removed help/result2.png
Binary file not shown.
Binary file removed help/result3.png
Binary file not shown.
Binary file removed help/result4.png
Binary file not shown.

0 comments on commit 664d7e0

Please sign in to comment.