emacs: doc/misc/nxml-mode.texi annotate

annotate doc/misc/nxml-mode.texi @ 86809:8ac1aa3f0181

*** empty log message ***

author	Richard M. Stallman <rms@gnu.org>
date	Thu, 29 Nov 2007 01:08:57 +0000
parents	aa024a0d77d4
children	1f5bfb7b57da

rev	line source
86378 5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	1 \input texinfo @c -- texinfo --
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	2 @c %**start of header
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	3 @setfilename ../../info/nxml-mode
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	4 @settitle nXML Mode
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	5 @c %**end of header
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	6
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	7 @dircategory Emacs
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	8 @direntry
86402 aa024a0d77d4 Fix file name to match @setfilename. Romain Francoise <romain@orebokech.com> parents: 86401 diff changeset	9 * nXML Mode: (nxml-mode). XML editing mode with RELAX NG support.
86378 5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	10 @end direntry
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	11
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	12 @node Top
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	13 @top nXML Mode
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	14
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	15 This manual documents nxml-mode, an Emacs major mode for editing
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	16 XML with RELAX NG support. This manual is not yet complete.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	17
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	18 @menu
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	19 * Completion::
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	20 * Inserting end-tags::
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	21 * Paragraphs::
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	22 * Outlining::
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	23 * Locating a schema::
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	24 * DTDs::
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	25 * Limitations::
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	26 @end menu
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	27
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	28 @node Completion
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	29 @chapter Completion
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	30
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	31 Apart from real-time validation, the most important feature that
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	32 nxml-mode provides for assisting in document creation is "completion".
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	33 Completion assists the user in inserting characters at point, based on
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	34 knowledge of the schema and on the contents of the buffer before
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	35 point.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	36
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	37 The traditional GNU Emacs key combination for completion in a
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	38 buffer is @kbd{M-@key{TAB}}. However, many window systems
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	39 and window managers use this key combination themselves (typically for
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	40 switching between windows) and do not pass it to applications. It's
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	41 hard to find key combinations in GNU Emacs that are both easy to type
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	42 and not taken by something else. @kbd{C-@key{RET}} (i.e.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	43 pressing the Enter or Return key, while the Ctrl key is held down) is
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	44 available. It won't be available on a traditional terminal (because
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	45 it is indistinguishable from Return), but it will work with a window
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	46 system. Therefore we adopt the following solution by default: use
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	47 @kbd{C-@key{RET}} when there's a window system and
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	48 @kbd{M-@key{TAB}} when there's not. In the following, I
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	49 will assume that a window system is being used and will therefore
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	50 refer to @kbd{C-@key{RET}}.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	51
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	52 Completion works by examining the symbol preceding point. This
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	53 is the symbol to be completed. The symbol to be completed may be the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	54 empty. Completion considers what symbols starting with the symbol to
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	55 be completed would be valid replacements for the symbol to be
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	56 completed, given the schema and the contents of the buffer before
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	57 point. These symbols are the possible completions. An example may
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	58 make this clearer. Suppose the buffer looks like this (where @point{}
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	59 indicates point):
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	60
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	61 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	62 <html xmlns="http://www.w3.org/1999/xhtml">
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	63 <h@point{}
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	64 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	65
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	66 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	67 and the schema is XHTML. In this context, the symbol to be completed
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	68 is @samp{h}. The possible completions consist of just
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	69 @samp{head}. Another example, is
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	70
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	71 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	72 <html xmlns="http://www.w3.org/1999/xhtml">
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	73 <head>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	74 <@point{}
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	75 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	76
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	77 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	78 In this case, the symbol to be completed is empty, and the possible
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	79 completions are @samp{base}, @samp{isindex},
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	80 @samp{link}, @samp{meta}, @samp{script},
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	81 @samp{style}, @samp{title}. Another example is:
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	82
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	83 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	84 <html xmlns="@point{}
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	85 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	86
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	87 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	88 In this case, the symbol to be completed is empty, and the possible
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	89 completions are just @samp{http://www.w3.org/1999/xhtml}.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	90
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	91 When you type @kbd{C-@key{RET}}, what happens depends
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	92 on what the set of possible completions are.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	93
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	94 @itemize @bullet
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	95 @item
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	96 If the set of completions is empty, nothing
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	97 happens.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	98 @item
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	99 If there is one possible completion, then that completion is
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	100 inserted, together with any following characters that are
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	101 required. For example, in this case:
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	102
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	103 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	104 <html xmlns="http://www.w3.org/1999/xhtml">
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	105 <@point{}
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	106 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	107
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	108 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	109 @kbd{C-@key{RET}} will yield
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	110
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	111 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	112 <html xmlns="http://www.w3.org/1999/xhtml">
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	113 <head@point{}
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	114 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	115 @item
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	116 If there is more than one possible completion, but all
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	117 possible completions share a common non-empty prefix, then that prefix
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	118 is inserted. For example, suppose the buffer is:
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	119
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	120 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	121 <html x@point{}
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	122 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	123
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	124 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	125 The symbol to be completed is @samp{x}. The possible completions
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	126 are @samp{xmlns} and @samp{xml:lang}. These share a
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	127 common prefix of @samp{xml}. Thus, @kbd{C-@key{RET}}
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	128 will yield:
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	129
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	130 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	131 <html xml@point{}
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	132 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	133
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	134 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	135 Typically, you would do @kbd{C-@key{RET}} again, which would
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	136 have the result described in the next item.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	137 @item
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	138 If there is more than one possible completion, but the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	139 possible completions do not share a non-empty prefix, then Emacs will
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	140 prompt you to input the symbol in the minibuffer, initializing the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	141 minibuffer with the symbol to be completed, and popping up a buffer
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	142 showing the possible completions. You can now input the symbol to be
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	143 inserted. The symbol you input will be inserted in the buffer instead
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	144 of the symbol to be completed. Emacs will then insert any required
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	145 characters after the symbol. For example, if it contains:
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	146
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	147 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	148 <html xml@point{}
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	149 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	150
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	151 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	152 Emacs will prompt you in the minibuffer with
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	153
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	154 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	155 Attribute: xml@point{}
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	156 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	157
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	158 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	159 and the buffer showing possible completions will contain
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	160
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	161 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	162 Possible completions are:
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	163 xml:lang xmlns
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	164 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	165
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	166 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	167 If you input @kbd{xmlns}, the result will be:
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	168
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	169 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	170 <html xmlns="@point{}
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	171 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	172
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	173 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	174 (If you do @kbd{C-@key{RET}} again, the namespace URI will
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	175 be inserted. Should that happen automatically?)
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	176 @end itemize
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	177
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	178 @node Inserting end-tags
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	179 @chapter Inserting end-tags
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	180
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	181 The main redundancy in XML syntax is end-tags. nxml-mode provides
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	182 several ways to make it easier to enter end-tags. You can use all of
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	183 these without a schema.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	184
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	185 You can use @kbd{C-@key{RET}} after @samp{</}
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	186 to complete the rest of the end-tag.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	187
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	188 @kbd{C-c C-f} inserts an end-tag for the element containing
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	189 point. This command is useful when you want to input the start-tag,
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	190 then input the content and finally input the end-tag. The @samp{f}
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	191 is mnemonic for finish.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	192
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	193 If you want to keep tags balanced and input the end-tag at the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	194 same time as the start-tag, before inputting the content, then you can
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	195 use @kbd{C-c C-i}. This inserts a @samp{>}, then inserts
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	196 the end-tag and leaves point before the end-tag. @kbd{C-c C-b}
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	197 is similar but more convenient for block-level elements: it puts the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	198 start-tag, point and the end-tag on successive lines, appropriately
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	199 indented. The @samp{i} is mnemonic for inline and the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	200 @samp{b} is mnemonic for block.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	201
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	202 Finally, you can customize nxml-mode so that @kbd{/}
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	203 automatically inserts the rest of the end-tag when it occurs after
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	204 @samp{<}, by doing
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	205
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	206 @display
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	207 @kbd{M-x customize-variable @key{RET} nxml-slash-auto-complete-flag @key{RET}}
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	208 @end display
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	209
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	210 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	211 and then following the instructions in the displayed buffer.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	212
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	213 @node Paragraphs
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	214 @chapter Paragraphs
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	215
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	216 Emacs has several commands that operate on paragraphs, most
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	217 notably @kbd{M-q}. nXML mode redefines these to work in a way
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	218 that is useful for XML. The exact rules that are used to find the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	219 beginning and end of a paragraph are complicated; they are designed
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	220 mainly to ensure that @kbd{M-q} does the right thing.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	221
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	222 A paragraph consists of one or more complete, consecutive lines.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	223 A group of lines is not considered a paragraph unless it contains some
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	224 non-whitespace characters between tags or inside comments. A blank
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	225 line separates paragraphs. A single tag on a line by itself also
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	226 separates paragraphs. More precisely, if one tag together with any
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	227 leading and trailing whitespace completely occupy one or more lines,
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	228 then those lines will not be included in any paragraph.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	229
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	230 A start-tag at the beginning of the line (possibly indented) may
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	231 be treated as starting a paragraph. Similarly, an end-tag at the end
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	232 of the line may be treated as ending a paragraph. The following rules
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	233 are used to determine whether such a tag is in fact treated as a
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	234 paragraph boundary:
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	235
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	236 @itemize @bullet
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	237 @item
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	238 If the schema does not allow text at that point, then it
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	239 is a paragraph boundary.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	240 @item
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	241 If the end-tag corresponding to the start-tag is not at
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	242 the end of its line, or the start-tag corresponding to the end-tag is
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	243 not at the beginning of its line, then it is not a paragraph
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	244 boundary. For example, in
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	245
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	246 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	247 <p>This is a paragraph with an
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	248 <emph>emphasized</emph> phrase.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	249 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	250
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	251 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	252 the @samp{<emph>} start-tag would not be considered as
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	253 starting a paragraph, because its corresponding end-tag is not at the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	254 end of the line.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	255 @item
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	256 If there is text that is a sibling in element tree, then
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	257 it is not a paragraph boundary. For example, in
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	258
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	259 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	260 <p>This is a paragraph with an
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	261 <emph>emphasized phrase that takes one source line</emph>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	262 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	263
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	264 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	265 the @samp{<emph>} start-tag would not be considered as
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	266 starting a paragraph, even though its end-tag is at the end of its
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	267 line, because there the text @samp{This is a paragraph with an}
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	268 is a sibling of the @samp{emph} element.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	269 @item
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	270 Otherwise, it is a paragraph boundary.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	271 @end itemize
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	272
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	273 @node Outlining
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	274 @chapter Outlining
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	275
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	276 nXML mode allows you to display all or part of a buffer as an
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	277 outline, in a similar way to Emacs' outline mode. An outline in nXML
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	278 mode is based on recognizing two kinds of element: sections and
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	279 headings. There is one heading for every section and one section for
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	280 every heading. A section contains its heading as or within its first
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	281 child element. A section also contains its subordinate sections (its
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	282 subsections). The text content of a section consists of anything in a
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	283 section that is neither a subsection nor a heading.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	284
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	285 Note that this is a different model from that used by XHTML.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	286 nXML mode's outline support will not be useful for XHTML unless you
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	287 adopt a convention of adding a @code{div} to enclose each
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	288 section, rather than having sections implicitly delimited by different
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	289 @code{h@var{n}} elements. This limitation may be removed
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	290 in a future version.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	291
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	292 The variable @code{nxml-section-element-name-regexp} gives
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	293 a regexp for the local names (i.e. the part of the name following any
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	294 prefix) of section elements. The variable
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	295 @code{nxml-heading-element-name-regexp} gives a regexp for the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	296 local names of heading elements. For an element to be recognized
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	297 as a section
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	298
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	299 @itemize @bullet
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	300 @item
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	301 its start-tag must occur at the beginning of a line
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	302 (possibly indented);
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	303 @item
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	304 its local name must match
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	305 @code{nxml-section-element-name-regexp};
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	306 @item
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	307 either its first child element or a descendant of that
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	308 first child element must have a local name that matches
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	309 @code{nxml-heading-element-name-regexp}; the first such element
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	310 is treated as the section's heading.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	311 @end itemize
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	312
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	313 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	314 You can customize these variables using @kbd{M-x
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	315 customize-variable}.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	316
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	317 There are three possible outline states for a section:
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	318
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	319 @itemize @bullet
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	320 @item
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	321 normal, showing everything, including its heading, text
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	322 content and subsections; each subsection is displayed according to the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	323 state of that subsection;
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	324 @item
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	325 showing just its heading, with both its text content and
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	326 its subsections hidden; all subsections are hidden regardless of their
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	327 state;
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	328 @item
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	329 showing its heading and its subsections, with its text
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	330 content hidden; each subsection is displayed according to the state of
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	331 that subsection.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	332 @end itemize
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	333
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	334 In the last two states, where the text content is hidden, the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	335 heading is displayed specially, in an abbreviated form. An element
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	336 like this:
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	337
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	338 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	339 <section>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	340 <title>Food</title>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	341 <para>There are many kinds of food.</para>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	342 </section>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	343 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	344
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	345 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	346 would be displayed on a single line like this:
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	347
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	348 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	349 <-section>Food...</>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	350 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	351
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	352 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	353 If there are hidden subsections, then a @code{+} will be used
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	354 instead of a @code{-} like this:
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	355
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	356 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	357 <+section>Food...</>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	358 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	359
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	360 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	361 If there are non-hidden subsections, then the section will instead be
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	362 displayed like this:
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	363
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	364 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	365 <-section>Food...
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	366 <-section>Delicious Food...</>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	367 <-section>Distasteful Food...</>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	368 </-section>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	369 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	370
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	371 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	372 The heading is always displayed with an indent that corresponds to its
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	373 depth in the outline, even it is not actually indented in the buffer.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	374 The variable @code{nxml-outline-child-indent} controls how much
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	375 a subheading is indented with respect to its parent heading when the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	376 heading is being displayed specially.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	377
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	378 Commands to change the outline state of sections are bound to
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	379 key sequences that start with @kbd{C-c C-o} (@kbd{o} is
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	380 mnemonic for outline). The third and final key has been chosen to be
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	381 consistent with outline mode. In the following descriptions
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	382 current section means the section containing point, or, more precisely,
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	383 the innermost section containing the character immediately following
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	384 point.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	385
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	386 @itemize @bullet
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	387 @item
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	388 @kbd{C-c C-o C-a} shows all sections in the buffer
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	389 normally.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	390 @item
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	391 @kbd{C-c C-o C-t} hides the text content
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	392 of all sections in the buffer.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	393 @item
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	394 @kbd{C-c C-o C-c} hides the text content
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	395 of the current section.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	396 @item
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	397 @kbd{C-c C-o C-e} shows the text content
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	398 of the current section.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	399 @item
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	400 @kbd{C-c C-o C-d} hides the text content
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	401 and subsections of the current section.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	402 @item
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	403 @kbd{C-c C-o C-s} shows the current section
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	404 and all its direct and indirect subsections normally.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	405 @item
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	406 @kbd{C-c C-o C-k} shows the headings of the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	407 direct and indirect subsections of the current section.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	408 @item
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	409 @kbd{C-c C-o C-l} hides the text content of the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	410 current section and of its direct and indirect
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	411 subsections.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	412 @item
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	413 @kbd{C-c C-o C-i} shows the headings of the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	414 direct subsections of the current section.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	415 @item
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	416 @kbd{C-c C-o C-o} hides as much as possible without
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	417 hiding the current section's text content; the headings of ancestor
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	418 sections of the current section and their child section sections will
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	419 not be hidden.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	420 @end itemize
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	421
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	422 When a heading is displayed specially, you can use
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	423 @key{RET} in that heading to show the text content of the section
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	424 in the same way as @kbd{C-c C-o C-e}.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	425
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	426 You can also use the mouse to change the outline state:
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	427 @kbd{S-mouse-2} hides the text content of a section in the same
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	428 way as@kbd{C-c C-o C-c}; @kbd{mouse-2} on a specially
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	429 displayed heading shows the text content of the section in the same
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	430 way as @kbd{C-c C-o C-e}; @kbd{mouse-1} on a specially
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	431 displayed start-tag toggles the display of subheadings on and
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	432 off.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	433
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	434 The outline state for each section is stored with the first
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	435 character of the section (as a text property). Every command that
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	436 changes the outline state of any section updates the display of the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	437 buffer so that each section is displayed correctly according to its
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	438 outline state. If the section structure is subsequently changed, then
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	439 it is possible for the display to no longer correctly reflect the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	440 stored outline state. @kbd{C-c C-o C-r} can be used to refresh
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	441 the display so it is correct again.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	442
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	443 @node Locating a schema
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	444 @chapter Locating a schema
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	445
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	446 nXML mode has a configurable set of rules to locate a schema for
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	447 the file being edited. The rules are contained in one or more schema
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	448 locating files, which are XML documents.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	449
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	450 The variable @samp{rng-schema-locating-files} specifies
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	451 the list of the file-names of schema locating files that nXML mode
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	452 should use. The order of the list is significant: when file
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	453 @var{x} occurs in the list before file @var{y} then rules
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	454 from file @var{x} have precedence over rules from file
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	455 @var{y}. A filename specified in
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	456 @samp{rng-schema-locating-files} may be relative. If so, it will
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	457 be resolved relative to the document for which a schema is being
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	458 located. It is not an error if relative file-names in
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	459 @samp{rng-schema-locating-files} do not not exist. You can use
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	460 @kbd{M-x customize-variable @key{RET} rng-schema-locating-files
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	461 @key{RET}} to customize the list of schema locating
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	462 files.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	463
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	464 By default, @samp{rng-schema-locating-files} list has two
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	465 members: @samp{schemas.xml}, and
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	466 @samp{@var{dist-dir}/schema/schemas.xml} where
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	467 @samp{@var{dist-dir}} is the directory containing the nXML
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	468 distribution. The first member will cause nXML mode to use a file
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	469 @samp{schemas.xml} in the same directory as the document being
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	470 edited if such a file exist. The second member contains rules for the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	471 schemas that are included with the nXML distribution.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	472
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	473 @menu
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	474 * Commands for locating a schema::
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	475 * Schema locating files::
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	476 @end menu
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	477
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	478 @node Commands for locating a schema
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	479 @section Commands for locating a schema
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	480
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	481 The command @kbd{C-c C-s C-w} will tell you what schema
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	482 is currently being used.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	483
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	484 The rules for locating a schema are applied automatically when
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	485 you visit a file in nXML mode. However, if you have just created a new
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	486 file and the schema cannot be inferred from the file-name, then this
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	487 will not locate the right schema. In this case, you should insert the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	488 start-tag of the root element and then use the command @kbd{C-c
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	489 C-a}, which reapplies the rules based on the current content of
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	490 the document. It is usually not necessary to insert the complete
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	491 start-tag; often just @samp{<@var{name}} is
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	492 enough.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	493
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	494 If you want to use a schema that has not yet been added to the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	495 schema locating files, you can use the command @kbd{C-c C-s C-f}
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	496 to manually select the file contaiing the schema for the document in
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	497 current buffer. Emacs will read the file-name of the schema from the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	498 minibuffer. After reading the file-name, Emacs will ask whether you
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	499 wish to add a rule to a schema locating file that persistently
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	500 associates the document with the selected schema. The rule will be
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	501 added to the first file in the list specified
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	502 @samp{rng-schema-locating-files}; it will create the file if
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	503 necessary, but will not create a directory. If the variable
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	504 @samp{rng-schema-locating-files} has not been customized, this
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	505 means that the rule will be added to the file @samp{schemas.xml}
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	506 in the same directory as the document being edited.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	507
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	508 The command @kbd{C-c C-s C-t} allows you to select a schema by
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	509 specifying an identifier for the type of the document. The schema
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	510 locating files determine the available type identifiers and what
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	511 schema is used for each type identifier. This is useful when it is
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	512 impossible to infer the right schema from either the file-name or the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	513 content of the document, even though the schema is already in the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	514 schema locating file. A situation in which this can occur is when
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	515 there are multiple variants of a schema where all valid documents have
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	516 the same document element. For example, XHTML has Strict and
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	517 Transitional variants. In a situation like this, a schema locating file
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	518 can define a type identifier for each variant. As with @kbd{C-c
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	519 C-s C-f}, Emacs will ask whether you wish to add a rule to a schema
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	520 locating file that persistently associates the document with the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	521 specified type identifier.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	522
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	523 The command @kbd{C-c C-s C-l} adds a rule to a schema
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	524 locating file that persistently associates the document with
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	525 the schema that is currently being used.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	526
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	527 @node Schema locating files
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	528 @section Schema locating files
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	529
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	530 Each schema locating file specifies a list of rules. The rules
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	531 from each file are appended in order. To locate a schema each rule is
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	532 applied in turn until a rule matches. The first matching rule is then
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	533 used to determine the schema.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	534
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	535 Schema locating files are designed to be useful for other
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	536 applications that need to locate a schema for a document. In fact,
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	537 there is nothing specific to locating schemas in the design; it could
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	538 equally well be used for locating a stylesheet.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	539
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	540 @menu
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	541 * Schema locating file syntax basics::
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	542 * Using the document's URI to locate a schema::
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	543 * Using the document element to locate a schema::
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	544 * Using type identifiers in schema locating files::
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	545 * Using multiple schema locating files::
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	546 @end menu
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	547
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	548 @node Schema locating file syntax basics
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	549 @subsection Schema locating file syntax basics
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	550
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	551 There is a schema for schema locating files in the file
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	552 @samp{locate.rnc} in the schema directory. Schema locating
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	553 files must be valid with respect to this schema.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	554
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	555 The document element of a schema locating file must be
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	556 @samp{locatingRules} and the namespace URI must be
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	557 @samp{http://thaiopensource.com/ns/locating-rules/1.0}. The
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	558 children of the document element specify rules. The order of the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	559 children is the same as the order of the rules. Here's a complete
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	560 example of a schema locating file:
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	561
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	562 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	563 <?xml version="1.0"?>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	564 <locatingRules xmlns="http://thaiopensource.com/ns/locating-rules/1.0">
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	565 <namespace ns="http://www.w3.org/1999/xhtml" uri="xhtml.rnc"/>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	566 <documentElement localName="book" uri="docbook.rnc"/>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	567 </locatingRules>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	568 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	569
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	570 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	571 This says to use the schema @samp{xhtml.rnc} for a document with
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	572 namespace @samp{http://www.w3.org/1999/xhtml}, and to use the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	573 schema @samp{docbook.rnc} for a document whose local name is
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	574 @samp{book}. If the document element had both a namespace URI
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	575 of @samp{http://www.w3.org/1999/xhtml} and a local name of
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	576 @samp{book}, then the matching rule that comes first will be
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	577 used and so the schema @samp{xhtml.rnc} would be used. There is
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	578 no precedence between different types of rule; the first matching rule
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	579 of any type is used.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	580
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	581 As usual with XML-related technologies, resources are identified
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	582 by URIs. The @samp{uri} attribute identifies the schema by
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	583 specifying the URI. The URI may be relative. If so, it is resolved
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	584 relative to the URI of the schema locating file that contains
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	585 attribute. This means that if the value of @samp{uri} attribute
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	586 does not contain a @samp{/}, then it will refer to a filename in
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	587 the same directory as the schema locating file.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	588
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	589 @node Using the document's URI to locate a schema
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	590 @subsection Using the document's URI to locate a schema
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	591
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	592 A @samp{uri} rule locates a schema based on the URI of the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	593 document. The @samp{uri} attribute specifies the URI of the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	594 schema. The @samp{resource} attribute can be used to specify
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	595 the schema for a particular document. For example,
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	596
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	597 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	598 <uri resource="spec.xml" uri="docbook.rnc"/>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	599 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	600
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	601 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	602 specifies that that the schema for @samp{spec.xml} is
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	603 @samp{docbook.rnc}.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	604
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	605 The @samp{pattern} attribute can be used instead of the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	606 @samp{resource} attribute to specify the schema for any document
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	607 whose URI matches a pattern. The pattern has the same syntax as an
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	608 absolute or relative URI except that the path component of the URI can
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	609 use a @samp{*} character to stand for zero or more characters
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	610 within a path segment (i.e. any character other @samp{/}).
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	611 Typically, the URI pattern looks like a relative URI, but, whereas a
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	612 relative URI in the @samp{resource} attribute is resolved into a
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	613 particular absolute URI using the base URI of the schema locating
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	614 file, a relative URI pattern matches if it matches some number of
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	615 complete path segments of the document's URI ending with the last path
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	616 segment of the document's URI. For example,
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	617
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	618 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	619 <uri pattern="*.xsl" uri="xslt.rnc"/>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	620 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	621
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	622 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	623 specifies that the schema for documents with a URI whose path ends
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	624 with @samp{.xsl} is @samp{xslt.rnc}.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	625
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	626 A @samp{transformURI} rule locates a schema by
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	627 transforming the URI of the document. The @samp{fromPattern}
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	628 attribute specifies a URI pattern with the same meaning as the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	629 @samp{pattern} attribute of the @samp{uri} element. The
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	630 @samp{toPattern} attribute is a URI pattern that is used to
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	631 generate the URI of the schema. Each @samp{*} in the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	632 @samp{toPattern} is replaced by the string that matched the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	633 corresponding @samp{*} in the @samp{fromPattern}. The
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	634 resulting string is appended to the initial part of the document's URI
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	635 that was not explicitly matched by the @samp{fromPattern}. The
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	636 rule matches only if the transformed URI identifies an existing
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	637 resource. For example, the rule
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	638
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	639 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	640 <transformURI fromPattern=".xml" toPattern=".rnc"/>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	641 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	642
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	643 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	644 would transform the URI @samp{file:///home/jjc/docs/spec.xml}
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	645 into the URI @samp{file:///home/jjc/docs/spec.rnc}. Thus, this
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	646 rule specifies that to locate a schema for a document
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	647 @samp{@var{foo}.xml}, Emacs should test whether a file
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	648 @samp{@var{foo}.rnc} exists in the same directory as
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	649 @samp{@var{foo}.xml}, and, if so, should use it as the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	650 schema.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	651
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	652 @node Using the document element to locate a schema
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	653 @subsection Using the document element to locate a schema
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	654
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	655 A @samp{documentElement} rule locates a schema based on
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	656 the local name and prefix of the document element. For example, a rule
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	657
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	658 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	659 <documentElement prefix="xsl" localName="stylesheet" uri="xslt.rnc"/>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	660 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	661
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	662 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	663 specifies that when the name of the document element is
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	664 @samp{xsl:stylesheet}, then @samp{xslt.rnc} should be used
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	665 as the schema. Either the @samp{prefix} or
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	666 @samp{localName} attribute may be omitted to allow any prefix or
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	667 local name.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	668
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	669 A @samp{namespace} rule locates a schema based on the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	670 namespace URI of the document element. For example, a rule
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	671
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	672 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	673 <namespace ns="http://www.w3.org/1999/XSL/Transform" uri="xslt.rnc"/>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	674 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	675
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	676 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	677 specifies that when the namespace URI of the document is
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	678 @samp{http://www.w3.org/1999/XSL/Transform}, then
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	679 @samp{xslt.rnc} should be used as the schema.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	680
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	681 @node Using type identifiers in schema locating files
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	682 @subsection Using type identifiers in schema locating files
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	683
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	684 Type identifiers allow a level of indirection in locating the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	685 schema for a document. Instead of associating the document directly
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	686 with a schema URI, the document is associated with a type identifier,
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	687 which is in turn associated with a schema URI. nXML mode does not
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	688 constrain the format of type identifiers. They can be simply strings
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	689 without any formal structure or they can be public identifiers or
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	690 URIs. Note that these type identifiers have nothing to do with the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	691 DOCTYPE declaration. When comparing type identifiers, whitespace is
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	692 normalized in the same way as with the @samp{xsd:token}
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	693 datatype: leading and trailing whitespace is stripped; other sequences
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	694 of whitespace are normalized to a single space character.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	695
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	696 Each of the rules described in previous sections that uses a
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	697 @samp{uri} attribute to specify a schema, can instead use a
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	698 @samp{typeId} attribute to specify a type identifier. The type
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	699 identifier can be associated with a URI using a @samp{typeId}
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	700 element. For example,
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	701
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	702 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	703 <locatingRules xmlns="http://thaiopensource.com/ns/locating-rules/1.0">
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	704 <namespace ns="http://www.w3.org/1999/xhtml" typeId="XHTML"/>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	705 <typeId id="XHTML" typeId="XHTML Strict"/>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	706 <typeId id="XHTML Strict" uri="xhtml-strict.rnc"/>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	707 <typeId id="XHTML Transitional" uri="xhtml-transitional.rnc"/>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	708 </locatingRules>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	709 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	710
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	711 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	712 declares three type identifiers @samp{XHTML} (representing the
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	713 default variant of XHTML to be used), @samp{XHTML Strict} and
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	714 @samp{XHTML Transitional}. Such a schema locating file would
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	715 use @samp{xhtml-strict.rnc} for a document whose namespace is
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	716 @samp{http://www.w3.org/1999/xhtml}. But it is considerably
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	717 more flexible than a schema locating file that simply specified
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	718
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	719 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	720 <namespace ns="http://www.w3.org/1999/xhtml" uri="xhtml-strict.rnc"/>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	721 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	722
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	723 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	724 A user can easily use @kbd{C-c C-s C-t} to select between XHTML
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	725 Strict and XHTML Transitional. Also, a user can easily add a catalog
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	726
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	727 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	728 <locatingRules xmlns="http://thaiopensource.com/ns/locating-rules/1.0">
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	729 <typeId id="XHTML" typeId="XHTML Transitional"/>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	730 </locatingRules>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	731 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	732
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	733 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	734 that makes the default variant of XHTML be XHTML Transitional.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	735
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	736 @node Using multiple schema locating files
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	737 @subsection Using multiple schema locating files
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	738
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	739 The @samp{include} element includes rules from another
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	740 schema locating file. The behavior is exactly as if the rules from
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	741 that file were included in place of the @samp{include} element.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	742 Relative URIs are resolved into absolute URIs before the inclusion is
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	743 performed. For example,
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	744
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	745 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	746 <include rules="../rules.xml"/>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	747 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	748
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	749 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	750 includes the rules from @samp{rules.xml}.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	751
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	752 The process of locating a schema takes as input a list of schema
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	753 locating files. The rules in all these files and in the files they
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	754 include are resolved into a single list of rules, which are applied
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	755 strictly in order. Sometimes this order is not what is needed.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	756 For example, suppose you have two schema locating files, a private
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	757 file
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	758
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	759 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	760 <locatingRules xmlns="http://thaiopensource.com/ns/locating-rules/1.0">
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	761 <namespace ns="http://www.w3.org/1999/xhtml" uri="xhtml.rnc"/>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	762 </locatingRules>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	763 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	764
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	765 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	766 followed by a public file
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	767
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	768 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	769 <locatingRules xmlns="http://thaiopensource.com/ns/locating-rules/1.0">
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	770 <transformURI pathSuffix=".xml" replacePathSuffix=".rnc"/>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	771 <namespace ns="http://www.w3.org/1999/XSL/Transform" typeId="XSLT"/>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	772 </locatingRules>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	773 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	774
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	775 @noindent
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	776 The effect of these two files is that the XHTML @samp{namespace}
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	777 rule takes precedence over the @samp{transformURI} rule, which
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	778 is almost certainly not what is needed. This can be solved by adding
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	779 an @samp{applyFollowingRules} to the private file.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	780
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	781 @example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	782 <locatingRules xmlns="http://thaiopensource.com/ns/locating-rules/1.0">
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	783 <applyFollowingRules ruleType="transformURI"/>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	784 <namespace ns="http://www.w3.org/1999/xhtml" uri="xhtml.rnc"/>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	785 </locatingRules>
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	786 @end example
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	787
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	788 @node DTDs
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	789 @chapter DTDs
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	790
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	791 nxml-mode is designed to support the creation of standalone XML
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	792 documents that do not depend on a DTD. Although it is common practice
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	793 to insert a DOCTYPE declaration referencing an external DTD, this has
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	794 undesirable side-effects. It means that the document is no longer
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	795 self-contained. It also means that different XML parsers may interpret
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	796 the document in different ways, since the XML Recommendation does not
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	797 require XML parsers to read the DTD. With DTDs, it was impractical to
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	798 get validation without using an external DTD or reference to an
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	799 parameter entity. With RELAX NG and other schema languages, you can
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	800 simulataneously get the benefits of validation and standalone XML
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	801 documents. Therefore, I recommend that you do not reference an
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	802 external DOCTYPE in your XML documents.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	803
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	804 One problem is entities for characters. Typically, as well as
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	805 providing validation, DTDs also provide a set of character entities
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	806 for documents to use. Schemas cannot provide this functionality,
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	807 because schema validation happens after XML parsing. The recommended
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	808 solution is to either use the Unicode characters directly, or, if this
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	809 is impractical, use character references. nXML mode supports this by
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	810 providing commands for entering characters and character references
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	811 using the Unicode names, and can display the glyph corresponding to a
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	812 character reference.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	813
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	814 @node Limitations
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	815 @chapter Limitations
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	816
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	817 nXML mode has some limitations:
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	818
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	819 @itemize @bullet
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	820 @item
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	821 DTD support is limited. Internal parsed general entities declared
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	822 in the internal subset are supported provided they do not contain
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	823 elements. Other usage of DTDs is ignored.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	824 @item
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	825 The restrictions on RELAX NG schemas in section 7 of the RELAX NG
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	826 specification are not enforced.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	827 @item
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	828 Unicode support has problems. This stems mostly from the fact that
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	829 the XML (and RELAX NG) character model is based squarely on Unicode,
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	830 whereas the Emacs character model is not. Emacs 22 is slated to have
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	831 full Unicode support, which should improve the situation here.
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	832 @end itemize
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	833
5d15069189ff Fixups for nxml per Romain Francoise email. Mark A. Hershberger <mah@everybody.org> parents: diff changeset	834 @bye
86379 2ac1a9b70580 Add arch tagline Miles Bader <miles@gnu.org> parents: 86378 diff changeset	835
2ac1a9b70580 Add arch tagline Miles Bader <miles@gnu.org> parents: 86378 diff changeset	836 @ignore
2ac1a9b70580 Add arch tagline Miles Bader <miles@gnu.org> parents: 86378 diff changeset	837 arch-tag: 3b6e8ac2-ae8d-4f38-bd43-ce9f80be04d6
2ac1a9b70580 Add arch tagline Miles Bader <miles@gnu.org> parents: 86378 diff changeset	838 @end ignore

Mercurial > emacs

annotate doc/misc/nxml-mode.texi @ 86809:8ac1aa3f0181