aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGlenn Morris2010-11-23 01:19:57 -0800
committerGlenn Morris2010-11-23 01:19:57 -0800
commitd3dfb185aef3ed50fb5a5ab41d8093392c090728 (patch)
treea3aed6e46271b7106839971498c61f4217b82378
parentf98a3c94837dbaccfed3d6ea52931a985f7db9df (diff)
downloademacs-d3dfb185aef3ed50fb5a5ab41d8093392c090728.tar.gz
emacs-d3dfb185aef3ed50fb5a5ab41d8093392c090728.zip
* doc/misc/nxml-mode.texi (Introduction): New section.
This summarizes the still-relevant information from the standalone nxml README fle, mistakenly removed in the initial import of nxml-mode. See http://lists.gnu.org/archive/html/emacs-devel/2007-11/msg01716.html and associated thread, also bug#7456.
-rw-r--r--doc/misc/ChangeLog5
-rw-r--r--doc/misc/nxml-mode.texi59
2 files changed, 60 insertions, 4 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog
index a47dff59e93..8b2f3b07999 100644
--- a/doc/misc/ChangeLog
+++ b/doc/misc/ChangeLog
@@ -1,3 +1,8 @@
12010-11-23 Glenn Morris <rgm@gnu.org>
2 James Clark <jjc@public.jclark.com>
3
4 * nxml-mode.texi (Introduction): New section.
5
12010-11-10 Glenn Morris <rgm@gnu.org> 62010-11-10 Glenn Morris <rgm@gnu.org>
2 7
3 * edt.texi: Remove information about Emacs 19. 8 * edt.texi: Remove information about Emacs 19.
diff --git a/doc/misc/nxml-mode.texi b/doc/misc/nxml-mode.texi
index 423bdc85a24..c22ba6e0f9f 100644
--- a/doc/misc/nxml-mode.texi
+++ b/doc/misc/nxml-mode.texi
@@ -8,7 +8,8 @@
8This manual documents nxml-mode, an Emacs major mode for editing 8This manual documents nxml-mode, an Emacs major mode for editing
9XML with RELAX NG support. 9XML with RELAX NG support.
10 10
11Copyright @copyright{} 2007, 2008, 2009, 2010 Free Software Foundation, Inc. 11Copyright @copyright{} 2007, 2008, 2009, 2010
12Free Software Foundation, Inc.
12 13
13@quotation 14@quotation
14Permission is granted to copy, distribute and/or modify this document 15Permission is granted to copy, distribute and/or modify this document
@@ -43,6 +44,7 @@ license to the document, as described in section 6 of the license.
43This manual is not yet complete. 44This manual is not yet complete.
44 45
45@menu 46@menu
47* Introduction::
46* Completion:: 48* Completion::
47* Inserting end-tags:: 49* Inserting end-tags::
48* Paragraphs:: 50* Paragraphs::
@@ -52,6 +54,58 @@ This manual is not yet complete.
52* Limitations:: 54* Limitations::
53@end menu 55@end menu
54 56
57@node Introduction
58@chapter Introduction
59
60nXML mode is an Emacs major-mode for editing XML documents. It supports
61editing well-formed XML documents, and provides schema-sensitive editing
62using RELAX NG Compact Syntax. To get started, visit a file containing an
63XML document, and, if necessary, use @kbd{M-x nxml-mode} to switch to nXML
64mode. By default, @code{auto-mode-alist} and @code{magic-fallback-alist}
65put buffers in nXML mode if they have recognizable XML content or file
66extensions. You may wish to customize the settings, for example to
67recognize different file extensions.
68
69Once in nXML mode, you can type @kbd{C-h m} for basic information on the
70mode.
71
72The @file{etc/nxml} directory in the Emacs distribution contains some data
73files used by nXML mode, and includes two files (@file{test.valid.xml} and
74@file{test.invalid.xml}) that provide examples of valid and invalid XML
75documents.
76
77To get validation and schema-sensitive editing, you need a RELAX NG Compact
78Syntax (RNC) schema for your document (@pxref{Locating a schema}). The
79@file{etc/schema} directory includes some schemas for popular document
80types. See @url{http://relaxng.org/} for more information on RELAX NG.
81You can use the @samp{Trang} program from
82@url{http://www.thaiopensource.com/relaxng/trang.html} to
83automatically create RNC schemas. This program can:
84
85@itemize @bullet
86@item
87infer an RNC schema from an instance document;
88@item
89convert a DTD to an RNC schema;
90@item
91convert a RELAX NG XML syntax schema to an RNC schema.
92@end itemize
93
94@noindent To convert a RELAX NG XML syntax (@samp{.rng}) schema to a RNC
95one, you can also use the XSLT stylesheet from
96@url{http://www.pantor.com/download.html}.
97
98To convert a W3C XML Schema to an RNC schema, you need first to convert it
99to RELAX NG XML syntax using Sun's RELAX NG converter tool @code{rngconv}
100(built on top of MSV). See @url{https://github.com/kohsuke/msv}
101and @url{https://msv.dev.java.net/}.
102
103For historical discussions only, see the mailing list archives at
104@url{http://groups.yahoo.com/group/emacs-nxml-mode/}. Please make all new
105discussions on the @samp{help-gnu-emacs} and @samp{emacs-devel} mailing
106lists. Report any bugs with @kbd{M-x report-emacs-bug}.
107
108
55@node Completion 109@node Completion
56@chapter Completion 110@chapter Completion
57 111
@@ -855,6 +909,3 @@ specification are not enforced.
855 909
856@bye 910@bye
857 911
858@ignore
859 arch-tag: 3b6e8ac2-ae8d-4f38-bd43-ce9f80be04d6
860@end ignore