developer.jelix.org is not used any more and exists only for history. Post new tickets on the Github account.
developer.jelix.org n'est plus utilisée, et existe uniquement pour son historique. Postez les nouveaux tickets sur le compte github.

Changes between Version 2 and Version 3 of en/doc-guidelines


Ignore:
Timestamp:
Jun 21, 2009, 9:14:26 PM (11 years ago)
Author:
afroxav
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • en/doc-guidelines

    v2 v3  
    1111
    1212=== Files and folders ===
    13 For files and folders referenced inside text, use the inline code syntax. You simply add @@F@ before the path and @@ after.
     13For files and folders referenced inside text, use the inline code syntax. You simply add @@F@ before the path and @@ after. This will make the paths easily identifiable.
    1414{{{
    1515@@F@The/path/of/the/file.php@@
     
    1717
    1818=== Function names ===
    19 To specify a function name inside a paragraph, surround it with **.
     19To specify a function name inside a paragraph, surround it with **. This will make the function name bold, and catch the eye easier.
    2020{{{
    2121**jelixClass::function**
    2222**function** of the jelixClass
    2323}}}
     24
     25=== Jelix terms ===
     26All Jelix-specific terms should be in italics. This will separate generic terms from Jelix-specific terms. Surround the terms with //.
     27{{{
     28//jelix term//
     29}}}
     30
     31== Example code ==
     32Example code is code that is used as example, and that could be directly used in a website. First, you need to surround the code with the <code code_type> </code> tags. The most used code types are php, html and ini.
     33{{{
     34<code html>
     35<p>A html paragraph</p>
     36</code>
     37}}}
     38{{{
     39<code php>
     40$var = $this->param('var');
     41</code>
     42}}}
     43{{{
     44<code ini>
     45[section]
     46key = something
     47</code>
     48}}}
     49
     50 * Use a single language in the example code. Since most of the documentation was originally a translation from the french docs, examples sometime mix english and french. They should all be edited to include only english.
     51 * Be consistent in you examples. Use the same examples throughout the whole page. This will make comprehension of the concepts easier.
     52 * Use 4 spaces to indent the examples. Never use the tab character.
     53 * Indent the code using the [http://en.wikipedia.org/wiki/Indent_style#Variant:_1TBS 1TBS] coding style.
     54 * Use clear variable names. Instead of using a variable called $x, use on called $numberOfResultProcessed.