discuss: Need help with DocBook for Emacs Cheat Sheet
Subject:
Re: Need help with DocBook for Emacs Cheat Sheet
From:
Poet/Joshua Drake ####@####.####
Date:
23 Mar 2001 17:46:30 -0000
Message-Id: <Pine.LNX.4.30.0103230937470.31839-100000@crazypenguins.commandprompt.com>
Hello,
Check out the SGML with Emacs HOWTO at http://www.linuxports.com
On Fri, 23 Mar 2001, Patrick K. O'Brien wrote:
>I'm working on an Emacs/PSGML Cheat Sheet and I could use some advice on how
>to structure the file. The main thing I'm trying to provide is a list of
>keystrokes with an accompanying explanation of what they key combination
>does. So obviously I'll need to use elements like keycombo and keycap and
>mousebutton. If anyone can save me some time by giving me an outline or
>point me to a similar document I would be most thankful.
>
>Here is an example of the type of list I want to create:
>
>C-x C-c Exits Emacs.
>C-x C-s Saves the current file.
>M-x Invokes the Emacs command line so you can type in commands.
>C-g Aborts the current command.
>C-_ Undoes the previous command. Same as C-x u.
>C-x u Undoes the previous command. Same as C-_.
>
>So the basic idea is a table with two columns. The first column contains the
>key combination and the second columns contains a description of that key
>combination. I may decide to add one or more columns with additional
>information as well.
>
>I'm also wondering about the best way to handle the Emacisms in describing
>keystrokes. For example, "M" stands for the "Meta" key which maps to the Alt
>or Esc key on modern keyboards. Emacs users will definitely recognize these
>keystroke conventions, but a computer program reading my XML file looking
>for keystroke information might be confused.
>
>My final question is how do I handle the cross references where I say
>something like "Same as C-x u." I did look at the one Emacs HOWTO on the LDP
>and all of the keyboard stuff was tagged as <literal>, which seemed kind of
>"weak" to me. I'd like to do mine up "proper" if I could. Thanks for the
>help.
>
>---
>Patrick K. O'Brien
>Orbtech (http://www.orbtech.com)
>"I am, therefore I think."
>
>
>
>_________________________
>http://list.linuxdoc.org/
>
--
--
<COMPANY>CommandPrompt - http://www.commandprompt.com </COMPANY>
<PROJECT>OpenDocs, LLC. - http://www.opendocs.org </PROJECT>
<PROJECT>LinuxPorts - http://www.linuxports.com </PROJECT>
<WEBMASTER>LDP - http://www.linuxdoc.org </WEBMASTER>
--
Instead of asking why a piece of software is using "1970s technology,"
start asking why software is ignoring 30 years of accumulated wisdom.
--
