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

classic Classic list List threaded Threaded
33 messages Options
12
Reply | Threaded
Open this post in threaded view
|

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

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

            Bug ID: 18483
           Summary: Customised help: Enhance staff client with news based,
                    easily editable help system
 Change sponsored?: ---
           Product: Koha
           Version: master
          Hardware: All
                OS: All
            Status: NEW
          Severity: enhancement
          Priority: P5 - low
         Component: Staff Client
          Assignee: [hidden email]
          Reporter: [hidden email]
        QA Contact: [hidden email]
                CC: [hidden email]

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 can be 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).

The display can be managed with a system preference (Bug 18472: Add system
preference CustomOnlineHelpStaff to hide / select custom online help system).

--
You are receiving this mail because:
You are watching all bug changes.
You are the assignee for the bug.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

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

Marc Véron <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
           Assignee|[hidden email]-commun |[hidden email]
                   |ity.org                     |
             Status|NEW                         |ASSIGNED

--
You are receiving this mail because:
You are watching all bug changes.
You are the assignee for the bug.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

--- Comment #1 from Marc Véron <[hidden email]> ---
Created attachment 62576
  -->
https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=62576&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 can be 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).

The display can be managed with a system preference (Bug 18472: Add system
preference
CustomOnlineHelpStaff to hide / select custom online help system).

This patch is a first draft. It is not yet ready for testing or sign-off.

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

Marc Véron <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
         Depends on|                            |18472


Referenced Bugs:

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18472
[Bug 18472] Add system preference CustomOnlineHelpStaff to hide / select custom
online help system
--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

Marc Véron <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
           See Also|                            |https://bugs.koha-community
                   |                            |.org/bugzilla3/show_bug.cgi
                   |                            |?id=13835

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

Marc Véron <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
  Attachment #62576|0                           |1
        is obsolete|                            |

--- Comment #2 from Marc Véron <[hidden email]> ---
Created attachment 62577
  -->
https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=62577&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 can be 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).

The display can be managed with a system preference (Bug 18472: Add system
preference
CustomOnlineHelpStaff to hide / select custom online help system).

This patch is a first draft. It is not yet ready for testing or sign-off.
Amended to resolve minor conflicts with Bug 18472

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

Marc Véron <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
  Attachment #62577|0                           |1
        is obsolete|                            |

--- Comment #3 from Marc Véron <[hidden email]> ---
Created attachment 62579
  -->
https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=62579&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 can be 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).

The display can be managed with a system preference (Bug 18472: Add system
preference
CustomOnlineHelpStaff to hide / select custom online help system).

This patch is a first draft. It is not yet ready for testing or sign-off.
Amended to resolve minor conflicts with Bug 18472
Amended to expand sysprefs from Bug 18472

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

Marc Véron <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
  Attachment #62579|0                           |1
        is obsolete|                            |

--- Comment #4 from Marc Véron <[hidden email]> ---
Created attachment 62648
  -->
https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=62648&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 can be 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).

The display can be managed with a system preference (Bug 18472: Add system
preference
CustomOnlineHelpStaff to hide / select custom online help system).

This patch is a first draft. It is not yet ready for testing or sign-off.
Amended to resolve minor conflicts with Bug 18472
Amended to expand sysprefs from Bug 18472
Amended to add permissions

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

Marc Véron <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
  Attachment #62648|0                           |1
        is obsolete|                            |

--- Comment #5 from Marc Véron <[hidden email]> ---
Created attachment 62705
  -->
https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=62705&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 can be 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).

The display can be managed with a system preference (Bug 18472: Add system
preference
CustomOnlineHelpStaff to hide / select custom online help system).

This patch is a first draft. It is not yet ready for testing or sign-off.
Amended to resolve minor conflicts with Bug 18472
Amended to expand sysprefs from Bug 18472
Amended to add permissions
Amended for visibility of edit buttons

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

Marc Véron <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
  Attachment #62705|0                           |1
        is obsolete|                            |

--- Comment #6 from Marc Véron <[hidden email]> ---
Created attachment 62718
  -->
https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=62718&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 can be 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).

The display can be managed with a system preference (Bug 18472: Add system
preference
CustomOnlineHelpStaff to hide / select custom online help system).

This patch is a first draft. It is not yet ready for testing or sign-off.
Amended to resolve minor conflicts with Bug 18472
Amended to expand sysprefs from Bug 18472
Amended to add permissions
Amended for visibility of edit buttons
Amended for updatedb fixes

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

Marc Véron <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
  Attachment #62718|0                           |1
        is obsolete|                            |

--- Comment #7 from Marc Véron <[hidden email]> ---
Created attachment 62804
  -->
https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=62804&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 can be 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).

The display can be managed with a system preference (Bug 18472: Add system
preference
CustomOnlineHelpStaff to hide / select custom online help system).

This patch is work in progress. It is not yet ready for testing or sign-off.
Amended to resolve minor conflicts with Bug 18472
Amended to expand sysprefs from Bug 18472
Amended to add permissions
Amended for visibility of edit buttons
Amended for updatedb fixes
Amended for managing permissions

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

Marc Véron <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
  Attachment #62804|0                           |1
        is obsolete|                            |

--- Comment #8 from Marc Véron <[hidden email]> ---
Created attachment 62812
  -->
https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=62812&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 can be 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).

The display can be managed with a system preference (Bug 18472: Add system
preference
CustomOnlineHelpStaff to hide / select custom online help system).

This patch is work in progress. It is not yet ready for testing or sign-off.
Amended to resolve minor conflicts with Bug 18472
Amended to expand sysprefs from Bug 18472
Amended to add permissions
Amended for visibility of edit buttons
Amended for updatedb fixes
Amended for managing permissions
Amended to use news manging page as popup, needs Bug 13835 to test (not to
apply)

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

Marc Véron <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
         Depends on|                            |13835


Referenced Bugs:

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13835
[Bug 13835] Popup with searches: results hidden by language menu in footer
--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

Marc Véron <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
  Attachment #62812|0                           |1
        is obsolete|                            |

--- Comment #9 from Marc Véron <[hidden email]> ---
Created attachment 62892
  -->
https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=62892&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 can be 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).

The display can be managed with a system preference (Bug 18472: Add system
preference
CustomOnlineHelpStaff to hide / select custom online help system).

This patch is work in progress. It is not yet ready for testing or sign-off.
Amended to resolve minor conflicts with Bug 18472
Amended to expand sysprefs from Bug 18472
Amended to add permissions
Amended for visibility of edit buttons
Amended for updatedb fixes
Amended for managing permissions
Amended to use news manging page as popup, needs Bug 13835 to test (not to
apply)

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

--- Comment #10 from M. Tompsett <[hidden email]> ---
Comment on attachment 62892
  --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=62892
Bug 18483 - Customised help: Enhance staff client with news based, easily
editable help system

Review of attachment 62892:
 --> (https://bugs.koha-community.org/bugzilla3/page.cgi?id=splinter.html&bug=18483&attachment=62892)
-----------------------------------------------------------------

::: koha-tmpl/intranet-tmpl/prog/en/includes/header.inc
@@ +98,4 @@
>                      </li>
>                  </ul>
>              </li>
> +                [% IF Koha.Preference('HelpSystem').match('filebased|newsbased')  %]

Is there ever a method that won't require a Help link? This condition seems
weird.

::: koha-tmpl/intranet-tmpl/prog/en/includes/help-bottom.inc
@@ +1,1 @@
> +[% USE Koha %]

I haven't checked, but does scoping require this?

::: koha-tmpl/intranet-tmpl/prog/en/includes/help-top.inc
@@ +5,2 @@
>  <link rel="stylesheet" type="text/css" href="[% interface %]/[% theme %]/css/help.css" />
> +[% USE Koha %]

Why a second time?

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

--- Comment #11 from Marc Véron <[hidden email]> ---
(In reply to M. Tompsett from comment #10)
> Comment on attachment 62892 [details] [review]
> Bug 18483 - Customised help: Enhance staff client with news based, easily
> editable help system
>
> Review of attachment 62892 [details] [review]:
> -----------------------------------------------------------------

Thanks for testing and for your comments, I really appreciate!

Yes, there seems to be a scoping issue with [% USE Koha %] in includes.

If the parent of an include has [% USE Koha %], it is visible for the include.
If the parent does not have [% USE Koha %], it is not visible for the include
(even if a precedent sibling include has [% USE Koha %]).

I had a similar problem with Bug 18472 (see there comments #2 and #12).

BTW the patch is still work in progress. It is not yet ready for sign-off.

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

Marc Véron <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
  Attachment #62892|0                           |1
        is obsolete|                            |

--- Comment #12 from Marc Véron <[hidden email]> ---
Created attachment 62898
  -->
https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=62898&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 can be 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).

The display can be managed with a system preference (Bug 18472: Add system
preference
CustomOnlineHelpStaff to hide / select custom online help system).

This patch is work in progress. It is not yet ready for testing or sign-off.
Amended to resolve minor conflicts with Bug 18472
Amended to expand sysprefs from Bug 18472
Amended to add permissions
Amended for visibility of edit buttons
Amended for updatedb fixes
Amended for managing permissions
Amended to use news manging page as popup, needs Bug 13835 to test (not to
apply)
Amended to make it apply again on 18472

Still work in progress, not yet ready to test.

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

Marc Véron <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
  Attachment #62898|0                           |1
        is obsolete|                            |

--- Comment #13 from Marc Véron <[hidden email]> ---
Created attachment 62899
  -->
https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=62899&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 can be 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).

The display can be managed with a system preference (Bug 18472: Add system
preference
CustomOnlineHelpStaff to hide / select custom online help system).

This patch is work in progress. It is not yet ready for testing or sign-off.
Amended to resolve minor conflicts with Bug 18472
Amended to expand sysprefs from Bug 18472
Amended to add permissions
Amended for visibility of edit buttons
Amended for updatedb fixes
Amended for managing permissions
Amended to use news managing page as popup, needs Bug 13835 to test (not to
apply)
Amended to make it apply again on 18472
Amended for better cycle through popup

Still work in progress, not yet ready to test.

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

Marc Véron <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
  Attachment #62899|0                           |1
        is obsolete|                            |

--- Comment #14 from Marc Véron <[hidden email]> ---
Created attachment 62900
  -->
https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=62900&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 can be 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).

The display can be managed with a system preference (Bug 18472: Add system
preference
CustomOnlineHelpStaff to hide / select custom online help system).

This patch is work in progress. It is not yet ready for testing or sign-off.
Amended to resolve minor conflicts with Bug 18472
Amended to expand sysprefs from Bug 18472
Amended to add permissions
Amended for visibility of edit buttons
Amended for updatedb fixes
Amended for managing permissions
Amended to use news managing page as popup, needs Bug 13835 to test (not to
apply)
Amended to make it apply again on 18472
Amended for better cycle through popup
Amended for last steps before switching to NSO

Still work in progress, not yet ready to test.

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

Marc Véron <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
  Attachment #62900|0                           |1
        is obsolete|                            |

--- Comment #15 from Marc Véron <[hidden email]> ---
Created attachment 62901
  -->
https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=62901&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

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

Marc Véron <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
   Patch complexity|---                         |Medium patch
             Status|ASSIGNED                    |Needs Signoff

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

Marc Véron <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
           See Also|                            |https://bugs.koha-community
                   |                            |.org/bugzilla3/show_bug.cgi
                   |                            |?id=10232

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

--- Comment #16 from M. Tompsett <[hidden email]> ---
Comment on attachment 62901
  --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=62901
Bug 18483 - Customised help: Enhance staff client with news based, easily
editable help system

Review of attachment 62901:
 --> (https://bugs.koha-community.org/bugzilla3/page.cgi?id=splinter.html&bug=18483&attachment=62901)
-----------------------------------------------------------------

::: koha-tmpl/intranet-tmpl/prog/en/includes/header.inc
@@ +98,4 @@
>                      </li>
>                  </ul>
>              </li>
> +                [% IF Koha.Preference('HelpSystem').match('filebased|newsbased')  %]

Is there ever going to be a HelpSystem which does not need the Help link? Is
this really necessary?

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

Marc Véron <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Blocks|                            |18515


Referenced Bugs:

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18515
[Bug 18515] Use news based help system for OPAC
--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

--- Comment #17 from Marc Véron <[hidden email]> ---
(In reply to M. Tompsett from comment #16)

> Comment on attachment 62901 [details] [review]
> Bug 18483 - Customised help: Enhance staff client with news based, easily
> editable help system
>
> Review of attachment 62901 [details] [review]:
> -----------------------------------------------------------------
>
> ::: koha-tmpl/intranet-tmpl/prog/en/includes/header.inc
> @@ +98,4 @@
> >                      </li>
> >                  </ul>
> >              </li>
> > +                [% IF Koha.Preference('HelpSystem').match('filebased|newsbased')  %]
>
> Is there ever going to be a HelpSystem which does not need the Help link? Is
> this really necessary?

I implemented this because the help system can totally be turned off (nothing
selected in system preference 'HelpSystem').

And 'yes' to the question, or better 'yes, but not yet':
- I'm thinking about expanding the news based help to the OPAC as well, see Bug
18515 - Use news based help system for OPAC, and I do not want it to trigger
the link on staff client.
- I can imagine a help system that for example displays a small help text
directly on the screen

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

Marc Véron <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Blocks|                            |18516


Referenced Bugs:

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18516
[Bug 18516] Add possibility to import text from file based help system as news
based help system item
--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

Josef Moravec <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|Needs Signoff               |Signed Off

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

Josef Moravec <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
  Attachment #62901|0                           |1
        is obsolete|                            |

--- Comment #18 from Josef Moravec <[hidden email]> ---
Created attachment 62952
  -->
https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=62952&action=edit
[SIGNED-OFF] 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 <[hidden email]>

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

--- Comment #19 from Marc Véron <[hidden email]> ---
Still applies on current master

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

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

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483

--- Comment #20 from Marc Véron <[hidden email]> ---
Still applies on current master

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
12