ecl/doc
Daniel Kochmański e2e6e5304e cosmetic: doc typo and declaration
Signed-off-by: Daniel Kochmański <daniel@turtleware.eu>
2015-08-22 19:06:00 +02:00
..
figures
uffi
xsl
.gitignore
ansi_arrays.xml
ansi_characters.xml
ansi_conditions.xml
ansi_conses.xml
ansi_data_flow.xml doc: update doc 2015-08-17 14:14:40 +02:00
ansi_environment.xml
ansi_evaluation.xml
ansi_filenames.xml
ansi_files.xml
ansi_hash_tables.xml
ansi_numbers.xml
ansi_objects.xml
ansi_overview.xml doc: verify "1. Overview", wrap some lines to 75 characters 2015-08-08 19:28:58 +02:00
ansi_packages.xml doc: I.11.1C: add FFI package 2015-08-08 20:25:44 +02:00
ansi_printer.xml
ansi_reader.xml
ansi_sequences.xml
ansi_streams.xml
ansi_strings.xml
ansi_structures.xml
ansi_symbols.xml
ansi_system_construction.xml
ansi_types.xml doc: mention single-float and double-float built-in-classes in 1.4.1 2015-08-08 19:58:08 +02:00
asdf.xmlf doc: asdf: update api information 2015-08-09 14:32:19 +02:00
bibliography.xmlf
clos.xmlf
compiler.xmlf
COPYING.GFDL
copyright.xmlf doc: fix broken section tag 2015-08-09 11:09:10 +02:00
declarations.xmlf
discarded.xmlf
ecl.css
ecl.ent
ecl.html
ecl.xml doc: mention single-float and double-float built-in-classes in 1.4.1 2015-08-08 19:58:08 +02:00
ecldev.xmlf
emacs.el
embed.xmlf
ffi.xmlf cosmetic: doc typo and declaration 2015-08-22 19:06:00 +02:00
internals.xmlf
interpreter.xmlf
intro.xmlf doc: fix broken section tag 2015-08-09 11:09:10 +02:00
io.xmlf
macros.xmlf
memory.xmlf doc: cosmetic: II.5 line wrap + typos 2015-08-09 13:05:40 +02:00
mop.xmlf
mp.xmlf doc: II.4.1 fix typo 2015-08-09 12:56:28 +02:00
os.xmlf doc: document run-program and external-process 2015-08-11 18:25:31 +02:00
pde.xmlf
preface.xmlf doc: add windows 8 to tested platforms 2015-08-08 19:10:58 +02:00
README
ref_c_arrays.xml
ref_c_characters.xml
ref_c_conditions.xml
ref_c_conses.xml
ref_c_data_flow.xml
ref_c_environment.xml
ref_c_evaluation.xml
ref_c_filenames.xml
ref_c_files.xml
ref_c_hash_tables.xml
ref_c_numbers.xml
ref_c_objects.xml
ref_c_packages.xml
ref_c_printer.xml
ref_c_reader.xml
ref_c_sequences.xml
ref_c_streams.xml
ref_c_strings.xml
ref_c_structures.xml
ref_c_symbols.xml
ref_c_system_construction.xml
ref_c_types_and_classes.xml
ref_embed.xmlf
ref_memory.xmlf
ref_mp.xmlf
ref_os.xmlf doc: refine documentation for external-process 2015-08-12 11:21:27 +02:00
ref_signals.xmlf
schemas.xml
signals.xmlf

Instructions to edit/build this book
====================================

This is the recommended way to edit this manual. It is the one I found
most convenient both under Linux and OS X.

* Install the xmlto package. You can do it in almost any Linux machine
  and also under OS X using the Fink packages.

* Install Emacs (Linux) or Aquamacs (OS X).

* Make sure you have the nxml-mode package. This is available in some
  Linux distributions and comes for free with Aquamacs.

* In the nxml-mode you should replace the Docbook schemas, which go
  only up to version 4.2. These are the steps to do so:

  - Go to http://www.docbook.org/schemas/4x.html

  - Download the RELAX NG schema. It will suffice with docbook-rng-4.4.zip

  - Go to the place where nxml stores its schema files. In Debian/Ubuntu
    it is /usr/share/emacs/site-lisp/nxml-mode/schema, in Aquamacs it is
    in /Applications/Aquamacs.app/Content/Resources/site-lisp/nxml-mode/schema.

  - Make a backup copy of these schemas.

  - Unzip the previous package directly on top of the directory mentioned before.

After these steps, you should be able to edit the manual. To build it,
ensure that the "xmlto" program is in some of the directories listed
in the PATH environment variable and type "make" from the command
line. This will build the HTML version.