LISTSERV mailing list manager LISTSERV 16.0

Help for LATEX-L Archives


LATEX-L Archives

LATEX-L Archives


LATEX-L@LISTSERV.UNI-HEIDELBERG.DE


View:

Message:

[

First

|

Previous

|

Next

|

Last

]

By Topic:

[

First

|

Previous

|

Next

|

Last

]

By Author:

[

First

|

Previous

|

Next

|

Last

]

Font:

Proportional Font

LISTSERV Archives

LISTSERV Archives

LATEX-L Home

LATEX-L Home

LATEX-L  March 2004

LATEX-L March 2004

Subject:

DocTeX -- the next generation?

From:

David Kastrup <[log in to unmask]>

Reply-To:

Mailing list for the LaTeX3 project <[log in to unmask]>

Date:

Sun, 21 Mar 2004 17:59:38 +0100

Content-Type:

text/plain

Parts/Attachments:

Parts/Attachments

text/plain (100 lines)

Hello,

I have been musing about the best ways of providing people with
integrated help systems, input helps and so forth and so on.

The usual TeX authoring system (like Emacs with AUCTeX, or kile, or
WinEdt, or even LyX) will provide menu entries for commands,
descriptions like the following:

  File: latex.info,  Node: \makebox,  Next: \mbox,  Prev: lrbox,  Up: Spaces & Boxes

  \makebox
  --------

     `\makebox[width][position]{text}'

     The `\makebox' command creates a box just wide enough to contain the
  `text' specified.  The width of the box is specified by the optional
  `width' argument.  The position of the text within the box is
  determined by the optional `position' argument.

     * `c' -- centred (default)

     * `l' -- flushleft

     * `r' -- flushright

     * `s' -- stretch from left to right margin. The text must contain
       stretchable space for this to work.

     See *Note \makebox (picture)::.


and so forth and so on (not to mention syntax highlighting).  Now the
usual way DocTeX files describe things are with \DescribeMacro{...},
with examples of code, with the synposis of commands (using things
like \marg, \oarg and so in the descriptions).

I would propose that the next iteration of DocTeX should try to
formalize most of the stuff into somewhat more rigid patterns.  It
would appear that the material before \StopEventually{} would
usually, if just given a bit more formal markup, be quite sufficient
to let the following be generated:

Pages fit for TeXinfo or similar systems (like the above example)
that can be accessed once the editing system knows what packages one
uses, by referring to the name of the defined commands.

Examples typeset with something like
\begin{examplepreamble}
\documentclass[fleqn]{article}
\usepackage{amsmath}
\end{examplepreamble}
With the fleqn class option to article, the look will be as follows:
\begin{examplebody}
\begin{equation}
  E = mc^2
\end{equation}
\end{examplebody}
In the typeset version, the source text of the example body and the
result would be side by side (hello Frank, nice you managed doing
this sort of thing in TLC2), in the help text version, an
appropriately generated image will be placed.

The usual AUCTeX input system will let you do something like
C-c RET \makebox RET

optional width: RET
optional position: RET
text:

Or, if the synopsis specifies that \makebox is considered to be
`long' in some manner, it will just place {} with the cursor inside
and revert to normal text editing again.

If the next DocTeX format is enhanced like this, we will gain

a) automatically generated help systems including examples and
graphics in HTML, TeXinfo and other editing-system friendly ways.
b) instructions sufficient for helping with the entry of commands and
arguments.
c) graphical examples and cut&paste code guaranteed to run.
d) producing TLC3 will just entail listing all the names of the .dtx
files to some program, and it will be able to gather all the rest
automatically.
e) a hyperlink into the complete program source documentation for more
info.

Of course, for help texts and stuff like that, one should try to come
up with a nice scheme that would help adding translations into
different languages, too.

Pipe dream?

Maybe.  But I think there is a case to be made to formalize quite a
bit more in the usage instructions part of DocTeX files, to a degree
where mechanical exploitation becomes feasible.

--
David Kastrup, Kriemhildstr. 15, 44793 Bochum

Top of Message | Previous Page | Permalink

Advanced Options


Options

Log In

Log In

Get Password

Get Password


Search Archives

Search Archives


Subscribe or Unsubscribe

Subscribe or Unsubscribe


Archives

September 2019
July 2019
April 2019
March 2019
February 2019
January 2019
December 2018
November 2018
October 2018
September 2018
August 2018
June 2018
May 2018
April 2018
February 2018
January 2018
December 2017
September 2017
August 2017
July 2017
June 2017
May 2017
April 2017
March 2017
February 2017
January 2017
December 2016
July 2016
April 2016
March 2016
February 2016
January 2016
October 2015
September 2015
August 2015
July 2015
June 2015
May 2015
April 2015
March 2015
February 2015
January 2015
December 2014
November 2014
October 2014
September 2014
August 2014
July 2014
June 2014
May 2014
April 2014
March 2014
February 2014
January 2014
December 2013
November 2013
October 2013
August 2013
July 2013
June 2013
May 2013
April 2013
March 2013
February 2013
January 2013
December 2012
November 2012
September 2012
August 2012
July 2012
June 2012
May 2012
March 2012
February 2012
January 2012
December 2011
November 2011
October 2011
September 2011
August 2011
July 2011
June 2011
May 2011
April 2011
March 2011
February 2011
January 2011
December 2010
November 2010
October 2010
September 2010
August 2010
July 2010
June 2010
May 2010
March 2010
February 2010
January 2010
December 2009
November 2009
October 2009
September 2009
August 2009
July 2009
June 2009
May 2009
April 2009
March 2009
February 2009
January 2009
December 2008
November 2008
October 2008
September 2008
May 2008
April 2008
March 2008
February 2008
January 2008
December 2007
November 2007
September 2007
August 2007
June 2007
May 2007
March 2007
December 2006
November 2006
October 2006
August 2006
July 2006
June 2006
May 2006
April 2006
March 2006
February 2006
November 2005
October 2005
September 2005
August 2005
May 2005
April 2005
March 2005
November 2004
October 2004
August 2004
July 2004
May 2004
April 2004
March 2004
February 2004
January 2004
December 2003
October 2003
August 2003
July 2003
June 2003
May 2003
April 2003
March 2003
February 2003
January 2003
December 2002
October 2002
September 2002
August 2002
July 2002
June 2002
March 2002
December 2001
October 2001
September 2001
August 2001
July 2001
June 2001
May 2001
April 2001
March 2001
February 2001
January 2001
December 2000
November 2000
October 2000
September 2000
August 2000
July 2000
May 2000
April 2000
March 2000
February 2000
January 2000
December 1999
November 1999
October 1999
September 1999
August 1999
May 1999
April 1999
March 1999
February 1999
January 1999
December 1998
November 1998
October 1998
September 1998
August 1998
July 1998
June 1998
May 1998
April 1998
March 1998
February 1998
January 1998
December 1997
November 1997
October 1997
September 1997
August 1997
July 1997
June 1997
May 1997
April 1997
March 1997
February 1997
January 1997
December 1996

ATOM RSS1 RSS2



LISTSERV.UNI-HEIDELBERG.DE

Universität Heidelberg | Impressum | Datenschutzerklärung

CataList Email List Search Powered by the LISTSERV Email List Manager