Page MenuHome GnuPG

Kleopatra: Add Help menu entries for new manuals
Testing, NormalPublic

Description

Edited 2025-03-19 to reflect the discussion result.

The new entries should be named:
"User Manual" and "Admin Manual" "Administrator Manual"
The new files contain basically the current documentation pdfs plus some new info.

The old documentation entries disappear automatically when the respective pdf is not available at build. For the time being I would therefore keep the entries on the Help menu until the switch was a success. But I leave that up to you, @ikloecker. At least until the admin manual is finished (likely not for vsd34) we will need to keep "More Documentation" and the documents there.

The new documents we link to will be (re)named for VSD and GPD in the respective different build dirs as follows:

user-manual-en.pdf, user-manual-de.pdf
admin-manual-en.pdf, admin-manual-de.pdf

Revisions and Commits

Event Timeline

ebo triaged this task as Normal priority.Thu, Mar 12, 11:08 AM
ebo created this task.
ebo created this object with edit policy "Contributor (Project)".

Alternative suggestion:

Administrator Manual (Administrator-Handbuch)
User Manual (Benutzer-Handbuch)

The abbreviation "Admin" does look a bit informal, and spelling it out looks cleaner and more professional.

Please keep in mind, that for the 3.4 release, we will most likely only have the User Manual ready, not sure about the Administrator Manual. :)

Please keep in mind, that for the 3.4 release, we will most likely only have the User Manual ready, not sure about the Administrator Manual.

In that case we should keep "More documentation" at the moment. As there are the certification management and the smart card setup documents in that section, which I believe are in the administrator section. Or will smart card be in the user section in the future?

Good point! Just to clarify: there are several chapters that appear in both the User Manual and the Administrator Manual, each with a different focus. Smartcards, Backup, and Trust Management are topics covered in both.

That said, this doesn't quite address the question above: what's the reasoning behind putting one manual in the "More documentation" section and the other in the main section?

  1. That the users focus on the documentation which is more important for them.
  2. That the menu is not too long. This point will be +/- moot now but removing "more documentation" now would make extra work.

And 1) stays valid. So I'd keep it in place until all the new documentation is available. Unless @ikloecker sees this differently

ebo renamed this task from Draft: Kleopatra: Add Help menu entries for new manuals to Kleopatra: Add Help menu entries for new manuals.Thu, Mar 19, 11:07 AM
ebo updated the task description. (Show Details)
ebo added projects: vsd, gpd5x.
ebo updated the task description. (Show Details)
ikloecker moved this task from Backlog to WIP on the gpd5x board.

Note: I noticed that most of the old documents use underscores instead of hyphens in the document names. It doesn't really matter, but being consistent makes it easier to avoid typos.

ikloecker changed the task status from Open to Testing.Thu, Mar 19, 3:38 PM
ikloecker moved this task from Backlog to WIP on the vsd34 board.

Done. And backported for VSD 3.4.

I put the new menu entries below the menu entry for the Quick Guide into the Help menu.

ikloecker mentioned this in Unknown Object (Maniphest Task).Mon, Mar 23, 8:53 AM