Skip to content
This repository has been archived by the owner on Jan 9, 2019. It is now read-only.

Commit

Permalink
doc review
Browse files Browse the repository at this point in the history
  • Loading branch information
Marco Maggi committed Aug 12, 2017
1 parent baa2ea0 commit 9a42087
Showing 1 changed file with 25 additions and 42 deletions.
67 changes: 25 additions & 42 deletions doc/chezscheme-mode.texi
Original file line number Diff line number Diff line change
Expand Up @@ -39,36 +39,32 @@

@set GITHUB_URL @url{http://github.com/marcomaggi/chez-mode}
@set DOCUMENTATION_URL @url{http://marcomaggi.github.io/docs/chez-mode.html}
@set CHEZ_HOMEPAGE_URL @url{http://marcomaggi.github.io/chez.html}
@set CHEZ_HOMEPAGE_URL @url{http://github.io/cisco/ChezScheme}

@c page
@c ------------------------------------------------------------
@c Copyright notice.
@c ------------------------------------------------------------

@copying
This document describes version @version{} of @value{PACKAGE}, a
distribution of Emacs Lisp files implementing an editing mode for Chez
Scheme under @gnu{} Emacs. Chez Scheme is an @rnrs{6} compliant
Scheme implementation in the form of a native compiler for x86
architectures, officially supporting @gnu{}+Linux systems.
This document describes version @version{} of @value{PACKAGE}, a distribution of Emacs Lisp files
implementing an editing mode for Chez Scheme under @gnu{} Emacs. Chez Scheme is an @rnrs{6}
compliant Scheme implementation in the form of a native compiler.

The package is distributed under the terms of the @gnu{} General Public
License (@gpl{}), its development takes place at:
The package is distributed under the terms of the @gnu{} General Public License (@gpl{}), its
development takes place at:

@center @value{GITHUB_URL}

@noindent
Copyright @copyright{} @value{COPYRIGHT_YEARS} by @value{AUTHOR} @value{AUTHOR_EMAIL}

@quotation
Permission is granted to copy, distribute and/or modify this document
under the terms of the @gnu{} Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with
Invariant Sections being ``@gnu{} Free Documentation License'' and
``@gnu{} General Public License'', no Front--Cover Texts, and no
Back--Cover Texts. A copy of the license is included in the section
entitled ``@gnu{} Free Documentation License''.
Permission is granted to copy, distribute and/or modify this document under the terms of the @gnu{}
Free Documentation License, Version 1.3 or any later version published by the Free Software
Foundation; with Invariant Sections being ``@gnu{} Free Documentation License'' and ``@gnu{} General
Public License'', no Front--Cover Texts, and no Back--Cover Texts. A copy of the license is
included in the section entitled ``@gnu{} Free Documentation License''.
@end quotation
@end copying

Expand All @@ -91,7 +87,7 @@ entitled ``@gnu{} Free Documentation License''.
@ifinfo
@dircategory Development
@direntry
* chez-mode: (chez-mode). @value{TITLE}.
* chezscheme-mode: (chezscheme-mode). @value{TITLE}.
@end direntry
@end ifinfo

Expand Down Expand Up @@ -133,45 +129,32 @@ Indexes
@chapter Overview of the package


Chez Scheme is an @rnrs{6} compliant Scheme language implementation in
the form of a native compiler for x86 architectures, officially
supporting @gnu{}+Linux systems. @value{PACKAGE} is a distribution of
Emacs Lisp files implementing an editing mode for Chez Scheme under
@gnu{} Emacs.

After installation of the package, it is possible to load the main
module by adding the following to the @file{.emacs} file:

@example
(autoload 'chez-mode "chez" "Editing mode for Chez Scheme." t)
@end example
Chez Scheme is an @rnrs{6} compliant Scheme language implementation in the form of a native
compiler. @value{PACKAGE} is a distribution of Emacs Lisp files implementing an editing mode for
Chez Scheme under @gnu{} Emacs.

@noindent
it is also possible to enable @func{chez-mode} automatically when
opening @rnrs{6} files with the following:
After installation of the package, it is possible to load the main module by adding the following to
the @file{.emacs} file:

@example
(add-to-list 'auto-mode-alist '("\\.sls\\'" . chez-mode))
(add-to-list 'auto-mode-alist '("\\.sps\\'" . chez-mode))
(autoload 'chezscheme-mode "chezscheme" "Editing mode for Chez Scheme." t)
@end example

@noindent
but, instead, it is suggested to append the following comments at the
end of Chez Scheme source code files:
it is also possible to enable @func{chezscheme-mode} automatically when opening @rnrs{6} files with
the following:

@example
;; Local Variables:
;; mode: chez
;; coding: utf-8
;; End:
(add-to-list 'auto-mode-alist '("\\.chez\\'" . chezscheme-mode))
(add-to-list 'auto-mode-alist '("\\.sls\\'" . chezscheme-mode))
(add-to-list 'auto-mode-alist '("\\.sps\\'" . chezscheme-mode))
@end example

To enable automatic insertion of Chez Scheme source file templates we
can do:
To enable automatic insertion of Chez Scheme source file templates we can do:

@example
(add-to-list 'auto-insert-alist
'("\\.\\(sls\\|sps\\)\\'" . chez-auto-insert-template))
'("\\.\\(sls\\|sps\\|chez\\)\\'" . chez-auto-insert-template))
@end example

@c page
Expand Down

0 comments on commit 9a42087

Please sign in to comment.