ecl/doc
Daniel Kochmański 364c27d81c manual: fix typos in chapters
Closes #367.
2017-03-16 08:52:57 +01:00
..
figures doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
tmp old-doc: fix Makefile 2016-08-05 15:59:11 +02:00
uffi doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
xsl doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
.gitignore doc: fix documnetation builds 2015-09-11 14:23:16 +02:00
ansi_arrays.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ansi_characters.xml manual: fix typos in chapters 2017-03-16 08:52:57 +01:00
ansi_conditions.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ansi_conses.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ansi_data_flow.xml doc: update doc 2015-08-17 14:14:40 +02:00
ansi_environment.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ansi_evaluation.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ansi_filenames.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ansi_files.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ansi_hash_tables.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ansi_numbers.xml doc: update random-sates section 2015-09-21 19:38:30 +02:00
ansi_objects.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ansi_overview.xml doc: verify "1. Overview", wrap some lines to 75 characters 2015-08-08 19:28:58 +02:00
ansi_packages.xml cleanup: purge clx 2016-09-07 14:58:50 +02:00
ansi_printer.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ansi_reader.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ansi_sequences.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ansi_streams.xml doc: ansi-streams: correct encodings package 2015-09-11 14:16:31 +02:00
ansi_strings.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ansi_structures.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ansi_symbols.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ansi_system_construction.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
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 doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
clos.xmlf doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
compiler.xmlf doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
COPYING.GFDL doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
copyright.xmlf cleanup: purge clx 2016-09-07 14:58:50 +02:00
declarations.xmlf doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
discarded.xmlf doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ecl.css doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ecl.ent doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ecl.html doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
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 doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
emacs.el doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
embed.xmlf doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ffi.xmlf doc: ffi: example: fix typo in the example 2016-03-01 13:19:18 +01:00
internals.xmlf doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
interpreter.xmlf doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
intro.xmlf xml-doc: correct pathnames 2016-12-09 22:15:40 +01:00
io.xmlf doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
macros.xmlf doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
Makefile old-doc: fix Makefile 2016-08-05 15:59:11 +02:00
memory.xmlf doc: cosmetic: II.5 line wrap + typos 2015-08-09 13:05:40 +02:00
mop.xmlf doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
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 doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
preface.xmlf xml-doc: correct pathnames 2016-12-09 22:15:40 +01:00
README doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ref_c_arrays.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ref_c_characters.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ref_c_conditions.xml doc: fix handler_case example 2016-05-28 20:30:39 +02:00
ref_c_conses.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ref_c_data_flow.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ref_c_environment.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ref_c_evaluation.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ref_c_filenames.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ref_c_files.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ref_c_hash_tables.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ref_c_numbers.xml manual: fix typos in chapters 2017-03-16 08:52:57 +01:00
ref_c_objects.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ref_c_packages.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ref_c_printer.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ref_c_reader.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ref_c_sequences.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ref_c_streams.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ref_c_strings.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ref_c_structures.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ref_c_symbols.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ref_c_system_construction.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ref_c_types_and_classes.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ref_embed.xmlf doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ref_memory.xmlf doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
ref_mp.xmlf manual: document new function 2016-10-05 13:51:36 +02:00
ref_os.xmlf doc: refine documentation for external-process 2015-08-12 11:21:27 +02:00
ref_signals.xmlf doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
schemas.xml doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00
signals.xmlf doc: add documentation as doc subdirectory 2015-08-04 21:55:36 +02:00

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.