Help15

Difference between revisions of "Screen.templates.15"

From Joomla! Documentation

(New page: ==Description== {{Help screen description placeholder}} ==Version Changes== Describe any significant changes between the 1.0.x series and the 1.5 version of this particular screen. For ex...)
 
m
Line 3: Line 3:
  
 
==Version Changes==
 
==Version Changes==
Describe any significant changes between the 1.0.x series and the 1.5 version of this particular screen. For example Content Items are now Articles and Static Content Items have become Unassigned Articles. Use paragraph format type and do not add extra white space. Ensure that you use the correct styles for inline emphasis and notices.
+
{{Help screen version changes placeholder}}
  
 
==Unique Column Headers: Common Column Headers==
 
==Unique Column Headers: Common Column Headers==

Revision as of 19:11, 6 January 2008

Description[edit]

Description Placeholder

Enter a general overview of the functions of the screen under consideration. Use paragraph format type and do not add extra white space. Ensure that you use the correct styles for inline emphasis and notices.

Please remove this placeholder as soon as you start entering text here.

Version Changes[edit]

Version Changes Placeholder

Describe any significant changes between the 1.0.x series and the 1.5 version of this particular screen. For example Content Items are now Articles and Static Content Items have become Unassigned Articles. Use paragraph format type and do not add extra white space. Ensure that you use the correct styles for inline emphasis and notices.

Please remove this placeholder as soon as you start entering text here.

Unique Column Headers: Common Column Headers[edit]

Enter details of any specific Column Headers definitions that are unique to this function alone. Do not include this section if not applicable. There is no need to go into major detail in this section unless it is appropriate to do so. Use your judgement or discuss with other team members. Use definition term (dt) and style (dt15) for the name of the Column Header and definition description (dd) and style (dd15) for the explanation of the term.

Typical Usage[edit]

This is the most important new section in these Help Screens. This is the meat on the bones of the Help Screen. This should represent the typical basic usage of the screens' functionality in normal use. Write it as a guide not just as a sequence of instructions - except when this is required. Include links to other screens that are needed to complete the function effectively. Use paragraph format type and do not add extra white space. Ensure that you use the correct styles for inline emphasis and notices.

Quick Tips[edit]

Using the analogy of the previous section this is the sauce and condiments that go with the meat! Provide any one liners that may not normally be obvious. These may already be known to you or you may spot something within the forums or other publications. Just ensure they work and that the wording is consistent with the rest of the document and not a straight copy of the content from other sources. Use paragraph format type and do not add extra white space. Ensure that you use the correct styles for inline emphasis and notices.

Points to Watch[edit]

Highlight known issues or easy traps that can be fallen into when using this function. Include references to known solutions rather than repeating the solutions here, unless considered essential. Even if there are none immediately apparent leave this section in the Help Screen - this message for future reference. Just replace this message with None Known at this Time. Use paragraph format type and do not add extra white space. Ensure that you use the correct styles for inline emphasis and notices.

Dependencies[edit]

Describe other screens that rely on the presence of this function or that this function relies upon, in order to work correctly for example: a Category depends upon the presence of a Section (up) and it must be in place before a Categorised Article (down) can be created. If there are no Dependencies either up or down for the particular screen just state None but do include the section. Use paragraph format type and do not add extra white space. Ensure that you use the correct styles for inline emphasis and notices. It will probably be sufficient to just list these and provide links to the Help Screens relating to the dependency.