Difference between revisions of "Template:ContextSensitiveHelp"

From Freeside
Jump to: navigation, search
Line 1: Line 1:
<includeonly></includeonly><noinclude>
+
<includeonly><div style="background: #F0F0F0;">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:ContextSensitiveHelp]]</includeonly><noinclude>
  
This template, included by <em><b><nowiki>{{:ContextSensitiveHelp}}</nowiki></b></em> (from any namespace), or <nowiki>{{ContextSensitiveHelp}}</nowiki> is for inclusion on pages where an installed [[Freeside]] instance may reference the wiki for <em>Context Sensitive Help</em>.  This will help make it more clear which pages are sensitive to this specific type of change to the documentation.  It's especially important to not modify topic links.  Freeside help relies upon wiki generated <pre style="padding: inherit; border: none; display: inline;"><a name="topic"></a></pre> anchors.
+
This template, included by <em><b><nowiki>{{:ContextSensitiveHelp}}</nowiki></b></em> (from any namespace), or <nowiki>{{ContextSensitiveHelp}}</nowiki> in the <em>Main</em> name space, 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 ==
 +
 +
=== 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 <pre style="padding: inherit; border: none; display: inline;"><a name="topic"></a></pre> html anchors.
 +
 +
=== Discuss when in doubt ===
 +
 +
Please do not edit the documentation lightly, just because you have an installation problem. (Thanks Ivan)
 +
 +
Your comments in the Discussion page is still welcome.  However, it will only be seen by a fraction of the [[Freeside:Community_Portal|Freeside community]].
 
</noinclude>
 
</noinclude>

Revision as of 09:55, 27 February 2008


This template, included by {{:ContextSensitiveHelp}} (from any namespace), or {{ContextSensitiveHelp}} in the Main name space, 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

Topic Names

It's especially important to not modify names of topic headers ( such as == Topic == ). Freeside help relies upon wiki generated
<a name="topic"></a>
html anchors.

Discuss when in doubt

Please do not edit the documentation lightly, just because you have an installation problem. (Thanks Ivan)

Your comments in the Discussion page is still welcome. However, it will only be seen by a fraction of the Freeside community.