Settings.php

From ARK
Revision as of 12:20, 14 November 2008 by Andydufton (talk | contribs) (→‎Navigation Pages)

Jump to: navigation, search

This is the main settings file for each instance of ARK. The file is divide into sections as set out below


// -- GENERAL -- // // Set to TRUE if you want to use the minimising right hand navigation bar $minimiser = TRUE; // The Ark name $ark_name = 'Tutorial';

// Live search controls /*

  • live = live search
  • dd = drop down menu
  • plain = plain text search
  • /

$mode = "live";

// Live search controls for xmi /*

  • live = live search - this should only be set to live if you are using the collapsing data entry
  • dd = drop down menu
  • plain = plain text search
  • /

$xmi_mode = "live";


// List the modules that need to be loaded in this ARK project $loaded_modules = 

   array(

'abk', // address book 

       'cxt', // contexts
       'pln', // plans

'smp', // samples 

       'spf', // Special finds
       'sph', // Site photos

);

// Lists the modules to load maps for $loaded_map_mods = 

   array(
       'cxt', // context

'smp', // samples ); 

   // The default item key for this instance of Ark - format: mod_cd

$default_itemkey = 'cxt_cd'; // context


// DSN (this shouldn't need adjusting) $dsn = 'mysql://'.$sql_user.':'.$sql_pwd.'@'.$sql_server.'/'.$ark_db;


// -- SECURITY -- //

// Liveuser: // These are the names of the liveuser objects. They should be unique per ARK // (to prevent cross ark hacking). They need to be called in the code as // $$liveuser and $$liveuser_admin $liveuser = $ark_name . 'usr'; $liveuser_admin = $ark_name . 'usr' . '_admin'; // The path to the login script (relative to the document root) $loginScript = 'index.php'; // Anonymous Logins // If these variables are set then you are allowing anonymous logins // This is a security risk! Its best to leave these statements commented out. // Bear in mind that this does not need to be a real user. $anonymous_login['username'] = 'anon'; $anonymous_login['password'] = 'anon'; // Method used in forms: // get = form messages sent via get method - vissible in browser bar. // post = form message sent via post method - invisible to the user. $form_method = 'get';

// -- SKIN -- // // Skin name $skin = 'arkologik'; // Skin path $skin_path = "$ark_dir/skins/$skin";

// -- THUMBNAILS -- // // Optional $thumbnail_sizes = 

   array(
       'arkthumb_width' => 100,
       'arkthumb_height' => 100,
       'webthumb_width' => 500,
       'webthumb_height' => 500

);

// -- FORMS -- // //Default year as a setting for form data entry $default_year = '2008'; //Default site code $default_site_cd = 'PCO06';

// -- VIEWERS -- // // Number of rows to display on the data viewer $conf_viewer_rows = 25; // Default Micro viewer page (used by search result handlers) $conf_micro_viewer = $ark_dir."micro_view.php"; // Default data viewer page $conf_data_viewer = $ark_dir."data_view.php"; // Default search page - search funtions will send data thru to this page $conf_search_viewer = $ark_dir."data_view.php"; // Default $output_mode for the data viewer $default_output_mode = 'tbl';

// MAPPING // Path to temp directory (server) $ark_maptemp_dir = 'C:/ms4w/Apache/htdocs/'.$ark_dir.'mapserver/tmp/'; // Path to temp directory (web) $ark_web_maptemp_dir = 'mapserver/tmp/'; // Path to WMS mapfile (server) $ark_wms_map = 'C:/ms4w/Apache/htdocs/'.$ark_dir.'mapserver/mapfiles/ark_wms.map'; // Path to WFS mapfile (server) $ark_wfs_map = 'C:/ms4w/Apache/htdocs/'.$ark_dir.'mapserver/mapfiles/ark_wfs.map'; // Map scales $map_scales = '[1000,750,500,250,150,100,50,25,10]'; // Tilecache_path - only set this if you have a tilecache setup on your server //$tilecache_path = '/cgi-bin/tilecache.cgi?';

/*$wms_qlayers = array ( array( 'name' => 'cxt_schm', 'geom' => 'pgn' ), array( 'name' => 'sfi_points', 'geom' => 'pt' ), );*/ // Map projection (in form: "EPSG:4326") $map_projection = 'EPSG:27700'; // Map extents (in form: "1075,970,1115,1010") $map_extents = '533866, 180940,533963, 181000'; // Maplayers from the WMS layer used inthe map view $mapview_layers = array ('contexts');

// -- LOGGING -- // //Logging levels $conf_log_add = 'on'; $conf_log_edt = 'on'; $conf_log_del = 'on';

// -- SEARCH ENGINE -- // // words to cut out of multi string searches $conf_non_search_words = array('and', 'di', 'in');

// -- LANGUAGES -- // // The default lang $default_lang = 'en'; // These are the languages in use (in order) $conf_langs = array('en', 'da');

// -- FIELDS -- // include_once('field_settings.php');

// -- DOCTYPE -- // // The doctype to use for web output $doctype = "html \n 

    PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"\n
    \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\"";

// -- NAV LINKS -- //s // these links will appear in the end of the navbar $conf_linklist = 

   array(
       'file' => 'index.php',
       'vars' => 'logout=true',
       'label' => 'logout'

);


Navigation Pages

Unless listed in this array, all pages will appear in the main nav.

Example
$conf_hide_pages =
    array(
        'index.php',
        'record_view.php',
        'contact.php',
        'about.php',
        'search.php',
        'folder.php',
);

Left Panel Configuration

Left Panel- Data Entry

Configures the left panel in the data entry pages, requires the following:

  • view - the view the link should point to (regist, detfrm, files or a custom view)
  • item_key - itemkey to point to if any (cxt_cd, smp_cd)
  • href - link to the output
  • mknname - mark-up nickname will search the markup table for this nickname and print the markup
Example
$data_entry_left_panel[] = 
array(
        'href' => "{$_SERVER['PHP_SELF']}?view=regist&item_key=cxt_cd", 
        'mknname' => 'regcxt'
	);
$data_entry_left_panel[] = 
array(
	'href' => "{$_SERVER['PHP_SELF']}?view=detfrm&item_key=cxt_cd", 
	'mknname' => 'detcxt'
	);
$data_entry_left_panel[] = 
array(
	'href' => "{$_SERVER['PHP_SELF']}?view=regist&item_key=pln_cd", 
	'mknname' => 'regpln'
	);
$data_entry_left_panel[] = 
array(
	'href' => "{$_SERVER['PHP_SELF']}?view=regist&item_key=sph_cd", 
	'mknname' => 'regsph'
	);
$data_entry_left_panel[] = 
array(
	'href' => "{$_SERVER['PHP_SELF']}?view=regist&item_key=abk_cd", 
	'mknname' => 'regabk'
	);
$data_entry_left_panel[] = 
array(
	'href' => "{$_SERVER['PHP_SELF']}?view=regist&item_key=smp_cd", 
	'mknname' => 'regsmp'
	);
$data_entry_left_panel[] = 
array(
	'href' => "{$_SERVER['PHP_SELF']}?view=detfrm&item_key=smp_cd", 
	'mknname' => 'detsmp'
	);
$data_entry_left_panel[] = 
array(
	'href' => "{$_SERVER['PHP_SELF']}?view=materi&item_key=smp_cd", 
	'mknname' => 'matsmp'
	);
$data_entry_left_panel[] = 
array(
	'href' => "{$_SERVER['PHP_SELF']}?view=regist&item_key=spf_cd", 
	'mknname' => 'regspf'
	);
$data_entry_left_panel[] = 
array(
	'href' => "{$_SERVER['PHP_SELF']}?view=files", 
	'mknname' => 'uplfile'
	);

Left Panel- Micro View

Configures the left panel in the micro view pages, requires the following:

  • item_key - itemkey to point to if any (cxt_cd, smp_cd)
  • href - link to the output
  • mknname - mark-up nickname will search the markup table for this nickname and print the markup
Example
$micro_view_left_panel[] = 
array(
	'href' => "{$_SERVER['PHP_SELF']}?item_key=cxt_cd", 
	'mknname' => 'vwcxt'
	);
$micro_view_left_panel[] = 
array(
	'href' => "{$_SERVER['PHP_SELF']}?item_key=pln_cd", 
	'mknname' => 'vwpln'
	);
$micro_view_left_panel[] = 
array(
	'href' => "{$_SERVER['PHP_SELF']}?item_key=smp_cd", 
	'mknname' => 'vwsmp'
	);
$micro_view_left_panel[] = 
array(
	'href' => "{$_SERVER['PHP_SELF']}?item_key=spf_cd", 
	'mknname' => 'vwspf'
	);
$micro_view_left_panel[] = 
array(
	'href' => "{$_SERVER['PHP_SELF']}?item_key=sph_cd", 
	'mknname' => 'vwsph'
	);

Left Panel- Data View

This configures the left panel for the data view pages and needs the following:

  • href - link to the output ({$_SERVER['PHP_SELF']} is on same page, $ark_dir/export.php is on export page)
  • output_mode - output format for internal links
  • output - is output format for external links
  • mknname - mark-up nickname will search the markup table for this nickname and print the markup
Example
$data_view_left_panel[] =
    array(
        'href' => "$ark_dir/export.php?output=CSVExt",
        'mknname' => 'expcsv'
);
$data_view_left_panel[] =
    array(
        'href' => "$ark_dir/export.php?output=XMLExt",
        'mknname' => 'expxml'
);
$data_view_left_panel[] =
    array(
        'href' => "{$_SERVER['PHP_SELF']}?output_mode=tbl",
        'mknname' => 'vwtbl'
);
$data_view_left_panel[] =
    array(
        'href' => "{$_SERVER['PHP_SELF']}?output_mode=chat",
        'mknname' => 'vwchat'
);

Left Panel- User Home

This configures the left-panel for the user home pages and needs the following fields:

  • href - link to the output
  • mknname - mark-up nickname will search the markup table for this nickname and print the markup
Example
$user_home_left_panel[] =
    array(
        'href' => "data_view.php?vtok=1&nname=All_Contexts&ftype=key&key=1&ktype=all",
        'mknname' => 'vwcxt'
);


OLD OLD OLD OLD OLD

General

This sets the display name of the ARK instance. Used in page titles etc. 

// The Ark name
$ark_name = 'FASTI admin';

The folder name of THIS instance of Ark (relative to the document root of the host in which it is hosted) 

// The folder name of THIS instance of Ark (relative to the document root of the host in which it is hosted)
$ark_dir = '/v2/';
<pre>

A list of loaded modules
<pre>
//array of loaded modules
$loaded_modules = 
    array(
        'fst',
        'sea',
        'bib',
        'rpt',
        'abk',
);

A default itemkey. Not essential but handy in guessing the itemkey sometimes. 

//  The default item key for this instance of Ark.
$default_itemkey = 'fst_cd';

Database

// DATABASE
// The mysql db name of this instance of ark
$ark_db = 'fasti_db2';
// The mysqlserver
$sql_server = 'localhost';
// The mysql user who will make all the db calls
$sql_user = 'sql_php_user';
// The mysql user's password
$sql_pwd = 'test';
// DSN (this shouldn;t need adjusting)
$dsn = 'mysql://'.$sql_user.':'.$sql_pwd.'@'.$sql_server.'/'.$ark_db;

Security

/*SECURITY
 *these are the names of the liveuser objects. They should be unique per ARK 
 *(to prevent cross ark hacking). They need to be called in the code as
 * $$liveuser and $$liveuser_admin
 */
$liveuser = $ark_name . 'usr';
$liveuser_admin = $ark_name . 'usr' . '_admin';
//the path to the login script (relative to the document root)
$loginScript = 'index.php';
//Anonymous Logins
//If these variables are set then you are allowing anonymous logins
//This is a security risk! Its best to leave these statements commented out.
//Bear in mind that this does not need to be a real user.
//$anonymous_login['username'] = 'anon';
//$anonymous_login['password'] = 'anon';

Skin

// SKIN
// Skin name
$skin = 'fasti';
// Skin path
$skin_path = "$ark_dir"."skins/$skin";

Forms

// FORMS
//Default year as a setting for form data entry
$default_year = '2005';
//Default site code
$default_site_cd = 'AIAC';

Viewers

// VIEWERS
// FIXME: make this an option of the table setup array
// Number of rows to display on the data viewer
$conf_viewer_rows = 15;
// Default Micro viewer page (used by search result handlers)
$conf_micro_viewer = $ark_dir."micro_view.php";
// Default data viewer page
$conf_data_viewer = $ark_dir."data_view.php";
// Default search page - search funtions will send data thru to this page
$conf_search_viewer = $ark_dir."data_view.php";
//Default $output_mode for the data viewer
$default_output_mode = 'tbl';

Mapping

// MAPPING
// Path to clarent (web)
$clarent_path = "clarent/0_6/clarent";
// Path to data directory (server)
$ark_mapdata_dir = '/srv/www/htdocs/fasti/'.$ark_dir.'mapserver/data/';
// Path to temp directory (server)
$ark_maptemp_dir = '/srv/www/htdocs/fasti/'.$ark_dir.'mapserver/tmp/';
// Path to temp directory (web)
$ark_web_maptemp_dir = 'mapserver/tmp/';
// Default maptype (STU WHATS THIS)
$default_maptype = 1;
// Path to base_map (server)
$default_base_map = '/srv/www/htdocs/fasti/'.$ark_dir.'mapserver/mapfiles/base.map';
//$default_base_map = '/srv/www/htdocs/fasti/mapserver/base.map';
// Path to WMS mapfile (server)
$wms_map = '/srv/www/htdocs/fasti/'.$ark_dir.'mapserver/mapfiles/fasti_wms.map';
// Path to WFS mapfile (server)
$wfs_map = '/srv/www/htdocs/fasti/'.$ark_dir.'mapserver/mapfiles/fasti_wfs.map';
//spatial modules - these are the modules that have geometry
$spat_mods = array('cor');

Logging

// LOGGING
//Logging levels
$conf_log_add = 'on';
$conf_log_edt = 'on';
$conf_log_del = 'on';

Search Engine

// SEARCH ENGINE
// words to cut out of multi string searches
$conf_non_search_words = array('and', 'di', 'in');

Languages

// LANGUAGES
// The default lang
$default_lang = 'en';
// These are the languages in use (in order)
$conf_langs = array('en', 'it', 'ro', 'mk');

Fields

// FIELDS
include_once('field_settings.php');

Doctype

// DOCTYPE
// The doctype to use for web output
$doctype = "html \n
     PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"\n
     \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\"";

Navigation Links

// NAV LINKS
// these links will appear in the end of the navbar
$conf_linklist =
    array(
        'file' => 'index.php',
        'vars' => 'logout=true',
        'label' => 'logout'
);

Navigation Pages

// NAV PAGES
// unless listed in this array, all pages will appear int he main nav
$conf_hide_pages =
    array(
        'index.php',
        'record_view.php',
        'contact.php',
        'about.php',
        'search.php',
        'folder.php',
        'export.php'
);
Retrieved from "https://ark.lparchaeology.com/wiki/index.php?title=Settings.php&oldid=607"