User Tools

Site Tools


merkalt:merkalt_site_configuration_manual

This is an old revision of the document!


Merk Alt site configuration manual

The core is not contain any settings, all the settings are instance-dependent.

Some settings for merkalt site instance are carried out to a single file settings.inc.php, placed in includes subfolder in root directory. Another instance settings contained in the set of xml files placed in xml subfolder of root directory.

Settings in settings.inc.php are need to be set up depending on site instance purpose and language:


** common site instance settings **

  • domain path (DOMAIN_ABSOLUTE_PATH constant) define full real path to the main folder of sites location;
  • instance relative path (INSTANCE_RELATIVE_PATH constant) define name of subfolder for instance location (empty for root instance);
  • server-side path (SITE_ABSOLUTE_PATH constant) define absolute path to instance subfolder (composed of domain path & instance relative path);
  • main host virtual path (MAIN_HOST_PATH constant) define virtual path for main (root) host (e.g. http://merkalt.no/ for all instances);
  • instance virtual path (HOST_PATH) define full instance virtual path (e.g. 'http://merkalt.no/bedrift/'). Composed of previously defined main host virtual path and instance relative path;
  • includes absolute path (INCLUDES_ABSOLUTE_PATH constant) define path to included site-specific modules;
  • templates absolute path (TEMPLATES_ABSOLUTE_PATH constant) define path to templates set location;
  • libraries absolute path (LIBRARIES_ABSOLUTE_PATH) define path to libraries modules;
  • URL for affiliates program (AFFILIATE_PATH constant) define virtual path to affiliates program package location. Composed of previously defined main host virtual path and relative path of affiliates package scripts location;
  • product ID for affiliates program (AFFILIATE_PRODUCT constant) define product identifier which would be passed for affiliates program sale registration. Has different values for different instances (e.g. 'Navnelapper', 'Bedrift Merkelapper', etc.);
  • ajax scripts relative path (AJAX_RELATIVE_PATH constant) define path to ajax scripts in relation to instance subfolder;
  • javascript library relative path (JSLIB_RELATIVE_PATH constant) define path to javascripts library in relation to instance subfolder;
  • motifs folder absolute path (MOTIFS_ABSOLUTE_PATH constant) define absolute path to instance motifs folder;
  • motifs folder relative path (MOTIFS_RELATIONAL_PATH constant) define relative path to instance motifs folder;


** e-mail settings **

  • name of e-mail sender (EMAIL_SENDER constant) define the name which will be shown as author (or origin) of e-mail (e.g. 'Merkalt.no');
  • address of e-mail sender (EMAIL_SENDER_ADDR constant) define e-mail address which will be shown as address of author (or origin) (e.g. 'post@merkalt.no');
  • subject of customer e-mail (EMAIL_CUSTOMER_SUBJECT constant) define subject string of customer e-mail (e.g. 'Ordrebekreftelse - Merkalt.no');
  • e-mail address of webmaster (EMAIL_WM_ADDR constant) define e-mail address of webmaster on which e-mails with orders content will be sent (e.g. 'post@merkalt.no');
  • subject of webmaster e-mail (EMAIL_WM_SUBJECT constant) define subject string for webmaster's e-mail (e.g. 'Bestilling - Merkalt.no');


** e-mail language settings ** allows to set up order table appearance in e-mails depending on language, used by site instance

  • currency (CURRENCY_NAME constant) define a name of currency used by site instance (e.g. 'Kr.');
  • order table header settings: product name (PRODUCT_NAME constant), quantity (PRODUCT_QUANTITY constant), price (PRODUCT_PRICE constant), generated label URL (PRODUCT_URL constant) are the strings, containing the text which will be shown in the columns of header of order table (e.g. 'Produktnavn', 'Ant. sett', 'Pris', 'URL');
  • order table footer rows settings: shipping cost row titles (SHIPPING_TEXT and SHIPPING_FREE constants, e.g. 'Fraktkostnad' and 'GRATIS' correspondingly), discount sum row title (DISCOUNT_TEXT constant, e.g. 'Kvantumsrabatt') and grand total title text (TOTAL_TEXT constant, e.g. 'Totalt е betale (ink. mva)');


** instance settings **

  • discounts are used (USE_DISCOUNTS constant) define using of discounts code and data by site instance; it takes values true or false only;
  • project (or instance) name (PROJECT_NAME constant) define alias for instance in order to change process logic (if required, e.g. like for idband);
  • fractional prices are used (FRACTIONAL_PRICE constant) set to true if used prices are not integer (like for english version), false otherwise;
  • maximal number of chars in text strings (MAX_TEXT_LENGTH constant) define a warning threshold (by number of characters entered) for text line if motif is added into design;
  • color selector is used (USE_COLORS constant) define using color selector for label colorization;


XML files containing additional settings, depending on language and purpose of site instance:

  • discounts.xml include a sequence of amounts thresholds and discounts values;
  • bottom_menu.xml contain settings for bottom (small gray) menu items on index (main) page of site;
  • menu.xml contain settings for main menu items on index (main) page of site;
  • messages.xml contain message strings for user notification (error and confirmation messages);
  • pages.xml contain title and metatags strings for all site instance pages (HTML headers);
  • products.xml contain product names and prices to be shown on main page and in e-mails.
  • project_props.xml additional instance settings for using in js processing. settings carried out to settings.inc.php.
merkalt/merkalt_site_configuration_manual.1246624320.txt.gz · Last modified: (external edit)