Friday, July 30, 2010
   
Text Size

Documentation Conventions

Rate this item
(0 votes)

Documentation Conventions

This documentation uses some typographic conventions to convey important information. The most important feature is the "admonitions" styles. These are specially styled paragraphs, used to denote some piece of information which is not obvious but you should be aware of. There are four levels of importance used in this manual: Warning, Important, Note, Tip. Here are some samples:

[Warning]Warning

The highest level is Warning. This is used to stress out a specific condition which will cause the software to fail or might compromise your site's integrity.

[Important]Important

The second level of importance is Important. It is used to highlight some not very obvious information you should be aware of in order to avoid software failure.

[Note]Note

This is a low level of importance piece of information, usually informing you on background or otherwise non-critical facts.

[Tip]Tip

Last, but not least, we have the Tips. These are used to give you advice for doing something you probably didn't know it was possible.

These paragraphs point out some non-obvious information you must be aware of. Reading these thoroughly will decrease the chance of getting stuck and will alleviate the need to post to the support forums for help.

JoomlaPack comes in two editions: JoomlaPack Core and JoomlaPack Plus. When we are refering to features present only in JoomlaPack Plus, we will mark them with a [JP+] marking right beside them.

[Note]Note

The JoomlaPack Core and Plus are both available free of charge. JoomlaPack Core is designed for novice users, whereas JoomlaPack Plus is designed for power users and web professionals.

Then, there are code sections, which look like this:

This is a code section.
This is one code line of the section.
Here is another line.
And yet another one.

Code sections are used mainly for external configuration file contents.

Last modified on Wednesday, 17 February 2010 14:38

Sponsored Links

Banner

Support Unavailability

Enhanced Support will experience reduced or no availability during the dates marked in red on the calendar below. If you file a support ticket during this period, we might take longer to get back to you.

Calendar shown in Athens timezone
See the full calendar