[AUCTeX-devel] Re: Cross-references in changes.texi

[Reiner Steib]

On Fri, Jun 02 2006, Ralf Angeli wrote:

> * Reiner Steib (2006-06-02) writes:
>> I'd suggest to add a new node "Miscellaneous Commands" or "Other
>> Commands" (or similar; suggestions?).  We could (later) add the other
>> entries from the Command menu too, if appropriate.  WDYT?
>
> Hm, I'm not sure `TeX-doc' fits into the "Running TeX and friends"
> category.  It's not really part of the typesetting cycle.
> Unfortunately we don't have a section where it really fits.

Agreed (on both).

> The other big ones are about text manipulation and source display.
> How about giving it its own section below "Running TeX and friends"
> in order to spell it out more explicitely?

Do you mean @section or @chapter?  "Running TeX and friends" is a
@chapter.  Creating a new @chapter for a single command (or is the
anything else that would fit there?) seems a little heavy.  And having
two "Miscellaneous"-like sections also don't make too much sense.  I
won't object to move it out of the current node, but I don't see much
benefit (yet).

>> +* Miscellaneous Commands::      Miscellaneous Commands.
>>  @end menu
>
> This requires the detailed node listing to be regenerated.

Added.

>> address@hidden Miscellaneous Commands
>> address@hidden Miscellaneous Commands
>> +
>> address@hidden Command TeX-doc
>> address@hidden C-c ?
>
> How about adding a "(@kbd{C-c ?})" in front of the following
> description and removing the reference to the key binding from the
> text?

Good idea.  Done.

>> +The function @code{TeX-doc} provides easy access to documentation about
>> +commands and packages or information related to @TeX{} and friends in
>> +general.  It is accessible with the key binding @kbd{C-c ?} or the
>> address@hidden Documentation...} entry in the mode menus.
>> address@hidden deffn
>> +
>> address@hidden Command TeX-clean
>> +You can get rid of generated intermediate and output files by means of
>> +the new @samp{Clean} and @samp{Clean All} entries in
>        ^^^
> The time will come when those won't be new anymore. (c:

Fixed.

>> address@hidden accessible with @kbd{C-c C-c} or the Command
>> +menu.
>
> I guess we should explain the prefix argument as well if we present
> `TeX-clean' as a function

Done.

Here's a new suggestion:

--8<---------------cut here---------------start------------->8---
@node Miscellaneous Commands
@section Miscellaneous Commands

@deffn Command TeX-clean
Delete generated intermediate files associated with current master file.
With prefix argument, not only remove intermediate but also output
files.  These funtions are also accessible by means of the @samp{Clean}
and @samp{Clean All} entries in @code{TeX-command-list} (@kbd{C-c C-c})
and the Command menu.
@end deffn

@deffn Command TeX-doc
@kindex C-c ?
(@kbd{C-c ?}) The function @code{TeX-doc} provides easy access to
documentation about commands and packages or information related to
@TeX{} and friends in general.  It is also accessible from the
@samp{Find Documentation...} entry in the mode menus.
@end deffn
--8<---------------cut here---------------end--------------->8---

Bye, Reiner.
-- 
       ,,,
      (o o)
---ooO-(_)-Ooo---  |  PGP key available  |  http://rsteib.home.pages.de/