yatex
view docs/yahtmle @ 364:d69fd7b1ac4d
yatex-1.78
| author | HIROSE Yuuji <yuuji@gentei.org> |
|---|---|
| date | Fri, 26 Dec 2014 01:02:52 +0900 |
| parents | d0c09133ced7 |
| children | a3ba09c1e8e9 |
line source
1 Info file: yahtmle, -*-Text-*-
2 produced by `texinfo-format-buffer'
3 from file `yahtmle.tex'
4 using `texinfmt.el' version 2.38 of 3 July 1998.
6 START-INFO-DIR-ENTRY
7 * yahtml-e: (yahtmle). Yet Another html-mode for Emacs (English).
8 END-INFO-DIR-ENTRY
15 File: yahtmle, Node: Top, Next: Intro, Prev: (dir), Up: (dir)
17 * Menu:
19 * Intro:: Introduction
20 * Installation:: Installing yahtml
21 * Command Invocation:: Using External Commands
22 * Completion:: Input with Completion
23 * Jump:: Moving the Cursor
24 * Changing and Deleting:: Changing and Deleting
25 * CSS Support:: Style Sheet Support
26 * Customizations:: List of Customize Variables
27 * Copying:: Copyright
28 * Concept Index:: Index
32 File: yahtmle, Node: Intro, Next: Installation, Prev: Top, Up: Top
34 Introduction
35 ************
37 yahtml is a package to support creating HTML documents on Emacsens. Easy
38 input of elements (tags) by completion, syntax checking with programs like
39 weblint, and invoking the appropriate browser or image viewer depending on
40 the cursor position is its main features.
42 (This Info is still incomplete)
46 File: yahtmle, Node: Installation, Next: Command Invocation, Prev: Intro, Up: Top
48 Installing yahtml
49 *****************
50 * Menu:
52 * Setting up yahtml::
53 * Setting environments for weblint browsers and image viewers::
54 * Setting environment variables for WWW pages::
58 File: yahtmle, Node: Setting up yahtml, Next: Setting environments for weblint browsers and image viewers, Prev: Installation, Up: Installation
60 Setting up yahtml
61 =================
64 Add the following to `~/.emacs'
66 (setq auto-mode-alist
67 (cons (cons "\\.html$" 'yahtml-mode) auto-mode-alist))
68 (autoload 'yahtml-mode "yahtml" "Yet Another HTML mode" t)
70 Next, add to load-path the directory with the yahtml files (`yahtml.el',
71 `yatexlib.el', `yatexprc.el'). For example, if you put them in
72 `~/src/emacs/yahtml',
74 (setq load-path (cons (expand-file-name "~/src/emacs/yahtml") load-path))
76 is what you add.
78 By this, yahtml will be automatically loaded when editing files with .html
79 extensions. "yahtml" will be displayed on the mode line if no errors
80 occurred.
84 File: yahtmle, Node: Setting environments for weblint browsers and image viewers, Next: Setting environment variables for WWW pages, Prev: Setting up yahtml, Up: Installation
86 Setting environments for weblint, browsers, and image viewers
87 =============================================================
89 Check the variables for invoking external commands and modify as needed.
90 Defaults are in parenthesis.
92 `yahtml-www-browser'
93 ... browser command name (netscape)
94 `yahtml-image-viewer'
95 ... image viewer command name (xv)
96 `yahtml-lint-program'
97 ... syntax check programs command name (jweblint)
98 `yahtml-kanji-code'
99 ... kanji code for HTML files
103 File: yahtmle, Node: Setting environment variables for WWW pages, Prev: Setting environments for weblint browsers and image viewers, Up: Installation
105 Setting environment variables for WWW pages
106 ===========================================
108 Variables regarding path names for files that will be your home page.
109 `yahtml-path-url-alist'
110 ... list of matching path name on file system and URLs
111 `yahtml-directory-index'
112 ... index file displayed when none is given in URL. Usually
113 `index.html' on NCSA type httpd and `Welcome.html' on CERN types.
115 Examples for `yahtml-path-url-alist'. If `/home/yuuji/http/' is
116 `http://localhost/~yuuji' at home and `/usr/home/yuuji/www/' is
117 `http://www.keio.ac.jp/~yuuji/' at work, then
119 (setq yahtml-path-url-alist
120 '(("/home/yuuji/http" . "http://localhost/~yuuji")
121 ("/usr/home/yuuji/www" . "http://www.keio.ac.jp/~yuuji")))
123 Any number of additions can be made to this list.
127 File: yahtmle, Node: Command Invocation, Next: Completion, Prev: Installation, Up: Top
129 Invoking external commands
130 **************************
132 For easy use of commands that are handy when editing HTML files.
133 `[prefix] t j'
134 ... Invoke HTML syntax checker (jweblint)
135 `[prefix] t p'
136 ... Display current page in browser
137 `[prefix] t r'
138 ... Reload current page if browser is already running
142 File: yahtmle, Node: Completion, Next: Jump, Prev: Command Invocation, Up: Top
144 Completion Input
145 ****************
147 Completion input of HTML elements is done through the same key strokes as
148 YaTeX's begin-type completion, section-type completion, large-type
149 completion, maketitle-type completion, and accent completion.
150 Corresponding elements in this order is; elements that span multiple
151 lines, empty elements such as img, tags that start and end in a single
152 line, elements with no attributes or contents, and special or symbol
153 entities.
155 `[prefix] b (YaTeX begin-type completion)'
156 ...
157 <ul>
158 </ul>
160 Completion for elements that the start tag and the end tag span
161 multiple lines. Mostly block-level elements.
163 `[prefix] s (YateX section-type completion)'
164 ...
165 <img src="foo.gif" alt="photo">
167 Completion for elements that do not have end tags and require only
168 attributes. Possible completions are, <img>, <input>.
170 `[prefix] l (YaTeX large-type completion)'
171 ...
173 <big> ` </big>
175 Similar to begin-type completion but used for elements that start and
176 end on a single line.
179 `[prefix] m (YaTeX maketitle-type completion)'
180 ... Completion for elements without attributes or contents. Possible
181 completion is <br>
183 `[prefix] a (YaTeX accent completion)'
184 ... Used to enter special or symbol entities. By default completion
185 for < (<), > (>), & (&), " ("), ' ('), blank
186 ( ) is possible.
190 File: yahtmle, Node: Jump, Next: Changing and Deleting, Prev: Completion, Up: Top
192 Cursor Movement
193 ***************
194 By using
196 `[prefix] g'
197 ... move to corresponding object
199 the cursor will go to the corresponding object according to the context.
200 Recognized contexts are
202 * `<TAG>' <--> `</TAG>'
203 * `<img src="image.file">' -> invoke viewer
204 * `<a href="link.to.somewhere">' -> move cursor to linked target
205 * `<applet code="program">' -> open Java source
209 File: yahtmle, Node: Changing and Deleting, Next: CSS Support, Prev: Jump, Up: Top
211 Changing and Deleting
212 *********************
214 * Menu:
216 * Changing tags in pairs::
217 * Changing entities::
218 * URLencoding of strings within region::
219 * td-enclosure/tr-enclosure::
223 File: yahtmle, Node: Changing tags in pairs, Next: Changing entities, Prev: Changing and Deleting, Up: Changing and Deleting
225 Changing tags in pairs
226 ======================
227 By using
229 `[prefix] c'
230 ... change tags in matching pairs
232 the content can be changed according to the context of the HTML document
233 where the cursor is located.
235 * `<TAG>'``</TAG>'
236 ... change `TAG' element name
237 * attributes such as `<img src="image.file" alt="photo">'
238 ... change attributes
242 File: yahtmle, Node: Changing entities, Next: URLencoding of strings within region, Prev: Changing tags in pairs, Up: Changing and Deleting
244 Changing entities
245 =================
246 Special characters such as < or > must be written as < and >. Easy
247 conversion of these characters can be done when importing text from non
248 HTML files.
251 `[prefix] ;'
252 ... convert char to special entity in marked region
253 `[prefix] :'
254 ... convert special entity to original char in marked region
255 (reverse of [prefix] ;)
260 File: yahtmle, Node: URLencoding of strings within region, Next: td-enclosure/tr-enclosure, Prev: Changing entities, Up: Changing and Deleting
262 URLencoding of strings within region
263 ====================================
265 `[prefix] #'
266 ... encode chars that needs to be URLencoded within region
270 File: yahtmle, Node: td-enclosure/tr-enclosure, Prev: URLencoding of strings within region, Up: Changing and Deleting
272 td-enclosure/tr-enclosure
273 =========================
274 If you wan to convert series of field into <td>...</td> repetitions for
275 table element, td-enclosure or tr-enclosure is convenient.
277 `[prefix] }'
279 ... Enclose each field in a region into <td>...</td>'s.
280 `[prefix] ]'
282 ... Enclose each line in a region into <tr>...</tr>'s, with every
283 line converted to <td>...</td> repetition. They presume white space as
284 field separator by default. To change this, enter other delimiting
285 character for a query. You can convert CSV, for example, into table by
286 specifying comma(,) as a delimiter.
288 If you want to enclose fields with th, call with universal-argument
289 (`C-u'). Enter `th' to enclose fields with <th>...</th>. The special
290 answer `thd' means that enclose the only first column with th, and the
291 rest with td.
295 File: yahtmle, Node: CSS Support, Next: Customizations, Prev: Changing and Deleting, Up: Top
297 CSS(Style Sheets) Support
298 *************************
300 * Menu:
302 * CSS-class completion::
303 * Reread CSS definition::
307 File: yahtmle, Node: CSS-class completion, Next: Reread CSS definition, Prev: CSS Support, Up: CSS Support
309 CSS class-name completion
310 =========================
311 You can input a class name in your CSS definition with completion. If you
312 have CSS defined as below;
314 h1.foo, h2.foo { background-color: 0xffffff; }
315 h1.bar, h2.bar { font-size: 120%; }
317 when you input h1(or h2) tag with completing-read by [prefix] b or
318 [prefix] l, yahtml prompts you to input class name with completion from
319 the words which are effective to h1 or h2. And if you defined global
320 class like this;
322 .caution { font-size: 120%; background-color: 0xc00000;}
324 when you input any tags via completing-read, yahtml prompts you to input
325 class name. If this is bothering, typing `C-j' instead of `RET' (or
326 `C-m') cancels the next prompt to class name completion.
330 File: yahtmle, Node: Reread CSS definition, Prev: CSS-class completion, Up: CSS Support
332 Re-reading CSS definition
333 =========================
334 If you add some class to your CSS file and you want yahtml to load new
335 definitions, type `M-x yahtml-mode RET' to make yahtml do.
339 File: yahtmle, Node: Customizations, Next: Copying, Prev: CSS Support, Up: Top
341 Customizations
342 **************
344 Variables that modify yahtml's behavior.
346 * Menu:
348 * All customizable variables:: List of customizable variables
349 * Hook variables:: hook variables
353 File: yahtmle, Node: All customizable variables, Next: Hook variables, Prev: Customizations, Up: Customizations
355 List of customizable variables. Defaults in parenthesis
356 ========================================================
358 -- Variable: yahtml-prefix
359 Prefix key for yahtml-mode. (`\C-c')
361 -- Variable: yahtml-image-viewer
362 Command to view image files refered by img. (xv)
364 -- Variable: yahtml-www-browser
365 Browser to view external pages with `[prefix]g'. (netscape)
367 -- Variable: yahtml-kanji-code
368 Default kanji code. 1=sjis, 2=jis, 3=euc, 4=utf-8 (2) If AddType
369 "text/html; charset=xxx" .html is written in .htaccess, this will
370 override yahtml-kanji-code.
372 -- Variable: yahtml-fill-column
373 Columns to auto-fill (72)
375 -- Variable: yahtml-fill-prefix
376 fill-prefix specific to yahtml-mode. (`nil')
378 -- Variable: yahtml-path-url-alist
379 Matching list of URL and full path name on OS's file system.
381 -- Variable: yahtml-directory-index
382 Default index filed opened when accessing a server without a
383 filename, usually index.html. (`"index.html"')
385 -- Variable: yahtml-lint-program
386 HTML syntax check program. (`"jweblint"')
388 -- Variable: yahtml-hate-too-deep-indentation
389 setq to t when indentations for nested enumerate elements are too
390 deep. (`nil')
392 -- Variable: yahtml-always-/p
393 setq to t if you always want `</p>' after `</p>'. `nil'
395 -- Variable: yahtml-p-prefered-env-regexp
396 Elements that `<p>' will be automatically inserted.
397 (`"^\\(body\\|dl\\|blockquote\\)"')
399 -- Variable: yahtml-template-file
400 File to automatically insert when editing a new HTML file.
401 `"~/http/template.html"'
403 -- Variable: yahtml-prefer-upcases
404 Use uppercase for tags. `nil'
406 -- Variable: yahtml-prefer-upcase-attributes
407 Use uppercase for attributes. `nil'
409 -- Variable: yahtml-server-type
410 setq to 'apache if using a Apache server, and will refer ./.htaccess.
411 `'apache'
413 -- Variable: yahtml-apache-access-file
414 When `yahtml-server-type' is `'apache', define name of access
415 restriction file. `".htaccess"'
417 -- Variable: yahtml-shell-command-option
418 Options needed to invoke shell commands.
420 -- Variable: yahtml-translate-hyphens-when-comment-region
421 Whether to change hyphens to `-' when commenting out region.
422 (`t')
424 -- Variable: yahtml-entity-reference-chars-alist
425 alist of characters that needs to be written by Entity Reference.
426 Enter as `'(?char . "EntityReference")'. By default, `<', `>', `&',
427 `'', is set. Add as needed. Do not include `&' at beginning and `;'
428 at end of cdr portion of `"EntityReference"'.
430 -- Variable: yahtml-faithful-to-htmllint
431 When using htmllint to check syntax, it will complain about excess
432 spaces. setq to `t' to avoid this.
434 -- Variable: yahtml-use-css
435 Use style-sheet support or not (`t')
437 -- Variable: yahtml-image-inspection-bytes
438 Number of bytes to inspect the image for geometry information
439 (`10000')
441 -- Variable: yahtml:img-default-alt-format
442 format of img entity's ALT attributes. %x: width, %y: height, %s:
443 size in bytes, %c: first comment string, %f: filename
444 (`"%xx%y(%sbytes)"')
446 -- Variable: yahtml-escape-chars
447 When, completing href-s, Escape reserved characters to URL-encoding
448 or not. Nil for never, t for everytime, and 'ask for inquiring at
449 each reserved chars. (`'ask')
451 -- Variable: yahtml-use-font-lock
452 Use font-lock to fontify buffer or not (`(featurep 'font-lock)')
454 -- Variable: yahtml-use-hilit19
455 Use hilit19 to highlight buffer or not (`(featurep 'hilit19)')
457 -- Variable: yahtml-indentation-boundary
458 Boundary regexp for indentation calculation. (`"^\\s *<h[1-3]>"')
462 File: yahtmle, Node: Hook variables, Prev: All customizable variables, Up: Customizations
464 hook variables
465 ==============
470 File: yahtmle, Node: Copying, Next: Concept Index, Prev: Customizations, Up: Top
472 Copying
473 *******
475 This program is distributed as freesoftware. The author will take no
476 responsibility to any damages due to the usage of this software
477 whatsoever. There are no restrictions to its redistribution, just use
478 common sense. Mail me your thoughts on this program and I will be more
479 than willing to help.
481 Complaints, requests, bug reports and comments are welcome. Make contacts
482 to yuuji@yatex.org@(as of December 2000)
484 If you like this program and use it on a regular basis, please join the
485 mailing list "fj Wild Bird Society". Procedures can be found in the "etc"
486 section of `docs/htmlqa.eng' in this package.
489 HIROSE, Yuuji
494 File: yahtmle, Node: Concept Index, Prev: Copying, Up: Top
496 Index
497 *****
499 * Menu:
501 * Customize: Customizations. 4.
502 * Demacs: Intro. 4.
503 * Key Assign: Customizations. 4.
504 * LaTeX: Intro. 4.
505 * Mule: Intro. 4.
506 * yahtml: Intro. 4.
512 Tag table:
513 Node: Top256
514 Node: Intro833
515 Node: Installation1231
516 Node: Setting up yahtml1512
517 Node: Setting environments for weblint browsers and image viewers2303
518 Node: Setting environment variables for WWW pages2999
519 Node: Command Invocation3970
520 Node: Completion4398
521 Node: Jump5914
522 Node: Changing and Deleting6394
523 Node: Changing tags in pairs6678
524 Node: Changing entities7173
525 Node: URLencoding of strings within region7709
526 Node: td-enclosure/tr-enclosure8010
527 Node: CSS Support8976
528 Node: CSS-class completion9202
529 Node: Reread CSS definition10055
530 Node: Customizations10330
531 Node: All customizable variables10606
532 Node: Hook variables14374
533 Node: Copying14500
534 Node: Concept Index15291
536 End tag table