yatex
view docs/yahtmle @ 541:7595fc6462ff
Add links
| author | HIROSE Yuuji <yuuji@gentei.org> |
|---|---|
| date | Thu, 31 May 2018 09:53:11 +0900 |
| parents | d69fd7b1ac4d |
| children |
line source
1 Info file: yahtmle, -*-Text-*-
2 produced by `texinfo-format-buffer'
3 from file `yahtmle.tex'
4 using `texinfmt.el' version 2.42 of 7 Jul 2006.
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
114 types.
116 Examples for `yahtml-path-url-alist'. If `/home/yuuji/http/' is
117 `http://localhost/~yuuji' at home and `/usr/home/yuuji/www/' is
118 `http://www.keio.ac.jp/~yuuji/' at work, then
120 (setq yahtml-path-url-alist
121 '(("/home/yuuji/http" . "http://localhost/~yuuji")
122 ("/usr/home/yuuji/www" . "http://www.keio.ac.jp/~yuuji")))
124 Any number of additions can be made to this list.
128 File: yahtmle, Node: Command Invocation, Next: Completion, Prev: Installation, Up: Top
130 Invoking external commands
131 **************************
133 For easy use of commands that are handy when editing HTML files.
134 `[prefix] t j'
135 ... Invoke HTML syntax checker (jweblint)
136 `[prefix] t p'
137 ... Display current page in browser
138 `[prefix] t r'
139 ... Reload current page if browser is already running
143 File: yahtmle, Node: Completion, Next: Jump, Prev: Command Invocation, Up: Top
145 Completion Input
146 ****************
148 Completion input of HTML elements is done through the same key strokes as
149 YaTeX's begin-type completion, section-type completion, large-type
150 completion, maketitle-type completion, and accent completion.
151 Corresponding elements in this order is; elements that span multiple
152 lines, empty elements such as img, tags that start and end in a single
153 line, elements with no attributes or contents, and special or symbol
154 entities.
156 `[prefix] b (YaTeX begin-type completion)'
157 ...
158 <ul>
159 </ul>
161 Completion for elements that the start tag and the end tag span
162 multiple lines. Mostly block-level elements.
164 `[prefix] s (YateX section-type completion)'
165 ...
166 <img src="foo.gif" alt="photo">
168 Completion for elements that do not have end tags and require only
169 attributes. Possible completions are, <img>, <input>.
171 `[prefix] l (YaTeX large-type completion)'
172 ...
174 <big> ` </big>
176 Similar to begin-type completion but used for elements that start and
177 end on a single line.
180 `[prefix] m (YaTeX maketitle-type completion)'
181 ... Completion for elements without attributes or contents. Possible
182 completion is <br>
184 `[prefix] a (YaTeX accent completion)'
185 ... Used to enter special or symbol entities. By default completion
186 for < (<), > (>), & (&), " ("), ' ('), blank
187 ( ) is possible.
191 File: yahtmle, Node: Jump, Next: Changing and Deleting, Prev: Completion, Up: Top
193 Cursor Movement
194 ***************
195 By using
197 `[prefix] g'
198 ... move to corresponding object
200 the cursor will go to the corresponding object according to the context.
201 Recognized contexts are
203 * `<TAG>' <--> `</TAG>'
204 * `<img src="image.file">' -> invoke viewer
205 * `<a href="link.to.somewhere">' -> move cursor to linked target
206 * `<applet code="program">' -> open Java source
210 File: yahtmle, Node: Changing and Deleting, Next: CSS Support, Prev: Jump, Up: Top
212 Changing and Deleting
213 *********************
215 * Menu:
217 * Changing tags in pairs::
218 * Changing entities::
219 * URLencoding of strings within region::
220 * td-enclosure/tr-enclosure::
224 File: yahtmle, Node: Changing tags in pairs, Next: Changing entities, Prev: Changing and Deleting, Up: Changing and Deleting
226 Changing tags in pairs
227 ======================
228 By using
230 `[prefix] c'
231 ... change tags in matching pairs
233 the content can be changed according to the context of the HTML document
234 where the cursor is located.
236 * `<TAG>'``</TAG>'
237 ... change `TAG' element name
238 * attributes such as `<img src="image.file" alt="photo">'
239 ... change attributes
243 File: yahtmle, Node: Changing entities, Next: URLencoding of strings within region, Prev: Changing tags in pairs, Up: Changing and Deleting
245 Changing entities
246 =================
247 Special characters such as < or > must be written as < and >. Easy
248 conversion of these characters can be done when importing text from non
249 HTML files.
252 `[prefix] ;'
253 ... convert char to special entity in marked region
254 `[prefix] :'
255 ... convert special entity to original char in marked region
256 (reverse of [prefix] ;)
261 File: yahtmle, Node: URLencoding of strings within region, Next: td-enclosure/tr-enclosure, Prev: Changing entities, Up: Changing and Deleting
263 URLencoding of strings within region
264 ====================================
266 `[prefix] #'
267 ... encode chars that needs to be URLencoded within region
271 File: yahtmle, Node: td-enclosure/tr-enclosure, Prev: URLencoding of strings within region, Up: Changing and Deleting
273 td-enclosure/tr-enclosure
274 =========================
275 If you wan to convert series of field into <td>...</td> repetitions for
276 table element, td-enclosure or tr-enclosure is convenient.
278 `[prefix] }'
280 ... Enclose each field in a region into <td>...</td>'s.
281 `[prefix] ]'
283 ... Enclose each line in a region into <tr>...</tr>'s, with every
284 line converted to <td>...</td> repetition. They presume
285 white space as field separator by default. To change this,
286 enter other delimiting character for a query. You can
287 convert CSV, for example, into table by specifying comma(,)
288 as a delimiter.
290 If you want to enclose fields with th, call with universal-argument
291 (`C-u'). Enter `th' to enclose fields with <th>...</th>. The special
292 answer `thd' means that enclose the only first column with th, and the
293 rest with td.
297 File: yahtmle, Node: CSS Support, Next: Customizations, Prev: Changing and Deleting, Up: Top
299 CSS(Style Sheets) Support
300 *************************
302 * Menu:
304 * CSS-class completion::
305 * Reread CSS definition::
309 File: yahtmle, Node: CSS-class completion, Next: Reread CSS definition, Prev: CSS Support, Up: CSS Support
311 CSS class-name completion
312 =========================
313 You can input a class name in your CSS definition with completion. If you
314 have CSS defined as below;
316 h1.foo, h2.foo { background-color: 0xffffff; }
317 h1.bar, h2.bar { font-size: 120%; }
319 when you input h1(or h2) tag with completing-read by [prefix] b or
320 [prefix] l, yahtml prompts you to input class name with completion from
321 the words which are effective to h1 or h2. And if you defined global
322 class like this;
324 .caution { font-size: 120%; background-color: 0xc00000;}
326 when you input any tags via completing-read, yahtml prompts you to input
327 class name. If this is bothering, typing `C-j' instead of
328 `RET' (or `C-m') cancels the next prompt to class name completion.
332 File: yahtmle, Node: Reread CSS definition, Prev: CSS-class completion, Up: CSS Support
334 Re-reading CSS definition
335 =========================
336 If you add some class to your CSS file and you want yahtml to load new
337 definitions, type `M-x yahtml-mode RET' to make yahtml do.
341 File: yahtmle, Node: Customizations, Next: Copying, Prev: CSS Support, Up: Top
343 Customizations
344 **************
346 Variables that modify yahtml's behavior.
348 * Menu:
350 * All customizable variables:: List of customizable variables
351 * Hook variables:: hook variables
355 File: yahtmle, Node: All customizable variables, Next: Hook variables, Prev: Customizations, Up: Customizations
357 List of customizable variables. Defaults in parenthesis
358 ========================================================
360 -- Variable: yahtml-prefix
361 Prefix key for yahtml-mode. (`\C-c')
363 -- Variable: yahtml-image-viewer
364 Command to view image files refered by img. (xv)
366 -- Variable: yahtml-www-browser
367 Browser to view external pages with `[prefix]g'. (netscape)
369 -- Variable: yahtml-kanji-code
370 Default kanji code. 1=sjis, 2=jis, 3=euc, 4=utf-8 (2) If AddType
371 "text/html; charset=xxx" .html is written in .htaccess, this
372 will override yahtml-kanji-code.
374 -- Variable: yahtml-fill-column
375 Columns to auto-fill (72)
377 -- Variable: yahtml-fill-prefix
378 fill-prefix specific to yahtml-mode. (`nil')
380 -- Variable: yahtml-path-url-alist
381 Matching list of URL and full path name on OS's file system.
383 -- Variable: yahtml-directory-index
384 Default index filed opened when accessing a server without a
385 filename, usually index.html. (`"index.html"')
387 -- Variable: yahtml-lint-program
388 HTML syntax check program. (`"jweblint"')
390 -- Variable: yahtml-hate-too-deep-indentation
391 setq to t when indentations for nested enumerate elements are too
392 deep. (`nil')
394 -- Variable: yahtml-always-/p
395 setq to t if you always want `</p>' after `</p>'. `nil'
397 -- Variable: yahtml-p-prefered-env-regexp
398 Elements that `<p>' will be automatically inserted.
399 (`"^\\(body\\|dl\\|blockquote\\)"')
401 -- Variable: yahtml-template-file
402 File to automatically insert when editing a new HTML file.
403 `"~/http/template.html"'
405 -- Variable: yahtml-prefer-upcases
406 Use uppercase for tags. `nil'
408 -- Variable: yahtml-prefer-upcase-attributes
409 Use uppercase for attributes. `nil'
411 -- Variable: yahtml-server-type
412 setq to 'apache if using a Apache server, and will refer ./.htaccess.
413 `'apache'
415 -- Variable: yahtml-apache-access-file
416 When `yahtml-server-type' is `'apache', define name of access
417 restriction file. `".htaccess"'
419 -- Variable: yahtml-shell-command-option
420 Options needed to invoke shell commands.
422 -- Variable: yahtml-translate-hyphens-when-comment-region
423 Whether to change hyphens to `-' when commenting out region.
424 (`t')
426 -- Variable: yahtml-entity-reference-chars-alist
427 alist of characters that needs to be written by Entity Reference.
428 Enter as `'(?char . "EntityReference")'. By default, `<', `>', `&',
429 `'', is set. Add as needed. Do not include `&' at beginning and `;'
430 at end of cdr portion of `"EntityReference"'.
432 -- Variable: yahtml-faithful-to-htmllint
433 When using htmllint to check syntax, it will complain about excess
434 spaces. setq to `t' to avoid this.
436 -- Variable: yahtml-use-css
437 Use style-sheet support or not (`t')
439 -- Variable: yahtml-image-inspection-bytes
440 Number of bytes to inspect the image for geometry information
441 (`10000')
443 -- Variable: yahtml:img-default-alt-format
444 format of img entity's ALT attributes. %x: width, %y: height, %s:
445 size in bytes, %c: first comment string, %f: filename
446 (`"%xx%y(%sbytes)"')
448 -- Variable: yahtml-escape-chars
449 When, completing href-s, Escape reserved characters to URL-encoding
450 or not. Nil for never, t for everytime, and 'ask for inquiring at
451 each reserved chars. (`'ask')
453 -- Variable: yahtml-use-font-lock
454 Use font-lock to fontify buffer or not (`(featurep 'font-lock)')
456 -- Variable: yahtml-use-hilit19
457 Use hilit19 to highlight buffer or not (`(featurep 'hilit19)')
459 -- Variable: yahtml-indentation-boundary
460 Boundary regexp for indentation calculation. (`"^\\s *<h[1-3]>"')
464 File: yahtmle, Node: Hook variables, Prev: All customizable variables, Up: Customizations
466 hook variables
467 ==============
472 File: yahtmle, Node: Copying, Next: Concept Index, Prev: Customizations, Up: Top
474 Copying
475 *******
477 This program is distributed as freesoftware. The author will take no
478 responsibility to any damages due to the usage of this software
479 whatsoever. There are no restrictions to its redistribution, just use
480 common sense. Mail me your thoughts on this program and I will be more
481 than willing to help.
483 Complaints, requests, bug reports and comments are welcome. Make contacts
484 to yuuji@yatex.org@(as of December 2000)
486 If you like this program and use it on a regular basis, please join the
487 mailing list "fj Wild Bird Society". Procedures can be found in the "etc"
488 section of `docs/htmlqa.eng' in this package.
491 HIROSE, Yuuji
496 File: yahtmle, Node: Concept Index, Prev: Copying, Up: Top
498 Index
499 *****
501 * Menu:
503 * Customize: Customizations. (line 5)
504 * Demacs: Intro. (line 5)
505 * Key Assign: Customizations. (line 5)
506 * LaTeX: Intro. (line 5)
507 * Mule: Intro. (line 5)
508 * yahtml: Intro. (line 5)
510 Tag table:
511 Node: Top259
512 Node: Intro836
513 Node: Installation1234
514 Node: Setting up yahtml1500
515 Node: Setting environments for weblint browsers and image viewers2291
516 Node: Setting environment variables for WWW pages2987
517 Node: Command Invocation3979
518 Node: Completion4407
519 Node: Jump5923
520 Node: Changing and Deleting6403
521 Node: Changing tags in pairs6665
522 Node: Changing entities7160
523 Node: URLencoding of strings within region7704
524 Node: td-enclosure/tr-enclosure8007
525 Node: CSS Support9032
526 Node: CSS-class completion9243
527 Node: Reread CSS definition10096
528 Node: Customizations10371
529 Node: All customizable variables10647
530 Node: Hook variables14427
531 Node: Copying14553
532 Node: Concept Index15344
534 End tag table