Closed Bug 182083 Opened 23 years ago Closed 18 years ago

Add documentation links to many pages in Bugzilla

Categories

(Bugzilla :: User Interface, enhancement, P3)

Product:
Bugzilla
Component:
User Interface
Version:
2.17
Type:
enhancement

Tracking

()

Status:
RESOLVED FIXED
Milestone:
Bugzilla 3.2

People

(Reporter: gerv, Assigned: LpSolit)

References

(Blocks 1 open bug)

Details

Attachments

(5 files)

patch, v1 (example)
2.14 KB, patch
cso
: review+
Details | Diff | Splinter Review
patch for admin.cgi, editparams.cgi and editusers.cgi, v1
5.27 KB, patch
cso
: review+
Details | Diff | Splinter Review
patch for edit{classifications|products|components|versions|milestones|flagtypes}.cgi
7.84 KB, patch
cso
: review+
Details | Diff | Splinter Review
patch for edit{fields|values|groups|whines}.cgi, v1
8.11 KB, patch
cso
: review+
Details | Diff | Splinter Review
patch for non-admin pages, v1
14.67 KB, patch
cso
: review+
Details | Diff | Splinter Review
Currently, the new help system only supports search.html.tmpl. It should support more pages. To add help to a new page, you need to: - Create a file similar to template/en/default/search/search-help.html.tmpl, which defines the ids (which actually correspond to the name attributes of form elements) and help text for each form element on the page in question. - Add a link to that page that reloads it with &help=1. It's that easy. I anticipate that this will be a tracking bug. Gerv
This one is mine too. Gerv
Assignee: myk → gerv
Priority: -- → P3
Target Milestone: --- → Bugzilla 2.18
Reassigning back to Myk. That stuff about Gerv taking over the User Interface component turned out to be short-lived. Please pardon our confusion, and I'm very sorry about the spam.
Assignee: gerv → myk
Severity: normal → enhancement
Assignee: myk → gerv
Enhancements which don't currently have patches on them which are targetted at 2.18 are being retargetted to 2.20 because we're about to freeze for 2.18. Consideration will be taken for moving items back to 2.18 on a case-by-case basis (but is unlikely for enhancements)
Target Milestone: Bugzilla 2.18 → Bugzilla 2.20
Can you add more instructions onto what needs to be added into all of the CGI's to put this help in. Im willing to have a go at this as I need to do it for work anyway, so might as well do it right.
From bug 114179, comment 10: Adding the help system to any form-based page is done as follows: - call initHelp() from the <body> onload handler - write a template defining help text for each form element's 'name' (taking search-help.html.tmpl as a model) - include it in the template, before the footer. Help is then activated if "help=1" is a param to the CGI. You need to provide a link to enable it. Currently, we only add the mouseover elements for help to form elements (text boxes, list boxes etc.) in the page. Give me a shout if that's too limiting for you. The obvious next page to do is the enter_bug page. Gerv
Bugzilla 2.20 feature set is now frozen as of 15 Sept 2004. Anything flagged enhancement that hasn't already landed is being pushed out. If this bug is otherwise ready to land, we'll handle it on a case-by-case basis, please set the blocking2.20 flag to '?' if you think it qualifies.
Target Milestone: Bugzilla 2.20 → Bugzilla 2.22
Assignee: gerv → myk
QA Contact: mattyt-bugzilla → default-qa
Target Milestone: Bugzilla 2.22 → ---
Assignee: myk → ui
IMO, we should rather point the user to the documentation itself (being opened in a new tab or window). This way, there is no need to duplicate the documentation, especially when you know that the doc itself is rarely up-to-date. And maintaining two separate documentations is painful and a waste of time. What I suggest is to pass $vars->{doc_section} to the template, and global/headers.html.tmpl would display a link pointing to the corresponding section in the documentation only if this hash key is set. The string passed to $vars->{doc_section} would be the ID of the section in the documentation. If no documentation has been written for some page yet, then we don't set $vars->{doc_section} for this page, which lets us update the doc incrementally.
Target Milestone: --- → Bugzilla 3.2
See how easy it is. :)
Attachment #285659 - Flags: review?(colin.ogilvie)
Comment on attachment 285659 [details] [diff] [review] patch, v1 (example) Looks good to me, tested and it works.
Attachment #285659 - Flags: review?(colin.ogilvie) → review+
I'm going to attach several patches in this bug.
Assignee: ui → LpSolit
justdave said on IRC he is fine with my proposal in comment 7. <LpSolit> justdave: are you fine with comment 7 of this bug? <justdave> certainly better than nothing. :)
Status: NEW → ASSIGNED
Flags: approval+
patch v1 checked in: Checking in template/en/default/account/prefs/prefs.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/account/prefs/prefs.html.tmpl,v <-- prefs.html.tmpl new revision: 1.30; previous revision: 1.29 done Checking in template/en/default/global/common-links.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/global/common-links.html.tmpl,v <-- common-links.html.tmpl new revision: 1.11; previous revision: 1.10 done Leaving this bug opened for future patches. This one was just to implement the feature.
Depends on: 400629
Blocks: 344619
Depends on: 400631
Attachment #285679 - Flags: review?(colin.ogilvie)
Keywords: relnote
Depends on: 400677
Depends on: 400678
Colin, about my last patch, I fixed the indentation in the docs locally. Just in case you were going to complain. ;)
Depends on: 98123, bz-custstat
Comment on attachment 285679 [details] [diff] [review] patch for admin.cgi, editparams.cgi and editusers.cgi, v1 r=me assuming you've tested the URLs are the correct ones.
Attachment #285679 - Flags: review?(colin.ogilvie) → review+
(In reply to comment #16) > (From update of attachment 285679 [details] [diff] [review]) > r=me assuming you've tested the URLs are the correct ones. Nit: Use ' instead of " if you're not interpolating variables in the string.
Comment on attachment 285724 [details] [diff] [review] patch for edit{classifications|products|components|versions|milestones|flagtypes}.cgi r=me
Attachment #285724 - Flags: review?(colin.ogilvie) → review+
Yes, I tested all links. Both patches checked in: Checking in editclassifications.cgi; /cvsroot/mozilla/webtools/bugzilla/editclassifications.cgi,v <-- editclassifications.cgi new revision: 1.29; previous revision: 1.28 done Checking in editcomponents.cgi; /cvsroot/mozilla/webtools/bugzilla/editcomponents.cgi,v <-- editcomponents.cgi new revision: 1.85; previous revision: 1.84 done Checking in editmilestones.cgi; /cvsroot/mozilla/webtools/bugzilla/editmilestones.cgi,v <-- editmilestones.cgi new revision: 1.61; previous revision: 1.60 done Checking in editproducts.cgi; /cvsroot/mozilla/webtools/bugzilla/editproducts.cgi,v <-- editproducts.cgi new revision: 1.138; previous revision: 1.137 done Checking in editversions.cgi; /cvsroot/mozilla/webtools/bugzilla/editversions.cgi,v <-- editversions.cgi new revision: 1.57; previous revision: 1.56 done Checking in docs/xml/administration.xml; /cvsroot/mozilla/webtools/bugzilla/docs/xml/administration.xml,v <-- administration.xml new revision: 1.75; previous revision: 1.74 done Checking in template/en/default/admin/admin.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/admin/admin.html.tmpl,v <-- admin.html.tmpl new revision: 1.5; previous revision: 1.4 done Checking in template/en/default/admin/sudo.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/admin/sudo.html.tmpl,v <-- sudo.html.tmpl new revision: 1.7; previous revision: 1.6 done Checking in template/en/default/admin/flag-type/confirm-delete.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/admin/flag-type/confirm-delete.html.tmpl,v <-- confirm-delete.html.tmpl new revision: 1.9; previous revision: 1.8 done Checking in template/en/default/admin/flag-type/edit.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/admin/flag-type/edit.html.tmpl,v <-- edit.html.tmpl new revision: 1.26; previous revision: 1.25 done Checking in template/en/default/admin/flag-type/list.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/admin/flag-type/list.html.tmpl,v <-- list.html.tmpl new revision: 1.19; previous revision: 1.18 done Checking in template/en/default/admin/params/editparams.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/admin/params/editparams.html.tmpl,v <-- editparams.html.tmpl new revision: 1.8; previous revision: 1.7 done Checking in template/en/default/admin/users/confirm-delete.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/admin/users/confirm-delete.html.tmpl,v <-- confirm-delete.html.tmpl new revision: 1.19; previous revision: 1.18 done Checking in template/en/default/admin/users/create.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/admin/users/create.html.tmpl,v <-- create.html.tmpl new revision: 1.5; previous revision: 1.4 done Checking in template/en/default/admin/users/edit.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/admin/users/edit.html.tmpl,v <-- edit.html.tmpl new revision: 1.15; previous revision: 1.14 done Checking in template/en/default/admin/users/list.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/admin/users/list.html.tmpl,v <-- list.html.tmpl new revision: 1.6; previous revision: 1.5 done Checking in template/en/default/admin/users/search.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/admin/users/search.html.tmpl,v <-- search.html.tmpl new revision: 1.6; previous revision: 1.5 done
Marking as blocking 3.1.3 to let me finish the implementation on time (not a real blocker though, we can postpone it when a new blocking flag is available, but I want to keep this bug in my radar).
Flags: blocking3.1.3+
Interesting, the way this is getting implemented changes the original idea of this bug. So, are you planning to do something about the field specific help in Advanced Search? Either remove it in favour of doc links or improve it to get help data directly from the docs? I haven't seen this new help system in action but I'm not sure we should be maintaining two different systems that do similar/same thing.
(In reply to comment #21) > So, are you planning to do something about the field specific help in > Advanced Search? Either remove it in favour of doc links or improve it to get > help data directly from the docs? We shouldn't remove the existing help system for query.cgi. This page has *many* fields and having a per-field help makes sense. Other pages all have less fields and a link pointing to the external doc is enough.
Depends on: 45207
Depends on: 281809, 386702
Depends on: 403397
Last patch about administration pages.
Attachment #288208 - Flags: review?(colin.ogilvie)
This is the last patch for this bug. Note that votes.cgi and request.cgi have no documentation, but that's a separate issue.
Attachment #288222 - Flags: review?(colin.ogilvie)
Comment on attachment 288208 [details] [diff] [review] patch for edit{fields|values|groups|whines}.cgi, v1 r=me by Inspection and limited testing Nit: Keep the process sections in the templates consistent - some have all the variables on one line, some don't. These should be consistent (preferably on seperate lines)
Attachment #288208 - Flags: review?(colin.ogilvie) → review+
Comment on attachment 288222 [details] [diff] [review] patch for non-admin pages, v1 r=me by Inspection and limited testing Nit: Keep the process sections in the templates consistent - some have all the variables on one line, some don't. These should be consistent (preferably on seperate lines)
Attachment #288222 - Flags: review?(colin.ogilvie) → review+
Remaining admin pages, with Colin's nit fixed: Checking in editvalues.cgi; /cvsroot/mozilla/webtools/bugzilla/editvalues.cgi,v <-- editvalues.cgi new revision: 1.26; previous revision: 1.25 done Checking in docs/xml/administration.xml; /cvsroot/mozilla/webtools/bugzilla/docs/xml/administration.xml,v <-- administration.xml new revision: 1.78; previous revision: 1.77 done Checking in template/en/default/admin/custom_fields/create.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/admin/custom_fields/create.html.tmpl,v <-- create.html.tmpl new revision: 1.9; previous revision: 1.8 done Checking in template/en/default/admin/custom_fields/edit.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/admin/custom_fields/edit.html.tmpl,v <-- edit.html.tmpl new revision: 1.8; previous revision: 1.7 done Checking in template/en/default/admin/custom_fields/list.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/admin/custom_fields/list.html.tmpl,v <-- list.html.tmpl new revision: 1.6; previous revision: 1.5 done Checking in template/en/default/admin/groups/confirm-remove.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/admin/groups/confirm-remove.html.tmpl,v <-- confirm-remove.html.tmpl new revision: 1.4; previous revision: 1.3 done Checking in template/en/default/admin/groups/create.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/admin/groups/create.html.tmpl,v <-- create.html.tmpl new revision: 1.11; previous revision: 1.10 done Checking in template/en/default/admin/groups/delete.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/admin/groups/delete.html.tmpl,v <-- delete.html.tmpl new revision: 1.12; previous revision: 1.11 done Checking in template/en/default/admin/groups/edit.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/admin/groups/edit.html.tmpl,v <-- edit.html.tmpl new revision: 1.17; previous revision: 1.16 done Checking in template/en/default/admin/groups/list.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/admin/groups/list.html.tmpl,v <-- list.html.tmpl new revision: 1.13; previous revision: 1.12 done Checking in template/en/default/whine/schedule.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/whine/schedule.html.tmpl,v <-- schedule.html.tmpl new revision: 1.11; previous revision: 1.10 done
Non-admin pages: Checking in chart.cgi; /cvsroot/mozilla/webtools/bugzilla/chart.cgi,v <-- chart.cgi new revision: 1.26; previous revision: 1.25 done Checking in createaccount.cgi; /cvsroot/mozilla/webtools/bugzilla/createaccount.cgi,v <-- createaccount.cgi new revision: 1.57; previous revision: 1.56 done Checking in enter_bug.cgi; /cvsroot/mozilla/webtools/bugzilla/enter_bug.cgi,v <-- enter_bug.cgi new revision: 1.159; previous revision: 1.158 done Checking in report.cgi; /cvsroot/mozilla/webtools/bugzilla/report.cgi,v <-- report.cgi new revision: 1.41; previous revision: 1.40 done Checking in docs/xml/using.xml; /cvsroot/mozilla/webtools/bugzilla/docs/xml/using.xml,v <-- using.xml new revision: 1.71; previous revision: 1.70 done Checking in template/en/default/attachment/confirm-delete.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/attachment/confirm-delete.html.tmpl,v <-- confirm-delete.html.tmpl new revision: 1.6; previous revision: 1.5 done Checking in template/en/default/attachment/create.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/attachment/create.html.tmpl,v <-- create.html.tmpl new revision: 1.34; previous revision: 1.33 done Checking in template/en/default/attachment/created.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/attachment/created.html.tmpl,v <-- created.html.tmpl new revision: 1.17; previous revision: 1.16 done Checking in template/en/default/attachment/diff-header.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/attachment/diff-header.html.tmpl,v <-- diff-header.html.tmpl new revision: 1.18; previous revision: 1.17 done Checking in template/en/default/attachment/edit.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/attachment/edit.html.tmpl,v <-- edit.html.tmpl new revision: 1.48; previous revision: 1.47 done Checking in template/en/default/attachment/updated.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/attachment/updated.html.tmpl,v <-- updated.html.tmpl new revision: 1.16; previous revision: 1.15 done Checking in template/en/default/bug/dependency-tree.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/bug/dependency-tree.html.tmpl,v <-- dependency-tree.html.tmpl new revision: 1.28; previous revision: 1.27 done Checking in template/en/default/bug/show-multiple.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/bug/show-multiple.html.tmpl,v <-- show-multiple.html.tmpl new revision: 1.40; previous revision: 1.39 done Checking in template/en/default/bug/show.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/bug/show.html.tmpl,v <-- show.html.tmpl new revision: 1.20; previous revision: 1.19 done Checking in template/en/default/bug/summarize-time.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/bug/summarize-time.html.tmpl,v <-- summarize-time.html.tmpl new revision: 1.11; previous revision: 1.10 done Checking in template/en/default/list/list.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/list/list.html.tmpl,v <-- list.html.tmpl new revision: 1.56; previous revision: 1.55 done Checking in template/en/default/reports/menu.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/reports/menu.html.tmpl,v <-- menu.html.tmpl new revision: 1.9; previous revision: 1.8 done Checking in template/en/default/reports/old-charts.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/reports/old-charts.html.tmpl,v <-- old-charts.html.tmpl new revision: 1.3; previous revision: 1.2 done Checking in template/en/default/search/search-advanced.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/search/search-advanced.html.tmpl,v <-- search-advanced.html.tmpl new revision: 1.32; previous revision: 1.31 done Checking in template/en/default/search/search-create-series.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/search/search-create-series.html.tmpl,v <-- search-create-series.html.tmpl new revision: 1.14; previous revision: 1.13 done Checking in template/en/default/search/search-report-graph.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/search/search-report-graph.html.tmpl,v <-- search-report-graph.html.tmpl new revision: 1.12; previous revision: 1.11 done Checking in template/en/default/search/search-report-table.html.tmpl; /cvsroot/mozilla/webtools/bugzilla/template/en/default/search/search-report-table.html.tmpl,v <-- search-report-table.html.tmpl new revision: 1.13; previous revision: 1.12 done
Status: ASSIGNED → RESOLVED
Closed: 18 years ago
Resolution: --- → FIXED
Summary: Help system should support more pages → Add documentation links to many pages in Bugzilla
Added to the release notes for Bugzilla 3.2 in a patch on bug 432331.
Keywords: relnote
Blocks: 194750
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Creator:
Created:
Updated:
Size: