[anaconda][master/f21-branch][PATCH 0/3] Help for every screen

Martin Kolman mkolman at redhat.com
Thu Aug 14 11:01:20 UTC 2014


After fighting GTK, C, glade and our class hierarchy the Anaconda built-in help patch is finally here !

The first patch adds the actually help button, currently situated in the upper right corner of the screen
next to the keymap indicator and it has the form of a simple button with a "Help!" label. Clicking the
button opens the yelp help viewer with a screen-specific help content - if available - or a placeholder.
The patch also adds the new ihelp plugin (the i prefix is used so that the module does not shadow the
Python help command) and two placeholder pages (one with links for live install and one link-free).

The second patch adds help file names for our spokes and hubs. It is basically "<spoke name>.xml".

And the third patch removes the "wall of unformatted text in a dialogue box" in custom spoke as the
new help system effectively obsoletes it.

A few notes about the patch set:
* the current layout of the help button is definitely not final and suggestion on improving the button design
  and placement are definitely welcome (Mairin ? :) ) !
* I am I bit unsure if I got the autotools stuff for installing the placeholders right - can someone better
  versed in the black arts check ? :)
* as for the help text content, the current plan is to use modified installation guide, yelp can read
  docbook directly so conversion to mallard should not be needed
* regarding RHEL7, the current plan is to first let the help system stabilize a bit in Fedora and then
  backport the relevant patches to the rhel7-branch.

Martin Kolman (3):
  Add a help button to every Anaconda screen
  Specify help file names for hubs and spokes
  Remove the old custom partitioning help dialog

 anaconda.spec.in                                   |  1 +
 data/HelpPlaceholder.html                          |  5 ++
 data/HelpPlaceholderWithLinks.html                 | 13 ++++
 data/Makefile.am                                   |  2 +
 pyanaconda/constants.py                            |  6 ++
 pyanaconda/ihelp.py                                | 90 ++++++++++++++++++++++
 pyanaconda/ui/gui/__init__.py                      | 12 +++
 pyanaconda/ui/gui/hubs/progress.py                 |  1 +
 pyanaconda/ui/gui/hubs/summary.py                  |  1 +
 pyanaconda/ui/gui/spokes/__init__.py               |  9 +++
 pyanaconda/ui/gui/spokes/custom.glade              | 17 ----
 pyanaconda/ui/gui/spokes/custom.py                 |  8 +-
 pyanaconda/ui/gui/spokes/datetime_spoke.py         |  1 +
 pyanaconda/ui/gui/spokes/filter.py                 |  1 +
 pyanaconda/ui/gui/spokes/keyboard.py               |  1 +
 pyanaconda/ui/gui/spokes/langsupport.py            |  1 +
 .../ui/gui/spokes/lib/custom_storage_helpers.glade | 71 -----------------
 .../ui/gui/spokes/lib/custom_storage_helpers.py    | 78 +------------------
 pyanaconda/ui/gui/spokes/network.py                |  1 +
 pyanaconda/ui/gui/spokes/password.py               |  1 +
 pyanaconda/ui/gui/spokes/software.py               |  1 +
 pyanaconda/ui/gui/spokes/source.py                 |  1 +
 pyanaconda/ui/gui/spokes/storage.py                |  1 +
 pyanaconda/ui/gui/spokes/user.py                   |  1 +
 pyanaconda/ui/gui/spokes/welcome.py                |  1 +
 widgets/glade/AnacondaWidgets.xml                  |  5 ++
 widgets/src/BaseWindow.c                           | 48 ++++++++++++
 widgets/src/BaseWindow.h                           |  3 +
 28 files changed, 210 insertions(+), 171 deletions(-)
 create mode 100644 data/HelpPlaceholder.html
 create mode 100644 data/HelpPlaceholderWithLinks.html
 create mode 100644 pyanaconda/ihelp.py

-- 
1.9.3



More information about the anaconda-patches mailing list