Mercurial > hg > xemacs-beta

comparison lisp/psgml/README.psgml @ 2:ac2d302a0011 r19-15b2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import from CVS: tag r19-15b2
author cvs
date Mon, 13 Aug 2007 08:46:35 +0200
parents 376386a54a3c
children bcdc7deadc19
comparison
equal deleted inserted replaced
1:c0c6a60d29db 2:ac2d302a0011
1 This is the READ ME file for psgml.el version 1a9. -*- text -*- 1 This is the READ ME file for psgml.el version 1a12. -*- text -*-
2 2
3 PSGML is a major mode for editing SGML documents. It works with 3 PSGML is a major mode for editing SGML documents. It works with
4 GNU Emacs 19.19 and later or with Lucid Emacs 19.9. 4 GNU Emacs 19.19 and later or with XEmacs 19.13.
5 5
6 This distribution should contain the following source files: 6 This distribution should contain the following source files:
7 psgml.el 7 psgml.el
8 psgml.texi 8 psgml.texi
9 psgml-other.el 9 psgml-other.el
15 psgml-charent.el 15 psgml-charent.el
16 psgml-debug.el -- some functions used in development 16 psgml-debug.el -- some functions used in development
17 psgml-api.texi -- internals documentation 17 psgml-api.texi -- internals documentation
18 psgml-api.el -- Extra functions for the API 18 psgml-api.el -- Extra functions for the API
19 fs.el -- Example use of psgml to format a SGML file 19 fs.el -- Example use of psgml to format a SGML file
20 style.el -- example style file for fs.el 20 style.fs -- example style file for fs.el
21 catalog.sgml -- example SGML-file for fs.el and style.el 21 catalog.sgml -- example SGML-file for fs.el and style.el
22 iso88591.map 22 iso88591.map
23 Makefile.in
23 24
24 In addition the distribution contains the formatted versions of the 25 In addition the distribution contains the formatted versions of the
25 documentation files (psgml.info, ...). But the compiled elisp code is 26 documentation files (psgml.info, ...). But the compiled elisp code is
26 no longer supplied. You will have to byte compile the files before 27 no longer supplied. You will have to byte compile the files before
27 PSGML will achive usable speed. 28 PSGML will achieve usable speed.
28 29
29 If you are not using Lucid Emacs or XEmacs you should compile: 30 PSGML now comes with autoconf support. See INSTALL for generic
30 psgml.el 31 instructions. Run
31 psgml-other.el 32
32 psgml-edit.el 33 sh configure
33 psgml-parse.el 34 make
34 psgml-dtd.el 35
35 psgml-info.el 36 and possibly
36 psgml-charent.el 37
37 38 make install
38 If you on the other hand are using Lucid Emacs or XEmacs you should 39
39 compile 40 If you are using xemacs, you can run give the argument `--with-xemacs'
40 psgml.el 41 to configure, or use `make xemacs'.
41 psgml-lucid.el 42
42 psgml-edit.el 43 Instead of using configure you can load the psgml-main.el file and run
43 psgml-parse.el 44 the command psgml-compile-files. Then you have to set load-path or
44 psgml-dtd.el 45 move the .elc files.
45 psgml-info.el
46 psgml-charent.el
47
48 Additionally the following can be compiled, they are not normaly used
49 by PSGML:
50 psgml-api.el -- Extra functions for the API
51 fs.el -- Example use of psgml to format a SGML file
52 psgml-debug.el -- some functions used in development
53 46
54 Send bug reports, comments and suggestions to lenst@lysator.liu.se. 47 Send bug reports, comments and suggestions to lenst@lysator.liu.se.
48
49 New in version 1.0a12
50
51 See ChangeLog...
52
53
54 New in version 1.0a11
55
56 * Autoconf support
57
58 Tanks to Karl Eichwalder.
59
60 * Bugs fixed
61
62 ** after-change-function lost if text entity referenced
63
64 ** Mouse button 3, has wrong binding in XEmacs.
65
66
67 New in version 1.0a10
68
69 * Changed how fontification is done
70
71 First the current line is parsed and fontified. If this would mean
72 parsing more than 500 chars, wait 1 second first.
73
74 Wait 6 seconds and then fontify rest of buffer.
75
76 These waits and the parsing can be interrupted by any input event.
77
78 This seems to work well with Emacs 19.29 and XEmacs 19.13 on Linux.
79
80 * XEmacs menus made with easy-menu
81
82 Now there is only one set of menu for both Emacs and XEmacs.
83
84 * Tracing catalog lookup
85
86 To help debug entity lookup there is a new option
87 `sgml-trace-entity-lookup'. If this option is t messages will be
88 logged in *SGML LOG* buffer when external entities are looked up.
89 These messages shows entity, catalogs searched, and entry type in
90 catalog where entity was found.
91
92
93
94 * Renamed default style sheet for fs.el
95
96 The default style sheet used by fs.el, style sheet formatter example
97 is now "style.fs".
98
55 99
56 New in version 1.0a9 100 New in version 1.0a9
57 101
58 * XEmacs may have problem if sgml-set-face is t 102 * XEmacs may have problem if sgml-set-face is t
59 103
60 I tried with the latest version on a sun4 Solaris 2 machine and PSGML 104 I tried with the latest version on a sun4 Solaris 2 machine and PSGML
61 would always parse to the end of the buffer even if I typed something. 105 would always parse to the end of the buffer even if I typed something.
62 There seem to be a problem with the input-pending-p function. I don't 106 There seem to be a problem with the input-pending-p function. I don't
63 know if this is specific fo Solaris. Emacs on Solaris has problems 107 know if this is specific for Solaris. Emacs on Solaris has problems
64 with signal handling. 108 with signal handling.
65 109
66 110
67 * New options for insert-element 111 * New options for insert-element
68 ** sgml-insert-missing-element-comment 112 ** sgml-insert-missing-element-comment
70 114
71 * psgml-api: 115 * psgml-api:
72 ** sgml-map-content: new optional argument. If the argument ENTITY-FUN 116 ** sgml-map-content: new optional argument. If the argument ENTITY-FUN
73 is specified it should be a function with one argument. The function 117 is specified it should be a function with one argument. The function
74 will be called for data entity references instead of the entity text 118 will be called for data entity references instead of the entity text
75 beeing passed to the DATA-FUN. The argument is the entity referenced. 119 being passed to the DATA-FUN. The argument is the entity referenced.
76 Use `sgml-entity-name', `sgml-entity-type' etc. 120 Use `sgml-entity-name', `sgml-entity-type' etc.
77 121
78 122
79 Version 1.0a8 has only bugfixes. 123 Version 1.0a8 has only bug-fixes.
80 124
81 125
82 New in version 1.0a7 126 New in version 1.0a7
83 127
84 * Better CATALOG parsing 128 * Better CATALOG parsing
86 ** Will handle SGMLDECL, etc.. 130 ** Will handle SGMLDECL, etc..
87 131
88 ** New option: sgml-system-identifiers-are-preferred 132 ** New option: sgml-system-identifiers-are-preferred
89 If nil PSGML will look up external entities by searching the catalogs 133 If nil PSGML will look up external entities by searching the catalogs
90 in `sgml-local-catalogs' and `sgml-catalog-files' and only if the entity 134 in `sgml-local-catalogs' and `sgml-catalog-files' and only if the entity
91 is not found in will a given system identifer be used. If the variable 135 is not found in will a given system identifier be used. If the variable
92 is non-nil and a system identifer is given, the system identifier will 136 is non-nil and a system identifier is given, the system identifier will
93 be used for the entity. If no system identifier is given the catalogs 137 be used for the entity. If no system identifier is given the catalogs
94 will searched. 138 will searched.
95 139
96 * File names for external entities (e.g system identifiers) are 140 * File names for external entities (e.g system identifiers) are
97 relative to the directory containing the file declaring of the entity. 141 relative to the directory containing the file declaring of the entity.
106 current files content fits into the element hierarchy. The variable 150 current files content fits into the element hierarchy. The variable
107 should have the form 151 should have the form
108 152
109 (parent-file context-element* top-element (has-seen-element*)?) 153 (parent-file context-element* top-element (has-seen-element*)?)
110 154
111 *** parent-file (string) is the name of the file contatining the 155 *** parent-file (string) is the name of the file containing the
112 document entity. 156 document entity.
113 157
114 *** context-element (string) is used to set up exceptions and short 158 *** context-element (string) is used to set up exceptions and short
115 reference map. Good candidates for these elements are the elements 159 reference map. Good candidates for these elements are the elements
116 open when the entity pointing to the current file is used. 160 open when the entity pointing to the current file is used.
148 192
149 This file contain API-functions that are not used by other parts of 193 This file contain API-functions that are not used by other parts of
150 psgml. Use (require 'psgml-api) to use the API functions (psgml-api 194 psgml. Use (require 'psgml-api) to use the API functions (psgml-api
151 includes the rest of the psgml files). 195 includes the rest of the psgml files).
152 196
153 The new functions in psgml-api is two functions to travers the element 197 The new functions in psgml-api is two functions to traverse the element
154 structure. 198 structure.
155 199
156 *** (sgml-map-content element element-function data-function pi-function) 200 *** (sgml-map-content element element-function data-function pi-function)
157 201
158 Call element-function with every child of element. 202 Call element-function with every child of element.
187 231
188 * Insert element leaves point at the end of the element, 232 * Insert element leaves point at the end of the element,
189 it used to leave point at the beginning of the element. 233 it used to leave point at the beginning of the element.
190 234
191 * sgml-hide-tags/attributes is better at handling minimized tags 235 * sgml-hide-tags/attributes is better at handling minimized tags
192 236
193 * New options 237 * New options
194 ** sgml-validate-files and slight change of sgml-validate-command. 238 ** sgml-validate-files and slight change of sgml-validate-command.
195 ** sgml-recompile-out-of-date-cdtd 239 ** sgml-recompile-out-of-date-cdtd
196 240
197 * Now saving attribute specification list in parse tree 241 * Now saving attribute specification list in parse tree
198 Faster sgml-element-attval, but more memory used. 242 Faster sgml-element-attval, but more memory used.
199 243
200 * Long menus that are split into submenus now show the range of 244 * Long menus that are split into sub-menus now show the range of
201 choices in the different submenus. 245 choices in the different sub-menus.
202 246
203 The option `sgml-range-indicator-max-length' determines how many 247 The option `sgml-range-indicator-max-length' determines how many
204 characters from the first and the last choice to show. 248 characters from the first and the last choice to show.
205 249
206 * Private abbrev table 250 * Private abbrev table
271 start tag will be used. I.e., if the document starts with `<book>', a 315 start tag will be used. I.e., if the document starts with `<book>', a
272 document type declaration `<!DOCTYPE book SYSTEM>' will be assumed. 316 document type declaration `<!DOCTYPE book SYSTEM>' will be assumed.
273 317
274 318
275 * Compiled DTDs are now associated with external `Document Type 319 * Compiled DTDs are now associated with external `Document Type
276 Declaration Subset' entitys. You will have to create a catalog with 320 Declaration Subset' entities. You will have to create a catalog with
277 entries for all the DTDs that should be compiled. This should make 321 entries for all the DTDs that should be compiled. This should make
278 it, in most cases, unnecessary to make saved dtds or to set the 322 it, in most cases, unnecessary to make saved dtds or to set the
279 `sgml-default-dtd-file', at the expense of having to maintain the 323 `sgml-default-dtd-file', at the expense of having to maintain the
280 catalog file. 324 catalog file.
281 325
348 Put ~/sgml/CATALOG in sgml-catalog-files and ~/sgml/ECAT in 392 Put ~/sgml/CATALOG in sgml-catalog-files and ~/sgml/ECAT in
349 sgml-ecat-files. 393 sgml-ecat-files.
350 394
351 Now it should be possible to edit html files if you put them in 395 Now it should be possible to edit html files if you put them in
352 sgml-mode. The file must either start with a proper DOCTYPE or with a 396 sgml-mode. The file must either start with a proper DOCTYPE or with a
353 <html> tag. To be abel to start with empty files and to edit files 397 <html> tag. To be able to start with empty files and to edit files
354 not starting with <html> you can create a html-mode that sets the 398 not starting with <html> you can create a html-mode that sets the
355 default document type name: 399 default document type name:
356 400
357 (defun html-mode () 401 (defun html-mode ()
358 (interactive) 402 (interactive)
370 414
371 415
372 * Handling of tags for undefined elements 416 * Handling of tags for undefined elements
373 417
374 ** Start-tags for undefined elements will either be ignored, if 418 ** Start-tags for undefined elements will either be ignored, if
375 `sgml-ignore-undefined-elements' is t, or assumed to be acceptabled in 419 `sgml-ignore-undefined-elements' is t, or assumed to be acceptable in
376 the current element and defined with `O O ANY'. 420 the current element and defined with `O O ANY'.
377 421
378 ** An end-tag for an element that is not currently open will be ignored. 422 ** An end-tag for an element that is not currently open will be ignored.
379 423
380 424
431 ** Command: sgml-expand-all-shortrefs 475 ** Command: sgml-expand-all-shortrefs
432 Expand all short references in the buffer. Short references to text 476 Expand all short references in the buffer. Short references to text
433 entities are expanded to the replacement text of the entity, other 477 entities are expanded to the replacement text of the entity, other
434 short references are expanded into general entity references. If 478 short references are expanded into general entity references. If
435 argument, TO-ENTITY, is non-nil, or if called interactive with numeric 479 argument, TO-ENTITY, is non-nil, or if called interactive with numeric
436 prefix argument, all short references are replaced by generaly entity 480 prefix argument, all short references are replaced by generally entity
437 references. 481 references.
438 482
439 ** sgml-normalize: expand short references also 483 ** sgml-normalize: expand short references also
440 Normalize buffer by filling in omitted tags and expanding empty tags. 484 Normalize buffer by filling in omitted tags and expanding empty tags.
441 Argument TO-ENTITY controls how short references are expanded as with 485 Argument TO-ENTITY controls how short references are expanded as with
464 parsing, with error messages turned off, as much as possible after 508 parsing, with error messages turned off, as much as possible after
465 every command. The parsing is interrupted by input and is almost 509 every command. The parsing is interrupted by input and is almost
466 transparent. 510 transparent.
467 511
468 * Local catalog files 512 * Local catalog files
469 Variabel `sgml-local-catalogs' 513 Variable `sgml-local-catalogs'
470 A list of SGML entity catalogs to be searched first when parsing the buffer. 514 A list of SGML entity catalogs to be searched first when parsing the buffer.
471 This is used in addtion to `sgml-catalog-files', and `sgml-public-map'. 515 This is used in addition to `sgml-catalog-files', and `sgml-public-map'.
472 This variable is automatically local to the buffer. 516 This variable is automatically local to the buffer.
473 517
474 * New commands 518 * New commands
475 Thanks to David Megginson the custom menus are now reacable from the 519 Thanks to David Megginson the custom menus are now reachable from the
476 keyboard: 520 keyboard:
477 ** C-c C-u C-d (sgml-custom-dtd) 521 ** C-c C-u C-d (sgml-custom-dtd)
478 ** C-c C-u C-m (sgml-custom-markup) 522 ** C-c C-u C-m (sgml-custom-markup)
479 523
480 * New command: sgml-expand-entity-reference 524 * New command: sgml-expand-entity-reference
574 Each name is a lowercase string, and start-tags and end-tags must be 618 Each name is a lowercase string, and start-tags and end-tags must be
575 listed individually. 619 listed individually.
576 620
577 `sgml-exposed-tags' is local to each buffer in which it has been set; 621 `sgml-exposed-tags' is local to each buffer in which it has been set;
578 use `setq-default' to set it to a value that is shared among buffers. 622 use `setq-default' to set it to a value that is shared among buffers.
623
624
625 Local variables:
626 mode: text
627 mode: outline
628 end: