[Koha-bugs] [Bug 18483] Customised help: Enhance staff client with news based, easily editable help system

bugzilla-daemon at bugs.koha-community.org bugzilla-daemon at bugs.koha-community.org
Tue Sep 5 15:47:10 CEST 2017


https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

--- Comment #22 from Marc Véron <veron at veron.ch> ---
Created attachment 66852
  -->
https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=66852&action=edit
Bug 18483 - Customised help: Enhance staff client with news based, easily
editable help system

Koha's staff client has a file based help system with an edit function for
customising. However, the edited files have to be saved and restored with each
release. Otherwise they are overwritten.

As an enhancement or alternative, the existing news system is used to implement
a
complementing help system. Similar to the news, the text can be created for all
branches or for individual branches. Help is context sensitive (based on the
existing help system), and it can be created / edited directly from the help
page
(based on a user permission). Du to the need of this user permissen, a user
permission for editing news is implemented as well.

Display can be managed with a system preference (Bug 18472: Add system
preference
to manage online help system). Preferences default to legacy (fiele based)
help.

To test:
- Apply patch on top of Bug 18472, restart memcached and plack
- Update database (Alternative: fresh install)
- Log in as superlibrarian (later we test the permisisons)
- Verify that news behave as before
- Verify that legacy help works as before
- Locate system preferences 'EnableEditingFilebasedHelp' and 'Help system'
- For our tests, set 'EnableEditingFilebasedHelp' to 'No'
- In 'HelpSystem', uncheck 'File based'  (none selected)
- Refresh any page and verify that 'Help' Link in the main menu has vanished
- Check both 'File based' and 'News based'
- Verify that 'Help appears again in top menu
- Click 'Help' for any page, verify that, above the 'classic' filebased help,
you
  see a title 'Help for (library name) and two buttons 'Add help for this page'
  and 'Add help for all pages'
- Close the help page
- Go back to system preferences, select 'News based' only for 'HelpSystem'
- Open Help again for any page
- Verify that the text from file based help no longer displays, you should have
  a title and buttons only at the moment.
- Click 'Add help for this page'. You are taken to the form you already know
from
  editing 'News'
- Click 'Cancel'. You should be taken back to the help page as before
- Again click 'Add help for this page' and add an easyly identifiable title and
  some text, like you would do with news.
- Leave the new field 'Help key' unchanged.
- Submit. You should be taken back to the help you just created should appear
- Close help page and open it again to verify that the text persists (for this
  page)
- Go to an other page and verify that the help you added for the first page
does
  not appear.
- Add a help entry using the button 'Add help for all pages'
- Go back to the first page you entered help for and verify, that it displays
it's
  own help text and the text for all pages
- Edit one of the texts, verify that it saves correctly
- Add some more entries and verify that they appear as expected
- Go to More > Tools (in an other tab)
- Verify that the menu entry for News appears/disappears and changes text
  depending on the settings of system preference 'HelpSystem'
- Open 'News' rsp. 'Help', verify that entries appear depending on the settings
  of syspref 'HelpSystem'
- Verify that the filter for 'Display location' works
- Verify that in the 'Location' column a hint about the page appears the entry
  was created for
- Edit a staff help entry, verify that submit or close takes you back to the
list
- Bonus test: Edit a staff help entry, change the key to 'all', verify that the
  entry now appears for all pages. Change the key to 'help/admin/preferences'
and
  verify that it appears now for the preferences page
- Create a staff user with following permisisons only: catalogue (for login),
  edit_help and edit_news
- Test visibility of news / help  editing functionality depending on the
  edit_ permissions
- Run QA tools

Signed-off-by: Josef Moravec <josef.moravec at gmail.com>

(Amended to resolve minor merge conflict. 2017-09-05 mv)

-- 
You are receiving this mail because:
You are watching all bug changes.


More information about the Koha-bugs mailing list