We are moving to Git Issues for bug tracking in future releases. During transition, content will be in both tools. If you'd like to file a new bug, please create an issue.

Bug 1292 - Help topic IDs should be assigned in templates, not code
Help topic IDs should be assigned in templates, not code
Product: OJS
Classification: Unclassified
Component: Help
All All
: P3 minor
Assigned To: James MacGregor
Depends on:
  Show dependency treegraph
Reported: 2005-03-12 00:13 PST by Kevin Jamieson
Modified: 2013-05-29 14:48 PDT (History)
3 users (show)

See Also:
Version Reported In:
Also Affects:


Note You need to log in before you can comment on or make changes to this bug.
Description Kevin Jamieson 2005-03-12 00:13:42 PST
Comment 1 Jason 2005-04-09 15:35:54 PDT
I placed the help topic ids in the code because templates were getting reused by
multiple sections of the system.  For example, the section editor's and editor's
share the same templates (e.g. metadata) considerably.  I thought that inserting
the help topic id in the code would give a better account of what topic to load.
 The logic to determine which help topic to load in the templates were getting
messy if 2 or more sections were reusing the same topic.

I don't mind moving the help topic ids back into the templates so I'll just wait
for your thoughts after my explanation for doing so.

Comment 2 Kevin Jamieson 2005-04-09 16:01:24 PDT
Will defer this for reconsideration in the future based on Jason's comments.
Comment 3 James MacGregor 2008-10-07 17:57:03 PDT
I will be trying this out as part of the PKP platform redesign. Objectives will be 

-- to move help file calls from class files to template files;  
-- for each template to have some sort of clickable help widget as appropriate; 
-- to possibly cull XML help files from one larger, more easily maintained XML file (eg. Docbook). This last point will probably merit a new bug entry. 
Comment 4 Alec Smecher 2009-02-13 10:48:40 PST
Suggest deferring to 2.3 release -- no need to overhaul this for a stable release.
Comment 5 James MacGregor 2009-07-28 15:20:58 PDT
Deferred, to my chagrin.
Comment 6 mai samir 2011-01-25 12:00:50 PST
DB Error: Can't connect to local MySQL server through socket '/var/lib/mysql/mysql.sock' (2)
Comment 7 Alec Smecher 2011-01-25 12:10:14 PST
Mai, your error message in comment #6 has nothing to do with this bug entry; please search through the support forum at http://pkp.sfu.ca/support/forum and post questions there.
Comment 8 Alec Smecher 2013-05-29 14:48:42 PDT
Existing inline help is deprecated.