raster pushed a commit to branch master.
http://git.enlightenment.org/website/www.git/commit/?id=5098c932c4da40bded1ea127b49c5de0de80ef41
commit 5098c932c4da40bded1ea127b49c5de0de80ef41
Author: Carsten Haitzler (Rasterman) <ras...@rasterman.com>
Date: Mon Apr 20 14:27:40 2015 +0900
add docs on how to set up a local dokuwiki and sample config
---
README | 40 ++++++++++++++++++++++-
local.php.sample | 96 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 135 insertions(+), 1 deletion(-)
diff --git a/README b/README
index cd439f9..de9a782 100644
--- a/README
+++ b/README
@@ -1,2 +1,40 @@
-under public_html is a dokuwiki tree with plugins enabled, some config
+Under public_html is a dokuwiki tree with plugins enabled, some config
and a template made to work with e.org. this does NOT contain content.
+
+To help do things nicely, you probably want to set up this tree
+locally and run an apache (or ngix or whatever you prefer) and ensure
+it can do php5 or better.
+
+You will want to:
+
+ cp local.php.sample public_html/conf/local.php
+
+and then modify $conf['datadir'] and $conf['mediadir'] to point to the
+paged and media subdirs of the www-content git that you can get on
+http://git.enlightenment.org as well. You can also symlink the
+www-content dir from the public_html/data dir like:
+
+ ln -s /path/to/www-content public_html/data/www-content
+
+as an alternative.
+
+The first time you run your local webserver and go there, you may get
+permission denied problems. You may have to either make your www tree
+owned by your http server, or run your webserver as you. You will get
+to set up an admin account the first time if all directories are
+accessible correctly. You are now pretty much done. Enjoy your local
+wiki install and save time by not having to comit changes to the wiki
+before testing.
+
+Note that we want to keep changes to the wiki tself at a minimum beyond:
+
+ 1. installing PRISTINE plugins (with as few or no changes as possible)
+ 2. modifying the public_html/lib/tpl/e subdirectory where the
+ css/templates etc. live for the look and feel.
+
+If you do change things, please start your commit log line with the
+all caps:
+
+ WIKI CUSTOM
+
+So we can easily find it later for upgrades.
diff --git a/local.php.sample b/local.php.sample
new file mode 100644
index 0000000..67c6030
--- /dev/null
+++ b/local.php.sample
@@ -0,0 +1,96 @@
+<?php
+/*
+ * Dokuwiki's Main Configuration File - Local Settings
+ * Auto-generated by config plugin
+ * Run for user: beber
+ * Date: Sat, 11 Apr 2015 14:51:26 -0700
+ */
+
+$conf['title'] = '';
+$conf['template'] = 'e';
+$conf['license'] = '0';
+$conf['recent'] = 0;
+$conf['recent_days'] = 0;
+$conf['breadcrumbs'] = 0;
+$conf['dformat'] = '';
+$conf['tocminheads'] = '20';
+$conf['maxtoclevel'] = '0';
+$conf['maxseclevel'] = '0';
+$conf['useheading'] = '1';
+$conf['useacl'] = 1;
+$conf['passcrypt'] = 'sha512';
+$conf['superuser'] = '@admin';
+$conf['disableactions'] = 'recent,revisions';
+$conf['jpg_quality'] = 90;
+$conf['subscribers'] = 1;
+$conf['mailfrom'] = 'no-re...@enlightenment.org';
+$conf['mailprefix'] = 'Enlightenment';
+$conf['sitemap'] = 1;
+$conf['updatecheck'] = 0;
+$conf['userewrite'] = '1';
+$conf['useslash'] = 1;
+$conf['compress'] = 0;
+$conf['send404'] = 1;
+$conf['compression'] = '0';
+$conf['plugin']['include']['showfooter'] = 0;
+$conf['plugin']['include']['showdate'] = 0;
+$conf['plugin']['include']['showuser'] = 0;
+$conf['plugin']['include']['showcomments'] = 0;
+$conf['plugin']['include']['showlinkbacks'] = 0;
+$conf['plugin']['include']['showtags'] = 0;
+$conf['plugin']['include']['showeditbtn'] = 0;
+$conf['plugin']['include']['doredirect'] = 0;
+$conf['plugin']['include']['doindent'] = 0;
+$conf['plugin']['include']['parlink'] = 0;
+$conf['plugin']['include']['safeindex'] = 0;
+$conf['plugin']['include']['readmore'] = 0;
+$conf['plugin']['captcha']['mode'] = 'audio';
+$conf['plugin']['captcha']['width'] = 300;
+$conf['plugin']['captcha']['height'] = 100;
+$conf['plugin']['discussion']['allowguests'] = 0;
+$conf['plugin']['discussion']['urlfield'] = 1;
+$conf['plugin']['discussion']['moderatorgroups'] = 'admin,edit';
+$conf['plugin']['gitbacked']['pushAfterCommit'] = 0;
+$conf['plugin']['gitbacked']['periodicPull'] = 0;
+$conf['plugin']['gitbacked']['periodicMinutes'] = 0;
+$conf['plugin']['gitbacked']['repoPath'] = 'data/www-content';
+$conf['plugin']['gitbacked']['repoWorkDir'] = 'data/www-content/tmp';
+$conf['tpl']['dokui']['hide-entry-title'] = '1';
+$conf['datadir'] = 'data/www-content/pages';
+$conf['mediadir'] = 'data/www-content/media';
+/* new config - patches to dokuwiki enabled this. this is a directory
+ * realtive to 'datadir' config above where we store metadata right in the
+ * wiki itself to holid linking and documentation for keywords in specific
+ * languages like c, lua, cpp, js, python etc. you need the below directory
+ * and then like
+ * $dir/$language/keyword-link.txt
+ * #dir/$language/keyword-list.txt
+ *
+ * where $dir is the below base dir and $language is the lang in a code
+ * block like c, cpp, js etc. so for example you may have:
+ *
+ * docs/generated/c/keyword-link.txt
+ * docs/generated/c/keyword-list.txt
+ *
+ * inside your "pages" dir for the wiki. the link file is simply a base url
+ * pattern that allows you to direct where a detected keyword link is pointed
+ * to such as:
+ *
+ * /docs/generated/c/keywords/{FNAMEL}
+ *
+ * this replaces {FNAMEL} with the keyword. so if ou have in the wiki there
+ * a keywords directory and keyword.txt - this cam be the documentation for
+ * that keyword. this is done to alllow auto-linking of code examples as
+ * well as anything else code-related to appropriate documentation for a
+ * project without people having to hand link in everything all the time,
+ * much like what doxygen does, but in dokuwiki. right now it only works
+ * inside code blocks syntax hilighted by geshi
+ */
+$conf['code_extn'] = 'docs/efl/ref';
+/* max cache time for a wiki pagee - this is so that code keyword
+ * hilighting works even if a page doesn't have a
+ * ~~NOCACHE~~ directive in it. if it has this in it, then code keyword
+ * extension hilighting is updated immediately
+ */
+$conf['cachetime'] = 10;
+// end auto-generated content
--
