Re: [RFR] templates://docbookwiki/{templates}
Christian PERRIER wrote:
> Your review should be sent as an answer to this mail.
>
> Rationale:
> --- docbookwiki.old/debian/templates 2011-02-11 06:39:23.193190930 +0100
> +++ docbookwiki/debian/templates 2011-02-15 07:45:01.080462687 +0100
> @@ -2,7 +2,7 @@
> Type: boolean
> Default: false
> _Description: Remove books during purge?
> - If you accept here, any books uploaded into DocBookWiki, including XML
> + If you choose this option, any book uploaded into DocBookWiki, including XML
> source and downloadable formats, will be removed along with the program
> files.
>
>
> Use our "standard" formula in such case...
This long description sounds as if it's removing them on install!
Append:
when the package is purged.
> @@ -10,43 +10,45 @@
> Type: boolean
> Default: false
> _Description: Generate downloadable formats now?
> - DocBookWiki can generate downloadable formats (HTML, PDF, etc) for the
> + DocBookWiki can generate downloadable formats (HTML, PDF, etc.) for the
>
> "etc" is an abbreviation so needs a dot
(Missing dots off things like this is a bit of an en_GBism - there's
even a case of it in my name...)
[...]
> Template: docbookwiki/setup_password
> Type: password
> Default: admin
> -_Description: Password for web-based setup system:
> +_Description: Password for DocBoookWiki web-based setup system:
ook!
> DocBookWiki comes with an administration script that can help you with
> managing users. The script is located at http://localhost/books/admin.php.
> For security reasons it requires authorization. The administrator's
^
Singlespace for consistency.
[...]
> Template: docbookwiki/sudo_warning
> Type: note
> +#flag:translate!:3
> +_Description: Sudo-related changes needed for DocBookWiki
> In order for DocBookWiki to function correctly, you must run the command
> + "visudo" after installation finishes. That command will open the
> + "sudo" configuration file where you should add the following:
> .
> #includedir /etc/sudoers.d
Hang on - my unmodified upstream /etc/sudoers file already *has* this
line. It's confusing enough that it uses this dumb syntax that makes
it look as if it's commented out when in fact it's active... So don't
tell people to add it; at most, tell them to make sure it's there -
and better yet, put this information in a README and don't
unnecessarily interrupt the install. Or maybe even grep for it and
use an "error" template if the line's missing?
> +Description: web application to display and edit DocBook documents online
> + DocBookWiki is a wiki-like application that allows editing documents
> + in XML (DocBook) format. It has the following features:
> + * online display of DocBook documents;
> + * simultaneous display of multiple documents;
> + * multiple-language display;
> + * granular modification by section and language;
> + * multiple editing modes: text, HTML, XML, texi, LaTeX, etc.;
> + * automatic conversion of DocBook documents to other formats (such
> + as PDF, RTF, LaTeX, etc.) for downloading;
> + * document modifications history in SVN;
> + * authentication system with granular access rights management.
Perfect.
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
diff -ru old/control new/control
--- old/control 2011-02-11 11:46:54.901258752 +0000
+++ new/control 2011-02-15 19:59:55.064925565 +0000
@@ -9,21 +9,15 @@
Architecture: all
Depends: apache2, php5-cli, libapache-mod-php5 | libapache2-mod-php5, debconf | debconf-2.0, xsltproc (>=1.1.18), libxml2-utils, openssl, sudo (>=1.7.2p1-1), swish-e, docbook-xml, docbook-xsl, xmlto, docbook-utils, dblatex, xmltex, docbook-dsssl, jadetex, subversion, adduser, gawk, svn-load, dbconfig-common, php-gettext
Recommends: dbconfig-mysql
-Description: a Web application to display and edit DocBook documents online
- DocBookWiki is like a wikiwiki which saves the content in XML (DocBook)
- format. It has the following features:
- * Can display a DocBook document online.
- * Can display several documents at once (a list of books).
- * Can display each of them in several languages.
- * Allows to edit a certain section of a certain book in a certain language.
- * Editing can be done in several modes, like text, html, xml, texi, latex
- etc.
- * The basic format is always DocBook (XML), no matter how it is displayed
- or edited.
- * Each document (in each language) can be converted automatically into
- other formats (like PDF, RTF, LaTeX, etc.) for downloading.
- * All the history of modifications is kept (in SVN) and any previous
- versions of a document can be recovered (by tag or by date) by the admin
- of the site.
- * Authentication of editors can be enabled and admin can assign different
- access rights and permissions to the editors.
+Description: web application to display and edit DocBook documents online
+ DocBookWiki is a wiki-like application that allows editing documents
+ in XML (DocBook) format. It has the following features:
+ * online display of DocBook documents;
+ * simultaneous display of multiple documents;
+ * multiple-language display;
+ * granular modification by section and language;
+ * multiple editing modes: text, HTML, XML, texi, LaTeX, etc.;
+ * automatic conversion of DocBook documents to other formats (such
+ as PDF, RTF, LaTeX, etc.) for downloading;
+ * document modifications history in SVN;
+ * authentication system with granular access rights management.
diff -ru old/templates new/templates
--- old/templates 2011-02-11 11:46:48.229257317 +0000
+++ new/templates 2011-02-15 20:04:35.232925896 +0000
@@ -2,51 +2,53 @@
Type: boolean
Default: false
_Description: Remove books during purge?
- If you accept here, any books uploaded into DocBookWiki, including XML
+ If you choose this option, any book uploaded into DocBookWiki, including XML
source and downloadable formats, will be removed along with the program
- files.
+ files when the package is purged.
Template: docbookwiki/generate_downloads
Type: boolean
Default: false
_Description: Generate downloadable formats now?
- DocBookWiki can generate downloadable formats (HTML, PDF, etc) for the
+ DocBookWiki can generate downloadable formats (HTML, PDF, etc.) for the
default set of books during installation, but this will take quite some
- time to do. If you do not want to generate these now, decline here and
- they will be generated when the next DocBookWiki weekly cron job runs.
+ time to do.
+ .
+ If you do not want to generate these now, they will be generated when
+ the next DocBookWiki weekly cron job runs.
Template: docbookwiki/reconfigure_webserver
Type: multiselect
-__Choices: apache, apache-ssl, apache-perl, apache2
-Default:
-_Description: Which web server would you like to reconfigure automatically?
+__Choices: apache2
+_Description: Web server to reconfigure for DocBookWiki:
DocBookWiki supports any web server that PHP does, but this automatic
configuration process only supports Apache.
Template: docbookwiki/restart_webserver
Type: boolean
Default: false
-_Description: Do you want to restart Apache now?
- In order to activate the new configuration Apache has to be restarted. If
- you do not confirm here, please remember to restart Apache manually.
+_Description: Do you want to restart the web server now?
+ In order to activate the new configuration, the web server has to be
+ restarted. You may however prefer doing this manually later.
Template: docbookwiki/setup_password
Type: password
Default: admin
-_Description: Password for web-based setup system:
+_Description: Password for DocBoookWiki web-based setup system:
DocBookWiki comes with an administration script that can help you with
managing users. The script is located at http://localhost/books/admin.php.
- For security reasons it requires authorization. The administrator's
- username is 'superuser' and the default password is 'admin'.
+ For security reasons it requires authorization. The administrator's
+ username is "superuser" and the default password is "admin".
.
It is recommended that you enter a different superuser password here.
Leave empty if you want to use the default password.
Template: docbookwiki/sudo_warning
Type: note
-_Description: Important change to be made using "visudo"
+#flag:translate!:3
+_Description: Sudo-related changes needed for DocBookWiki
In order for DocBookWiki to function correctly, you must run the command
- "visudo" after installation finishes. This will open an editor into which
- you should add the following line at the bottom:
+ "visudo" after installation finishes. That command will open the
+ "sudo" configuration file where you should add the following:
.
#includedir /etc/sudoers.d
Template: docbookwiki/purge_books
Type: boolean
Default: false
_Description: Remove books during purge?
If you choose this option, any book uploaded into DocBookWiki, including XML
source and downloadable formats, will be removed along with the program
files when the package is purged.
Template: docbookwiki/generate_downloads
Type: boolean
Default: false
_Description: Generate downloadable formats now?
DocBookWiki can generate downloadable formats (HTML, PDF, etc.) for the
default set of books during installation, but this will take quite some
time to do.
.
If you do not want to generate these now, they will be generated when
the next DocBookWiki weekly cron job runs.
Template: docbookwiki/reconfigure_webserver
Type: multiselect
__Choices: apache2
_Description: Web server to reconfigure for DocBookWiki:
DocBookWiki supports any web server that PHP does, but this automatic
configuration process only supports Apache.
Template: docbookwiki/restart_webserver
Type: boolean
Default: false
_Description: Do you want to restart the web server now?
In order to activate the new configuration, the web server has to be
restarted. You may however prefer doing this manually later.
Template: docbookwiki/setup_password
Type: password
Default: admin
_Description: Password for DocBoookWiki web-based setup system:
DocBookWiki comes with an administration script that can help you with
managing users. The script is located at http://localhost/books/admin.php.
For security reasons it requires authorization. The administrator's
username is "superuser" and the default password is "admin".
.
It is recommended that you enter a different superuser password here.
Leave empty if you want to use the default password.
Template: docbookwiki/sudo_warning
Type: note
#flag:translate!:3
_Description: Sudo-related changes needed for DocBookWiki
In order for DocBookWiki to function correctly, you must run the command
"visudo" after installation finishes. That command will open the
"sudo" configuration file where you should add the following:
.
#includedir /etc/sudoers.d
Reply to: