yatex
view docs/yahtmle @ 206:99cb56e58ec3
RCS-Checked in as 1.75
| author | yuuji@gentei.org |
|---|---|
| date | Thu, 12 Jan 2012 12:25:08 +0900 |
| parents | 2638644ff9a0 |
| children | d467c0fb6083 |
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.
11 File: yahtmle, Node: Top, Next: Intro, Prev: (dir), Up: (dir)
13 * Menu:
15 * Intro:: Introduction
16 * Installation:: Installing yahtml
17 * Command Invocation:: Using External Commands
18 * Completion:: Input with Completion
19 * Jump:: Moving the Cursor
20 * Changing and Deleting:: Changing and Deleting
21 * CSS Support:: Style Sheet Support
22 * Customizations:: List of Customize Variables
23 * Copying:: Copyright
24 * Concept Index:: Index
28 File: yahtmle, Node: Intro, Next: Installation, Prev: Top, Up: Top
30 Introduction
31 ************
33 yahtml is a package to support creating HTML documents on Emacsens. Easy
34 input of elements (tags) by completion, syntax checking with programs like
35 weblint, and invoking the appropriate browser or image viewer depending on
36 the cursor position is its main features.
38 (This Info is still incomplete)
42 File: yahtmle, Node: Installation, Next: Command Invocation, Prev: Intro, Up: Top
44 Installing yahtml
45 *****************
46 * Menu:
48 * Setting up yahtml::
49 * Setting environments for weblint browsers and image viewers::
50 * Setting environment variables for WWW pages::
54 File: yahtmle, Node: Setting up yahtml, Next: Setting environments for weblint browsers and image viewers, Prev: Installation, Up: Installation
56 Setting up yahtml
57 =================
60 Add the following to `~/.emacs'
62 (setq auto-mode-alist
63 (cons (cons "\\.html$" 'yahtml-mode) auto-mode-alist))
64 (autoload 'yahtml-mode "yahtml" "Yet Another HTML mode" t)
66 Next, add to load-path the directory with the yahtml files (`yahtml.el',
67 `yatexlib.el', `yatexprc.el'). For example, if you put them in
68 `~/src/emacs/yahtml',
70 (setq load-path (cons (expand-file-name "~/src/emacs/yahtml") load-path))
72 is what you add.
74 By this, yahtml will be automatically loaded when editing files with .html
75 extensions. "yahtml" will be displayed on the mode line if no errors
76 occurred.
80 File: yahtmle, Node: Setting environments for weblint browsers and image viewers, Next: Setting environment variables for WWW pages, Prev: Setting up yahtml, Up: Installation
82 Setting environments for weblint, browsers, and image viewers
83 =============================================================
85 Check the variables for invoking external commands and modify as needed.
86 Defaults are in parenthesis.
88 `yahtml-www-browser'
89 ... browser command name (netscape)
90 `yahtml-image-viewer'
91 ... image viewer command name (xv)
92 `yahtml-lint-program'
93 ... syntax check programs command name (jweblint)
94 `yahtml-kanji-code'
95 ... kanji code for HTML files
99 File: yahtmle, Node: Setting environment variables for WWW pages, Prev: Setting environments for weblint browsers and image viewers, Up: Installation
101 Setting environment variables for WWW pages
102 ===========================================
104 Variables regarding path names for files that will be your home page.
105 `yahtml-path-url-alist'
106 ... list of matching path name on file system and URLs
107 `yahtml-directory-index'
108 ... index file displayed when none is given in URL. Usually
109 `index.html' on NCSA type httpd and `Welcome.html' on CERN types.
111 Examples for `yahtml-path-url-alist'. If `/home/yuuji/http/' is
112 `http://localhost/~yuuji' at home and `/usr/home/yuuji/www/' is
113 `http://www.keio.ac.jp/~yuuji/' at work, then
115 (setq yahtml-path-url-alist
116 '(("/home/yuuji/http" . "http://localhost/~yuuji")
117 ("/usr/home/yuuji/www" . "http://www.keio.ac.jp/~yuuji")))
119 Any number of additions can be made to this list.
123 File: yahtmle, Node: Command Invocation, Next: Completion, Prev: Installation, Up: Top
125 Invoking external commands
126 **************************
128 For easy use of commands that are handy when editing HTML files.
129 `[prefix] t j'
130 ... Invoke HTML syntax checker (jweblint)
131 `[prefix] t p'
132 ... Display current page in browser
133 `[prefix] t r'
134 ... Reload current page if browser is already running
138 File: yahtmle, Node: Completion, Next: Jump, Prev: Command Invocation, Up: Top
140 Completion Input
141 ****************
143 Completion input of HTML elements is done through the same key strokes as
144 YaTeX's begin-type completion, section-type completion, large-type
145 completion, maketitle-type completion, and accent completion.
146 Corresponding elements in this order is; elements that span multiple
147 lines, empty elements such as img, tags that start and end in a single
148 line, elements with no attributes or contents, and special or symbol
149 entities.
151 `[prefix] b (YaTeX begin-type completion)'
152 ...
153 <ul>
154 </ul>
156 Completion for elements that the start tag and the end tag span
157 multiple lines. Mostly block-level elements.
159 `[prefix] s (YateX section-type completion)'
160 ...
161 <img src="foo.gif" alt="photo">
163 Completion for elements that do not have end tags and require only
164 attributes. Possible completions are, <img>, <input>.
166 `[prefix] l (YaTeX large-type completion)'
167 ...
169 <big> 〜 </big>
171 Similar to begin-type completion but used for elements that start and
172 end on a single line.
175 `[prefix] m (YaTeX maketitle-type completion)'
176 ... Completion for elements without attributes or contents. Possible
177 completion is <br>
179 `[prefix] a (YaTeX accent completion)'
180 ... Used to enter special or symbol entities. By default completion
181 for < (<), > (>), & (&), " ("), ' ('), blank
182 ( ) is possible.
186 File: yahtmle, Node: Jump, Next: Changing and Deleting, Prev: Completion, Up: Top
188 Cursor Movement
189 ***************
190 By using
192 `[prefix] g'
193 ... move to corresponding object
195 the cursor will go to the corresponding object according to the context.
196 Recognized contexts are
198 * `<TAG>' <--> `</TAG>'
199 * `<img src="image.file">' -> invoke viewer
200 * `<a href="link.to.somewhere">' -> move cursor to linked target
201 * `<applet code="program">' -> open Java source
205 File: yahtmle, Node: Changing and Deleting, Next: CSS Support, Prev: Jump, Up: Top
207 Changing and Deleting
208 *********************
210 * Menu:
212 * Changing tags in pairs::
213 * Changing entities::
214 * URLencoding of strings within region::
218 File: yahtmle, Node: Changing tags in pairs, Next: Changing entities, Prev: Changing and Deleting, Up: Changing and Deleting
220 Changing tags in pairs
221 ======================
222 By using
224 `[prefix] c'
225 ... change tags in matching pairs
227 the content can be changed according to the context of the HTML document
228 where the cursor is located.
230 * `<TAG>'〜`</TAG>'
231 ... change `TAG' element name
232 * attributes such as `<img src="image.file" alt="photo">'
233 ... change attributes
237 File: yahtmle, Node: Changing entities, Next: URLencoding of strings within region, Prev: Changing tags in pairs, Up: Changing and Deleting
239 Changing entities
240 =================
241 Special characters such as < or > must be written as < and >. Easy
242 conversion of these characters can be done when importing text from non
243 HTML files.
246 `[prefix] ;'
247 ... convert char to special entity in marked region
248 `[prefix] :'
249 ... convert special entity to original char in marked region
250 (reverse of [prefix] ;)
255 File: yahtmle, Node: URLencoding of strings within region, Next: td-enclosure/tr-enclosure, Prev: Changing entities, Up: Changing and Deleting
257 URLencoding of strings within region
258 ====================================
260 `[prefix] #'
261 ... encode chars that needs to be URLencoded within region
265 File: yahtmle, Node: td-enclosure/tr-enclosure, Prev: URLencoding of strings within region, Up: Changing and Deleting
267 td-enclosure/tr-enclosure
268 =========================
269 If you wan to convert series of field into <td>...</td> repetitions for
270 table element, td-enclosure or tr-enclosure is convenient.
272 `[prefix] '}
274 ... Enclose each field in a region into <td>...</td>'s.
275 `[prefix] ]'
277 ... Enclose each line in a region into <tr>...</tr>'s, with every
278 line converted to <td>...</td> repetition. They presume white space as
279 field separator by default. To change this, enter other delimiting
280 character for a query. You can convert CSV, for example, into table by
281 specifying comma(,) as a delimiter.
283 If you want to enclose fields with th, call with universal-argument
284 (`C-u'). Enter `th' to enclose fields with <th>...</th>. The special
285 answer `thd' means that enclose the only first column with th, and the
286 rest with td.
290 File: yahtmle, Node: CSS Support, Next: Customizations, Prev: Changing and Deleting, Up: Top
292 CSS(Style Sheets) Support
293 *************************
295 * Menu:
297 * CSS-class completion::
298 * Reread CSS definition::
302 File: yahtmle, Node: CSS-class completion, Next: Reread CSS definition, Prev: CSS Support, Up: CSS Support
304 CSS class-name completion
305 =========================
306 You can input a class name in your CSS definition with completion. If you
307 have CSS defined as below;
309 h1.foo, h2.foo { background-color: 0xffffff; }
310 h1.bar, h2.bar { font-size: 120%; }
312 when you input h1(or h2) tag with completing-read by [prefix] b or
313 [prefix] l, yahtml prompts you to input class name with completion from
314 the words which are effective to h1 or h2. And if you defined global
315 class like this;
317 .caution { font-size: 120%; background-color: 0xc00000;}
319 when you input any tags via completing-read, yahtml prompts you to input
320 class name. If this is bothering, typing `C-j' instead of `RET' (or
321 `C-m') cancels the next prompt to class name completion.
325 File: yahtmle, Node: Reread CSS definition, Prev: CSS-class completion, Up: CSS Support
327 Re-reading CSS definition
328 =========================
329 If you add some class to your CSS file and you want yahtml to load new
330 definitions, type `M-x yahtml-mode RET' to make yahtml do.
334 File: yahtmle, Node: Customizations, Next: Copying, Prev: CSS Support, Up: Top
336 Customizations
337 **************
339 Variables that modify yahtml's behavior.
341 * Menu:
343 * All customizable variables:: List of customizable variables
344 * Hook variables:: hook variables
348 File: yahtmle, Node: All customizable variables, Next: Hook variables, Prev: Customizations, Up: Customizations
350 List of customizable variables. Defaults in parenthesis
351 ========================================================
353 -- Variable: yahtml-prefix
354 Prefix key for yahtml-mode. (`\C-c')
356 -- Variable: yahtml-image-viewer
357 Command to view image files refered by img. (xv)
359 -- Variable: yahtml-www-browser
360 Browser to view external pages with `[prefix]g'. (netscape)
362 -- Variable: yahtml-kanji-code
363 Default kanji code. 1=sjis, 2=jis, 3=euc, 4=utf-8 (2) If AddType
364 "text/html; charset=xxx" .html is written in .htaccess, this will
365 override yahtml-kanji-code.
367 -- Variable: yahtml-fill-column
368 Columns to auto-fill (72)
370 -- Variable: yahtml-fill-prefix
371 fill-prefix specific to yahtml-mode. (`nil')
373 -- Variable: yahtml-path-url-alist
374 Matching list of URL and full path name on OS's file system.
376 -- Variable: yahtml-directory-index
377 Default index filed opened when accessing a server without a
378 filename, usually index.html. (`"index.html"')
380 -- Variable: yahtml-lint-program
381 HTML syntax check program. (`"jweblint"')
383 -- Variable: yahtml-hate-too-deep-indentation
384 setq to t when indentations for nested enumerate elements are too
385 deep. (`nil')
387 -- Variable: yahtml-always-/p
388 setq to t if you always want `</p>' after `</p>'. `nil'
390 -- Variable: yahtml-p-prefered-env-regexp
391 Elements that `<p>' will be automatically inserted.
392 (`"^\\(body\\|dl\\|blockquote\\)"')
394 -- Variable: yahtml-template-file
395 File to automatically insert when editing a new HTML file.
396 `"~/http/template.html"'
398 -- Variable: yahtml-prefer-upcases
399 Use uppercase for tags. `nil'
401 -- Variable: yahtml-prefer-upcase-attributes
402 Use uppercase for attributes. `nil'
404 -- Variable: yahtml-server-type
405 setq to 'apache if using a Apache server, and will refer ./.htaccess.
406 `'apache'
408 -- Variable: yahtml-apache-access-file
409 When `yahtml-server-type' is `'apache', define name of access
410 restriction file. `".htaccess"'
412 -- Variable: yahtml-shell-command-option
413 Options needed to invoke shell commands.
415 -- Variable: yahtml-translate-hyphens-when-comment-region
416 Whether to change hyphens to `-' when commenting out region.
417 (`t')
419 -- Variable: yahtml-entity-reference-chars-alist
420 alist of characters that needs to be written by Entity Reference.
421 Enter as `'(?char . "EntityReference")'. By default, `<', `>', `&',
422 `'', is set. Add as needed. Do not include `&' at beginning and `;'
423 at end of cdr portion of `"EntityReference"'.
425 -- Variable: yahtml-faithful-to-htmllint
426 When using htmllint to check syntax, it will complain about excess
427 spaces. setq to `t' to avoid this.
429 -- Variable: yahtml-use-css
430 Use style-sheet support or not (`t')
432 -- Variable: yahtml-image-inspection-bytes
433 Number of bytes to inspect the image for geometry information
434 (`10000')
436 -- Variable: yahtml:img-default-alt-format
437 format of img entity's ALT attributes. %x: width, %y: height, %s:
438 size in bytes, %c: first comment string, %f: filename
439 (`"%xx%y(%sbytes)"')
441 -- Variable: yahtml-escape-chars
442 When, completing href-s, Escape reserved characters to URL-encoding
443 or not. Nil for never, t for everytime, and 'ask for inquiring at
444 each reserved chars. (`'ask')
446 -- Variable: yahtml-use-font-lock
447 Use font-lock to fontify buffer or not (`(featurep 'font-lock)')
449 -- Variable: yahtml-use-hilit19
450 Use hilit19 to highlight buffer or not (`(featurep 'hilit19)')
452 -- Variable: yahtml-indentation-boundary
453 Boundary regexp for indentation calculation. (`"^\\s *<h[1-3]>"')
457 File: yahtmle, Node: Hook variables, Prev: All customizable variables, Up: Customizations
459 hook variables
460 ==============
465 File: yahtmle, Node: Copying, Next: Concept Index, Prev: Customizations, Up: Top
467 Copying
468 *******
470 This program is distributed as freesoftware. The author will take no
471 responsibility to any damages due to the usage of this software
472 whatsoever. There are no restrictions to its redistribution, just use
473 common sense. Mail me your thoughts on this program and I will be more
474 than willing to help.
476 Complaints, requests, bug reports and comments are welcome. Make contacts
477 to yuuji@yatex.org (as of December 2000)
479 If you like this program and use it on a regular basis, please join the
480 mailing list "fj Wild Bird Society". Procedures can be found in the "etc"
481 section of `docs/htmlqa.eng' in this package.
484 HIROSE, Yuuji
489 File: yahtmle, Node: Concept Index, Prev: Copying, Up: Top
491 Index
492 *****
494 * Menu:
496 * Customize: Customizations. 4.
497 * Demacs: Intro. 4.
498 * Key Assign: Customizations. 4.
499 * LaTeX: Intro. 4.
500 * Mule: Intro. 4.
501 * yahtml: Intro. 4.
507 Tag table:
508 Node: Top148
509 Node: Intro725
510 Node: Installation1123
511 Node: Setting up yahtml1404
512 Node: Setting environments for weblint browsers and image viewers2195
513 Node: Setting environment variables for WWW pages2891
514 Node: Command Invocation3862
515 Node: Completion4290
516 Node: Jump5807
517 Node: Changing and Deleting6287
518 Node: Changing tags in pairs6538
519 Node: Changing entities7033
520 Node: URLencoding of strings within region7569
521 Node: td-enclosure/tr-enclosure7870
522 Node: CSS Support8836
523 Node: CSS-class completion9062
524 Node: Reread CSS definition9915
525 Node: Customizations10190
526 Node: All customizable variables10466
527 Node: Hook variables14234
528 Node: Copying14360
529 Node: Concept Index15151
531 End tag table