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

Re: [RFR] templates://openoffice.org/{templates}



Justin B Rye wrote:
> I could review the control file for this one, too, if I had a spare
> weekend (so maybe I will).

I thought I would be spending this weekend doing a trial install of
Debian GNU/kFreeBSD, but that was so easy (congrats to the d-i team)
that I've ended up doing a review of just the control file.

>  Description: full-featured office productivity suite
>   OpenOffice.org is a full-featured office productivity suite that provides
>   a near drop-in replacement for Microsoft(R) Office.

Someday I'll get round to asking on debian-legal about whether
there's ever any reason for package descriptions to use this sort of
selective flagging of trademarks.

>   This metapackage installs all components of openoffice.org:
> -  * openoffice.org-writer: Word processor
> -  * openoffice.org-calc: Spreadsheet
> -  * openoffice.org-impress: Presentation
> -  * openoffice.org-draw: Drawing
> -  * openoffice.org-base: Database
> -  * openoffice.org-math: Equation editor
> -  * openoffice.org-filter-mobiledev: Mobile Devices filters
> -  * openoffice.org-filter-binfilter: legacy filters (e.g. StarOffice 5.2)
> +  * openoffice.org-base: database software;
> +  * openoffice.org-calc: spreadsheet;
> +  * openoffice.org-draw: drawing software;
> +  * openoffice.org-filter-mobiledev: filters for mobile devices;
> +  * openoffice.org-filter-binfilter: legacy filters (e.g. StarOffice 5.2);
> +  * openoffice.org-impress: presentation software;
> +  * openoffice.org-math: equation editor;
> +  * openoffice.org-writer: word processor.

Alphabeticised, re-punctuated, and slightly rephrased (e.g.:
Writer is a word processor but Draw isn't a drawing).

>   .
>   You can extend the functionality of OpenOffice.org by installing these
>   packages:
> -  * hunspell-dictionary-*/myspell-dictionary-*: Hunspell/Myspell dictionaries
> -    for use with OpenOffice.org
> -  * openoffice.org-l10n-*: UI interface translation
> -  * openoffice.org-help-*: User help
> -  * openoffice.org-thesaurus-*: Thesauri for the use with OpenOffice.org
> -  * openoffice.org-hyphenation-*: Hyphenation patterns for OpenOffice.org
> -  * openoffice.org-gtk: Gtk UI Plugin, GNOME File Picker support,
> -    QuickStarter for GNOMEs notification are
> -  * openoffice.org-gnome: GNOME VFS, GConf backend
> -  * openoffice.org-kde: KDE UI Plugin and KDE File Picker support
> -  * menu: Will add openoffice.org menu entries for every Debian window manager.
> -  * unixodbc: ODBC database support
> -  * cups-bsd: Allows OpenOffice.org to detect your CUPS printer queues
> -     automatically
> -  * libsane: Use your sane-supported scanner with OpenOffice.org
> -  * libxrender1: Speed up display by using Xrender library
> -  * libgl1: OpenGL support 
> -  * openclipart-openoffice.org: Open Clip Art Gallery with OOo index files
> -  * iceweasel | firefox | icedove | thunderbird | iceape-browser | mozilla-browser:
> -    Mozilla profile with Certificates needed for XML Security...
> -  * java-gcj-compat | sun-java5-jre | java2-runtime
> -    Java Runtime Environment for use with OpenOffice.org
> -  * pstoedit / imagemagick: helper tools for EPS thumbnails
> -  * gstreamer0.10-plugins-*: GStreamer plugins for use with OOos media backend
> -  * libpaper-utils: papersize detection support via paperconf
> +  * cups-bsd: CUPS printer queue autodetection support;
> +  * gstreamer0.10-plugins-*: GStreamer media-player plug-ins;
> +  * hunspell-dictionary-*/myspell-dictionary-*: Hunspell/Myspell dictionaries;
> +  * iceweasel/firefox/icedove/thunderbird/iceape-browser: for security
> +    certificate integration;
> +  * java-gcj-compat/sun-java5-jre/java2-runtime: Java Runtime Environment;
> +  * libgl1: OpenGL support;
> +  * libpaper-utils: papersize detection support via paperconf;
> +  * libsane: scanner support;
> +  * libxrender1: faster display support;
> +  * menu: Debian window manager menu entries;
> +  * openclipart-openoffice.org: Open Clip Art gallery with OOo index files;
> +  * openoffice.org-gnome: GNOME VFS and GConf back-end;
> +  * openoffice.org-gtk: GNOME file picker plug-in;
> +  * openoffice.org-help-*: user help;
> +  * openoffice.org-hyphenation-*: hyphenation patterns;
> +  * openoffice.org-kde: KDE file picker plug-in;
> +  * openoffice.org-l10n-*: user interface translations;
> +  * openoffice.org-thesaurus-*: thesaurus files;
> +  * pstoedit/imagemagick: helper tools for EPS thumbnails;
> +  * unixodbc: ODBC database support.

Alphabeticised, re-punctuated, and slightly rephrased (e.g.:
don't use "|" to mean "or" within English text).

>  Package: broffice.org
>  Priority: extra
>  Architecture: all
>  Depends: openoffice.org, openoffice.org-l10n-pt-br, openoffice.org-help-pt-br, myspell-pt-br, ${misc:Depends}
> -Description: full-featured office productivity suite -- BrOffice.org branding
> +Description: OOo suite - BrOffice.org branding
>   OpenOffice.org is a full-featured office productivity suite that provides
>   a near drop-in replacement for Microsoft(R) Office.

Leave the OOo metapackage with its long summary, but shorten it in
all the other packages because otherwise things get ridiculous (the
phrase is right there in the next line, after all).  I'm not sure it
needs to be as short as "OOo suite", but there's no point repeating
the full name that's already in the packagename.

>   .
> @@ -77,7 +73,7 @@
>  Section: localization
>  Architecture: all
>  Depends: openoffice.org-l10n-af, openoffice.org-l10n-en-za, openoffice.org-l10n-nr, openoffice.org-l10n-ns, openoffice.org-l10n-ss, openoffice.org-l10n-st, openoffice.org-l10n-tn, openoffice.org-l10n-ts, openoffice.org-l10n-ve, openoffice.org-l10n-xh, openoffice.org-l10n-zu, ${misc:Depends}
> -Description: full-featured office productivity suite -- South African language packages
> +Description: OOo suite - South African language packs
>   OpenOffice.org is a full-featured office productivity suite that provides
>   a near drop-in replacement for Microsoft(R) Office.

"Language pack" is another space-saver, like the single dash.

>   . 
> @@ -89,12 +85,13 @@
>  Architecture: all
>  Depends: openoffice.org-l10n-as-in, openoffice.org-l10n-bn, openoffice.org-l10n-gu-in, openoffice.org-l10n-hi-in, openoffice.org-l10n-ml-in, openoffice.org-l10n-mr-in, openoffice.org-l10n-or-in, openoffice.org-l10n-pa-in, openoffice.org-l10n-ta-in, openoffice.org-l10n-te-in, ${misc:Depends}
>  Recommends: ttf-indic-fonts
> -Description: full-featured office productivity suite -- Indic language packages
> +Description: OOo suite - Indic-script language packs
>   OpenOffice.org is a full-featured office productivity suite that provides
>   a near drop-in replacement for Microsoft(R) Office.
>   .
>   This package is a metapackage installing l10n packages for all available
> - indic languages.
> + Indic-script languages.

Tamil and Telugu aren't "Indic languages", they're Dravidian
languages.  Unfortunately we can't just substitute "Indian" either -
Bangla is Indic but not Indian.

Of course this is really just another case of confusion between
writing systems and languages.  This is a metapackage for
localisation in Indic *scripts*.  That's why it excludes Urdu
(closely akin to Hindi, but written in an Arabic-based script).

The best suggestion I can come up with is to expand "Indic
languages" to "Indic-script languages".

[...]
> @@ -147,11 +144,11 @@
>  Conflicts: openoffice.org-debian-files, openoffice.org2-writer (<< ${binary:Version}), openoffice.org-java-common (<= 1:2.3.1)
>  Provides: openoffice.org2-writer
>  Suggests: openoffice.org-gcj, openoffice.org-base
> -Description: full-featured office productivity suite -- word processor
> +Description: OOo suite - word processor
>   OpenOffice.org is a full-featured office productivity suite that provides
>   a near drop-in replacement for Microsoft(R) Office.
>   .
> - This package contains the wordprocessor component for OpenOffice.org.
> + This package contains the word processor component for OpenOffice.org.

As two words, for consistency.

[...]
> @@ -232,20 +229,11 @@
>   .
>   You can extend the functionality of OpenOffice.org Base by installing these
>   packages:
> - .
> -  * unixodbc: ODBC database support
> -  * libmyodbc | odbc-postgresql | libsqliteodbc | tdsodbc | mdbtools: ODBC
> -    drivers for:
> -    - MySQL
> -    - PostgreSQL
> -    - SQLite
> -    - MS SQL / Sybase SQL
> -    - *.mdb (JET / MS Access)
> -  * libmysql-java | libpg-java | libjtds-java: JDBC Drivers
> -    for:
> -    - MySQL
> -    - PostgreSQL
> -    - MS SQL Server and Sybase
> +  * unixodbc: for ODBC database support;
> +  * libmyodbc/odbc-postgresql/libsqliteodbc/tdsodbc/mdbtools: ODBC drivers for
> +    MySQL, PostgreSQL, SQLite, MS/Sybase SQL, and *.mdb (JET/MS Access);
> +  * libmysql-java/libpg-java/libjtds-java: JDBC Drivers for MySQL, PostgreSQL,
> +    and MS/Sybase SQL.

It really doesn't need anything as fancy as this list-within-a-list
layout.  Also, fix the punctuation, avoiding "|" and spaced " / ".

[...]
> @@ -253,11 +241,11 @@
>  Suggests: kde-icons-crystal, crystalcursors
>  Replaces: openoffice.org-common (<< 2.1~m190)
>  Provides: openoffice.org-style
> -Description: full-featured office productivity suite -- Crystal symbol style
> +Description: OOo suite - Crystal theme

Partly a space-saver.

>   OpenOffice.org is a full-featured office productivity suite that provides
>   a near drop-in replacement for Microsoft(R) Office.
>   .
> - This package contains the "crystal" symbol style, default style for KDE 3.
> + This package contains the "Crystal" symbol style, default style for KDE 3.

I'm assuming they're canonically capitalised.

[...]
> - This package contains the "tango" symbol style, default style
> - for GTK+/Gnome.
> + This package contains the "Tango" symbol style, default style for GTK+/GNOME.

Repeating the same tweaks; here also using capitalised GNOME.
  
[...]
> - This package contains the "hicontrast" symbol style, needs to be manually
> - enabled in the OpenOffice.org option menu.
> + This package contains the "Hicontrast" symbol style, which needs to be
> + manually enabled in the OpenOffice.org option menu.

Extra syntax fix.

[...]
>   This package contains the "Galaxy" symbol style from Sun, normally used on
> - MS Windows (tm) and when not using GNOME or KDE, needs to be manually
> - enabled in the OpenOffice.org option menu.
> + MS Windows and outside GNOME or KDE, which needs to be manually enabled in
> + the OpenOffice.org option menu.

There's already a "Microsoft(R)" in the previous paragraph, so drop
the inaccurate "(tm)".  Also fix the syntax.  But in what sense is
this a "default style" if it needs to be manually enabled?
  
>  Package: openoffice.org-style-andromeda
>  Architecture: all
>  Depends: ${misc:Depends}
>  Replaces: openoffice.org-common (<< 2.1~m190)
>  Provides: openoffice.org-style
> -Description: full-featured office productivity suite -- Andromeda (Classic) symbol style
> +Description: OOo suite - Andromeda (Classic) theme

That was not a "short" description.

>   OpenOffice.org is a full-featured office productivity suite that provides
>   a near drop-in replacement for Microsoft(R) Office.
>   .
> - This package contains the "Andromeda" symbol style from Sun; the "Classic"
> - symbol style used by OpenOffice.org before 3.0 on MS Windows (tm) and when
> - not using GNOME or KDE, needs to be manually enabled in the OpenOffice.org
> + This package contains the "Andromeda" symbol style from Sun (the "Classic"
> + symbol style used by OpenOffice.org before 3.0 on MS Windows and outside
> + GNOME or KDE), which needs to be manually enabled in the OpenOffice.org
>   option menu.

Same as Galaxy, but with one minor extra tweak to the punctuation.
  
[...]
> - This package contains the Gtk plugin for drawing OOo's widgets with
> - Gtk+ and a Gtk/GNOMEish File Picker when running under GNOME. It also
> - contains a QuickStarter for the "notification area".
> + This package contains the GTK plug-in for drawing OOo's widgets with
> + GTK+ and a GTK/GNOMEish File Picker when running under GNOME. It also
> + contains a Quickstarter for the "notification area".

Fixing some capitalisation and hyphenating "plug-in".
  
[...]
> - This package contains the GNOME VFS support and a GConf backend.
> + This package contains the GNOME VFS support and a GConf back-end.

Likewise standardising on hyphenated "back-end".

> - You can extend the functionality of this by installing these packages:
> - .
> -  * openoffice.org-evolution: Evolution addressbook support
> -  * evolution
> + You can extend its functionality by installing these packages:
> +  * evolution: groupware suite;
> +  * openoffice.org-evolution: Evolution addressbook support.

Alphabetical order, and including an explanation of what Evolution
actually is (since the name conveys nothing).
  
[...]
> @@ -395,12 +382,12 @@
>  Depends: ${misc:Depends}
>  Enhances: openoffice.org-writer
>  Replaces: python-uno (<< 1:2.4.1-5)
> -Description: full-featured office productivity suite -- email mail merge
> +Description: OOo suite - e-mail mail merge
>   OpenOffice.org is a full-featured office productivity suite that provides
>   a near drop-in replacement for Microsoft(R) Office.
>   .
>   This package contains a component which allows OpenOffice.org to "mail merge"
> - to E-Mail.
> + to e-mail.

Or we could standardise both to "email".
  
>  Package: python-uno
>  Provides: ${python:Provides}
> @@ -410,12 +397,11 @@
>  Enhances: openoffice.org
>  Depends: openoffice.org-core (= ${binary:Version}), ${python:Depends}, ${shlibs:Depends}, ${misc:Depends}
>  Replaces: openoffice.org-common (<< 1.9.82)
> -Description: full-featured office productivity suite -- Python interface
> +Description: OOo suite - Python interface
>   The Python-UNO bridge allows use of the standard OpenOffice.org API 
> - with the Python scripting language. It additionally allows 
> - others to develop UNO components in Python, thus Python UNO components 
> - may be run within the OpenOffice.org process and can be called from C++
> - or the built in StarBasic scripting language.
> + with the Python scripting language. UNO components developed in Python
> + can be run within the OpenOffice.org process and can be called from C++
> + or the built-in StarBasic scripting language.

This flows better, but it probably needs fact-checking.

[...]
>   This package contains the "binfilters", legacy filters for
> -  - the old StarOffice 5.2 formats
> -  - StarWriter 1.0/2.0
> -  - StarWriter/DOS
> -  - *Writer* filters for
> -    + Excel
> -    + Lotus
> +  * the old StarOffice 5.2 formats;
> +  * StarWriter 1.0/2.0;
> +  * StarWriter/DOS;
> +  * *Writer* filters for Excel and Lotus.

The best way to do multi-level lists is almost always not to.

[...]
>   MyThes is a simple thesaurus that uses a structured
>   text data file and an index file with binary search
> - to lookup words and phrases and return information
> - on part of speech, meanings, and synonyms
> + to look up words and phrases and return information
> + on part of speech, meanings, and synonyms.

Look (something) up, two words; full stop at the end.

>   .
>   This package contains the static library and header file needed
> - to develop applications using mythes and the perl script to create
> + to develop applications using mythes, and the Perl script to create
>   the index files.

Capitalisation for the language name, and a necessary comma (it
doesn't mean "the header file needed to develop the Perl script").

In all the localisation packages:

> - Spelling dictionaries, hyphenation patterns, thesauri and help are not
> + Spelling dictionaries, hyphenation patterns, thesaurus files and help are not
>   included in this package. There are some available in separate packages
>   (myspell-*, openoffice.org-hyphenation-*, openoffice.org-thesaurus-*,
> - openoffice.org-help-*)
> + openoffice.org-help-*).
>   .
>   If you just want to be able to spellcheck etc. in other languages, you can
> - install extra dictionaries/hyphenation patterns/thesauri independently of
> + install extra dictionaries/hyphenation patterns/thesaurus files independently of
>   the language packs.

Never use "thesauri" unless you specifically intend to start an
argument about plural morphology.

[...]
> @@ -924,23 +908,24 @@
>  Suggests: hunspell-dictionary-en-gb | myspell-dictionary-en-gb, openoffice.org-hyphenation-en-gb, openoffice.org2-thesaurus-en-gb, openoffice.org-help-en-gb
>  Conflicts: openoffice.org-core (<< ${base-version}), openoffice.org-core (>= ${base-version}.1), openoffice.org2-l10n-en-gb
>  Replaces: openoffice.org2-l10n-en-gb
> -Description: full-featured office productivity suite -- English_british language package
> +Description: OOo suite - British English language pack

There's no such language as English_british.  I would suggest
shortening it to "UK English" (since "gb" actually means the United
Kindom of Great Britain and Northern Ireland) if I thought there was
any hope of keeping the long suite-blurb.

[...]
> -Description: full-featured office productivity suite -- English_southafrican language package
> +Description: OOo suite - South African English language pack

This "short" description was nearly 100 characters long, hence the
radically shortened suite blurb I'm using.

> -Description: full-featured office productivity suite -- Norwegian language package
> +Description: OOo suite - Norwegian Bokmal language pack

The English name of the dominant written standard in Norway is
"Norwegian Bokmal" (or "Bokmål", but we'll get away with ASCII).
See following.

[...]
> -Description: full-featured office productivity suite -- Norwegian_nynorsk language package
> +Description: OOo suite - Norwegian Nynorsk language pack

The minority written standard for Norwegian.

[...]
> -Description: full-featured office productivity suite -- Northernsotho language package
> +Description: OOo suite - Northern Sotho language pack

Obviously.  Likewise Southern.

> -Description: full-featured office productivity suite -- Portuguese language package
> +Description: OOo suite - European Portuguese language pack

Versus:

> -Description: full-featured office productivity suite -- Portuguese_brazilian language package
> +Description: OOo suite - Brazilian Portuguese language pack

Now that there's room, be clear.

> -Description: full-featured office productivity suite -- Chinese_simplified language package
> +Description: OOo suite - Simplified Chinese language pack

Versus:

> -Description: full-featured office productivity suite -- Chinese_traditional language package
> +Description: OOo suite - Traditional Chinese language pack

Another one that's just a difference of standard writing systems,
not languages. 

> -Description: full-featured office productivity suite -- English_american help
> +Description: OOo suite - American English help

If there was a separate openoffice.org-l10n-en-ca then I suppose
Canadians would be entitled to quibble about whether "American" was
specific enough, but never mind.
 
[...]
> -Description: OpenOffice.org UNO runtime environment -- public shared libraries
> +Description: OpenOffice.org UNO runtime environment - shared libraries

Just shortening it; would you get packages of private shared
libraries?

[...]
>   This package contains the public libraries:
> -  - libuno_sal: System Abstraction Layer (C Interface)
> -  - libuno_salhelpergcc3: additional C++ functionality for sal
> -  - libuno_cppu: C++ UNO bridge (C Interface)
> -  - libuno_cppuhelpergcc3: additionl C++ functionality for cppu
> -  - libuno_purpenvhelpergcc3: "purpose environments" helper
> +  * libuno_sal: System Abstraction Layer (C Interface);
> +  * libuno_salhelpergcc3: additional C++ functionality for SAL;
> +  * libuno_cppu: C++ UNO bridge (C Interface);
> +  * libuno_cppuhelpergcc3: additionl C++ functionality for CPPU;
> +  * libuno_purpenvhelpergcc3: "purpose environments" helper.

Punctuation and capitalisation.

[...]
> -Description: OpenOffice.org UNO runtime environment -- public shared library debug symbols
> +Description: OpenOffice.org UNO runtime environment - debug symbols

Shrtn!

>   Package: openoffice.org-gcj
[...]
> - This package has NO effect with Suns/Blackdowns/IBMs/etc. JDK.
> + This package has NO effect with JDKs from Sun/Blackdown/IBM/etc.

Misshapen possessives.
 
>  Package: cli-uno-bridge
>  Section: cli-mono
> @@ -3206,14 +3191,14 @@
>   This package contains the CLI bindings to OpenOffice.org for
>   accessing the OpenOffice.org API from Mono languages (e.g. C# and Boo)
>   .
> - Note that currently the use of Mono for add-ins & scripting inside
> + Note that currently the use of Mono for add-ins and scripting inside
>   OpenOffice.org is *not* yet supported.

Don't use ampersand for "and" within normal text.
 
>  Package: openoffice.org-ogltrans
[...]
>   .
> - This package contains the extension making OpenOffice.org able to use
> - OpenGL for impress transitions.
> + This package contains an extension making OpenOffice.org able to use
> + OpenGL for Impress transitions.

Introductory indefinite article; standardise capitalisation.
  
>  Package: openoffice.org-pdfimport
[...]
>   This package contains the OpenSymbol TrueType font included in
> - OpenOffice.org. This font contains symbols (like fonts as Wingdings(tm)),
> - bullets (needed for bullets in OpenOffice.org) and non-latin character
> + OpenOffice.org. This font contains symbols (like MS Wingdings), bullets
> + (needed for OpenOffice.org) and non-Latin characters.

De-garble, avoid inaccurate "(tm)".
  
> -Description: full-featured office productivity suite -- SDK
> +Description: OOo suite - SDK
>   OpenOffice.org is a full-featured office productivity suite that provides
>   a near drop-in replacement for Microsoft(R) Office.
>   .
> - This package contains the files needed to build plugins/add-ons for
> - OpenOffice.org (includes, IDL files, build tools, ...). It also contains
> - the zipped source of the UNO Java libraries for use in IDEs like eclipse.
> + This package contains the includes, IDL files, build tools, etcetera needed
> + to build plug-ins/add-ons for OpenOffice.org. It also contains the zipped
> + source of the UNO Java libraries for use in IDEs such as Eclipse.

Rephrase more naturally, with hyphenated "plug-ins".

> - This package contains the KDE plugin for drawing OOo's widgets with
> + This package contains the KDE plug-in for drawing OOo's widgets with
>   KDE/Qt and a KDEish File Picker when running under KDE.
> - You can extend the functionality of this by installing these packages:
> - .
> -  * konqueror / kmail
> -  * openoffice.org-kab: KDE Addressbook support
> + You can extend its functionality by installing these packages:
> +  * konqueror/kmail;
> +  * openoffice.org-kab: KDE Addressbook support.

Adjusting the punctuation.  Why do konqueror/kmail share a bullet?
  
[...]
> - The PostgreSQL SDBC Driver allows to use the PostgreSQL database from
> + The PostgreSQL SDBC Driver allows the PostgreSQL database to be used from
>   OpenOffice.org without any wrapper layer such as ODBC or JDBC.

Oh, here's my old friend, objectless allow!

[...]
> - The MySQL Connectot extension allows to use the MySQL database from
> + The MySQL Connector extension allows the MySQL database to be used from
>   OpenOffice.org without any wrapper layer such as ODBC or JDBC.

Ditto with added typo-fix.
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package


Reply to: