|-
|
! File !! Description
|
|-
|
-| ''pkg''/bit_setup_inc.php || This is the only file required for a package. It registers information about the package during initial setup.
|
+| ''pkg''/bit_setup_inc.php |
+| This is the only file required for a package. It registers information about the package during initial setup. |
|-
|
-| ''pkg''/admin/schema_inc.php ~~grey:''pkg''/admin/bit_schema_inc.php~~|| If your package has any database information, the information is defined in this file. It will be scanned during install, and a few administration pages
|
+| ''pkg''/admin/schema_inc.php%%% ~~grey:''pkg''/admin/bit_schema_inc.php~~ |
+| If your package has any database information, the information is defined in this file. It will be scanned during install, and a few administration pages |
|-
|
-| ''pkg''/admin/admin_''pkg''_inc.php ~~grey:''pkg''/admin/bit_admin_inc.php~~ || Administration page for the package, picked up by kernel/admin/index.php?page=''pkg''.
|
+| ''pkg''/admin/admin_''pkg''_inc.php%%% ~~grey:''pkg''/admin/bit_admin_inc.php~~ |
+| Administration page for the package, picked up by kernel/admin/index.php?page=''pkg''. |
|-
|
-| ''pkg''/admin/upgrades/ || This directory contains files named with the form ''version''.php that describe package versions and any code needed to upgrade data and tables when that ''version'' upgrade occurs.
|
+| ''pkg''/admin/upgrades/ |
+| This directory contains files named with the form ''version''.php that describe package versions and any code needed to upgrade data and tables when that ''version'' upgrade occurs. |
|-
|
-| ''pkg''/modules/ || This directory contains the interfaces blocks that can be arranged in various layouts
|
+| ''pkg''/modules/ |
+| This directory contains the interfaces blocks that can be arranged in various layouts |
|-
|
-| ''pkg''/templates/ || This directory contains the Smarty templates for the package pages
|
+| ''pkg''/templates/ |
+| This directory contains the Smarty templates for the package pages |
|-
|
-| ''pkg''/templates/admin_''pkg''.tpl ~~grey:''pkg''/templates/bit_admin.tpl~~ || Administration template for the package, picked up by kernel/admin/index.php?page=''pkg''.
|
+| ''pkg''/templates/admin_''pkg''.tpl%%% ~~grey:''pkg''/templates/bit_admin.tpl~~ |
+| Administration template for the package, picked up by kernel/admin/index.php?page=''pkg''. |
|-
|
-| ''pkg''/templates/menu_''pkg''_admin.tpl ~~grey:''pkg''/templates/bit_admin_menu.tpl~~ || template for the package administration menu.
|
+| ''pkg''/templates/menu_''pkg''_admin.tpl%%% ~~grey:''pkg''/templates/bit_admin_menu.tpl~~ |
+| template for the package administration menu. |
|-
|
-| ''pkg''/templates/menu_''pkg''.tpl ~~grey:''pkg''/templates/menu.tpl~~ || template for the package menu. Usually specified in ''pkg''/bit_setup_inc.php.
|
+| ''pkg''/templates/menu_''pkg''.tpl%%% ~~grey:''pkg''/templates/menu.tpl~~ |
+| template for the package menu. Usually specified in ''pkg''/bit_setup_inc.php. |
|}
|
|
The ~~grey:filenames specified in grey~~ are my thoughts are what the file names could be migrated to with the aim of improving consistency and ease of understanding. The ideas being; that there is no point in package name repetition/redundancy in the file names and it is already discouraged in the ((CodingGuidelines)), and that introducing a prefix of 'bit_' to files that are loaded just because of their names and location in a package would help indicate them as such files. |