psgml/psgml-1.3.2/psgml.texi

224 (autoload 'sgml-mode "psgml" "Major mode to edit SGML files." t)
252 @findex sgml-mode
253 PSGML defines major modes called @code{sgml-mode} and @code{xml-mode}.
254 Files with extensions @file{.sgml}, @file{.sgm} or @file{.dtd} will
256 mode, type @kbd{M-x sgml-mode @key{RET}} after finding the file.
262 automatically set sgml mode and user options when the file is loaded.
268 mode: sgml
273 You can also put a line at the top of the file to tell emacs to use sgml
277 <!-- -*- sgml -*- -->
280 For XML replace @samp{sgml} with @samp{xml} in the above examples.
294 @c *** sgml-sysid-resolve-functions
320 variable @code{sgml-public-map}.
346 (@code{sgml-validate-command}).
355 @vindex sgml-system-identifiers-are-preferred
358 identifier and the variable @code{sgml-system-identifiers-are-preferred}
360 @code{sgml-public-map}.  If the system identifier is a relative file name
364 Look thru each catalog in @code{sgml-local-catalogs} and
365 @code{sgml-catalog-files} in order.  For each catalog look first for
375 If @code{sgml-system-identifiers-are-preferred} is @code{nil}
376 and there is no elements containing @samp{%s} in @code{sgml-public-map}.
379 Try the entries in @code{sgml-public-map}.  Using the catalogs are
380 preferred.  The @code{sgml-public-map} may disappear in a future version
385 The @code{sgml-public-map} variable can contain a list of file name
391 @code{sgml-public-transliterations}.  The templates in the list is tried
392 in order until an existing file is found.  The @code{sgml-public-map} is
396 @code{sgml-public-map} is taken from the environment variable
400 @samp{@prefix@/share/sgml/%o/%c/%d}, the resulting file name is
403 @prefix@/share/sgml/ISO_8879:1986/entities/Added_Latin_1
407 @samp{%}) and the text class is down cased.
411 @defopt sgml-catalog-files
419 ("catalog" "@prefix@/share/sgml/catalog")
423 @defopt sgml-local-catalogs
425 buffer.  This is used in addition to @code{sgml-catalog-files}, and
426 @code{sgml-public-map}.  This variable is automatically local to the
430 @defopt sgml-system-identifiers-are-preferred
432 catalogs in @code{sgml-local-catalogs} and @code{sgml-catalog-files} and
440 @defopt sgml-public-map
447 ("%S" "@prefix@/share/sgml/%o/%c/%d")
460 @findex sgml-validate
464 command @kbd{C-c C-v} (@code{sgml-validate}).
468 @defopt sgml-validate-command
473 value of @code{sgml-declaration} (or the empty string, if nil); the
477 If @code{sgml-validate-files} is non-nil, the format string should contain
478 one @code{%s} conversion specification for each element of its result.
480 If sgml-validate-command is a list, then every element should be a
490 means the SGML declaration specified in the sgml-declaration variable
499 @defopt sgml-validate-files
502 @code{sgml-validate-command} format control string instead of
506 @defopt sgml-declaration
510 @defopt sgml-offer-save
511 If non-nil, @kbd{C-c C-v} (@code{sgml-validate}) will ask about
518 @findex sgml-next-trouble-spot
520 C-o} (@code{sgml-next-trouble-spot}) is the best way to use the built-in
548 (@code{sgml-validate}) command (@pxref{Validate}).
554 @defopt sgml-omittag
559 @defopt sgml-shorttag
564 @defopt sgml-namecase-general
571 @defopt sgml-always-quote-attributes
573 attributes.  If this variable is @code{nil} and @code{sgml-shorttag} is
578 @defopt sgml-minimize-attributes
583 @code{sgml-omittag} and @code{sgml-shorttag} are set correctly).
594 @vindex sgml-default-doctype-name
603 where @var{name} is the value of @code{sgml-default-doctype-name}, if
606 @findex sgml-parse-prolog
607 @vindex sgml-auto-activate-dtd
610 variable @code{sgml-auto-activate-dtd} is @code{t}.  You can also
612 @code{sgml-parse-prolog}.  Big DTDs take some time to parse.
614 When the DTD has been parsed or loaded the name of the document element
644 @vindex sgml-ecat-files
645 @vindex sgml-local-ecat-files
649 containing lists of catalogs to search: @code{sgml-ecat-files} and
650 @code{sgml-local-ecat-files}.  The ECAT files can contain the following
674 @defopt sgml-recompile-out-of-date-cdtd
688 @findex sgml-save-dtd
689 @findex sgml-load-dtd
690 @vindex sgml-default-dtd-file
692 sgml-save-dtd}.  Next time PSGML can load that file instead of parsing
694 using the default name or do a @kbd{M-x sgml-save-options} after saving
696 containing the saved DTD with the command @kbd{M-x sgml-load-dtd}.
698 @defopt sgml-default-dtd-file
700 @code{sgml-mode} to the buffer file name less extension plus the
707 @c @code{sgml-default-dtd-file} to that file.  If
708 @c @code{sgml-default-dtd-file} contains a relative file name, the
709 @c directories in @code{sgml-system-path} will be searched for the file.
718 @vindex sgml-doctype
720 @code{sgml-doctype} to the other file.
722 @defopt sgml-parent-document
725 The variable describes how the current file's content fit into the element
729 (@var{parent-file} @var{context-element}* @var{top-element} (@var{has-seen-element}*)?)
737 @item context-element
738 is a string, that is the name of an element type.
744 @item top-element
745 is a string that is the name of the element type
746 of the top level element in the current file.  The file
747 should contain one instance of this element, unless
748 the last (lisp) element of sgml-parent-document is a
750 should follow the content model of top-element.
752 @item has-seen-element
753 is a string that is the name of an element type.  This
754 element is satisfied in the content model of top-element.
765 @findex sgml-custom-dtd
770 If you change the doctype you must execute @code{sgml-parse-prolog},
773 @defopt sgml-custom-dtd
777 Every entry should be a list.  The first element of the entry is a string
778 used as the menu entry.  The second element is a string containing a
782 @code{sgml-default-dtd-file}.  All variables are made buffer local and
793      sgml-default-dtd-file "~/sgml/html.ced"
794      sgml-omittag nil sgml-shorttag nil)
796      "~/sgml/htmlplus.ced"
797      sgml-omittag t sgml-shorttag nil)
799      "~/sgml/docbook.ced"
800      sgml-omittag nil sgml-shorttag t)))
817 @findex sgml-describe-dtd
818 @item sgml-describe-dtd
821 @findex sgml-describe-element-type
822 @item sgml-describe-element-type
823 Describe the properties of an element type as declared in the current DTD.
826 @findex sgml-describe-entity
827 @item sgml-describe-entity
830 @findex sgml-list-elements
831 @item sgml-list-elements
832 Will list all elements and the attributes declared for the element.
834 @findex sgml-list-attributes
835 @item sgml-list-attributes
838 @findex sgml-list-terminals
839 @item sgml-list-terminals
842 @findex sgml-list-occur-in-elements
843 @item sgml-list-occur-in-elements
844 Will list all element types and where it can occur.
846 @findex sgml-list-content-elements
847 @item sgml-list-content-elements
848 Will list all element types and the element types that can occur
859 in the DTD. Generally this associates some information with element
860 types. E.g., if @code{sgml-fill-element} should skip the element type
871 Where @var{gi} is the element type, @var{prop} is a propery
890 type will be ignored when filling with @code{sgml-fill-element}.
901 @code{sgml-edit-attributes} (@kbd{C-c C-a}) command. Only the
910 Control if element is included in @code{sgml-show-structure} (@kbd{C-c
911 C-s}). If set to @code{t}, the element is included and if set to
916 @code{sgml-show-current-element-type} (@kbd{C-c C-t}).
931 * Move::                        Move in the element structure
950 @findex sgml-insert-tag
953 tags that are valid at point (@code{sgml-insert-tag}).
955 If @code{sgml-auto-insert-required-elements} is non-nil, tags for elements
963 The end-tag for the current element, if it can be ended at the position.
969 @code{sgml-omittag-transparent} is nil, the above will be limited to the
970 elements that can occur within the current element.
975 @findex sgml-insert-element
976 @vindex sgml-insert-end-tag-on-new-line
978 Insert start and end-tags for an element
979 (@code{sgml-insert-element}).  The name of the element is read
981 @code{sgml-insert-end-tag-on-new-line} is non-nil or the
982 element has element content, the end-tag will be inserted on a
985 @vindex sgml-omittag-transparent
986 If @code{sgml-omittag-transparent} is nil, the list of valid elements
988 element.
990 @vindex sgml-auto-insert-required-elements
991 @vindex sgml-insert-missing-element-comment
993 option @code{sgml-auto-insert-required-elements} is non-nil.
994 When the content model demands an element but there is more
997 @code{sgml-insert-missing-element-comment} is non-nil.
1000 @findex sgml-add-element-to-element
1002 Inserts a new element in the current element where it is legal. Prompts
1003 for element name with completion. The completion list contains all
1004 elements that could be added to the current element somewhere, without
1007 inclusions. The new element will be inserted as late as possible in the
1008 current element (unless prefix argument is given, then as early as
1012 @findex sgml-tag-region
1014 Makes the region into a new element (@code{sgml-tag-region}).  Reads
1015 element name from mini-buffer with completion as for @kbd{C-c C-e}.
1018 @findex sgml-insert-end-tag
1020 Inserts an end-tag for the current element (@code{sgml-insert-end-tag}).
1028 @findex sgml-split-element
1030 Split the current element at point.  If repeated, the containing element
1031 will be split before the beginning of then current element.
1033 Typical use is to start a new paragraph element when inside a paragraph.
1036 @findex sgml-insert-attribute
1039 specification (@code{sgml-insert-attribute}).  If point is immediately
1041 the command will operate on the element after point.
1056 @findex sgml-custom-markup
1060 selector. (See @var{sgml-custom-markup} below.)
1074 @item Insert element
1076 the selected element.  Selections from the menu works like the @kbd{C-c
1095 Pops up a menu of all elements valid somewhere in the current element.
1097 element somewhere, without making the content invalid. The new element
1098 will be inserted as late as possible in the current element.
1101 Pops up a menu with all the attributes of an element.  The element is
1103 element after point.  Selecting from this menu edits the attribute
1104 specification list for the element.
1134 Editor}) or set the option @code{sgml-tag-region-if-active} to non-nil
1138 Alternatively make a secondary selection, this is done by holding down
1145 @defopt sgml-balanced-tag-edit
1150 @defopt sgml-auto-insert-required-elements
1152 of an inserted element.
1155 @defopt sgml-omittag-transparent
1160 @defopt sgml-tag-region-if-active
1166 @defopt sgml-custom-markup
1184 @defopt sgml-insert-missing-element-comment
1185 If non-nil, and sgml-auto-insert-required-elements also true,
1186 @code{sgml-insert-element} will insert a comment if there is an
1187 element required but there is more than one to choose from.
1190 @defopt sgml-insert-end-tag-on-new-line
1191 If non-nil, @code{sgml-insert-element} will put the end-tag on
1203 @findex sgml-complete
1232 @findex sgml-show-context
1235 content and the open elements (@code{sgml-show-context}). The form of
1237 @code{sgml-show-context-function}.
1240 @findex sgml-what-element
1242 Shows what element the character after point (under the cursor) belongs
1243 to; also shows context of element (@code{sgml-what-element}).
1246 @findex sgml-show-current-element-type
1248 Show information about the current element type and the valid element
1252 @findex sgml-show-structure
1254 Show the major element structure in a separate buffer (@samp{*Document
1258 shows container elements and the text of the first child element (if
1262 elements: it should have element content and be non empty. You can
1266 To include an element type @var{el1} that would otherwise be excluded:
1268 <?PSGML element @var{el1} structure=t?>
1271 To exclude an element type @var{el2} that would otherwise be included:
1273 <?PSGML element @var{el2} structure=ignore?>
1278 @findex sgml-list-valid-tags
1279 List contextually valid tags (@code{sgml-list-valid-tags}).  Displays
1280 information about current element, all valid end-tags, valid start-tags
1281 in current element, and start-tags valid at this point but in other
1287 You can make the mode-line display the name of the current open element
1288 by setting the @code{sgml-live-element-indicator} variable.  Setting
1292 @defopt sgml-live-element-indicator
1293 If non-nil, indicate current element in mode line.
1300 @defopt sgml-show-context-function
1301 The value shold be a function that generates a string from an element
1303 functions for this. The function @code{sgml-show-context-standard},
1305 in book}. The function @code{sgml-show-context-backslash} generates a
1317 @findex sgml-indent-or-tab
1319 You can indent a line according to the depth of element nesting at the
1324 @defopt sgml-indent-step
1325 How much to increment indent for every element level.  If nil, no
1331 @defopt sgml-indent-data
1340 @section Move in the element structure
1342 These commands move in the element structure.  The commands uses
1347 @findex sgml-beginning-of-element
1349 Move to the (content) beginning of the current element
1350 (@code{sgml-beginning-of-element}).
1353 @findex sgml-end-of-element
1355 Move to the (content) end of the current element (@code{sgml-end-of-element}).
1358 @findex sgml-forward-element
1360 Move forward by element (@code{sgml-forward-element}).
1363 @findex sgml-backward-element
1365 Move backward by element (@code{sgml-backward-element}).
1368 @findex sgml-backward-up-element
1370 Move up to before current element (@code{sgml-backward-up-element}).
1373 @findex sgml-up-element
1375 Move up to after current element (@code{sgml-up-element}).
1378 @findex sgml-down-element
1380 Move down to the (content) beginning of the next element
1381 (@code{sgml-down-element}).
1384 @findex sgml-next-data-field
1386 Move to the next place where data is allowed (@code{sgml-next-data-field}).
1398 @findex sgml-edit-attributes
1402 the start-tag and use the @code{sgml-edit-attributes} command, available
1437 @findex sgml-edit-attrib-field-start
1440 (@code{sgml-edit-attrib-field-start}).
1443 @findex sgml-edit-attrib-field-end
1446 (@code{sgml-edit-attrib-field-end}).
1449 @findex sgml-edit-attrib-clear
1452 (@code{sgml-edit-attrib-clear}).
1455 @findex sgml-edit-attrib-default
1458 (@code{sgml-edit-attrib-default}).  This is a special value that will
1470 @findex sgml-change-element-name
1472 Change the name of the current element (@code{sgml-change-element-name}).
1474 translated to an attribute with the same name.  If the new element has
1483 @findex sgml-kill-markup
1486 (@code{sgml-kill-markup}).
1489 @findex sgml-kill-element
1491 Kill the element following the cursor (@code{sgml-kill-element}).
1494 @findex sgml-untag-element
1496 Remove tags from current element (@code{sgml-untag-element}).
1499 @findex sgml-make-character-reference
1502 (@code{sgml-make-character-reference}).  If called with a numeric
1506 @findex sgml-fill-element
1508 Fills an element as a paragraph (@code{sgml-fill-element}).  This is a
1514 If point is in an element content, recursively fill the sub-elements.
1516 Find the biggest element with mixed content containing point.
1518 If the above element is mixed but contains elements with pure element
1523 @findex sgml-expand-all-shortrefs
1524 @item M-x sgml-expand-all-shortrefs
1531 @findex sgml-normalize
1532 @item M-x sgml-normalize
1547 @code{sgml-expand-all-shortrefs}.
1555 @defopt sgml-normalize-trims
1556 If non-nil, @code{sgml-normalize} will trim off white space from end of
1557 element when adding end-tag.
1570 Set the variable @code{sgml-display-char-list-filename} to a file that
1580 @findex sgml-charent-to-display-char
1581 @item sgml-charent-to-display-char
1582 @findex sgml-display-char-to-charent
1583 @item sgml-display-char-to-charent
1615 @findex sgml-fold-region
1617 The region between point and mark will be folded (@code{sgml-fold-region}).
1620 @findex sgml-fold-element
1622 The region between the start and end of the current element will be
1623 folded (@code{sgml-fold-element}).
1629 @findex sgml-fold-subelement
1631 Fold all the sub elements of the current element
1632 (@code{sgml-fold-subelement}).
1636 @findex sgml-unfold-line
1640 region (@code{sgml-unfold-line}).
1643 @findex sgml-unfold-element
1645 Make all lines in current element visible (@code{sgml-unfold-element}).
1648 @findex sgml-unfold-all
1650 Make all lines in current buffer visible (@code{sgml-unfold-all}).
1653 @findex sgml-expand-element
1655 Unfold current element and then fold the subelements
1656 (@code{sgml-expand-element}).  If the current element is folded this
1677 The highlighting will only be done if the variable @code{sgml-set-face}
1680 @code{sgml-markup-faces}.  When highlighting is on PSGML will parse after
1684 @findex sgml-clear-faces
1685 To remove the highlighting type @kbd{M-x sgml-clear-faces}.
1687 @defopt sgml-set-face
1691 @defopt sgml-markup-faces
1693 Each element looks like @code{(@var{markup-type} . @var{face})}.
1711 @item sgml
1729 *** describe sgml-save-options
1731 @defopt sgml-ignore-undefined-elements
1733 @code{sgml-ignore-undefined-elements} is @code{t}, or assumed to be
1734 acceptable in the current element and defined with @code{O O ANY}
1737 @defopt sgml-range-indicator-max-length
1741 @vindex sgml-max-menu-size
1743 into @code{sgml-max-menu-size} big sub-menus.
1759 You can report a bug with the command @kbd{M-x sgml-submit-bug-report}.
1767 C-o} (@code{sgml-next-trouble-spot}).