File: announce.texi

package info (click to toggle)
emacspeak 29.0-9
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 12,904 kB
  • sloc: xml: 55,354; lisp: 48,335; cpp: 2,321; tcl: 1,500; makefile: 936; python: 836; sh: 785; perl: 459; ansic: 241
file content (59 lines) | stat: -rw-r--r-- 2,042 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
@c $Id: announce.texi 4047 2006-08-11 19:11:17Z tv.raman.tv $

@node Announce
@chapter Announcing Emacspeak Manual 2nd Edition As An Open Source Project


This is to announce the launch of a new open source project
to create a user manual for Emacspeak --an Emacs speech extension that
provides a complete audio desktop.

@menu
* Contributing: Contributing.
* Authoring Guidelines: Authoring Guidelines.
* Credits: Credits.
@end menu

@node Contributing
@section How To Contribute To This Manual

This manual is organized as a series of chapters, with each chapter in a
separate file.
If you feel capable of contributing to a specific section,
send out a message to the Emacspeak mailing list
@code{emacspeak@@cs.vassar.edu}.
You can then start adding content to a local copy of the chapter to
which you are contributing.
When you feel you have something to submit, mail out the file to the
emacspeak mailing list--
I'll integrate new content as it comes in.

@node Authoring Guidelines
@section Authoring Guidelines

For this manual to hang together and make sense to the new user at whom
it is targeted, contributors need to stick to a consistent style.
If you plan to contribute content, you should take some time to read the
existing sections --note that many of these are skeletal and 
the first contributions will be to flesh these sections out.

If you are familiar with texinfo, go ahead and mark up your content
using texinfo.
If you are not, simply author the documentation you create as plain
formatted ASCII.
If you do submit files as texinfo source, make sure to validate them at
your end first by running the files through @code{makeinfo} --badly
created or malformed texinfo source takes more time to fix than marking
up straight text.




@node Credits
@section Credits

This initial version draws heavily from the original Emacspeak user
manual, and includes contributions from 
Jim Van Zandt and Jason White.
Authors who contribute complete sections will be acknowledged here as
well as in the specific section they author.