|
|
(45 intermediate revisions by the same user not shown) |
Line 1: |
Line 1: |
− | This is the main settings file for each instance of ARK. The file is divide into sections as set out below | + | This is the main settings file for administrators to set defaults for security settings and permissions, loaded modules, etc. for each instance of ARK. As of v1.0, for settings related to page display and navigation see [[page_settings.php]], and those related to server settings see [[env_settings.php]]. |
| | | |
− | ===Server Setup===
| + | ==Server Setup== |
− | The server setup being used. Currently ARK is configured for Mapserver 4 Windows (ms4w), Mac, and Linux servers. Set the server type and include the [[env_settings.php]] file using: | + | The server setup being used (can include"ms4w", "mac", or "linux"): |
| <pre> | | <pre> |
| $server="ms4w"; | | $server="ms4w"; |
− | // Include settings related to your server environment (this also uses the server specified above)
| |
− | include('env_settings.php');
| |
| </pre> | | </pre> |
| | | |
− | ====Server Specific Information====
| + | And include the settings related to your server environment contained within the [[env_settings.php]]: |
− | You will need to edit the following depending on your specific server information. Edit the information under the type of server you are using.
| |
− | | |
− | '''YOU MUST UPDATE THE SERVER SPECIFIC INFORMATION BEFORE YOUR ARK INSTALLATION WILL FUNCTION. AS A FIRST STEP UPDATE:'''
| |
− | *'''$ark_dir''' - your ark directory
| |
− | *'''$ark_db''' - your ark database
| |
− | *'''$sql_server''' - the MySQL server
| |
− | *'''$sql_user''' - The MySQL user who will make db calls
| |
− | *'''$sql_pwd''' - The mysql user password
| |
− | | |
− | The rest of the basic settings for each server are included below:
| |
| <pre> | | <pre> |
− | switch($server){
| + | // Include settings related to your server environment |
− |
| + | include('env_settings.php'); |
− | case ms4w:
| |
− | // The folder name of THIS instance of Ark (relative to the document root of the host in which it is hosted)
| |
− | $ark_dir = '/ark/';
| |
− | // The mysql db name of this instance of ark
| |
− | $ark_db = 'ark';
| |
− | // The mysqlserver
| |
− | $sql_server = 'localhost';
| |
− | // The mysql user who will make all the db calls
| |
− | $sql_user = 'usr';
| |
− | // The mysql user's password
| |
− | $sql_pwd = 'psw';
| |
− | // EXPORT
| |
− | $export_dir = $ark_dir.'data/tmp/';
| |
− | // FILE specific
| |
− | // Where the files are stored after they are registered (/ after last folder)
| |
− | $registered_files_dir = $doc_root. $ark_dir . 'data/files/';
| |
− | // Where the files are stored after they are registered (/ after last folder)
| |
− | // Browser option: default is $ark_dir . 'data/files/
| |
− | // If the registered files directory is outside the main server directory then you need to setup an alias in httdp.conf
| |
− | $registered_files_host = $ark_dir . 'data/files/';
| |
− | // Top directory of the file browser - can only search relative to this directory.
| |
− | $default_upload_dir = 'C:/';
| |
− | break;
| |
− | case mac:
| |
− | // The folder name of THIS instance of Ark (relative to the document root of the host in which it is hosted)
| |
− | $ark_dir = '/ark/';
| |
− | // The mysql db name of this instance of ark
| |
− | $ark_db = 'ark';
| |
− | // The mysqlserver
| |
− | $sql_server = '127.0.0.1';
| |
− | // The mysql user who will make all the db calls
| |
− | $sql_user = 'usr';
| |
− | // The mysql user's password
| |
− | $sql_pwd = 'pws';
| |
− | // EXPORT
| |
− | $export_dir = $ark_dir.'data/tmp/';
| |
− | // FILE specific
| |
− | // Where the files are stored after they are registered (/ after last folder)
| |
− | $registered_files_dir = $doc_root. $ark_dir . 'data/files/';
| |
− | // Where the files are stored after they are registered (/ after last folder)
| |
− | // Browser option: default is $ark_dir . 'data/files/
| |
− | // If the registered files directory is outside the main server directory then you need to setup an alias in httdp.conf
| |
− | $registered_files_host = $ark_dir . 'data/files/';
| |
− | // Top directory of the file browser - can only search relative to this directory.
| |
− | $default_upload_dir = '\srv';
| |
− | | |
− | break;
| |
− | case linux:
| |
− | // The folder name of THIS instance of Ark (relative to the document root of the host in which it is hosted)
| |
− | $ark_dir = '/ark/';
| |
− | // The mysql db name of this instance of ark
| |
− | $ark_db = 'ark';
| |
− | // The mysqlserver
| |
− | $sql_server = 'localhost';
| |
− | // The mysql user who will make all the db calls
| |
− | $sql_user = 'usr';
| |
− | // The mysql user's password
| |
− | $sql_pwd = 'pwd';
| |
− | // EXPORT
| |
− | $export_dir = $ark_dir.'data/tmp/';
| |
− | // FILE specific
| |
− | // Where the files are stored after they are registered (/ after last folder)
| |
− | $registered_files_dir = $doc_root. $ark_dir . 'data/files/';
| |
− | // Where the files are stored after they are registered (/ after last folder)
| |
− | // Browser option: default is $ark_dir . 'data/files/
| |
− | // If the registered files directory is outside the main server directory then you need to setup an alias in httdp.conf
| |
− | $registered_files_host = $ark_dir . 'data/files/';
| |
− | // Top directory of the file browser - can only search relative to this directory.
| |
− | $default_upload_dir = '\srv';
| |
− | break;
| |
− | }
| |
| </pre> | | </pre> |
| | | |
− | ===General=== | + | ==ARK Name and Markup== |
− | This contains general configuration for the ARK.
| |
− | | |
− | ====Minimiser====
| |
− | Is the minimiser enabled?
| |
− | To use the minimiser on specific data entry pages you need to go to the mod_settings files (ex. mod_cxt_settings.php) and make sure that 'col_type' => 'collaps_col', instead of single_col in the $conf_dat_materi and $conf_dat_detfrm settings.
| |
− | <pre>
| |
− | // Set to TRUE if you want to use the minimising left hand navigation bar
| |
− | $minimiser = TRUE;
| |
− | </pre>
| |
− | | |
− | ====ARK Name====
| |
| The name of this instance of ARK - can not contain spaces! | | The name of this instance of ARK - can not contain spaces! |
| <pre> | | <pre> |
Line 113: |
Line 19: |
| $ark_name = 'Tutorial'; | | $ark_name = 'Tutorial'; |
| </pre> | | </pre> |
− |
| |
− | ====ARK Name (Markup)====
| |
| The name of this instance of ARK - as markup. Appears on the index (home) page and in the browser window/tab title. Should be entered in cor_tbl_markup accordingly. | | The name of this instance of ARK - as markup. Appears on the index (home) page and in the browser window/tab title. Should be entered in cor_tbl_markup accordingly. |
| <pre> | | <pre> |
Line 122: |
Line 26: |
| </pre> | | </pre> |
| | | |
− | ===Live Search===
| + | ==Live Search== |
| The controls for the live search function | | The controls for the live search function |
| <pre> | | <pre> |
Line 147: |
Line 51: |
| </pre> | | </pre> |
| | | |
− | ===Fancy Text Search===
| + | ==Fancy Text Search== |
| The controls for fancy text search, using boolean functions such as +, -, "search term", etc (like Google). | | The controls for fancy text search, using boolean functions such as +, -, "search term", etc (like Google). |
| <pre> | | <pre> |
Line 158: |
Line 62: |
| </pre> | | </pre> |
| | | |
− | ===Modules===
| + | ==Modules== |
| Configure the modules to be used in this ARK project: | | Configure the modules to be used in this ARK project: |
| <pre> | | <pre> |
Line 196: |
Line 100: |
| </pre> | | </pre> |
| | | |
− | ===Security and Permissions===
| + | ==Security and Permissions== |
| The security and permissions for ARK is handled by LiveUser. | | The security and permissions for ARK is handled by LiveUser. |
− | ====Security====
| + | ===Security=== |
| The liveuser settings need to be set, as well as the variables for allowing anonymous logins. The liveuser configuration is as follows: | | The liveuser settings need to be set, as well as the variables for allowing anonymous logins. The liveuser configuration is as follows: |
| <pre> | | <pre> |
Line 219: |
Line 123: |
| </pre> | | </pre> |
| | | |
− | ====Permissions====
| + | ===Permissions=== |
| A variety of permissions need to be set to ensure the appropriate users are making use of advanced functions. All permissions are based on the numerical id of security groups (from the cor_lvu_groups table). For instance, it is possible to allow some users to make their personal saved filters public for all to use. As of v0.8, adding to control lists (adding attributes), and perhaps most importantly, advanced record functions such as edit module types and delete entire records need to also have sgrps defined. | | A variety of permissions need to be set to ensure the appropriate users are making use of advanced functions. All permissions are based on the numerical id of security groups (from the cor_lvu_groups table). For instance, it is possible to allow some users to make their personal saved filters public for all to use. As of v0.8, adding to control lists (adding attributes), and perhaps most importantly, advanced record functions such as edit module types and delete entire records need to also have sgrps defined. |
| <pre> | | <pre> |
Line 244: |
Line 148: |
| </pre> | | </pre> |
| | | |
− | ====Form Methods==== | + | ==Forms== |
| + | ===Form Methods=== |
| + | Choose between 'get' or 'post' form methods. |
| <pre> | | <pre> |
| // -- FORMS -- // | | // -- FORMS -- // |
Line 251: |
Line 157: |
| // post = form message sent via post method - invisible to the user. | | // post = form message sent via post method - invisible to the user. |
| $form_method = 'get'; | | $form_method = 'get'; |
| + | </pre> |
| + | ===Form Defaults=== |
| + | Set default year and site code for data entry and viewing: |
| + | <pre> |
| + | //Default year as a setting for form data entry |
| + | $default_year = '2008'; |
| + | //Default site code |
| + | $default_site_cd = 'PCO06'; |
| </pre> | | </pre> |
| | | |
− | | + | ==Skin== |
− | ===Skin===
| |
| Sets the skin name and skin path for this ARK project: | | Sets the skin name and skin path for this ARK project: |
| <pre> | | <pre> |
Line 263: |
Line 176: |
| </pre> | | </pre> |
| | | |
− | ===Thumbnails===
| + | ==Thumbnails== |
| Sets thumbnail sizes for ARK (this will be used when uploading files) | | Sets thumbnail sizes for ARK (this will be used when uploading files) |
| <pre> | | <pre> |
Line 276: |
Line 189: |
| </pre> | | </pre> |
| | | |
− | ===Forms===
| |
− | Set default year and site code for data entry and viewing:
| |
− | <pre>
| |
− | //Default year as a setting for form data entry
| |
− | $default_year = '2008';
| |
− | //Default site code
| |
− | $default_site_cd = 'PCO06';
| |
− | </pre>
| |
− |
| |
− | ===Viewers===
| |
− | Configure the viewers to display a set number of rows:
| |
− | <pre>
| |
− | // -- VIEWERS -- //
| |
− | // Number of rows to display on the data viewer
| |
− | $conf_viewer_rows = 25;
| |
− | </pre>
| |
− |
| |
− | And the number of pages to display on the data viewer:
| |
− | <pre>
| |
− | // Number of pages to display on the data viewer
| |
− | $conf_num_res_pgs = 5; // best choose an odd number
| |
− | </pre>
| |
− |
| |
− | Also configure the index pages for Micro View, Data View, and Search pages:
| |
− | <pre>
| |
− | // 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";
| |
− | </pre>
| |
− |
| |
− | Set the default for search results display:
| |
− | <pre>
| |
− | // Default $output_mode for the data viewer
| |
− | $default_output_mode = 'tbl';
| |
− | </pre>
| |
− |
| |
− | ===Mapping===
| |
− | Set the basic configuration for mapping functions (map directory, temp directory, etc):
| |
− | <pre>
| |
− | // 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?';
| |
− | </pre>
| |
− |
| |
− | Configure the wms query layers:
| |
− | <pre>
| |
− | /*$wms_qlayers = array (
| |
− | array(
| |
− | 'name' => 'cxt_schm',
| |
− | 'geom' => 'pgn'
| |
− | ),
| |
− | array(
| |
− | 'name' => 'sfi_points',
| |
− | 'geom' => 'pt'
| |
− | ),
| |
− | );*/
| |
− | </pre>
| |
− |
| |
− | Set up the map projection and extents to suit the location of the ARK project:
| |
− | <pre>
| |
− | // Map projection (in form: "EPSG:4326")
| |
− | $map_projection = 'EPSG:27700';
| |
− | // Map extents (in form: "1075,970,1115,1010")
| |
− | $map_extents = '533866, 180940,533963, 181000';
| |
− | </pre>
| |
− |
| |
− | Set the layer from WMS to be used in map view
| |
− | <pre>
| |
− | // Maplayers from the WMS layer used in the map view
| |
− | $mapview_layers = array ('contexts');
| |
− | </pre>
| |
| | | |
− | ===Logging===
| + | ==Logging== |
| Configures logging levels to record logging into database and changes to data. Set to 'on' to turn the logging on, otherwise set to FALSE. | | Configures logging levels to record logging into database and changes to data. Set to 'on' to turn the logging on, otherwise set to FALSE. |
| <pre> | | <pre> |
Line 369: |
Line 199: |
| </pre> | | </pre> |
| | | |
− | ===Search Engine===
| + | ==Search Engine== |
| Configures words to cut out of multi-string searches to streamline the search process and maximise results. | | Configures words to cut out of multi-string searches to streamline the search process and maximise results. |
| <pre> | | <pre> |
Line 376: |
Line 206: |
| </pre> | | </pre> |
| | | |
− | ===Languages===
| + | ==Languages== |
| Configures the default language and other languages in use. | | Configures the default language and other languages in use. |
| <pre> | | <pre> |
Line 385: |
Line 215: |
| </pre> | | </pre> |
| | | |
− | ===Fields===
| + | ==Fields== |
| Used to include the [[field_settings.php]] file. | | Used to include the [[field_settings.php]] file. |
| <pre> | | <pre> |
Line 391: |
Line 221: |
| </pre> | | </pre> |
| | | |
− | ===Document Type===
| + | ==Document Type== |
| Configures the document type to use for web output | | Configures the document type to use for web output |
| <pre> | | <pre> |
Line 397: |
Line 227: |
| PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"\n | | PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"\n |
| \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\""; | | \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\""; |
− | </pre>
| |
− |
| |
− | ===Navigation===
| |
− | ====Navigation Links====
| |
− | Configure to state what links will appear in the end of the navigation bar.
| |
− | <pre>
| |
− | $conf_linklist =
| |
− | array(
| |
− | 'file' => 'index.php',
| |
− | 'vars' => 'logout=true',
| |
− | 'label' => 'logout'
| |
− | );
| |
− | </pre>
| |
− |
| |
− | ====Navigation Pages====
| |
− | Unless listed in this array, all pages will appear in the main nav.
| |
− | <pre>
| |
− | $conf_hide_pages =
| |
− | array(
| |
− | 'index.php',
| |
− | 'record_view.php',
| |
− | 'contact.php',
| |
− | 'about.php',
| |
− | 'search.php',
| |
− | 'folder.php',
| |
− | 'overlay_holder.php',
| |
− | 'export.php',
| |
− | 'alias_admin.php',
| |
− | 'markup_admin.php',
| |
− | 'import.php'
| |
− | );
| |
− | </pre>
| |
− |
| |
− | ====Results Toolbar====
| |
− | Configure the tools and display options for the search page (data_view). All of the toolbars require the following in the array:
| |
− | *''''type'''' - Options of 'img', 'text', or 'newpage' (used in the all record view to display function in a new page
| |
− | *''''href'''' - The href link to the function being called
| |
− | *''''css_class'''' - The css class to style the button or display
| |
− | *''''mkname'''' - The name of markup contained within cor_tbl_markup used for buttons which combine text and images, are just text based. Set to FALSE if not used.
| |
− | *''''lightbox'''' - Option of using the lightbox when calling an overlay form, set to FALSE otherwise
| |
− |
| |
− | First form the individual buttons:
| |
− |
| |
− | *'''Tools''':
| |
− | <pre>
| |
− | // TOOLS
| |
− | $group_tools[] =
| |
− | array(
| |
− | 'type' => 'img',
| |
− | 'href' => "overlay_holder.php?sf_conf=conf_mac_userconfigfields&lboxreload=1",
| |
− | 'css_class' => 'gears',
| |
− | 'mkname' => FALSE,
| |
− | 'lightbox' => 'lightbox'
| |
− | );
| |
− | </pre>
| |
− |
| |
− | *'''Displays''':
| |
− | <pre>
| |
− | // DISPs
| |
− | $res = "results_mode=disp";
| |
− | // Text view
| |
− | $group_disp[] =
| |
− | array(
| |
− | 'type' => 'img',
| |
− | 'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=text",
| |
− | 'css_class' => 'text',
| |
− | 'mkname' => FALSE,
| |
− | 'lightbox' => FALSE
| |
− | );
| |
− | // Table view
| |
− | $group_disp[] =
| |
− | array(
| |
− | 'type' => 'img',
| |
− | 'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=table",
| |
− | 'css_class' => 'table',
| |
− | 'mkname' => FALSE,
| |
− | 'lightbox' => FALSE
| |
− | );
| |
− | // Map view
| |
− | $group_disp[] =
| |
− | array(
| |
− | 'type' => 'img',
| |
− | 'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=map",
| |
− | 'css_class' => 'map',
| |
− | 'mkname' => FALSE,
| |
− | 'lightbox' => FALSE
| |
− | );
| |
− | // All record view
| |
− | $group_disp[] =
| |
− | array(
| |
− | 'type' => 'newpage',
| |
− | 'href' => "resultsmicro_view.php?",
| |
− | 'css_class' => 'printall',
| |
− | 'mkname' => FALSE,
| |
− | 'lightbox' => FALSE
| |
− | );
| |
− | </pre>
| |
− |
| |
− | *'''Feeds''':
| |
− | <pre>
| |
− | // FEEDS
| |
− | $res = "results_mode=feed";
| |
− | // RSS feed
| |
− | $group_feeds[] =
| |
− | array(
| |
− | 'type' => 'text',
| |
− | 'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=rss",
| |
− | 'css_class' => FALSE,
| |
− | 'mkname' => 'rss',
| |
− | 'lightbox' => FALSE
| |
− | );
| |
− | // Atom feed
| |
− | $group_feeds[] =
| |
− | array(
| |
− | 'type' => 'text',
| |
− | 'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=atom",
| |
− | 'css_class' => FALSE,
| |
− | 'mkname' => 'atom',
| |
− | 'lightbox' => FALSE
| |
− | );
| |
− | </pre>
| |
− |
| |
− | *'''Downloads''':
| |
− | <pre>
| |
− | // DOWNLOADS
| |
− | $res = "results_mode=dl";
| |
− | // CSV download
| |
− | $group_dls[] =
| |
− | array(
| |
− | 'type' => 'text',
| |
− | 'href' => "overlay_holder.php?$res&dl_mode=csv&lboxreload=1&sf_conf=conf_mac_exportdownloadcsv",
| |
− | 'css_class' => FALSE,
| |
− | 'mkname' => 'csv',
| |
− | 'lightbox' => 'lightbox|200'
| |
− | );
| |
− | </pre>
| |
− |
| |
− | And then put them in the toolbar conf array:
| |
− | <pre>
| |
− | // Package these button groups up into a toolbar
| |
− | $conf_results_nav =
| |
− | array(
| |
− | 'tools' => $group_tools,
| |
− | 'result_views' => $group_disp,
| |
− | 'result_feeds' => $group_feeds,
| |
− | 'result_downloads' => $group_dls,
| |
− | );
| |
− | </pre>
| |
− |
| |
− | ====Data Entry Toolbar====
| |
− | Configure the tools for data entry. First form the individual buttons and displays:
| |
− | *'''User Navigation''':
| |
− | <pre>
| |
− | // Previous record button
| |
− | $group_entry_nav[] =
| |
− | array(
| |
− | 'name' => 'prev',
| |
− | 'type' => 'text',
| |
− | 'href' => "",
| |
− | 'css_class' => FALSE,
| |
− | 'mkname' => 'prev',
| |
− | 'lightbox' => FALSE
| |
− | );
| |
− | // Displays site code
| |
− | $group_entry_nav[] =
| |
− | array(
| |
− | 'name' => 'ste_cd',
| |
− | 'type' => 'text',
| |
− | 'href' => "",
| |
− | 'css_class' => FALSE,
| |
− | 'mkname' => 'ste_cd',
| |
− | 'lightbox' => FALSE
| |
− | );
| |
− | // Displays record number
| |
− | $group_entry_nav[] =
| |
− | array(
| |
− | 'name' => 'current',
| |
− | 'type' => 'text',
| |
− | 'href' => "",
| |
− | 'css_class' => FALSE,
| |
− | 'mkname' => 'current',
| |
− | 'lightbox' => FALSE
| |
− | );
| |
− | // Displays module type
| |
− | $group_entry_nav[] =
| |
− | array(
| |
− | 'name' => 'modtype',
| |
− | 'type' => 'text',
| |
− | 'href' => "",
| |
− | 'css_class' => FALSE,
| |
− | 'mkname' => 'modtype',
| |
− | 'lightbox' => FALSE
| |
− | );
| |
− | // Next record button
| |
− | $group_entry_nav[] =
| |
− | array(
| |
− | 'name' => 'next',
| |
− | 'type' => 'text',
| |
− | 'href' => "",
| |
− | 'css_class' => FALSE,
| |
− | 'mkname' => 'next',
| |
− | 'lightbox' => FALSE
| |
− | );
| |
− | </pre>
| |
− |
| |
− | *'''Administrator tools''':
| |
− | <pre>
| |
− | // Delete record
| |
− | $group_entry_admin[] =
| |
− | array(
| |
− | 'name' => 'delete',
| |
− | 'type' => 'img',
| |
− | 'href' => FALSE,
| |
− | 'css_class' => 'delimg',
| |
− | 'mkname' => 'del',
| |
− | 'lightbox' => 'lightbox|200'
| |
− | );
| |
− | // Edit module type
| |
− | $group_entry_admin[] =
| |
− | array(
| |
− | 'name' => 'changemod',
| |
− | 'type' => 'text',
| |
− | 'href' => FALSE,
| |
− | 'css_class' => 'recedit',
| |
− | 'mkname' => 'chngmod',
| |
− | 'lightbox' => 'lightbox|200'
| |
− | );
| |
− | // Edit record number
| |
− | $group_entry_admin[] =
| |
− | array(
| |
− | 'name' => 'changeval',
| |
− | 'type' => 'text',
| |
− | 'href' => FALSE,
| |
− | 'css_class' => 'recedit',
| |
− | 'mkname' => 'DEL',
| |
− | 'lightbox' => 'lightbox|200'
| |
− | );
| |
− | </pre>
| |
− |
| |
− | And then put them in the toolbar conf array:
| |
− | <pre>
| |
− | // Package these button groups up into a toolbar
| |
− | $conf_entry_nav =
| |
− | array(
| |
− | 'record_nav' => $group_entry_nav,
| |
− | 'record_admin' => $group_entry_admin,
| |
− | );
| |
− | </pre>
| |
− |
| |
− | ====Record Toolbar====
| |
− | Configure the tools for the record view toolbar. First form the individual buttons and displays:
| |
− |
| |
− | *'''Record Navigation''':
| |
− | <pre>
| |
− | // Previous record
| |
− | $group_nav[] =
| |
− | array(
| |
− | 'name' => 'prev',
| |
− | 'type' => 'text',
| |
− | 'href' => "",
| |
− | 'css_class' => FALSE,
| |
− | 'mkname' => 'prev',
| |
− | 'lightbox' => FALSE
| |
− | );
| |
− | // Displays current site code
| |
− | $group_nav[] =
| |
− | array(
| |
− | 'name' => 'ste_cd',
| |
− | 'type' => 'text',
| |
− | 'href' => "",
| |
− | 'css_class' => FALSE,
| |
− | 'mkname' => 'ste_cd',
| |
− | 'lightbox' => FALSE
| |
− | );
| |
− | // Displays current record number
| |
− | $group_nav[] =
| |
− | array(
| |
− | 'name' => 'current',
| |
− | 'type' => 'text',
| |
− | 'href' => "",
| |
− | 'css_class' => FALSE,
| |
− | 'mkname' => 'current',
| |
− | 'lightbox' => FALSE
| |
− | );
| |
− | // Displays current modtype
| |
− | $group_nav[] =
| |
− | array(
| |
− | 'name' => 'modtype',
| |
− | 'type' => 'text',
| |
− | 'href' => "",
| |
− | 'css_class' => FALSE,
| |
− | 'mkname' => 'modtype',
| |
− | 'lightbox' => FALSE
| |
− | );
| |
− | // Next record
| |
− | $group_nav[] =
| |
− | array(
| |
− | 'name' => 'next',
| |
− | 'type' => 'text',
| |
− | 'href' => "",
| |
− | 'css_class' => FALSE,
| |
− | 'mkname' => 'next',
| |
− | 'lightbox' => FALSE
| |
− | );
| |
− | </pre>
| |
− |
| |
− | *'''Refresh View''':
| |
− | <pre>
| |
− | // Refresh button
| |
− | $group_refresh[] =
| |
− | array(
| |
− | 'name' => 'refresh',
| |
− | 'type' => 'img',
| |
− | 'href' => "{$_SERVER['PHP_SELF']}?disp_reset=default",
| |
− | 'css_class' => 'refresh',
| |
− | 'mkname' => 'reset',
| |
− | 'lightbox' => FALSE
| |
− | );
| |
− | </pre>
| |
− |
| |
− | *'''Administrator Tools''':
| |
− | <pre>
| |
− | // ADMIN TOOLS
| |
− | // Delete record
| |
− | $group_admin[] =
| |
− | array(
| |
− | 'name' => 'delete',
| |
− | 'type' => 'img',
| |
− | 'href' => FALSE,
| |
− | 'css_class' => 'delimg',
| |
− | 'mkname' => 'del',
| |
− | 'lightbox' => 'lightbox|200'
| |
− | );
| |
− | // Edit modtype
| |
− | $group_admin[] =
| |
− | array(
| |
− | 'name' => 'changemod',
| |
− | 'type' => 'text',
| |
− | 'href' => FALSE,
| |
− | 'css_class' => 'recedit',
| |
− | 'mkname' => 'chgtype',
| |
− | 'lightbox' => 'lightbox|200'
| |
− | );
| |
− | // Edit record number
| |
− | $group_admin[] =
| |
− | array(
| |
− | 'name' => 'changeval',
| |
− | 'type' => 'text',
| |
− | 'href' => FALSE,
| |
− | 'css_class' => 'recedit',
| |
− | 'mkname' => 'chgkey',
| |
− | 'lightbox' => 'lightbox|200'
| |
− | );
| |
− | </pre>
| |
− |
| |
− | And then put them in the toolbar conf array:
| |
− | <pre>
| |
− | // Package these button groups up into a toolbar
| |
− | $conf_record_nav =
| |
− | array(
| |
− | 'record_nav' => $group_nav,
| |
− | 'record_refresh' => $group_refresh,
| |
− | 'record_admin' => $group_admin,
| |
− | );
| |
− | </pre>
| |
− |
| |
− | ===Left Panel Configuration===
| |
− |
| |
− | ====Left Panel- Data Entry====
| |
− | This section configures the left panel in the data entry pages. As of v0.8 there are two configuration options here.
| |
− |
| |
− | =====Option 1 - Link list=====
| |
− |
| |
− | This is a simple list of links that will be formatted and outputted into the left panel. Each link requires the following:
| |
− | *'''href''' - link to the output
| |
− | *'''mknname''' - mark-up nickname will search the markup table for this nickname and print the markup
| |
− |
| |
− | within the 'href' the following vars need to be set up (see example below):
| |
− | *'''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)
| |
− |
| |
− | <pre>
| |
− | $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'
| |
− | );
| |
− | </pre>
| |
− |
| |
− | =====Option 2 - Subform=====
| |
− |
| |
− | As of v0.8 subforms can be executed within the left panel. This opens the door for a range of custom subforms to be written providing useful user interface features. This also permits us to use conditional behaviours for the panel.
| |
− |
| |
− | In order to set this up correctly, you need to set up a subform and place it within a column as you would in data entry or micro view.
| |
− |
| |
− | <pre>
| |
− | $delp_subform1 =
| |
− | array(
| |
− | 'view_state' => 'max',
| |
− | 'edit_state' => 'view',
| |
− | 'sf_nav_type' => 'none',
| |
− | 'sf_title' => 'lplinklist',
| |
− | 'sf_html_id' => 'lplinklist', // Must be unique
| |
− | 'script' => 'php/subforms/sf_linklist.php',
| |
− | 'op_label' => 'space',
| |
− | 'op_input' => 'save',
| |
− | 'op_modtype' => FALSE, //if each modtype uses same fields (see below)
| |
− | 'op_condition' =>
| |
− | array(
| |
− | array(
| |
− | 'func'=> 'chkUserPerm',
| |
− | 'args'=> array(84)
| |
− | )
| |
− | ),
| |
− | 'fields' => $lp_link_list
| |
− | );
| |
− |
| |
− | $data_entry_left_panel =
| |
− | array(
| |
− | 'col_id' => 'delp',
| |
− | 'col_alias' => FALSE,
| |
− | 'col_type' => 'primary_col',
| |
− | 'subforms' =>
| |
− | array(
| |
− | $delp_subform1
| |
− | )
| |
− | );
| |
− | </pre>
| |
− |
| |
− | In order to use the [[sf_linklist]] ('''as in the above example''') create a link list array according to the criteria for option 1 (see above) and then put this into the 'fields' element of the subform instead of an array of fields. This is documented within the [[sf_linklist| page]] for this subform as this is now a behaviour specific to this subform.
| |
− |
| |
− | ====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
| |
− |
| |
− | <pre>
| |
− | $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'
| |
− | );
| |
− | </pre>
| |
− |
| |
− | ====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
| |
− |
| |
− | <pre>
| |
− | $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'
| |
− | );
| |
− | </pre>
| |
− |
| |
− | ====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
| |
− |
| |
− | <pre>
| |
− | $user_home_left_panel[] =
| |
− | array(
| |
− | 'href' => "data_view.php?vtok=1&nname=All_Contexts&ftype=key&key=1&ktype=all",
| |
− | 'mknname' => 'vwcxt'
| |
− | );
| |
| </pre> | | </pre> |
| | | |
| [[Category: Administrator]] | | [[Category: Administrator]] |
This is the main settings file for administrators to set defaults for security settings and permissions, loaded modules, etc. for each instance of ARK. As of v1.0, for settings related to page display and navigation see page_settings.php, and those related to server settings see env_settings.php.
And include the settings related to your server environment contained within the env_settings.php:
The name of this instance of ARK - as markup. Appears on the index (home) page and in the browser window/tab title. Should be entered in cor_tbl_markup accordingly.
The controls for fancy text search, using boolean functions such as +, -, "search term", etc (like Google).
The security and permissions for ARK is handled by LiveUser.
The liveuser settings need to be set, as well as the variables for allowing anonymous logins. The liveuser configuration is as follows:
A variety of permissions need to be set to ensure the appropriate users are making use of advanced functions. All permissions are based on the numerical id of security groups (from the cor_lvu_groups table). For instance, it is possible to allow some users to make their personal saved filters public for all to use. As of v0.8, adding to control lists (adding attributes), and perhaps most importantly, advanced record functions such as edit module types and delete entire records need to also have sgrps defined.
Choose between 'get' or 'post' form methods.
Configures logging levels to record logging into database and changes to data. Set to 'on' to turn the logging on, otherwise set to FALSE.
Configures words to cut out of multi-string searches to streamline the search process and maximise results.
Configures the default language and other languages in use.