From a0d4fecc1e070c73d055efd5926be21ab06f6974 Mon Sep 17 00:00:00 2001 From: Starbeamrainbowlabs Date: Tue, 26 May 2015 10:52:55 +0100 Subject: [PATCH] Overhauled the comments in the settings section --- index.php | 80 ++++++++++++++++++++++++++++--------------- settings.fragment.php | 80 ++++++++++++++++++++++++++++--------------- 2 files changed, 106 insertions(+), 54 deletions(-) diff --git a/index.php b/index.php index 366ca8d..06932a5 100644 --- a/index.php +++ b/index.php @@ -14,56 +14,75 @@ $start_time = time(true); * Bug reports: * #1 - Incorrect closing tag - nibreh */ - +// Initialises a new object to store your wiki's settings in. Please don't touch this. $settings = new stdClass(); -// the site's name +// The site's name. Used all over the place. +// Note that by default the session cookie is perfixed with a variant of the sitename so changing this will log everyone out! $settings->sitename = "Pepperminty Wiki"; -// the url from which to fetch updates. Defaults to the master (development) branch If there is sufficient demand, a separate stable branch will be created. -// note that if you use the automatic updater currently it won't save your module choices. -// MAKE SURE THAT THIS POINTS TO A HTTPS URL, OTHERWISE SOMEONE COULD INJECT A VIRUS INTO YOUR WIKI +// The url from which to fetch updates. Defaults to the master (development) +// branch If there is sufficient demand, a separate stable branch will be +// created. Note that if you use the automatic updater currently it won't save +// your module choices. +// MAKE SURE THAT THIS POINTS TO A *HTTPS* URL, OTHERWISE SOMEONE COULD INJECT A VIRUS INTO YOUR WIKI $settings->updateurl = "https://raw.githubusercontent.com/sbrl/pepperminty-wiki/master/index.php"; -// the secret key used to perform 'dangerous' actions, like updating the wiki, and deleting pages. It is strongly advised that you change this! -// note that (semi)automatic updating of your wiki has not been added yet. +// The secret key used to perform 'dangerous' actions, like updating the wiki, +// and deleting pages. It is strongly advised that you change this! $settings->sitesecret = "ed420502615bac9037f8f12abd4c9f02"; -// whether people can edit the site +// Determined whether edit is enabled. Set to false to disable disting for all +// users (anonymous or otherwise). $settings->editing = true; -// the maximum number of characters allowed in a single page -$settings->maxpagesize = 135000; //135,000 characters, or 50 pages +// The maximum number of characters allowed in a single page. The default is +// 135,000 characters, which is about 50 pages. +$settings->maxpagesize = 135000; -// whether users who aren't logged in are allowed to edit +// Determined whether users who aren't logged in are allowed to edit your wiki. +// Set to true to allow anonymous users to log in. $settings->anonedits = false; -// the name of the page that will act as the home page for the wiki. This page will be served if the user didn't specify a page. +// The name of the page that will act as the home page for the wiki. This page +// will be served if the user didn't specify a page. $settings->defaultpage = "Main Page"; -// the default action. This action will be performed if no other action is specified. +// The default action. This action will be performed if no other action is +// specified. It is recommended you set this to "view" - that way the user +// automatically views the default page (see above). $settings->defaultaction = "view"; -// usernames and passwords - passwords should be hashed with sha256 +// An array of usernames and passwords - passwords should be hashed with +// sha256. Put one user / password on each line, remembering the comma at the +// end. The last user in the list doesn't need a comma after their details though. $settings->users = [ "admin" => "5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8", //password "user" => "873ac9ffea4dd04fa719e8920cd6938f0c23cd678af330939cff53c3d2855f34" //cheese ]; -// array of usernames that are administrators. -// administrators can delete and move pages, though this functionality hasn't been added yet. +// An array of usernames that are administrators. Administrators can delete and +// move pages. $settings->admins = [ "admin" ]; -// The string that is prepended before an admin's name on the nav bar. defaults to a diamond shape (◆). +// The string that is prepended before an admin's name on the nav bar. Defaults +// to a diamond shape (◆). $settings->admindisplaychar = "◆"; -// contact details for the site administrator. Since user can only be added by editing this file, people will need a contact address to use to ask for an account. Displayed at the bottom of the page, and will be appropriatly obfusticated to deter spammers. +// Contact details for the site administrator. Since users can only be added by +// editing this file, people will need a contact address to use to ask for an +// account. Displayed at the bottom of the page, and will be appropriately +// obfusticated to deter spammers. $settings->admindetails = [ "name" => "Administrator", "email" => "admin@localhost" ]; -// array of links and display text to display at the top of the site +// Array of links and display text to display at the top of the site. +// Format: +// [ "Display Text", "Link" ] +// You can also use strings here and they will be printed as-is, except the following special strings: +// search: Expands to a search box. $settings->navlinks = [ [ "Home", "index.php" ], [ "Login", "index.php?action=login" ], @@ -83,8 +102,9 @@ $settings->navlinks = [ [ "Help", "index.php?action=help" ] ]; -// string of css to include -// may be a url - urls will be referenced via a tag +// A string of css to include. Will be included in the of every page +// inside a