Re: request for review: typo3-dummy
Christian Welzel wrote:
> Please send your answers as CC to me as i'm not reading here regulary.
(Meanwhile, I'm subscribed twice, because I've had so many mail outages
recently that I don't trust either route to reach me reliably...)
> Template: typo3-dummy/apache_mode
> Type: select
> __Choices: vhost, directory, none
> Default: directory
> _Description: Which mode of apache2 should be used?
Only boolean templates are allowed direct question forms. Select
template titles should label the thing the user's choosing (DevRef
6.5.3.1.4).
_Description: Apache integration mode:
> The typo3-dummy package provides two ways of including the TYPO3
> installation in the apache2 webserver: vhost and directory.
This isn't bad, but personally I wouldn't say there are two options
if I was going to follow it with a list of three! Just say
Please choose the method that should be used for integrating the
TYPO3 installation with the apache2 web server.
(I've also left out the name of the package typo3-dummy, on the
assumption that users don't care which member of the typo3 package
suite is providing this configuration infrastructure.)
> .
So far so good, but debconf front-ends won't respect the hard
linebreaks in the following unless you indent it as a conventional
itemised list.
> "vhost" generates shorter URIs because TYPO3 is included into the
> root of the website.
When you say root, you mean the domain name part, right? And this
is the particular kind of URI that can correctly be called by the
more familiar name of "URL", so do that.
> "directory" allows to install TYPO3 in parallel to an existing
^^^^^^^^^
Disallowed! ("http://www.xibalba.demon.co.uk/jbr/linux/esl.html#b1";)
> website. In this case TYPO3 is available under the address
> http://www.your.host/cms.
Of course www.your.host doesn't exist, but www.your.host.com
inevitably does; use an RFC-compliant example hostname. Then if
we're going to give example URLs it would make sense to give one for
vhost as well. (Oh, I see the first example in the .conf snippet is
typo3.example.com; that'll do.)
And since I'm being picky, I'll get rid of "in parallel", too; the
point is that this allows you to fit your CMS "inside" an existing
website.
> "none" does not include TYPO3 automatically and you have to change
> the config files manually yourself. Use this, if you are using a
> webserver other than apache2.
This only needs to be rephrased slightly to fit into the list.
Please choose the method that should be used for integrating the
TYPO3 installation with the apache2 web server.
.
vhost: generates shorter URLs with TYPO3 as part of the domain
name, such as http://typo3.example.com/;
directory: fits TYPO3 within the existing site, making it available
at an address like http://www.example.com/cms/;
none: does not configure TYPO3 automatically. The server will
need manual configuration. Choose this option if you are
using a web server other than apache2.
>
> Template: typo3-dummy/apache_restart
> Type: boolean
> _Description: Should apache2 be restarted after installation?
> The typo3-dummy package has included the TYPO3 configuration into
> the apache2 configuration and activated the rewrite module. To make this
> changes take effect apache2 must be reloaded.
s/this/these/, but otherwise not worth fiddling with.
> Template: typo3-dummy/old_symlink
> Type: note
Might it be worth upgrading this to an "error"?
> _Description: There is an old symlink in /etc/apache2/conf.d/
That's a full sentence; something terser is recommended, like:
_Description: Old symlink in /etc/apache2/conf.d/
> Older typo3-dummy packages (<4.3.0-3) installed the apache2
> configuration as symlink into /etc/apache2/conf.d/typo3-dummy.conf.
Presumably this means that it's installed as a symlink
/etc/apache2/conf.d/typo3-dummy.conf pointing into
/usr/lib/typo3/or/somewhere, not vice-versa, but I had to think about
it for a moment.
I would correct "as symlink" to "as a symlink", but this isn't what
has changed, so say "the apache2 configuration symlink".
Older versions (before 4.3.0-3) of typo3-dummy installed the apache2
configuration symlink as /etc/apache2/conf.d/typo3-dummy.conf.
> This has been changed and newer versions place two new symlinks into
> /etc/apache2/sites-available/. To prevent failures due to
> overlapping configuration directives you should remove the
> symlink typo3-dummy.conf from /etc/apache2/conf.d/ and merge your
> config in one of the new config files.
s/overlapping/conflicting/? Not sure, so I'll leave it. Otherwise
it's all good except that I'd change the last bit into
[...] and merge its
contents into one of the new .conf files.
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
--- typo3-dummy.templates.old 2010-05-04 23:50:24.000000000 +0100
+++ typo3-dummy.templates 2010-05-05 00:06:54.000000000 +0100
@@ -2,33 +2,32 @@
Type: select
__Choices: vhost, directory, none
Default: directory
-_Description: Which mode of apache2 should be used?
- The typo3-dummy package provides two ways of including the TYPO3
- installation in the apache2 webserver: vhost and directory.
+_Description: Apache integration mode:
+ Please choose the method that should be used for integrating the
+ TYPO3 installation with the apache2 web server.
.
- "vhost" generates shorter URIs because TYPO3 is included into the
- root of the website.
- "directory" allows to install TYPO3 in parallel to an existing
- website. In this case TYPO3 is available under the address
- http://www.your.host/cms.
- "none" does not include TYPO3 automatically and you have to change
- the config files manually yourself. Use this, if you are using a
- webserver other than apache2.
+ vhost: generates shorter URLs with TYPO3 as part of the domain
+ name, such as http://typo3.example.com/;
+ directory: fits TYPO3 within the existing site, making it available
+ at an address like http://www.example.com/cms/;
+ none: does not configure TYPO3 automatically. The server will
+ need manual configuration. Choose this option if you are
+ using a web server other than apache2.
Template: typo3-dummy/apache_restart
Type: boolean
_Description: Should apache2 be restarted after installation?
The typo3-dummy package has included the TYPO3 configuration into
- the apache2 configuration and activated the rewrite module. To make this
- changes take effect apache2 must be reloaded.
+ the apache2 configuration and activated the rewrite module. To make
+ these changes take effect apache2 must be reloaded.
Template: typo3-dummy/old_symlink
Type: note
-_Description: There is an old symlink in /etc/apache2/conf.d/
- Older typo3-dummy packages (<4.3.0-3) installed the apache2
- configuration as symlink into /etc/apache2/conf.d/typo3-dummy.conf.
+_Description: Old symlink in /etc/apache2/conf.d/
+ Older versions (before 4.3.0-3) of typo3-dummy installed the apache2
+ configuration symlink as /etc/apache2/conf.d/typo3-dummy.conf.
This has been changed and newer versions place two new symlinks into
/etc/apache2/sites-available/. To prevent failures due to
overlapping configuration directives you should remove the
- symlink typo3-dummy.conf from /etc/apache2/conf.d/ and merge your
- config in one of the new config files.
+ symlink typo3-dummy.conf from /etc/apache2/conf.d/ and merge its
+ contents into one of the new .conf files.
Template: typo3-dummy/apache_mode
Type: select
__Choices: vhost, directory, none
Default: directory
_Description: Apache integration mode:
Please choose the method that should be used for integrating the
TYPO3 installation with the apache2 web server.
.
vhost: generates shorter URLs with TYPO3 as part of the domain
name, such as http://typo3.example.com/;
directory: fits TYPO3 within the existing site, making it available
at an address like http://www.example.com/cms/;
none: does not configure TYPO3 automatically. The server will
need manual configuration. Choose this option if you are
using a web server other than apache2.
Template: typo3-dummy/apache_restart
Type: boolean
_Description: Should apache2 be restarted after installation?
The typo3-dummy package has included the TYPO3 configuration into
the apache2 configuration and activated the rewrite module. To make
these changes take effect apache2 must be reloaded.
Template: typo3-dummy/old_symlink
Type: note
_Description: Old symlink in /etc/apache2/conf.d/
Older versions (before 4.3.0-3) of typo3-dummy installed the apache2
configuration symlink as /etc/apache2/conf.d/typo3-dummy.conf.
This has been changed and newer versions place two new symlinks into
/etc/apache2/sites-available/. To prevent failures due to
overlapping configuration directives you should remove the
symlink typo3-dummy.conf from /etc/apache2/conf.d/ and merge its
contents into one of the new .conf files.
Reply to: