Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Compare: Installing WikiMindMap to work with your own wiki

Showing with 30 additions and 18 deletions.
  1. +30 −18 Installing-WikiMindMap-to-work-with-your-own-wiki.md
View
48 Installing-WikiMindMap-to-work-with-your-own-wiki.md
@@ -25,14 +25,14 @@ The software is in to main folders:
WikiMindMap to work.
2. Public - this contains the WikiMindMap installation files:
-```
+<pre>
/public/viewmap.php :This generates the map webpage - needs editing - can be renamed
/public/inc/config.inc.php : Config file for accessing Wikis - needs editing
/public/getpages.php : This is the core of WikiMindMap
/public/visorFreemind.swf : The binary of the flash browser
/public/js/flashobject.js : Needed by the flash browser
/public/getfreemind.php : This allows the mindmap to be downloaded
-```
+</pre>
There are additionally some image and CSS files used when rendering viewmap.php
@@ -47,10 +47,10 @@ so that the server name for the wiki that you want to map appears in the dropdow
box. This script also renders the flash browser, using data fed to it by getpages.php
viewmap.php submits three variables to getpages.php
-$wiki - the server part of the URL, in my case this is the IP address of the test server
+* **$wiki** - the server part of the URL, in my case this is the IP address of the test server
192.168.0.18, for the english wikipedia it is en.wikipedia.org etc.
-$topic - the topic / article name entered in the search box. (‘Mind map’ in my example)
-$rootName - This is the name of the this script file, allows the file to be renamed.
+* **$topic** - the topic / article name entered in the search box. (‘Mind map’ in my example)
+* **$rootName** - This is the name of the this script file, allows the file to be renamed.
Note - This file can be renamed as need, for example to index.php, without effecting the
functioning of WikiMindMap.
@@ -63,19 +63,25 @@ browser for display.
getfreemind.php can be accessed from the viewmap.php page by clicking on the [Download this mindmap
as Freemind file] link. It downloads the data from your mind map in a .mm file that can be opened by the
-open-source FreeMInd desktop tool
+open-source [FreeMind](http://freemind.sourceforge.net/wiki/index.php/Main_Page) desktop tool
### 4. config.inc.php (in subfolder /inc) - Needs Editing
-For each wiki you want to generate mind maps for you will need enter two variables, $index_path and
-$access_path within config.inc.php
+For each wiki you want to generate mind maps for you will need enter two variables, `$index_path` and
+`$access_path` within config.inc.php
Mediawiki by default runs user friendly URL’s so that for example, the full URL of
-http://server_name/wiki/index.php/index.php?title=Mind_map
+
+`http://server_name/wiki/index.php/index.php?title=Mind_map`
+
can be displayed as
-http://server_name/wiki/index.php/Mind_map
+
+`http://server_name/wiki/index.php/Mind_map`
+
or even as
-http://server_name/wiki/Mind_map
-$index_path
+
+`http://server_name/wiki/Mind_map`
+
+#### $index_path
This variable is used by getpages.php when it queries the wiki to return a ‘raw’ copy of the page, i.e. the
pure wiki text, without any html codes so that it can strip out everything and just leave all the links and
@@ -83,13 +89,19 @@ sections. To do this getpages.php need to know the part in the full URL between
index.php page, this will just be the folder route you created, from your web root, when you installed
mediawiki.
-For my installation $index_path was simply /wiki as I only added on folder level below the site root.
-It will be used with the variables $wiki and $topic to build the $url using
-$url = 'http://'.$wiki.$index_path.'/index.php?title='.$topic.'&action=raw';
+For my installation $index_path was simply `/wiki` as I only added on folder level below the site root.
+It will be used with the variables `$wiki` and `$topic` to build the `$url` using
+
+`$url = 'http://'.$wiki.$index_path.'/index.php?title='.$topic.'&action=raw'`
+
with my data it gives us
-$url = http://192.168.0.18/wiki/index.php?title=Mind_map&action=raw
-(&action=raw on the end returns the raw wiki text, rather than rendered html)
-$access_path
+
+`$url = http://192.168.0.18/wiki/index.php?title=Mind_map&action=raw`
+
+(`&action=raw` on the end returns the raw wiki text, rather than rendered html)
+
+#### $access_path
+
This variable is used by WikiMindMap when you click on the page link in the mindmap to open the relevant
mediawiki page in a new window.
Something went wrong with that request. Please try again.