[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

[RFR] templates://docbookwiki/{templates}



Please find, for review, the debconf templates and packages descriptions for the docbookwiki source package.

This review will last from Tuesday, February 15, 2011 to Friday, February 25, 2011.

Please send reviews as unified diffs (diff -u) against the original
files. Comments about your proposed changes will be appreciated.

Your review should be sent as an answer to this mail.

When appropriate, I will send intermediate requests for review, with
"[RFRn]" (n>=2) as a subject tag.

When we will reach a consensus, I send a "Last Chance For
Comments" mail with "[LCFC]" as a subject tag.

Finally, the reviewed templates will be sent to the package maintainer
as a bug report, and a mail will be sent to this list with "[BTS]" as
a subject tag.

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...

 
@@ -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

  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.

Split in two paragraphs. Drop the "decline here" (rather useless).

 
 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.

apache, apache-perl, apache-ssl are obsolete packages.

Don't use interrogative form (only to be used with boolean templates).

 
 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.

Juste in case some other web server is added to the list in the
future, just replace "Apache" by "the web server".

Apart from this, small style change....

 
 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'.
+ 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.

"web-based setup of what?" :-)
(some interfaces only show the short description)

We standardized on double quotes in other reviews...
 
 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

Mark the 2nd paragraph (3rd element) as non translatable

Style change...


--- docbookwiki.old/debian/control	2011-02-11 06:39:23.193190930 +0100
+++ docbookwiki/debian/control	2011-02-15 07:50:13.476461552 +0100
@@ -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.

Short description: drop article (see DevRef). Uncapitalize "web"

Enumeration: use a standard style and avoid repetition of "can <foo>"


-- 


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.

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
--- 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.
 
@@ -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
  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'.
+ 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
--- docbookwiki.old/debian/control	2011-02-11 06:39:23.193190930 +0100
+++ docbookwiki/debian/control	2011-02-15 07:50:13.476461552 +0100
@@ -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.
Source: docbookwiki
Section: web
Priority: extra
Maintainer: Jeremy Malcolm <terminus@debian.org>
Build-Depends: debhelper (>= 5), gettext, dpatch, po-debconf
Standards-Version: 3.8.3

Package: docbookwiki
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: 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.

Attachment: signature.asc
Description: Digital signature


Reply to: