Re: [RFR] templates://auctex/{auctex/templates}
(Incorporating some responses to Frank's review.)
Christian Perrier wrote:
> Your review should be sent as an answer to this mail.
>
> _Description: (La)TeX macros parsing mode:
> To greatly improve AUCTeX performances, every TeX macro package and LaTeX
Singular "performance".
> + style file currently installed on this site will be parsed.
>
> Unpersonnalization.
>
> We could even drop the Emacs jargon of "site".
In which case:
To improve the performance of AUCTeX, every currently installed TeX
macro package and LaTeX style file will be parsed.
> This may take a lot of time, so it should be probably done in the
That word-order would mean "it is necessary that it should be
probably done". We want "it is probably necessary that it should be
done":
This may take a lot of time, so it should probably be done in the
> + A weekly cron job will also take care of updating this data,
"Data" may not be the plural of "datum" in modern English, but
nonetheless I'd say "the cached data" here.
> + and therefore no specific action is required whenever you install new
> (La)TeX packages or remove old ones.
>
> slightly simplify the sentence
I'd recommend: s/and therefore/so that/
Or even if I want to install old ones or remove new ones! It just
means "when (La)TeX packages are added or removed".
> Package: auctex
(Reinstating the B-D-I field.)
> -Description: An integrated environment for editing TeX and friends documents
> +Description: integrated environment for editing TeX and related documents
No, it means "documents in TeX and related formats". Is there no
well-established way of saying that - something like "*TeX", maybe?
If not, reformulate it as:
Description: integrated document editing environment for TeX etc.
> AUCTeX is a comprehensive customizable integrated environment for writing
> input files for TeX/LaTeX/ConTeXt/Texinfo using Emacs.
GNU Emacs only (and looking at the docs it seems to be TeX/LaTeX and
probably not much else).
> - It lets you process your source files by running TeX and related tools (such
> + It allows processing source files by running TeX and related tools (such
>
> Unpersonnalization
A use of "allows" that would read better with "supports", IMHO.
> as output filters, post processors for generating indices and bibliographies,
> - and viewers) from inside Emacs. AUCTeX lets you browse through the errors
> - TeX reported, while it moves the cursor directly to the reported error, and
> - displays some documentation for that particular error. This will even work
> + and viewers) from inside Emacs. AUCTeX allows browsing through the errors
(This "allows" is slightly better, and preferable to a repeated
"supports".)
> + AUCTeX automatically indents LaTeX 'source', not only as it is written
> + but also by reformatting an entire document. It has a
> + special outline feature, which can greatly help 'getting an overview' of
> a document.
Eliminating "you" brings in subtle problems - for instance "as it is
written" is a common paraphrase for "literally". Let me see:
AUCTeX can automatically indent LaTeX 'source', either line by line or
for an entire document, and has a special outline feature which can
greatly assist in getting an overview of a document.
> Apart from these special features, AUCTeX provides a large range of handy
> + Emacs macros, which in several different ways can help writing
> documents fast and painlessly.
>
> Unpersonnalize
The only objective information here (even if we trust the
adjectives) is:
AUCTeX also provides a large range of handy Emacs macros.
And that hardly deserves a paragraph to itself - merge it in with
the one about Emacs-Lisp!
> All features of AUCTeX are documented using the GNU Emacs online
> - documentation system. That is, documentation for any command is just a key
> - click away!
> + documentation system.
>
> Drop thesecond sentence which adds few information and is not neutral
> enough to my taste..:)
It's objectively untrue - there is no single-keystroke way of
accessing these docs even if you somehow already know the name of
the function you're asking about. And besides, "online
documentation" means Wikipedia. I'd suggest:
Documentation for all features of AUCTeX is accessible via the Emacs
info browser.
But again, this isn't worth a paragraph.
> + Currently XEmacs ships with its own AUCTeX version, so this package should only
> + be used with GNU/Emacs.
Make that "GNU Emacs" (as in "apt-cache show emacs").
> Splitted from previous paragraph
If you ask me, it should be a correction to the very first paragraph.
So merge the last several paragraphs into:
AUCTeX is written entirely in Emacs Lisp, and may therefore be enhanced
with new features for specific needs. It comes with a large range of
handy Emacs macros. It is a GNU project, and documentation for all its
features is accessible via the Emacs info browser.
> Package: preview-latex-style
> Architecture: all
> Depends: tex-common
> Recommends: doc-base
> Conflicts: preview-latex (<=0.7.3-2)
> -Description: LaTeX style files for editor embedded preview of some environments
> +Description: preview LaTeX output inside Emacsen
Again I disagree with Frank; "embedded" is dead weight here, and "of
some environments" is just baffling. Nonetheless, Christian's
version is no good, since "preview stuff" is a verb phrase. Try:
Description: style files to support LaTeX output previewing in Emacs
Its dependencies imply this package is useful even with no version
of emacs installed, but I suspect that again it's specific to GNU
Emacs.
> + This package provides style files that enable previewing of equations
> + or figures in supported LaTeX environments.
It would be really helpful to know whether in fact there are any.
> + Designed for LaTeX users,
Obvious from the package name. Drop this and just start the next
sentence with "It combines...".
> + preview-latex is a combination of folding and in-source previewing that
> + provides true "What You See Is What You Get" experience in the sourcebuffer,
It seems absurd to expand such a universally understood term but
treat the obscure jargonism "folding" as self-explanatory.
Source buffer is two words (and en_EMACS).
> + while keeping full control. This utility comes with its own
> + manual.
It does things while keeping control? No, give *me* control!
This package provides style files that enable previewing of equations
or figures in supported LaTeX environments. It combines folding with
in-source previewing to give a true WYSIWYG experience in the source
buffer without sacrificing control. This utility comes with its own
manual.
--
JBR
Ankh kak! (Ancient Egyptian blessing)
--- ../auctex.old/debian/templates 2007-10-29 09:00:58.000000000 +0000
+++ debian/templates 2007-11-02 21:58:18.000000000 +0000
@@ -2,33 +2,36 @@
Type: select
__Choices: Background, Foreground, None
Default: Background
+#flag:comment:3
+# Translators: do NOT translate ${LOGFILE}
_Description: (La)TeX macros parsing mode:
- To greatly improve AUCTeX performances, every TeX macro package and LaTeX
- style file currently installed at your site will be parsed.
+ To improve the performance of AUCTeX performance, every currently installed
+ TeX macro package and LaTeX style file will be parsed.
.
- This may take a lot of time, so it should be probably done in the
- background; however you may also choose to have it done in the foreground,
- or to skip the parsing at all instead. If you choose Background, you will
- find a detailed log of the process in the file: ${LOGFILE}.
+ This may take a lot of time, so it should probably be done in the
+ background. You may also choose to have it done in the foreground,
+ or to skip that step. If you choose 'Background', you will
+ find a detailed log of the process in ${LOGFILE}.
.
- A weekly cron job will also take care of updating the data collected now,
- so usually you won't need to worry about them whenever you install new
- (La)TeX packages or remove old ones.
+ A weekly cron job will also take care of updating the cached data,
+ so that no specific action is required when (La)TeX packages are
+ added or removed.
.
- Anyway, you can update them by hand running update-auctex-elisp.
+ This update can be run manually at any moment by running
+ 'update-auctex-elisp'.
Template: auctex/doautofg
Type: select
__Choices: Console, File
Default: File
+#flag:comment:3
+# Translators: do NOT translate ${LOGFILE}
_Description: Parsing output destination:
You chose to parse TeX macro packages and LaTeX style files in foreground.
- This is OK, but normally it will also generate quite a lot of output.
+ This operation generates a lot of information. Please choose where
+ this information should be sent:
.
- By default -- i.e., answering File to this question -- further output from
- the parsing process will go to a file named: ${LOGFILE}.
- .
- If you answer Console, you will see all of the (boring) output right on
- your terminal.
+ File: output goes to ${LOGFILE};
+ Console: output goes to the current console.
# arch-tag: f0377964-4347-46dc-a310-3f371380b170-child
--- ../auctex.old/debian/control 2007-10-29 09:00:58.000000000 +0000
+++ debian/control 2007-11-02 22:39:06.000000000 +0000
@@ -5,6 +5,7 @@
Uploaders: OHURA Makoto <ohura@debian.org>
Standards-Version: 3.7.2
Build-Depends-Indep: emacs22 | emacs21 | emacs-snapshot, eperl, gs-gpl | gs, po-debconf, texlive-latex-base, texinfo, texi2html (>=1.76-1)
+Homepage: http://www.gnu.org/software/auctex/
Package: auctex
Architecture: all
@@ -14,53 +15,39 @@
Conflicts: emacspeak (<= 17.0-1), preview-latex
Replaces: preview-latex
Provides: preview-latex
-Description: An integrated environment for editing TeX and friends documents
+Description: integrated document editing environment for TeX etc.
AUCTeX is a comprehensive customizable integrated environment for writing
- input files for TeX/LaTeX/ConTeXt/Texinfo using Emacs.
+ input files for TeX/LaTeX/ConTeXt/Texinfo using GNU Emacs. Currently XEmacs
+ ships with its own AUCTeX version.
.
- It lets you process your source files by running TeX and related tools (such
+ It supports processing source files by running TeX and related tools (such
as output filters, post processors for generating indices and bibliographies,
- and viewers) from inside Emacs. AUCTeX lets you browse through the errors
- TeX reported, while it moves the cursor directly to the reported error, and
- displays some documentation for that particular error. This will even work
+ and viewers) from inside Emacs. AUCTeX allows browsing through the errors
+ reported by TeX, while it moves the cursor directly to the reported error, and
+ displays some documentation for that particular error. This will even work
when the document is spread over several files.
.
- One component of AUCTeX that LaTeX users will find attractive is
- preview-latex, a combination of folding and in-source previewing that
- provides true "What You See Is What You Get" experience in your sourcebuffer,
- while letting you retain full control. preview-latex comes with its own
- manual.
- .
- AUCTeX automatically indents your `LaTeX-source', not only as you write
- it---you can also let it indent and format an entire document. It has a
- special outline feature, which can greatly help you `getting an overview' of
- a document.
- .
- Apart from these special features, AUCTeX provides a large range of handy
- Emacs macros, which in several different ways can help you write your
- documents fast and painlessly.
- .
- All features of AUCTeX are documented using the GNU Emacs online
- documentation system. That is, documentation for any command is just a key
- click away!
- .
- AUCTeX is written entirely in Emacs-Lisp, and hence you can easily add new
- features for your own needs. It has become recently a GNU project. AUCTeX
- is distributed under the `GNU General Public License Version 2'.
- .
- Currently XEmacs ships with its own AUCTeX, so this package should only
- be used with GNU/Emacs. (I.e., you don't need to install this package if
- your site uses only XEmacs.)
- .
- Homepage: http://www.gnu.org/software/auctex/
+ AUCTeX can automatically indent LaTeX 'source', either line by line or
+ for an entire document, and has a special outline feature which can
+ greatly assist in getting an overview of a document.
+ .
+ AUCTeX is written entirely in Emacs Lisp, and may therefore be enhanced
+ with new features for specific needs. It comes with a large range of
+ handy Emacs macros. It is a GNU project, and documentation for all its
+ features is accessible via the Emacs info browser.
Package: preview-latex-style
Architecture: all
Depends: tex-common
Recommends: doc-base
Conflicts: preview-latex (<=0.7.3-2)
-Description: LaTeX style files for editor embedded preview of some environments
- These style files are allow previewing LaTeX environments such as math or
- figures in editors which support it.
- .
- Homepage: http://www.gnu.org/software/auctex/preview-latex.html
+Homepage: http://www.gnu.org/software/auctex/preview-latex.html
+Description: style files to support LaTeX output previewing in Emacs
+ This package provides style files that enable previewing of equations
+ or figures in supported LaTeX environments.
+ .
+ This package provides style files that enable previewing of equations
+ or figures in supported LaTeX environments. It combines folding with
+ in-source previewing to give a true WYSIWYG experience in the source
+ buffer without sacrificing control. This utility comes with its own
+ manual.
Template: auctex/doauto
Type: select
__Choices: Background, Foreground, None
Default: Background
#flag:comment:3
# Translators: do NOT translate ${LOGFILE}
_Description: (La)TeX macros parsing mode:
To improve the performance of AUCTeX performance, every currently installed
TeX macro package and LaTeX style file will be parsed.
.
This may take a lot of time, so it should probably be done in the
background. You may also choose to have it done in the foreground,
or to skip that step. If you choose 'Background', you will
find a detailed log of the process in ${LOGFILE}.
.
A weekly cron job will also take care of updating the cached data,
so that no specific action is required when (La)TeX packages are
added or removed.
.
This update can be run manually at any moment by running
'update-auctex-elisp'.
Template: auctex/doautofg
Type: select
__Choices: Console, File
Default: File
#flag:comment:3
# Translators: do NOT translate ${LOGFILE}
_Description: Parsing output destination:
You chose to parse TeX macro packages and LaTeX style files in foreground.
This operation generates a lot of information. Please choose where
this information should be sent:
.
File: output goes to ${LOGFILE};
Console: output goes to the current console.
# arch-tag: f0377964-4347-46dc-a310-3f371380b170-child
Source: auctex
Priority: optional
Section: tex
Maintainer: Davide G. M. Salvetti <salve@debian.org>
Uploaders: OHURA Makoto <ohura@debian.org>
Standards-Version: 3.7.2
Build-Depends-Indep: emacs22 | emacs21 | emacs-snapshot, eperl, gs-gpl | gs, po-debconf, texlive-latex-base, texinfo, texi2html (>=1.76-1)
Homepage: http://www.gnu.org/software/auctex/
Package: auctex
Architecture: all
Depends: debconf | debconf-2.0, emacs22 | emacs21 | emacs-snapshot, make, preview-latex-style
Recommends: doc-base, gs-gpl | gs, texlive-latex-recommended, xpdf-reader | pdf-viewer
Suggests: catdvi, dvipng, lacheck
Conflicts: emacspeak (<= 17.0-1), preview-latex
Replaces: preview-latex
Provides: preview-latex
Description: integrated document editing environment for TeX etc.
AUCTeX is a comprehensive customizable integrated environment for writing
input files for TeX/LaTeX/ConTeXt/Texinfo using GNU Emacs. Currently XEmacs
ships with its own AUCTeX version.
.
It supports processing source files by running TeX and related tools (such
as output filters, post processors for generating indices and bibliographies,
and viewers) from inside Emacs. AUCTeX allows browsing through the errors
reported by TeX, while it moves the cursor directly to the reported error, and
displays some documentation for that particular error. This will even work
when the document is spread over several files.
.
AUCTeX can automatically indent LaTeX 'source', either line by line or
for an entire document, and has a special outline feature which can
greatly assist in getting an overview of a document.
.
AUCTeX is written entirely in Emacs Lisp, and may therefore be enhanced
with new features for specific needs. It comes with a large range of
handy Emacs macros. It is a GNU project, and documentation for all its
features is accessible via the Emacs info browser.
Package: preview-latex-style
Architecture: all
Depends: tex-common
Recommends: doc-base
Conflicts: preview-latex (<=0.7.3-2)
Homepage: http://www.gnu.org/software/auctex/preview-latex.html
Description: style files to support LaTeX output previewing in Emacs
This package provides style files that enable previewing of equations
or figures in supported LaTeX environments.
.
This package provides style files that enable previewing of equations
or figures in supported LaTeX environments. It combines folding with
in-source previewing to give a true WYSIWYG experience in the source
buffer without sacrificing control. This utility comes with its own
manual.
Reply to: