doc/CUSTOMIZATION

   1 -------------------------------------------------------------------------------
   2 MantisBT - a php based bugtracking system
   3 Copyright (C) 2000-2002  Kenzaburo Ito - kenito@300baud.org
   4 Copyright (C) 2002-2010  MantisBT Team - mantisbt-dev@lists.sourceforge.net
   5 -------------------------------------------------------------------------------
   6
   7 CONFIGURATION
   8
   9 This file contains information to help you customize MantisBT.  A more
  10 detailed doc can be found at:
  11 http://docs.mantisbt.org/
  12
  13 * config_defaults_inc.php
  14   - this file contains the default values for all the site-wide variables.
  15 * config_inc.php
  16   - You should create this file to change config variable values.  Your
  17     values from this file will be used instead of the defaults.  This file
  18     will not be overwritten when you upgrade, but config_defaults_inc.php will.
  19     Look at config_inc.php.sample for an example.
  20
  21 * core/*_api.php - these files contains all the API library functions.
  22
  23 * global variables are prefixed by g_
  24 * parameters in functions are prefixed with p_ -- parameters shouldn't be modified within the function.
  25 * form variables are prefixed with f_
  26 * variables that have been cleaned for db insertiong are prefixed with c_
  27 * temporary variables are prefixed with t_.
  28 * template variables are prefixed with tpl_.
  29 * count variables have the word count in the variable name
  30
  31 More detail can be seen in the coding guidelines at:
  32 http://www.mantisbt.org/guidelines.php
  33
  34 * The files are split into three basic categories, viewable pages,
  35 include files and pure scripts. Examining the viewable pages (suffix _page)
  36 should make the basic file format fairly easy to see.  The file names
  37 themselves should make their purpose apparent.  The approach used is to break the
  38 work into many small files rather than have a small number of really
  39 large files.
  40
  41 * Most of the action scripts have a confirmation page to make sure the action
  42 completed successfully.  The pages will automatically redirect you after a
  43 short amount of time.  You can shorten of lengthen the time by editing
  44 $g_default_redirect_delay in config_inc.php.
  45
  46 * Edit css_inc.php to make your own page formatting.
  47
  48 * You can set $g_top_include_page and $g_bottom_include_page
  49   to alter what should be visible at the top and bottom of each page.
  50
  51 * All files were edited with TAB SPACES set to 4.
  52
  53 As a general debugging tip you should be extremely generous in using echo,
  54 print and exit functions.  This is the quickest way to see if a database
  55 query actually contains what you want, etc.