Difference between revisions of "Template:ContextSensitiveHelp"
From Freeside
m |
|||
| (16 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <noinclude> | + | <includeonly><div style="background: #F7FAFA; padding: 0.5em; margin: 0.5em; border: dashed 2px green;">This page is part of the Freeside Context Sensitive Help. Please review the [[:Template:ContextSensitiveHelp#Editing_Guidelines|Editing Guidelines]] before making modifications to this page.</div>[[Category:Context sensitive help]]</includeonly><noinclude> |
| − | This template, included by <em><b><nowiki>{{ | + | This template, included by <em><b><nowiki>{{ContextSensitiveHelp}}</nowiki></b></em> is for inclusion on pages where an installed Freeside instance may reference the wiki for <em>Context Sensitive Help</em>. This should make it more clear which pages are sensitive to specific changes. |
| + | == Editing Guidelines == | ||
| + | |||
| + | There are a few issues of concern while editing pages containing this template. | ||
| + | |||
| + | === Topic Names === | ||
| + | |||
| + | It's especially important to not modify names of topic headers <nowiki>( such as </nowiki><b><nowiki>== Topic ==</nowiki></b><nowiki> )</nowiki>. Freeside help relies upon wiki generated html anchors (Eg. <pre style="padding: inherit; border: none; display: inline;"><a name="topic"></a></pre>). | ||
| + | |||
| + | === Discuss when in doubt === | ||
| + | |||
| + | Please do not edit the documentation lightly, just because you have an installation problem. | ||
| + | |||
| + | Comments and proposed changes are still most welcome on the Discussion page. You may also want to ask on the [http://www.freeside.biz/cgi-bin/mailman/listinfo/freeside-users/ mailing list] or [http://www.freeside.biz/forum forum] to reach a larger fraction of the community. | ||
</noinclude> | </noinclude> | ||
Latest revision as of 14:06, 27 August 2010
This template, included by {{ContextSensitiveHelp}} is for inclusion on pages where an installed Freeside instance may reference the wiki for Context Sensitive Help. This should make it more clear which pages are sensitive to specific changes.
Editing Guidelines
There are a few issues of concern while editing pages containing this template.
Topic Names
It's especially important to not modify names of topic headers ( such as == Topic == ). Freeside help relies upon wiki generated html anchors (Eg.<a name="topic"></a>).
Discuss when in doubt
Please do not edit the documentation lightly, just because you have an installation problem.
Comments and proposed changes are still most welcome on the Discussion page. You may also want to ask on the mailing list or forum to reach a larger fraction of the community.
