From ee7b8834e3fff0c2734740288617f7879cb80ff6 Mon Sep 17 00:00:00 2001 From: Henry Sudhof Date: Fri, 29 Aug 2008 12:03:23 +0000 Subject: minor fixes to guidelines git-svn-id: file:///svn/phpbb/branches/phpBB-3_0_0@8798 89ea8834-ac86-4346-8a33-228a782c2dd0 --- phpBB/docs/coding-guidelines.html | 39 +++++++++++++++++++++------------------ 1 file changed, 21 insertions(+), 18 deletions(-) (limited to 'phpBB/docs/coding-guidelines.html') diff --git a/phpBB/docs/coding-guidelines.html b/phpBB/docs/coding-guidelines.html index 2f333756d0..3e73e186b2 100644 --- a/phpBB/docs/coding-guidelines.html +++ b/phpBB/docs/coding-guidelines.html @@ -76,7 +76,7 @@
  • Templating
    1. General Templating
    2. -
    3. Template Fallbacks
    4. +
    5. Template Inheritance
  • Character Sets and Encodings
  • Translation (i18n/L10n) Guidelines @@ -1004,12 +1004,15 @@ append_sid("{$phpbb_root_path}memberlist.$phpEx", 'mode=group&

    3.i. Style Config Files

    -

    Style cfg files are simple name-value lists with the information necessary for installing a style. Similar cfg files exist for templates, themes and imagesets. These follow the same principle and will not be introduced individually. The important part of the style configuration file is assigning an unique name.

    +

    Style cfg files are simple name-value lists with the information necessary for installing a style. Similar cfg files exist for templates, themes and imagesets. These follow the same principle and will not be introduced individually. Styles can use installed components by using the required_theme/required_template/required_imageset entries. The important part of the style configuration file is assigning an unique name.

    -# General Information about this style
    -name = prosilver
    -copyright = © phpBB Group, 2007
    -version = 3.0.2
    +        # General Information about this style
    +        name = prosilver_duplicate
    +        copyright = © phpBB Group, 2007
    +        version = 3.0.2
    +        required_template = prosilver
    +        required_theme = prosilver
    +        required_imageset = prosilver
     	

    3.2. General Styling Rules

    Templates should be produced in a consistent manner. Where appropriate they should be based off an existing copy, e.g. index, viewforum or viewtopic (the combination of which implement a range of conditional and variable forms). Please also note that the intendation and coding guidelines also apply to templates where possible.

    @@ -1468,22 +1471,22 @@ div </form>

    -

    4.ii. Template Fallbacks

    +

    4.ii. Template Inheritance

    When basing a new template on an existing one, it is not necessary to provide all template files. By declaring the template to be "inheriting" in the template configuration file.

    -

    The Limitation on this is that the base style has to installed and complete, meaning that it is not itself using a fallback.

    +

    The Limitation on this is that the base style has to installed and complete, meaning that it is not itself inheriting.

    The effect of doing so is that the template engine will use the files in the new template where they exist, but fall back to files in the base template otherwise. Declaring a style to be inheriting also causes it to use some of the configuration settings of the base style, notably database storage.

    -

    We strongly encourage the use of fallbacks for styles based on the bundled styles, as it will ease the update procedure.

    +

    We strongly encourage the use of inheritance for styles based on the bundled styles, as it will ease the update procedure.

    -		# General Information about this template
    -		name = inherits
    -		copyright = © phpBB Group, 2007
    -		version = 3.0.2
    +        # General Information about this template
    +        name = inherits
    +        copyright = © phpBB Group, 2007
    +        version = 3.0.2
     
    -		# Defining a different template bitfield
    -		template_bitfield = lNg=
    +        # Defining a different template bitfield
    +        template_bitfield = lNg=
     
    -		# Are we inheriting?
    -		inherit_from = prosilver
    +        # Are we inheriting?
    +        inherit_from = prosilver
     		
    @@ -2257,7 +2260,7 @@ if (utf8_case_fold_nfc($string1) == utf8_case_fold_nfc($string2))

    Revision 8596+

    -- cgit v1.2.1