01301: Include statements are missing $FarmD variable

Summary: Include statements are missing $FarmD variable
Created: 2012-10-17 14:53
Status: Suspended
Category: Bug
From: Maddes
Assigned:
Priority: 3
Version: 2.2.43
OS: Apache/2.2.16 (Debian) PHP/5.3.3-7+squeeze14 with Suhosin-Patch

Description:

The sample config is not correct as its includes are missing the $FarmD variable. That was the reason why UTF-8 was not working in my setup.

  • docs/sample-config.php(42): include_once("scripts/xlpage-utf-8.php");
  • docs/sample-config.php(56): # include_once("scripts/creole.php");
  • docs/sample-config.php(89): ## For more options with WikiWords, see scripts/wikiwords.php .
  • docs/sample-config.php(107): # if ($action == 'refcount') include_once("scripts/refcount.php");
  • docs/sample-config.php(111): # if ($action == 'rss') include_once("scripts/feeds.php"); # RSS 2.0
  • docs/sample-config.php(112): # if ($action == 'atom') include_once("scripts/feeds.php"); # Atom 1.0
  • docs/sample-config.php(113): # if ($action == 'dc') include_once("scripts/feeds.php"); # Dublin Core
  • docs/sample-config.php(114): # if ($action == 'rdf') include_once("scripts/feeds.php"); # RSS 1.0
  • docs/sample-config.php(140): # include_once("scripts/urlapprove.php");

Additional the documentation of some scripts are also missing the $FarmD variable and therefore mislead people to wrong usage.

  • scripts/creole.php(12): include_once('scripts/creole.php');
  • scripts/pgcust.php(14): include_once("scripts/pgcust.php");
  • scripts/refcount.php(10): include_once('scripts/refcount.php');
  • scripts/trails.php(14): include_once("scripts/trails.php");
  • scripts/urlapprove.php(11): include_once('scripts/urlapprove.php');

While additional wikis in a wiki farm will need the $FarmD variable, most new admins will likely start with a single wiki which doesn't need the $FarmD variable. An advanced admin may try to install a farm after reading and learning a little bit. So, in order to keep things simple for new admins with their first wiki, sample-config.php intentionally omits the $FarmD variable (less information overload). And advanced admins already know how to use the $FarmD variable. This was suggested before (and even changed in subversion), but Pm prefers it the current way (so it was reverted). --Petko October 17, 2012, at 04:01 PM