https://www.chiliproject.org/2011-05-02T10:41:25+02:00ChiliProjectChiliProject - Feature #362: Introduce Help controller to dynamically generate wiki help pageshttps://www.chiliproject.org/issues/362?journal_id=100632011-05-02T10:41:25+02:00Gregor Schmidtschmidt@nach-vorne.eu
<ul><li><strong>Start date</strong> set to <i>2011-05-02</i></li><li><strong>Estimated time</strong> deleted ()</li><li><strong>Priority</strong> changed from <i>Normal</i> to <i>Normal</i></li><li><strong>Project</strong> set to <i>ChiliProject</i></li><li><strong>Target version</strong> set to <i>1.4.0</i></li><li><strong>Assignee</strong> set to <i>Eric Davis</i></li><li><strong>% Done</strong> changed from <i>0</i> to <i>0</i></li><li><strong>Subject</strong> set to <i>Introduce Help controller to dynamically generate wiki help pages</i></li><li><strong>Category</strong> set to <i>Documentation</i></li><li><strong>Tracker</strong> set to <i>Feature</i></li><li><strong>Due date</strong> deleted ()</li><li><strong>Subproject of</strong> deleted ()</li><li><strong>Description</strong> set to <i>By introducing a help controller, we could dynamically generate the help page...</i> <a href="/journals/10063/diff/description" class="lightbox-ajax">More</a></li><li><strong>Status</strong> changed from <i>Open</i> to <i>Closed</i></li></ul> ChiliProject - Feature #362: Introduce Help controller to dynamically generate wiki help pageshttps://www.chiliproject.org/issues/362?journal_id=16872011-05-02T10:57:12+02:00Gregor Schmidtschmidt@nach-vorne.eu
<ul></ul><p>One downside would be: We then need to ask admins to clear the public directory with each ChiliProject update or plugin installation/removal.</p>
<p>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.</p> ChiliProject - Feature #362: Introduce Help controller to dynamically generate wiki help pageshttps://www.chiliproject.org/issues/362?journal_id=16882011-05-02T13:29:27+02:00Gregor Schmidtschmidt@nach-vorne.eu
<ul><li><strong>Status</strong> changed from <i>Open</i> to <i>Ready for review</i></li></ul><p>The pull request is at <a class="external" href="https://github.com/chiliproject/chiliproject/pull/45">https://github.com/chiliproject/chiliproject/pull/45</a>.</p>
<p>It does not include page caching, because of the expected maintenance overhead for a minimal performance benefits.</p> ChiliProject - Feature #362: Introduce Help controller to dynamically generate wiki help pageshttps://www.chiliproject.org/issues/362?journal_id=16892011-05-02T13:30:54+02:00Gregor Schmidtschmidt@nach-vorne.eu
<ul></ul><p>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.</p> ChiliProject - Feature #362: Introduce Help controller to dynamically generate wiki help pageshttps://www.chiliproject.org/issues/362?journal_id=16922011-05-02T21:38:26+02:00Eric Davis
<ul><li><strong>Target version</strong> changed from <i>2.0.0</i> to <i>1.4.0</i></li><li><strong>Assignee</strong> set to <i>Eric Davis</i></li><li><strong>Status</strong> changed from <i>Ready for review</i> to <i>Closed</i></li></ul><p>Merged into master.</p>
<p>Later on I'd like to improve this a bit. I'll open issues for them</p>
<ul>
<li>Separate the help pages from the textile help</li>
<li>Move the textile formatting and help to an included plugin (also renaming the <code>textilizable</code> helper method)</li>
<li>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.</li>
<li>Maybe change how the help appears, so it's in a lightbox. Then we can have better "on page" help.</li>
</ul> ChiliProject - Feature #362: Introduce Help controller to dynamically generate wiki help pageshttps://www.chiliproject.org/issues/362?journal_id=16942011-05-03T06:02:49+02:00Gregor Schmidtschmidt@nach-vorne.eu
<ul></ul><p>Thanks a lot, Eric. That was quick.</p> ChiliProject - Feature #362: Introduce Help controller to dynamically generate wiki help pageshttps://www.chiliproject.org/issues/362?journal_id=16952011-05-03T08:04:21+02:00Felix Schäferfelix+chili@oh14.de
<ul></ul><p>Eric Davis wrote:</p>
<blockquote>
<ul>
<li>Maybe change how the help appears, so it's in a lightbox. Then we can have better "on page" help.</li>
</ul>
</blockquote>
<p>Not sure about that one: I do like to have the help in an extra window when editing wiki stuff…</p> ChiliProject - Feature #362: Introduce Help controller to dynamically generate wiki help pageshttps://www.chiliproject.org/issues/362?journal_id=16962011-05-03T16:36:34+02:00Eric Davis
<ul></ul><p>Felix Schäfer wrote:</p>
<blockquote>
<p>Not sure about that one: I do like to have the help in an extra window when editing wiki stuff…</p>
</blockquote>
<p>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: <a href="https://www.chiliproject.org/issues/366" class="issue status-1 priority-2" title="Change HelpController to only have one "show" action (Open)">#366</a></p>