ChiliProject is not maintained anymore. Please be advised that there will be no more updates.

We do not recommend that you setup new ChiliProject instances and we urge all existing users to migrate their data to a maintained system, e.g. Redmine. We will provide a migration script later. In the meantime, you can use the instructions by Christian Daehn.

Introduce Help controller to dynamically generate wiki help pages (Feature #362)

Added by Gregor Schmidt at 2011-05-02 10:41 am. Updated at 2011-05-03 04:36 pm.

Status:Closed Start date:2011-05-02
Priority:Normal Due date:
Assignee:Eric Davis % Done:

0%
Category:Documentation
Target version:1.4.0
Remote issue URL: Affected version:

Description

By introducing a help controller, we could dynamically generate the help pages for wiki_syntax and wiki_syntax_detailed. In the long run, we are a then able to

  • Overwrite/Extend the help pages in plugins, e.g. to add documentation for custom makros
  • Translate the documentation to other languages

By using page cacheing we should be able to do this without significant perfomance impacts.

Related issues

related to Feature #361: [Cleanup] Removing code comment, by answering the implied... Closed 2011-05-02
related to Bug #380: Wiki-Help Page Closed 2011-05-05

History

#1
Updated by Gregor Schmidt at 2011-05-02 10:57 am

One downside would be: We then need to ask admins to clear the public directory with each ChiliProject update or plugin installation/removal.

On the other hand, we could just leave the page caching aside, since the help links are probably not used very often and caching them would add this additional complexity without significant benefit.

#2
Updated by Gregor Schmidt at 2011-05-02 01:29 pm

The pull request is at https://github.com/chiliproject/chiliproject/pull/45.

It does not include page caching, because of the expected maintenance overhead for a minimal performance benefits.

  • Status changed from Open to Ready for review

#3
Updated by Gregor Schmidt at 2011-05-02 01:30 pm

Please note: Besides the architectural changes, the pull request also includes fixes for some typos and replaces each occurrence of Redmine with ChiliProject within the wiki syntax documentation.

#4
Updated by Eric Davis at 2011-05-02 09:38 pm

Merged into master.

Later on I'd like to improve this a bit. I'll open issues for them

  • Separate the help pages from the textile help
  • Move the textile formatting and help to an included plugin (also renaming the textilizable helper method)
  • Change how the actions in the controller work, so there is only a "show" action that takes a params for which page (kinda like Wiki pages). Then we can add a help view easily.
  • Maybe change how the help appears, so it's in a lightbox. Then we can have better "on page" help.
  • Target version changed from 2.0.0 to 1.4.0
  • Assignee set to Eric Davis
  • Status changed from Ready for review to Closed

#5
Updated by Gregor Schmidt at 2011-05-03 06:02 am

Thanks a lot, Eric. That was quick.

#6
Updated by Felix Schäfer at 2011-05-03 08:04 am

Eric Davis wrote:

  • Maybe change how the help appears, so it's in a lightbox. Then we can have better "on page" help.

Not sure about that one: I do like to have the help in an extra window when editing wiki stuff…

#7
Updated by Eric Davis at 2011-05-03 04:36 pm

Felix Schäfer wrote:

Not sure about that one: I do like to have the help in an extra window when editing wiki stuff…

I agree for the syntax (more of a reference style of help) but I was thinking of the lightbox for more of the general help. e.g. Issue->New (Help) "The new issue screen is used to create a new issue...". CC: #366

Also available in: Atom PDF