From e8944fa2a75539214620baea671772a7d0921017 Mon Sep 17 00:00:00 2001 From: rurban Date: Sat, 23 Dec 2006 15:35:19 +0000 Subject: [PATCH] document new options git-svn-id: svn://svn.code.sf.net/p/phpwiki/code/trunk@5254 96ab9672-09ca-45d6-a79d-3d69d39ca109 --- config/config-default.ini | 4 ++- config/config-dist.ini | 72 +++++++++++++++++++++------------------ 2 files changed, 42 insertions(+), 34 deletions(-) diff --git a/config/config-default.ini b/config/config-default.ini index 73bce4e1b..500a0749c 100644 --- a/config/config-default.ini +++ b/config/config-default.ini @@ -1,4 +1,4 @@ -; $Id: config-default.ini,v 1.46 2006-07-23 14:03:18 rurban Exp $ +; $Id: config-default.ini,v 1.47 2006-12-23 15:35:19 rurban Exp $ ; This is the default PhpWiki configuration for undefined config.ini entries. ; recent development and debugging features: @@ -140,6 +140,8 @@ TOC_FULL_SYNTAX = true ENABLE_MARKUP_COLOR = true ENABLE_MARKUP_TEMPLATE = false DISABLE_MARKUP_WIKIWORD = false +ENABLE_MARKUP_DIVSPAN = false +PLUGIN_MARKUP_MAP = "" ; these not: ; DBAUTH_AUTH_DSN = diff --git a/config/config-dist.ini b/config/config-dist.ini index f95cd97d4..e06777485 100644 --- a/config/config-dist.ini +++ b/config/config-dist.ini @@ -45,7 +45,8 @@ ; Default: false ;ENABLE_DOUBLECLICKEDIT = false -; Enable WYSIWYG editing. Converting back HTML to wikitext does not work yet. Experimental! +; Enable WYSIWYG editing. Converting back HTML to wikitext does not work in most engines. +; Experimental! ;ENABLE_WYSIWYG = true ; Which backend? Must be seperately installed. See lib/WysiwygEdit/ @@ -57,7 +58,7 @@ ; htmlarea2 ;WYSIWYG_BACKEND = Wikiwyg -; Store all pages as HTML? Will loose most link and plugin options. +; Store all WYSIWYG pages as HTML? Will loose most link and plugin options. ; Not recommended, but presented here to test several WYSIWYG backends. ;WYSIWYG_DEFAULT_PAGETYPE_HTML = false @@ -373,8 +374,8 @@ COOKIE_EXPIRATION_DAYS = 365 ; PDO: The new PHP5 dataobkject library. (experimental, no paging yet) ; dba: use one of the standard UNIX dbm libraries. Use BerkeleyDB (db3,4) (fastest) ; file: use a serialized file database. (easiest) -; flatfile: use a flat file database. (readable, slow) -; cvs: use a CVS server to store everything. (experimental, not recommended) +; flatfile: use a flat file database. (experimental, readable, slow) +; cvs: use a CVS server to store everything. (experimental, slowest, not recommended) DATABASE_TYPE = dba ; Prefix for filenames or table names @@ -434,11 +435,11 @@ DATABASE_DIRECTORY = /tmp ; dbm - Older dba handler; suffers from limits on the size of data ; items. ; Better not use other hacks such as inifile, flatfile or cdb. -DATABASE_DBA_HANDLER = gdbm +DATABASE_DBA_HANDLER = db4 ; How long will the system wait for a database operation to complete? ; Specified in seconds. -DATABASE_TIMEOUT = 5 +DATABASE_TIMEOUT = 12 ; How often to try and optimise the database. Specified in seconds. ; Set to 0 to disable optimisation completely. Default is 50 (seconds). @@ -460,8 +461,9 @@ DATABASE_TIMEOUT = 5 ; Optional: Administrative SQL DB access (for action=upgrade) ;DBADMIN_PASSWD = secret -; Store DB query results in memory to avoid duplicate queries. +; Store DB query results (esp. for page lists) in memory to avoid duplicate queries. ; Disable only for old php's with low memory or memory_limit=8MB. +; Requires at least memory_limit=16MB ; Default: true ;USECACHE = false @@ -584,15 +586,16 @@ ALLOW_USER_PASSWORDS = true ; PersonalPage: Store passwords in the users homepage metadata (simple) ; Db: Use DBAUTH_AUTH_* (see below) with PearDB or ; ADODB only. -; LDAP: Authenticate against LDAP_AUTH_HOST with LDAP_BASE_DN (experimental) +; LDAP: Authenticate against LDAP_AUTH_HOST with LDAP_BASE_DN ; IMAP: Authenticate against IMAP_AUTH_HOST (email account) ; POP3: Authenticate against POP3_AUTH_HOST (email account) ; Session: Get username and level from a PHP session variable. (e.g. for gforge) ; File: Store username:crypted-passwords in .htaccess like files. ; Use Apache's htpasswd to manage this file. ; HttpAuth: Use the protection by the webserver (.htaccess/.htpasswd) -; Enforcing HTTP Auth not yet. Note that the ADMIN_USER should exist also. +; Note that the ADMIN_USER should exist also. ; Using HttpAuth disables all other methods and no userauth sessions are used. +; With mod_ntlm and mod_auth_sspi use this. (automatic login with MSIE) ; ; Several of these methods can be used together, in the manner specified by ; USER_AUTH_POLICY, below. To specify multiple authentication methods, @@ -645,30 +648,30 @@ USER_AUTH_POLICY = stacked ; Some LDAP servers need some more options, such as the Windows Active ; Directory Server. Specify the options (as allowed by the PHP LDAP module) ; and their values as NAME=value pairs separated by colons. -; LDAP_SET_OPTION = "LDAP_OPT_PROTOCOL_VERSION=3:LDAP_OPT_REFERRALS=0" +;LDAP_SET_OPTION = "LDAP_OPT_PROTOCOL_VERSION=3:LDAP_OPT_REFERRALS=0" ; DN to initially bind to the LDAP server as. This is needed if the server doesn't ; allow anonymous queries. (Windows Active Directory Server) -; LDAP_AUTH_USER = "CN=ldapuser,ou=Users,o=Development,dc=mycompany.com" +;LDAP_AUTH_USER = "CN=ldapuser,ou=Users,o=Development,dc=mycompany.com" ; Password to use to initially bind to the LDAP server, as the DN ; specified in the LDAP_AUTH_USER option (above). -; LDAP_AUTH_PASSWORD = secret +;LDAP_AUTH_PASSWORD = secret ; If you want to match usernames against an attribute other than uid, ; specify it here. Default: uid -; LDAP_SEARCH_FIELD = sAMAccountName +;LDAP_SEARCH_FIELD = sAMAccountName ; If you have an organizational unit for all users, define it here. ; This narrows the search, and is needed for LDAP group membership (if GROUP_METHOD=LDAP) ; Default: ou=Users -; LDAP_OU_USERS = ou=Users +;LDAP_OU_USERS = ou=Users ; If you have an organizational unit for all groups, define it here. ; This narrows the search, and is needed for LDAP group membership (if GROUP_METHOD=LDAP) ; The entries in this ou must have a gidNumber and cn attribute. ; Default: ou=Groups -; LDAP_OU_GROUP = ou=Groups +;LDAP_OU_GROUP = ou=Groups ; IMAP authentication options: @@ -678,15 +681,15 @@ USER_AUTH_POLICY = stacked ; Some IMAP_AUTH_HOST samples: ; "localhost", "localhost:143/imap/notls", ; "localhost:993/imap/ssl/novalidate-cert" (SuSE refuses non-SSL conections) -; IMAP_AUTH_HOST = "localhost:143/imap/notls" +;IMAP_AUTH_HOST = "localhost:143/imap/notls" ; POP3 authentication options: ; ; Host to connect to. -; POP3_AUTH_HOST = "localhost:110" +;POP3_AUTH_HOST = "localhost:110" ; Port to connect. Deprecated: Use POP3_AUTH_HOST: instead -; POP3_AUTH_PORT = 110 +;POP3_AUTH_PORT = 110 ; File authentication options: ; @@ -720,7 +723,7 @@ USER_AUTH_POLICY = stacked GROUP_METHOD = WIKIPAGE ; Page where all groups are listed. Default: Translation of "CategoryGroup" -; CATEGORY_GROUP_PAGE = CategoryGroup +;CATEGORY_GROUP_PAGE = CategoryGroup ; For GROUP_METHOD = FILE, the file given below is referenced to obtain ; group membership information. It should be in the same format as the @@ -738,8 +741,8 @@ GROUP_METHOD = WIKIPAGE ; ; A database DSN to connect to. Defaults to the DSN specified for the Wiki ; as a whole. -;DBAUTH_AUTH_DSN = "mysql://wikiuser:@localhost/phpwiki" - +;DBAUTH_AUTH_DSN = "mysql://wikiuser:@127.0.0.1/phpwiki" +; ; USER/PASSWORD queries ; ; For USER_AUTH_POLICY=strict and the Db method this is required: @@ -748,16 +751,16 @@ GROUP_METHOD = WIKIPAGE ; Check to see if the supplied username/password pair is OK ; ; Plaintext Passwords: -; DBAUTH_AUTH_CHECK = "SELECT IF(passwd='$password',1,0) AS ok FROM pref WHERE userid='$userid'" +; DBAUTH_AUTH_CHECK = "SELECT IF(TRIM(passwd)='$password',1,0) AS ok FROM pref WHERE TRIM(userid)='$userid'" ; ; Database-hashed passwords (more secure): -;DBAUTH_AUTH_CHECK = "SELECT IF(passwd=PASSWORD('$password'),1,0) AS ok FROM pref WHERE userid='$userid'" +;DBAUTH_AUTH_CHECK = "SELECT IF(TRIM(passwd)=PASSWORD('$password'),1,0) AS ok FROM pref WHERE TRIM(userid)='$userid'" DBAUTH_AUTH_CRYPT_METHOD = plain ; If you want to use Unix crypt()ed passwords, you can use DBAUTH_AUTH_CHECK ; to get the password out of the database with a simple SELECT query, and ; specify DBAUTH_AUTH_USER_EXISTS and DBAUTH_AUTH_CRYPT_METHOD: -;DBAUTH_AUTH_CHECK = "SELECT passwd FROM pref where userid='$userid'" +;DBAUTH_AUTH_CHECK = "SELECT passwd FROM pref WHERE TRIM(userid)='$userid'" ; DBAUTH_AUTH_CRYPT_METHOD = crypt ; Update the user's authentication credential. If this is not defined but @@ -825,6 +828,8 @@ THEME = default ;THEME = MacOSX ; as default, just some tricks to make the buttons smaller: ;THEME = smaller +; the popular wikipedia layout: +;THEME = MonoBook ; the popular Wordpress layout: ;THEME = Wordpress ; pure old-style c2wiki layout: @@ -833,8 +838,6 @@ THEME = default ;THEME = Sidebar ; mozilla friendly, with lots of icons instead of buttons (i18n friendly): ;THEME = Crao -; wikipedia layout: -;THEME = MonoBook ; default + rateit navbar: ;THEME = wikilens ; blogger style, rounded (experimental): @@ -852,10 +855,10 @@ THEME = default ; has been extensively tested only with the latin1 (iso-8859-1) ; character set. ; -; If you change the default from iso-8859-1 PhpWiki may not work -; properly and will require modifications in all existing pages. -; At the very least you will have to convert the files in pgsrc -; or locale/xx/pgsrc to match! +; If you change the default from iso-8859-1 with existing pages, +; PhpWiki may not work properly and will require modifications in all existing pages. +; You'll have to dump the old pages with the old charset +; and import it into the new one after having changed the charset. ; Currently we support utf-8 for zh and ja, euc-jp for ja (not enabled) ; and iso-8859-1 for all other langs. Changing languages (UserPreferences) ; from one charset to another will not work! @@ -863,8 +866,7 @@ THEME = default ; Character sets similar to iso-8859-1 may work with little or no ; modification depending on your setup. The database must also ; support the same charset, and of course the same is true for the -; web browser. Some work is in progress hopefully to allow more -; flexibility in this area. +; web browser. euc-jp and utf-8 is also supported. CHARSET = iso-8859-1 ; Most exotic charsets are not supported by htmlspecialchars, which prints a warning: @@ -888,7 +890,7 @@ CHARSET = iso-8859-1 ; ; If you set DEFAULT_LANGUAGE to the empty string, the users ; preferred language as determined by the browser setting will be used. -; Japanese requires CHARSET=euc-jp or utf-8 (not yet safe), Chinese CHARSET=utf-8 +; Japanese requires CHARSET=euc-jp or utf-8, Chinese CHARSET=utf-8 ;DEFAULT_LANGUAGE = en ; WIKI_PGSRC -- specifies the source for the initial page contents of @@ -993,8 +995,12 @@ CHARSET = iso-8859-1 ; Default: false ;DISABLE_MARKUP_WIKIWORD = true +; Enable
and HTML blocks and attributes. Experimental. Not yet working. +;ENABLE_MARKUP_DIVSPAN = true + ; Plugin shortcuts: Enable syntax mapped to a plugin invocation. (as in mediawiki) ; body or => +; This breaks the InlineParser. ;PLUGIN_MARKUP_MAP = "html:RawHtml dot:GraphViz toc:CreateToc amath:AsciiMath richtable:RichTable include:IncludePage tex:TexToPng" ;========================================================================== -- 2.45.0