Re: [RFR] templates://phpwiki/{templates}
Christian Perrier wrote:
> Your review should be sent as an answer to this mail.
> Template: phpwiki/notes/introduction
> Type: note
[...]
>
> So, in short, that note should imho be dropped. I even wonder whether
> I haven't already filed a bug report about this..:)
It even has the option of putting its README pointer in the basic
/phpwiki/index.html!
> Template: phpwiki/system/documentroot
> Type: string
> Default: /phpwiki
> +_Description: Web-accessible location of PHPWiki:
> + Please specify the location of PHPWiki home page in the web site tree.
Missing "the"... but this needs to avoid sounding as if it's talking
about phpwiki.org (while also not saying it's "your" web server).
Please specify the location within the web site tree of the PHPWiki pages.
> + .
> + The recommended (and default) value is http://<server>/phpwiki. Please
> + only specify the path (example: "/phpwiki").
Is it actually recommended, or just suggested because it's a chunk
of namespace the package can reasonably claim? And then after
pointing at it as the default it seems odd to mention it again as
an example. Yes, this is tricky... I'll try coming at it from a
different angle:
This value will be the local path portion of the wiki's URL, so for
example the default value of "/phpwiki" would make it accessible at
"http://<hostname>/phpwiki".
> Template: phpwiki/system/accessible
[...]
> +_Description: Hosts authorized to access the wiki pages:
> + It is possible to restrict access to the wiki to specific hosts
> + or IP addresses.
> + .
> + If you select "localhost only", access will be restricted to users
> + of the machine
> + the Wiki is running on. The "local network" choice will
> + allow people on machines in the same network than the wiki host to
> + access wiki pages. Finally, when choosing "global", any host can
> + connect to the wiki.
In need of slight anglification:
If you select "localhost only", access will be restricted to users of
the machine the wiki is running on. The "local network" option will
allow people on machines on the same network as the wiki host to access
wiki pages. Finally, choosing "global" allows any host to connect to
the wiki.
> Template: phpwiki/system/localnet
[...]
> +_Description: Local network:
> + Please specify the network that will be considered as "local" and
> + allowed to access the wiki pages. You must use either an IP network in CIDR format (x.x.x.x/y) or
> a domain specification (like *.mydomain.com).
mydomain.com exists! Oh, and I've cut "You must" (which makes it a
plain imperative, but we've already said please).
Please specify the network that will be considered as "local" and
allowed to access the wiki pages. Use either an IP network in CIDR
format (x.x.x.x/y) or a domain specification (like *.example.org).
(Is "an IP network" the right term? It seems odd somehow.)
> Template: phpwiki/notes/configupgrade
Only trivial corrections:
> Type: note
> _Description: New Configuration Method
c m
> PHPWiki 1.3.10 has implemented a new configuration system that no longer
> stores configuration details in the index.php file. The configuration syntax
> + has also been standardized and all directives are now placed in config.ini.
> .
> You still need to run the PHPWiki Upgrade Wizard manually to complete the
> + final portions of the upgrade. See Step 3 of "Wiki Upgrades" section in
^the
> README.Debian for details.
This might not have been debconf abuse when PHPWiki 1.3.10 hit Sid
in September 2005, but Sarge-to-Squeeze upgrades aren't supported
anyway, so it's probably time we cut it out.
In the control file:
> Depends: [...], php5-mysql | php5-pgsql | php5-sqlite, [...]
> Recommends: mysql-client | postgresql-client | sqlite
Wait, won't that preferentially pull in MySQL? README.Debian says
it treats SQLite as the out-of-the-box default. Shouldn't it be...
Depends: [...], php5-sqlite | php5-mysql | php5-pgsql, [...]
Recommends: sqlite | mysql-client | postgresql-client
(Left unmodified in my patch; maybe the default has changed since
the PHP4 days when the docs were written...)
> Suggests: php5-imap, php5-ldap
> Description: informal collaborative website manager
> + PHPWiki provides a Wiki server written in PHP.
s/Wiki/wiki/ throughout, where it's not WikiText.
> A Wiki is a dynamic website which can be edited by anyone at any time.
> Over time bad information is naturally filtered out, since the barrier to
> + modification is very low. Malicious or accidental destruction is obviated
> by the keeping of backup versions of all pages.
"Obviate" is an unfortunate choice, since it's often used to mean
"make unnecessary".
modification is very low. Malicious or accidental destruction is
limited by keeping backup versions of all pages.
I'd be more persuaded of the vandalproof nature of the WikiWikiWeb
concept if "http://phpwiki.org/"; had any surviving content!
> + This package provides an introductory material to the Wiki
> concept, which can be viewed via the Wiki interface when the package has
> been installed.
Turn "a material" back into some non-count-noun material, and avoid
repetition of "provides":
This package includes introductory material for the wiki
> As of today, I'm not sure it's worth explaining what is a wiki (that
> might have been different in the past). So, it would be much more
> preferable to have details about the specific features of
> PHPWiki. However, I don't really have many clues about what should be
> enhanced.
http://phpwiki.sourceforge.net/ has one fact we might incorporate
into the introductory line, like this:
PHPWiki is a reimplementation in PHP of the wiki engine behind the
original WikiWikiWeb at http://c2.com/cgi-bin/wiki?WikiWikiWeb.
A wiki is a dynamic website which can be edited by anyone [...]
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
Template: phpwiki/notes/introduction
Type: note
_Description: PHPWiki configuration
The most important settings for PHPWiki can be configured automatically.
This configuration process will generate a basic, standalone
PHPWiki. It is sufficient for simple local installations, but does not
encompass all of PHPWiki's capabilities. If you want to use the more
advanced features of the wiki, you need to modify /etc/phpwiki/config.ini
after the initial configuration is completed.
.
Please read /usr/share/doc/phpwiki/README.Debian for some important notices
regarding the first time you load pages into the new wiki.
Template: phpwiki/system/documentroot
Type: string
Default: /phpwiki
_Description: Web-accessible location of PHPWiki:
Please specify the location within the web site tree of the PHPWiki pages.
.
This value will be the local path portion of the wiki's URL, so for
example the default value of "/phpwiki" would make it accessible at
"http://<hostname>/phpwiki".
Template: phpwiki/system/accessible
Type: select
__Choices: localhost only, local network, global
Default: localhost only
_Description: Hosts authorized to access the wiki pages:
It is possible to restrict access to the wiki to specific hosts
or IP addresses.
.
If you select "localhost only", access will be restricted to users of
the machine the wiki is running on. The "local network" option will
allow people on machines on the same network as the wiki host to access
wiki pages. Finally, choosing "global" allows any host to connect to
the wiki.
Template: phpwiki/system/localnet
Type: string
Default: 10.0.0.0/24
_Description: Local network:
Please specify the network that will be considered as "local" and
allowed to access the wiki pages. Use either an IP network in CIDR
format (x.x.x.x/y) or a domain specification (like *.example.org).
Template: phpwiki/notes/configupgrade
Type: note
_Description: New configuration method
PHPWiki 1.3.10 has implemented a new configuration system that no longer
stores configuration details in the index.php file. The configuration syntax
has also been standardized and all directives are now placed in config.ini.
.
You still need to run the PHPWiki Upgrade Wizard manually to complete the
final portions of the upgrade. See Step 3 of the "Wiki Upgrades" section in
README.Debian for details.
.
An automatic migration of the configuration has been performed, which should
be enough in most cases. The resulting /etc/phpwiki/config.ini file
should however be checked carefully, particularly when
external authentication methods (LDAP, IMAP, SQL, etc) are
used.
Source: phpwiki
Section: web
Priority: optional
Maintainer: Matt Brown <mattb@debian.org>
Uploaders: David Moreno Garza <damog@debian.org>
Build-Depends: debhelper (>= 7), dpatch, po-debconf
Standards-Version: 3.8.2
Homepage: http://phpwiki.sourceforge.net/
Package: phpwiki
Architecture: all
Depends: ${misc:Depends}, apache2 | httpd, php5 | libapache2-mod-php5, php-db, php5-mysql | php5-pgsql | php5-sqlite, ucf (>= 1.05), dbconfig-common (>= 1.8.21)
Recommends: mysql-client | postgresql-client | sqlite
Suggests: php5-imap, php5-ldap
Description: informal collaborative website manager
PHPWiki is a reimplementation in PHP of the wiki engine behind the
original WikiWikiWeb at http://c2.com/cgi-bin/wiki?WikiWikiWeb.
A wiki is a dynamic website which can be edited by anyone at any time.
Over time bad information is naturally filtered out, since the barrier to
modification is very low. Malicious or accidental destruction is limited
by keeping backup versions of all pages.
.
This package includes introductory material for the wiki
concept, which can be viewed via the wiki interface when the package has
been installed.
--- ../phpwiki-1.3.14.pristine/debian/templates 2009-08-14 10:56:28.000000000 +0100
+++ debian/templates 2009-08-15 12:12:43.000000000 +0100
@@ -1,72 +1,61 @@
Template: phpwiki/notes/introduction
Type: note
-_Description: Welcome to PHPWiki!
- This is an automated config generator for PHPWiki. It is not intended to
- do everything, in fact, all it will do is generate a basic, standalone
- PHPWiki. It is sufficient for simple local installations, but does not
- encompass all of PHPWiki's capabilities. If you want to use the more
- advanced features of the Wiki, please edit /etc/phpwiki/config.ini
- yourself.
+_Description: PHPWiki configuration
+ The most important settings for PHPWiki can be configured automatically.
+ This configuration process will generate a basic, standalone
+ PHPWiki. It is sufficient for simple local installations, but does not
+ encompass all of PHPWiki's capabilities. If you want to use the more
+ advanced features of the wiki, you need to modify /etc/phpwiki/config.ini
+ after the initial configuration is completed.
.
Please read /usr/share/doc/phpwiki/README.Debian for some important notices
- regarding the first time you load pages into your new Wiki.
+ regarding the first time you load pages into the new wiki.
Template: phpwiki/system/documentroot
Type: string
Default: /phpwiki
-_Description: Specify the web-accessible location of PHPWiki:
- This is the path under your website that people should use to access
- the PHPWiki. By default, this is http://yourserver/phpwiki, but you can
- change it to be anything within your server. Enter just the path portion
- below.
+_Description: Web-accessible location of PHPWiki:
+ Please specify the location within the web site tree of the PHPWiki pages.
+ .
+ This value will be the local path portion of the wiki's URL, so for
+ example the default value of "/phpwiki" would make it accessible at
+ "http://<hostname>/phpwiki".
Template: phpwiki/system/accessible
Type: select
-_Choices: localhost only, local network, global
+__Choices: localhost only, local network, global
Default: localhost only
-_Description: Who should be able to access your PHPWiki?:
- A Wiki is normally used to provide unfettered access to information, which
- can be freely modified by anyone. Since that is sometimes not what one
- wants, it is possible to restrict access to the site on the basis of the
- originating IP address.
- .
- If you select 'localhost only', only people on the localhost (the machine
- the Wiki is running on) will be able to connect. 'local network' will
- allow people on machines in a local network (which you will need to
- specify) to talk to the Wiki. 'global' will allow anyone, anywhere, to
- connect to the Wiki.
- .
- For security, this is set to 'localhost only' by default. Unless you have
- a particular need for privacy on your Wiki, you should be able to allow
- access globally without compromising site security.
+_Description: Hosts authorized to access the wiki pages:
+ It is possible to restrict access to the wiki to specific hosts
+ or IP addresses.
+ .
+ If you select "localhost only", access will be restricted to users of
+ the machine the wiki is running on. The "local network" option will
+ allow people on machines on the same network as the wiki host to access
+ wiki pages. Finally, choosing "global" allows any host to connect to
+ the wiki.
Template: phpwiki/system/localnet
Type: string
Default: 10.0.0.0/24
-_Description: Specify your local network:
- The specification should either be an IP network in CIDR format (x.x.x.x/y) or
- a domain specification (like *.mydomain.com).
- .
- Anyone who matches the specification given below will be given full and
- complete access to the PHPWiki.
+_Description: Local network:
+ Please specify the network that will be considered as "local" and
+ allowed to access the wiki pages. Use either an IP network in CIDR
+ format (x.x.x.x/y) or a domain specification (like *.example.org).
Template: phpwiki/notes/configupgrade
Type: note
-_Description: New Configuration Method
+_Description: New configuration method
PHPWiki 1.3.10 has implemented a new configuration system that no longer
stores configuration details in the index.php file. The configuration syntax
- has also been standardised and all directives are now placed in config.ini.
+ has also been standardized and all directives are now placed in config.ini.
.
You still need to run the PHPWiki Upgrade Wizard manually to complete the
- final portions of the upgrade. See Step 3 of 'Wiki Upgrades' section in
- README.Debian for details.
- .
- An automatic migration of your configuration has been performed which should
- correctly migrate your configuration in 95+ percent of cases. However please
- check the new configuration at /etc/phpwiki/config.ini carefully as it is
- always possible that the automatic process was not perfect.
+ final portions of the upgrade. See Step 3 of the "Wiki Upgrades" section in
+ README.Debian for details.
.
- In particular there are known problems migrating configurations that use
- external authentication methods (LDAP, IMAP, SQL, etc) for user accounts.
- These methods are not used by the standard Debian package and their
- configuration is left to the administrator.
+ An automatic migration of the configuration has been performed, which should
+ be enough in most cases. The resulting /etc/phpwiki/config.ini file
+ should however be checked carefully, particularly when
+ external authentication methods (LDAP, IMAP, SQL, etc) are
+ used.
--- ../phpwiki-1.3.14.pristine/debian/control 2009-08-14 10:56:28.000000000 +0100
+++ debian/control 2009-08-15 12:12:53.000000000 +0100
@@ -13,11 +13,13 @@
Recommends: mysql-client | postgresql-client | sqlite
Suggests: php5-imap, php5-ldap
Description: informal collaborative website manager
- A Wiki is a dynamic website which can be edited by anyone at any time.
+ PHPWiki is a reimplementation in PHP of the wiki engine behind the
+ original WikiWikiWeb at http://c2.com/cgi-bin/wiki?WikiWikiWeb.
+ A wiki is a dynamic website which can be edited by anyone at any time.
Over time bad information is naturally filtered out, since the barrier to
- modification is very low. Malicious or accidental destruction is obviated
- by the keeping of backup versions of all pages.
+ modification is very low. Malicious or accidental destruction is limited
+ by keeping backup versions of all pages.
.
- Installed as part of this package is introductory material to the Wiki
- concept, which can be viewed via the Wiki interface when the package has
+ This package includes introductory material for the wiki
+ concept, which can be viewed via the wiki interface when the package has
been installed.
Reply to: