yatex
diff docs/yahtmle @ 271:d467c0fb6083
Preparing for 1.76 release
| author | HIROSE Yuuji <yuuji@gentei.org> |
|---|---|
| date | Thu, 10 May 2012 11:40:02 +0900 |
| parents | 5a16b237416f |
| children | 78d0fdc0459c |
line diff
1.1 --- a/docs/yahtmle Thu Jan 12 12:24:40 2012 +0900 1.2 +++ b/docs/yahtmle Thu May 10 11:40:02 2012 +0900 1.3 @@ -1,531 +1,531 @@ 1.4 -Info file: yahtmle, -*-Text-*- 1.5 -produced by `texinfo-format-buffer' 1.6 -from file `yahtmle.tex' 1.7 -using `texinfmt.el' version 2.38 of 3 July 1998. 1.8 - 1.9 - 1.10 - 1.11 - 1.12 - 1.13 - 1.14 -File: yahtmle, Node: Top, Next: Intro, Prev: (dir), Up: (dir) 1.15 - 1.16 -* Menu: 1.17 - 1.18 -* Intro:: Introduction 1.19 -* Installation:: Installing yahtml 1.20 -* Command Invocation:: Using External Commands 1.21 -* Completion:: Input with Completion 1.22 -* Jump:: Moving the Cursor 1.23 -* Changing and Deleting:: Changing and Deleting 1.24 -* CSS Support:: Style Sheet Support 1.25 -* Customizations:: List of Customize Variables 1.26 -* Copying:: Copyright 1.27 -* Concept Index:: Index 1.28 - 1.29 - 1.30 - 1.31 -File: yahtmle, Node: Intro, Next: Installation, Prev: Top, Up: Top 1.32 - 1.33 -Introduction 1.34 -************ 1.35 - 1.36 -yahtml is a package to support creating HTML documents on Emacsens. Easy 1.37 -input of elements (tags) by completion, syntax checking with programs like 1.38 -weblint, and invoking the appropriate browser or image viewer depending on 1.39 -the cursor position is its main features. 1.40 - 1.41 -(This Info is still incomplete) 1.42 - 1.43 - 1.44 - 1.45 -File: yahtmle, Node: Installation, Next: Command Invocation, Prev: Intro, Up: Top 1.46 - 1.47 -Installing yahtml 1.48 -***************** 1.49 -* Menu: 1.50 - 1.51 -* Setting up yahtml:: 1.52 -* Setting environments for weblint browsers and image viewers:: 1.53 -* Setting environment variables for WWW pages:: 1.54 - 1.55 - 1.56 - 1.57 -File: yahtmle, Node: Setting up yahtml, Next: Setting environments for weblint browsers and image viewers, Prev: Installation, Up: Installation 1.58 - 1.59 -Setting up yahtml 1.60 -================= 1.61 - 1.62 - 1.63 -Add the following to `~/.emacs' 1.64 - 1.65 - (setq auto-mode-alist 1.66 - (cons (cons "\\.html$" 'yahtml-mode) auto-mode-alist)) 1.67 - (autoload 'yahtml-mode "yahtml" "Yet Another HTML mode" t) 1.68 - 1.69 -Next, add to load-path the directory with the yahtml files (`yahtml.el', 1.70 -`yatexlib.el', `yatexprc.el'). For example, if you put them in 1.71 -`~/src/emacs/yahtml', 1.72 - 1.73 - (setq load-path (cons (expand-file-name "~/src/emacs/yahtml") load-path)) 1.74 - 1.75 -is what you add. 1.76 - 1.77 -By this, yahtml will be automatically loaded when editing files with .html 1.78 -extensions. "yahtml" will be displayed on the mode line if no errors 1.79 -occurred. 1.80 - 1.81 - 1.82 - 1.83 -File: yahtmle, Node: Setting environments for weblint browsers and image viewers, Next: Setting environment variables for WWW pages, Prev: Setting up yahtml, Up: Installation 1.84 - 1.85 -Setting environments for weblint, browsers, and image viewers 1.86 -============================================================= 1.87 - 1.88 -Check the variables for invoking external commands and modify as needed. 1.89 -Defaults are in parenthesis. 1.90 - 1.91 -`yahtml-www-browser' 1.92 - ... browser command name (netscape) 1.93 -`yahtml-image-viewer' 1.94 - ... image viewer command name (xv) 1.95 -`yahtml-lint-program' 1.96 - ... syntax check programs command name (jweblint) 1.97 -`yahtml-kanji-code' 1.98 - ... kanji code for HTML files 1.99 - 1.100 - 1.101 - 1.102 -File: yahtmle, Node: Setting environment variables for WWW pages, Prev: Setting environments for weblint browsers and image viewers, Up: Installation 1.103 - 1.104 -Setting environment variables for WWW pages 1.105 -=========================================== 1.106 - 1.107 -Variables regarding path names for files that will be your home page. 1.108 -`yahtml-path-url-alist' 1.109 - ... list of matching path name on file system and URLs 1.110 -`yahtml-directory-index' 1.111 - ... index file displayed when none is given in URL. Usually 1.112 - `index.html' on NCSA type httpd and `Welcome.html' on CERN types. 1.113 - 1.114 -Examples for `yahtml-path-url-alist'. If `/home/yuuji/http/' is 1.115 -`http://localhost/~yuuji' at home and `/usr/home/yuuji/www/' is 1.116 -`http://www.keio.ac.jp/~yuuji/' at work, then 1.117 - 1.118 - (setq yahtml-path-url-alist 1.119 - '(("/home/yuuji/http" . "http://localhost/~yuuji") 1.120 - ("/usr/home/yuuji/www" . "http://www.keio.ac.jp/~yuuji"))) 1.121 - 1.122 -Any number of additions can be made to this list. 1.123 - 1.124 - 1.125 - 1.126 -File: yahtmle, Node: Command Invocation, Next: Completion, Prev: Installation, Up: Top 1.127 - 1.128 -Invoking external commands 1.129 -************************** 1.130 - 1.131 -For easy use of commands that are handy when editing HTML files. 1.132 -`[prefix] t j' 1.133 - ... Invoke HTML syntax checker (jweblint) 1.134 -`[prefix] t p' 1.135 - ... Display current page in browser 1.136 -`[prefix] t r' 1.137 - ... Reload current page if browser is already running 1.138 - 1.139 - 1.140 - 1.141 -File: yahtmle, Node: Completion, Next: Jump, Prev: Command Invocation, Up: Top 1.142 - 1.143 -Completion Input 1.144 -**************** 1.145 - 1.146 -Completion input of HTML elements is done through the same key strokes as 1.147 -YaTeX's begin-type completion, section-type completion, large-type 1.148 -completion, maketitle-type completion, and accent completion. 1.149 -Corresponding elements in this order is; elements that span multiple 1.150 -lines, empty elements such as img, tags that start and end in a single 1.151 -line, elements with no attributes or contents, and special or symbol 1.152 -entities. 1.153 - 1.154 -`[prefix] b (YaTeX begin-type completion)' 1.155 - ... 1.156 - <ul> 1.157 - </ul> 1.158 - 1.159 - Completion for elements that the start tag and the end tag span 1.160 - multiple lines. Mostly block-level elements. 1.161 - 1.162 -`[prefix] s (YateX section-type completion)' 1.163 - ... 1.164 - <img src="foo.gif" alt="photo"> 1.165 - 1.166 - Completion for elements that do not have end tags and require only 1.167 - attributes. Possible completions are, <img>, <input>. 1.168 - 1.169 -`[prefix] l (YaTeX large-type completion)' 1.170 - ... 1.171 - 1.172 - <big> $B!A(B </big> 1.173 - 1.174 - Similar to begin-type completion but used for elements that start and 1.175 - end on a single line. 1.176 - 1.177 - 1.178 -`[prefix] m (YaTeX maketitle-type completion)' 1.179 - ... Completion for elements without attributes or contents. Possible 1.180 - completion is <br> 1.181 - 1.182 -`[prefix] a (YaTeX accent completion)' 1.183 - ... Used to enter special or symbol entities. By default completion 1.184 - for < (<), > (>), & (&), " ("), ' ('), blank 1.185 - ( ) is possible. 1.186 - 1.187 - 1.188 - 1.189 -File: yahtmle, Node: Jump, Next: Changing and Deleting, Prev: Completion, Up: Top 1.190 - 1.191 -Cursor Movement 1.192 -*************** 1.193 -By using 1.194 - 1.195 -`[prefix] g' 1.196 - ... move to corresponding object 1.197 - 1.198 -the cursor will go to the corresponding object according to the context. 1.199 -Recognized contexts are 1.200 - 1.201 - * `<TAG>' <--> `</TAG>' 1.202 - * `<img src="image.file">' -> invoke viewer 1.203 - * `<a href="link.to.somewhere">' -> move cursor to linked target 1.204 - * `<applet code="program">' -> open Java source 1.205 - 1.206 - 1.207 - 1.208 -File: yahtmle, Node: Changing and Deleting, Next: CSS Support, Prev: Jump, Up: Top 1.209 - 1.210 -Changing and Deleting 1.211 -********************* 1.212 - 1.213 -* Menu: 1.214 - 1.215 -* Changing tags in pairs:: 1.216 -* Changing entities:: 1.217 -* URLencoding of strings within region:: 1.218 - 1.219 - 1.220 - 1.221 -File: yahtmle, Node: Changing tags in pairs, Next: Changing entities, Prev: Changing and Deleting, Up: Changing and Deleting 1.222 - 1.223 -Changing tags in pairs 1.224 -====================== 1.225 -By using 1.226 - 1.227 -`[prefix] c' 1.228 - ... change tags in matching pairs 1.229 - 1.230 -the content can be changed according to the context of the HTML document 1.231 -where the cursor is located. 1.232 - 1.233 - * `<TAG>'$B!A(B`</TAG>' 1.234 - ... change `TAG' element name 1.235 - * attributes such as `<img src="image.file" alt="photo">' 1.236 - ... change attributes 1.237 - 1.238 - 1.239 - 1.240 -File: yahtmle, Node: Changing entities, Next: URLencoding of strings within region, Prev: Changing tags in pairs, Up: Changing and Deleting 1.241 - 1.242 -Changing entities 1.243 -================= 1.244 -Special characters such as < or > must be written as < and >. Easy 1.245 -conversion of these characters can be done when importing text from non 1.246 -HTML files. 1.247 - 1.248 - 1.249 -`[prefix] ;' 1.250 - ... convert char to special entity in marked region 1.251 -`[prefix] :' 1.252 - ... convert special entity to original char in marked region 1.253 - (reverse of [prefix] ;) 1.254 - 1.255 - 1.256 - 1.257 - 1.258 -File: yahtmle, Node: URLencoding of strings within region, Next: td-enclosure/tr-enclosure, Prev: Changing entities, Up: Changing and Deleting 1.259 - 1.260 -URLencoding of strings within region 1.261 -==================================== 1.262 - 1.263 -`[prefix] #' 1.264 - ... encode chars that needs to be URLencoded within region 1.265 - 1.266 - 1.267 - 1.268 -File: yahtmle, Node: td-enclosure/tr-enclosure, Prev: URLencoding of strings within region, Up: Changing and Deleting 1.269 - 1.270 -td-enclosure/tr-enclosure 1.271 -========================= 1.272 -If you wan to convert series of field into <td>...</td> repetitions for 1.273 -table element, td-enclosure or tr-enclosure is convenient. 1.274 - 1.275 - `[prefix] '} 1.276 - 1.277 - ... Enclose each field in a region into <td>...</td>'s. 1.278 - `[prefix] ]' 1.279 - 1.280 - ... Enclose each line in a region into <tr>...</tr>'s, with every 1.281 -line converted to <td>...</td> repetition. They presume white space as 1.282 -field separator by default. To change this, enter other delimiting 1.283 -character for a query. You can convert CSV, for example, into table by 1.284 -specifying comma(,) as a delimiter. 1.285 - 1.286 -If you want to enclose fields with th, call with universal-argument 1.287 -(`C-u'). Enter `th' to enclose fields with <th>...</th>. The special 1.288 -answer `thd' means that enclose the only first column with th, and the 1.289 -rest with td. 1.290 - 1.291 - 1.292 - 1.293 -File: yahtmle, Node: CSS Support, Next: Customizations, Prev: Changing and Deleting, Up: Top 1.294 - 1.295 -CSS(Style Sheets) Support 1.296 -************************* 1.297 - 1.298 -* Menu: 1.299 - 1.300 -* CSS-class completion:: 1.301 -* Reread CSS definition:: 1.302 - 1.303 - 1.304 - 1.305 -File: yahtmle, Node: CSS-class completion, Next: Reread CSS definition, Prev: CSS Support, Up: CSS Support 1.306 - 1.307 -CSS class-name completion 1.308 -========================= 1.309 -You can input a class name in your CSS definition with completion. If you 1.310 -have CSS defined as below; 1.311 - 1.312 - h1.foo, h2.foo { background-color: 0xffffff; } 1.313 - h1.bar, h2.bar { font-size: 120%; } 1.314 - 1.315 -when you input h1(or h2) tag with completing-read by [prefix] b or 1.316 -[prefix] l, yahtml prompts you to input class name with completion from 1.317 -the words which are effective to h1 or h2. And if you defined global 1.318 -class like this; 1.319 - 1.320 - .caution { font-size: 120%; background-color: 0xc00000;} 1.321 - 1.322 -when you input any tags via completing-read, yahtml prompts you to input 1.323 -class name. If this is bothering, typing `C-j' instead of `RET' (or 1.324 -`C-m') cancels the next prompt to class name completion. 1.325 - 1.326 - 1.327 - 1.328 -File: yahtmle, Node: Reread CSS definition, Prev: CSS-class completion, Up: CSS Support 1.329 - 1.330 -Re-reading CSS definition 1.331 -========================= 1.332 -If you add some class to your CSS file and you want yahtml to load new 1.333 -definitions, type `M-x yahtml-mode RET' to make yahtml do. 1.334 - 1.335 - 1.336 - 1.337 -File: yahtmle, Node: Customizations, Next: Copying, Prev: CSS Support, Up: Top 1.338 - 1.339 -Customizations 1.340 -************** 1.341 - 1.342 -Variables that modify yahtml's behavior. 1.343 - 1.344 -* Menu: 1.345 - 1.346 -* All customizable variables:: List of customizable variables 1.347 -* Hook variables:: hook variables 1.348 - 1.349 - 1.350 - 1.351 -File: yahtmle, Node: All customizable variables, Next: Hook variables, Prev: Customizations, Up: Customizations 1.352 - 1.353 -List of customizable variables. Defaults in parenthesis 1.354 -======================================================== 1.355 - 1.356 - -- Variable: yahtml-prefix 1.357 - Prefix key for yahtml-mode. (`\C-c') 1.358 - 1.359 - -- Variable: yahtml-image-viewer 1.360 - Command to view image files refered by img. (xv) 1.361 - 1.362 - -- Variable: yahtml-www-browser 1.363 - Browser to view external pages with `[prefix]g'. (netscape) 1.364 - 1.365 - -- Variable: yahtml-kanji-code 1.366 - Default kanji code. 1=sjis, 2=jis, 3=euc, 4=utf-8 (2) If AddType 1.367 - "text/html; charset=xxx" .html is written in .htaccess, this will 1.368 - override yahtml-kanji-code. 1.369 - 1.370 - -- Variable: yahtml-fill-column 1.371 - Columns to auto-fill (72) 1.372 - 1.373 - -- Variable: yahtml-fill-prefix 1.374 - fill-prefix specific to yahtml-mode. (`nil') 1.375 - 1.376 - -- Variable: yahtml-path-url-alist 1.377 - Matching list of URL and full path name on OS's file system. 1.378 - 1.379 - -- Variable: yahtml-directory-index 1.380 - Default index filed opened when accessing a server without a 1.381 - filename, usually index.html. (`"index.html"') 1.382 - 1.383 - -- Variable: yahtml-lint-program 1.384 - HTML syntax check program. (`"jweblint"') 1.385 - 1.386 - -- Variable: yahtml-hate-too-deep-indentation 1.387 - setq to t when indentations for nested enumerate elements are too 1.388 - deep. (`nil') 1.389 - 1.390 - -- Variable: yahtml-always-/p 1.391 - setq to t if you always want `</p>' after `</p>'. `nil' 1.392 - 1.393 - -- Variable: yahtml-p-prefered-env-regexp 1.394 - Elements that `<p>' will be automatically inserted. 1.395 - (`"^\\(body\\|dl\\|blockquote\\)"') 1.396 - 1.397 - -- Variable: yahtml-template-file 1.398 - File to automatically insert when editing a new HTML file. 1.399 - `"~/http/template.html"' 1.400 - 1.401 - -- Variable: yahtml-prefer-upcases 1.402 - Use uppercase for tags. `nil' 1.403 - 1.404 - -- Variable: yahtml-prefer-upcase-attributes 1.405 - Use uppercase for attributes. `nil' 1.406 - 1.407 - -- Variable: yahtml-server-type 1.408 - setq to 'apache if using a Apache server, and will refer ./.htaccess. 1.409 - `'apache' 1.410 - 1.411 - -- Variable: yahtml-apache-access-file 1.412 - When `yahtml-server-type' is `'apache', define name of access 1.413 - restriction file. `".htaccess"' 1.414 - 1.415 - -- Variable: yahtml-shell-command-option 1.416 - Options needed to invoke shell commands. 1.417 - 1.418 - -- Variable: yahtml-translate-hyphens-when-comment-region 1.419 - Whether to change hyphens to `-' when commenting out region. 1.420 - (`t') 1.421 - 1.422 - -- Variable: yahtml-entity-reference-chars-alist 1.423 - alist of characters that needs to be written by Entity Reference. 1.424 - Enter as `'(?char . "EntityReference")'. By default, `<', `>', `&', 1.425 - `'', is set. Add as needed. Do not include `&' at beginning and `;' 1.426 - at end of cdr portion of `"EntityReference"'. 1.427 - 1.428 - -- Variable: yahtml-faithful-to-htmllint 1.429 - When using htmllint to check syntax, it will complain about excess 1.430 - spaces. setq to `t' to avoid this. 1.431 - 1.432 - -- Variable: yahtml-use-css 1.433 - Use style-sheet support or not (`t') 1.434 - 1.435 - -- Variable: yahtml-image-inspection-bytes 1.436 - Number of bytes to inspect the image for geometry information 1.437 - (`10000') 1.438 - 1.439 - -- Variable: yahtml:img-default-alt-format 1.440 - format of img entity's ALT attributes. %x: width, %y: height, %s: 1.441 - size in bytes, %c: first comment string, %f: filename 1.442 - (`"%xx%y(%sbytes)"') 1.443 - 1.444 - -- Variable: yahtml-escape-chars 1.445 - When, completing href-s, Escape reserved characters to URL-encoding 1.446 - or not. Nil for never, t for everytime, and 'ask for inquiring at 1.447 - each reserved chars. (`'ask') 1.448 - 1.449 - -- Variable: yahtml-use-font-lock 1.450 - Use font-lock to fontify buffer or not (`(featurep 'font-lock)') 1.451 - 1.452 - -- Variable: yahtml-use-hilit19 1.453 - Use hilit19 to highlight buffer or not (`(featurep 'hilit19)') 1.454 - 1.455 - -- Variable: yahtml-indentation-boundary 1.456 - Boundary regexp for indentation calculation. (`"^\\s *<h[1-3]>"') 1.457 - 1.458 - 1.459 - 1.460 -File: yahtmle, Node: Hook variables, Prev: All customizable variables, Up: Customizations 1.461 - 1.462 -hook variables 1.463 -============== 1.464 - 1.465 - 1.466 - 1.467 - 1.468 -File: yahtmle, Node: Copying, Next: Concept Index, Prev: Customizations, Up: Top 1.469 - 1.470 -Copying 1.471 -******* 1.472 - 1.473 -This program is distributed as freesoftware. The author will take no 1.474 -responsibility to any damages due to the usage of this software 1.475 -whatsoever. There are no restrictions to its redistribution, just use 1.476 -common sense. Mail me your thoughts on this program and I will be more 1.477 -than willing to help. 1.478 - 1.479 -Complaints, requests, bug reports and comments are welcome. Make contacts 1.480 -to yuuji@yatex.org$B!!(B(as of December 2000) 1.481 - 1.482 -If you like this program and use it on a regular basis, please join the 1.483 -mailing list "fj Wild Bird Society". Procedures can be found in the "etc" 1.484 -section of `docs/htmlqa.eng' in this package. 1.485 - 1.486 - 1.487 - HIROSE, Yuuji 1.488 - 1.489 - 1.490 - 1.491 - 1.492 -File: yahtmle, Node: Concept Index, Prev: Copying, Up: Top 1.493 - 1.494 -Index 1.495 -***** 1.496 - 1.497 -* Menu: 1.498 - 1.499 -* Customize: Customizations. 4. 1.500 -* Demacs: Intro. 4. 1.501 -* Key Assign: Customizations. 4. 1.502 -* LaTeX: Intro. 4. 1.503 -* Mule: Intro. 4. 1.504 -* yahtml: Intro. 4. 1.505 - 1.506 - 1.507 - 1.508 - 1.509 - 1.510 -Tag table: 1.511 -Node: Top148 1.512 -Node: Intro725 1.513 -Node: Installation1123 1.514 -Node: Setting up yahtml1404 1.515 -Node: Setting environments for weblint browsers and image viewers2195 1.516 -Node: Setting environment variables for WWW pages2891 1.517 -Node: Command Invocation3862 1.518 -Node: Completion4290 1.519 -Node: Jump5807 1.520 -Node: Changing and Deleting6287 1.521 -Node: Changing tags in pairs6538 1.522 -Node: Changing entities7033 1.523 -Node: URLencoding of strings within region7569 1.524 -Node: td-enclosure/tr-enclosure7870 1.525 -Node: CSS Support8836 1.526 -Node: CSS-class completion9062 1.527 -Node: Reread CSS definition9915 1.528 -Node: Customizations10190 1.529 -Node: All customizable variables10466 1.530 -Node: Hook variables14234 1.531 -Node: Copying14360 1.532 -Node: Concept Index15151 1.533 - 1.534 -End tag table 1.535 +Info file: yahtmle, -*-Text-*- 1.536 +produced by `texinfo-format-buffer' 1.537 +from file `yahtmle.tex' 1.538 +using `texinfmt.el' version 2.38 of 3 July 1998. 1.539 + 1.540 + 1.541 + 1.542 + 1.543 + 1.544 + 1.545 +File: yahtmle, Node: Top, Next: Intro, Prev: (dir), Up: (dir) 1.546 + 1.547 +* Menu: 1.548 + 1.549 +* Intro:: Introduction 1.550 +* Installation:: Installing yahtml 1.551 +* Command Invocation:: Using External Commands 1.552 +* Completion:: Input with Completion 1.553 +* Jump:: Moving the Cursor 1.554 +* Changing and Deleting:: Changing and Deleting 1.555 +* CSS Support:: Style Sheet Support 1.556 +* Customizations:: List of Customize Variables 1.557 +* Copying:: Copyright 1.558 +* Concept Index:: Index 1.559 + 1.560 + 1.561 + 1.562 +File: yahtmle, Node: Intro, Next: Installation, Prev: Top, Up: Top 1.563 + 1.564 +Introduction 1.565 +************ 1.566 + 1.567 +yahtml is a package to support creating HTML documents on Emacsens. Easy 1.568 +input of elements (tags) by completion, syntax checking with programs like 1.569 +weblint, and invoking the appropriate browser or image viewer depending on 1.570 +the cursor position is its main features. 1.571 + 1.572 +(This Info is still incomplete) 1.573 + 1.574 + 1.575 + 1.576 +File: yahtmle, Node: Installation, Next: Command Invocation, Prev: Intro, Up: Top 1.577 + 1.578 +Installing yahtml 1.579 +***************** 1.580 +* Menu: 1.581 + 1.582 +* Setting up yahtml:: 1.583 +* Setting environments for weblint browsers and image viewers:: 1.584 +* Setting environment variables for WWW pages:: 1.585 + 1.586 + 1.587 + 1.588 +File: yahtmle, Node: Setting up yahtml, Next: Setting environments for weblint browsers and image viewers, Prev: Installation, Up: Installation 1.589 + 1.590 +Setting up yahtml 1.591 +================= 1.592 + 1.593 + 1.594 +Add the following to `~/.emacs' 1.595 + 1.596 + (setq auto-mode-alist 1.597 + (cons (cons "\\.html$" 'yahtml-mode) auto-mode-alist)) 1.598 + (autoload 'yahtml-mode "yahtml" "Yet Another HTML mode" t) 1.599 + 1.600 +Next, add to load-path the directory with the yahtml files (`yahtml.el', 1.601 +`yatexlib.el', `yatexprc.el'). For example, if you put them in 1.602 +`~/src/emacs/yahtml', 1.603 + 1.604 + (setq load-path (cons (expand-file-name "~/src/emacs/yahtml") load-path)) 1.605 + 1.606 +is what you add. 1.607 + 1.608 +By this, yahtml will be automatically loaded when editing files with .html 1.609 +extensions. "yahtml" will be displayed on the mode line if no errors 1.610 +occurred. 1.611 + 1.612 + 1.613 + 1.614 +File: yahtmle, Node: Setting environments for weblint browsers and image viewers, Next: Setting environment variables for WWW pages, Prev: Setting up yahtml, Up: Installation 1.615 + 1.616 +Setting environments for weblint, browsers, and image viewers 1.617 +============================================================= 1.618 + 1.619 +Check the variables for invoking external commands and modify as needed. 1.620 +Defaults are in parenthesis. 1.621 + 1.622 +`yahtml-www-browser' 1.623 + ... browser command name (netscape) 1.624 +`yahtml-image-viewer' 1.625 + ... image viewer command name (xv) 1.626 +`yahtml-lint-program' 1.627 + ... syntax check programs command name (jweblint) 1.628 +`yahtml-kanji-code' 1.629 + ... kanji code for HTML files 1.630 + 1.631 + 1.632 + 1.633 +File: yahtmle, Node: Setting environment variables for WWW pages, Prev: Setting environments for weblint browsers and image viewers, Up: Installation 1.634 + 1.635 +Setting environment variables for WWW pages 1.636 +=========================================== 1.637 + 1.638 +Variables regarding path names for files that will be your home page. 1.639 +`yahtml-path-url-alist' 1.640 + ... list of matching path name on file system and URLs 1.641 +`yahtml-directory-index' 1.642 + ... index file displayed when none is given in URL. Usually 1.643 + `index.html' on NCSA type httpd and `Welcome.html' on CERN types. 1.644 + 1.645 +Examples for `yahtml-path-url-alist'. If `/home/yuuji/http/' is 1.646 +`http://localhost/~yuuji' at home and `/usr/home/yuuji/www/' is 1.647 +`http://www.keio.ac.jp/~yuuji/' at work, then 1.648 + 1.649 + (setq yahtml-path-url-alist 1.650 + '(("/home/yuuji/http" . "http://localhost/~yuuji") 1.651 + ("/usr/home/yuuji/www" . "http://www.keio.ac.jp/~yuuji"))) 1.652 + 1.653 +Any number of additions can be made to this list. 1.654 + 1.655 + 1.656 + 1.657 +File: yahtmle, Node: Command Invocation, Next: Completion, Prev: Installation, Up: Top 1.658 + 1.659 +Invoking external commands 1.660 +************************** 1.661 + 1.662 +For easy use of commands that are handy when editing HTML files. 1.663 +`[prefix] t j' 1.664 + ... Invoke HTML syntax checker (jweblint) 1.665 +`[prefix] t p' 1.666 + ... Display current page in browser 1.667 +`[prefix] t r' 1.668 + ... Reload current page if browser is already running 1.669 + 1.670 + 1.671 + 1.672 +File: yahtmle, Node: Completion, Next: Jump, Prev: Command Invocation, Up: Top 1.673 + 1.674 +Completion Input 1.675 +**************** 1.676 + 1.677 +Completion input of HTML elements is done through the same key strokes as 1.678 +YaTeX's begin-type completion, section-type completion, large-type 1.679 +completion, maketitle-type completion, and accent completion. 1.680 +Corresponding elements in this order is; elements that span multiple 1.681 +lines, empty elements such as img, tags that start and end in a single 1.682 +line, elements with no attributes or contents, and special or symbol 1.683 +entities. 1.684 + 1.685 +`[prefix] b (YaTeX begin-type completion)' 1.686 + ... 1.687 + <ul> 1.688 + </ul> 1.689 + 1.690 + Completion for elements that the start tag and the end tag span 1.691 + multiple lines. Mostly block-level elements. 1.692 + 1.693 +`[prefix] s (YateX section-type completion)' 1.694 + ... 1.695 + <img src="foo.gif" alt="photo"> 1.696 + 1.697 + Completion for elements that do not have end tags and require only 1.698 + attributes. Possible completions are, <img>, <input>. 1.699 + 1.700 +`[prefix] l (YaTeX large-type completion)' 1.701 + ... 1.702 + 1.703 + <big> ` </big> 1.704 + 1.705 + Similar to begin-type completion but used for elements that start and 1.706 + end on a single line. 1.707 + 1.708 + 1.709 +`[prefix] m (YaTeX maketitle-type completion)' 1.710 + ... Completion for elements without attributes or contents. Possible 1.711 + completion is <br> 1.712 + 1.713 +`[prefix] a (YaTeX accent completion)' 1.714 + ... Used to enter special or symbol entities. By default completion 1.715 + for < (<), > (>), & (&), " ("), ' ('), blank 1.716 + ( ) is possible. 1.717 + 1.718 + 1.719 + 1.720 +File: yahtmle, Node: Jump, Next: Changing and Deleting, Prev: Completion, Up: Top 1.721 + 1.722 +Cursor Movement 1.723 +*************** 1.724 +By using 1.725 + 1.726 +`[prefix] g' 1.727 + ... move to corresponding object 1.728 + 1.729 +the cursor will go to the corresponding object according to the context. 1.730 +Recognized contexts are 1.731 + 1.732 + * `<TAG>' <--> `</TAG>' 1.733 + * `<img src="image.file">' -> invoke viewer 1.734 + * `<a href="link.to.somewhere">' -> move cursor to linked target 1.735 + * `<applet code="program">' -> open Java source 1.736 + 1.737 + 1.738 + 1.739 +File: yahtmle, Node: Changing and Deleting, Next: CSS Support, Prev: Jump, Up: Top 1.740 + 1.741 +Changing and Deleting 1.742 +********************* 1.743 + 1.744 +* Menu: 1.745 + 1.746 +* Changing tags in pairs:: 1.747 +* Changing entities:: 1.748 +* URLencoding of strings within region:: 1.749 +* td-enclosure/tr-enclosure:: 1.750 + 1.751 + 1.752 + 1.753 +File: yahtmle, Node: Changing tags in pairs, Next: Changing entities, Prev: Changing and Deleting, Up: Changing and Deleting 1.754 + 1.755 +Changing tags in pairs 1.756 +====================== 1.757 +By using 1.758 + 1.759 +`[prefix] c' 1.760 + ... change tags in matching pairs 1.761 + 1.762 +the content can be changed according to the context of the HTML document 1.763 +where the cursor is located. 1.764 + 1.765 + * `<TAG>'``</TAG>' 1.766 + ... change `TAG' element name 1.767 + * attributes such as `<img src="image.file" alt="photo">' 1.768 + ... change attributes 1.769 + 1.770 + 1.771 + 1.772 +File: yahtmle, Node: Changing entities, Next: URLencoding of strings within region, Prev: Changing tags in pairs, Up: Changing and Deleting 1.773 + 1.774 +Changing entities 1.775 +================= 1.776 +Special characters such as < or > must be written as < and >. Easy 1.777 +conversion of these characters can be done when importing text from non 1.778 +HTML files. 1.779 + 1.780 + 1.781 +`[prefix] ;' 1.782 + ... convert char to special entity in marked region 1.783 +`[prefix] :' 1.784 + ... convert special entity to original char in marked region 1.785 + (reverse of [prefix] ;) 1.786 + 1.787 + 1.788 + 1.789 + 1.790 +File: yahtmle, Node: URLencoding of strings within region, Next: td-enclosure/tr-enclosure, Prev: Changing entities, Up: Changing and Deleting 1.791 + 1.792 +URLencoding of strings within region 1.793 +==================================== 1.794 + 1.795 +`[prefix] #' 1.796 + ... encode chars that needs to be URLencoded within region 1.797 + 1.798 + 1.799 + 1.800 +File: yahtmle, Node: td-enclosure/tr-enclosure, Prev: URLencoding of strings within region, Up: Changing and Deleting 1.801 + 1.802 +td-enclosure/tr-enclosure 1.803 +========================= 1.804 +If you wan to convert series of field into <td>...</td> repetitions for 1.805 +table element, td-enclosure or tr-enclosure is convenient. 1.806 + 1.807 + `[prefix] }' 1.808 + 1.809 + ... Enclose each field in a region into <td>...</td>'s. 1.810 + `[prefix] ]' 1.811 + 1.812 + ... Enclose each line in a region into <tr>...</tr>'s, with every 1.813 +line converted to <td>...</td> repetition. They presume white space as 1.814 +field separator by default. To change this, enter other delimiting 1.815 +character for a query. You can convert CSV, for example, into table by 1.816 +specifying comma(,) as a delimiter. 1.817 + 1.818 +If you want to enclose fields with th, call with universal-argument 1.819 +(`C-u'). Enter `th' to enclose fields with <th>...</th>. The special 1.820 +answer `thd' means that enclose the only first column with th, and the 1.821 +rest with td. 1.822 + 1.823 + 1.824 + 1.825 +File: yahtmle, Node: CSS Support, Next: Customizations, Prev: Changing and Deleting, Up: Top 1.826 + 1.827 +CSS(Style Sheets) Support 1.828 +************************* 1.829 + 1.830 +* Menu: 1.831 + 1.832 +* CSS-class completion:: 1.833 +* Reread CSS definition:: 1.834 + 1.835 + 1.836 + 1.837 +File: yahtmle, Node: CSS-class completion, Next: Reread CSS definition, Prev: CSS Support, Up: CSS Support 1.838 + 1.839 +CSS class-name completion 1.840 +========================= 1.841 +You can input a class name in your CSS definition with completion. If you 1.842 +have CSS defined as below; 1.843 + 1.844 + h1.foo, h2.foo { background-color: 0xffffff; } 1.845 + h1.bar, h2.bar { font-size: 120%; } 1.846 + 1.847 +when you input h1(or h2) tag with completing-read by [prefix] b or 1.848 +[prefix] l, yahtml prompts you to input class name with completion from 1.849 +the words which are effective to h1 or h2. And if you defined global 1.850 +class like this; 1.851 + 1.852 + .caution { font-size: 120%; background-color: 0xc00000;} 1.853 + 1.854 +when you input any tags via completing-read, yahtml prompts you to input 1.855 +class name. If this is bothering, typing `C-j' instead of `RET' (or 1.856 +`C-m') cancels the next prompt to class name completion. 1.857 + 1.858 + 1.859 + 1.860 +File: yahtmle, Node: Reread CSS definition, Prev: CSS-class completion, Up: CSS Support 1.861 + 1.862 +Re-reading CSS definition 1.863 +========================= 1.864 +If you add some class to your CSS file and you want yahtml to load new 1.865 +definitions, type `M-x yahtml-mode RET' to make yahtml do. 1.866 + 1.867 + 1.868 + 1.869 +File: yahtmle, Node: Customizations, Next: Copying, Prev: CSS Support, Up: Top 1.870 + 1.871 +Customizations 1.872 +************** 1.873 + 1.874 +Variables that modify yahtml's behavior. 1.875 + 1.876 +* Menu: 1.877 + 1.878 +* All customizable variables:: List of customizable variables 1.879 +* Hook variables:: hook variables 1.880 + 1.881 + 1.882 + 1.883 +File: yahtmle, Node: All customizable variables, Next: Hook variables, Prev: Customizations, Up: Customizations 1.884 + 1.885 +List of customizable variables. Defaults in parenthesis 1.886 +======================================================== 1.887 + 1.888 + -- Variable: yahtml-prefix 1.889 + Prefix key for yahtml-mode. (`\C-c') 1.890 + 1.891 + -- Variable: yahtml-image-viewer 1.892 + Command to view image files refered by img. (xv) 1.893 + 1.894 + -- Variable: yahtml-www-browser 1.895 + Browser to view external pages with `[prefix]g'. (netscape) 1.896 + 1.897 + -- Variable: yahtml-kanji-code 1.898 + Default kanji code. 1=sjis, 2=jis, 3=euc, 4=utf-8 (2) If AddType 1.899 + "text/html; charset=xxx" .html is written in .htaccess, this will 1.900 + override yahtml-kanji-code. 1.901 + 1.902 + -- Variable: yahtml-fill-column 1.903 + Columns to auto-fill (72) 1.904 + 1.905 + -- Variable: yahtml-fill-prefix 1.906 + fill-prefix specific to yahtml-mode. (`nil') 1.907 + 1.908 + -- Variable: yahtml-path-url-alist 1.909 + Matching list of URL and full path name on OS's file system. 1.910 + 1.911 + -- Variable: yahtml-directory-index 1.912 + Default index filed opened when accessing a server without a 1.913 + filename, usually index.html. (`"index.html"') 1.914 + 1.915 + -- Variable: yahtml-lint-program 1.916 + HTML syntax check program. (`"jweblint"') 1.917 + 1.918 + -- Variable: yahtml-hate-too-deep-indentation 1.919 + setq to t when indentations for nested enumerate elements are too 1.920 + deep. (`nil') 1.921 + 1.922 + -- Variable: yahtml-always-/p 1.923 + setq to t if you always want `</p>' after `</p>'. `nil' 1.924 + 1.925 + -- Variable: yahtml-p-prefered-env-regexp 1.926 + Elements that `<p>' will be automatically inserted. 1.927 + (`"^\\(body\\|dl\\|blockquote\\)"') 1.928 + 1.929 + -- Variable: yahtml-template-file 1.930 + File to automatically insert when editing a new HTML file. 1.931 + `"~/http/template.html"' 1.932 + 1.933 + -- Variable: yahtml-prefer-upcases 1.934 + Use uppercase for tags. `nil' 1.935 + 1.936 + -- Variable: yahtml-prefer-upcase-attributes 1.937 + Use uppercase for attributes. `nil' 1.938 + 1.939 + -- Variable: yahtml-server-type 1.940 + setq to 'apache if using a Apache server, and will refer ./.htaccess. 1.941 + `'apache' 1.942 + 1.943 + -- Variable: yahtml-apache-access-file 1.944 + When `yahtml-server-type' is `'apache', define name of access 1.945 + restriction file. `".htaccess"' 1.946 + 1.947 + -- Variable: yahtml-shell-command-option 1.948 + Options needed to invoke shell commands. 1.949 + 1.950 + -- Variable: yahtml-translate-hyphens-when-comment-region 1.951 + Whether to change hyphens to `-' when commenting out region. 1.952 + (`t') 1.953 + 1.954 + -- Variable: yahtml-entity-reference-chars-alist 1.955 + alist of characters that needs to be written by Entity Reference. 1.956 + Enter as `'(?char . "EntityReference")'. By default, `<', `>', `&', 1.957 + `'', is set. Add as needed. Do not include `&' at beginning and `;' 1.958 + at end of cdr portion of `"EntityReference"'. 1.959 + 1.960 + -- Variable: yahtml-faithful-to-htmllint 1.961 + When using htmllint to check syntax, it will complain about excess 1.962 + spaces. setq to `t' to avoid this. 1.963 + 1.964 + -- Variable: yahtml-use-css 1.965 + Use style-sheet support or not (`t') 1.966 + 1.967 + -- Variable: yahtml-image-inspection-bytes 1.968 + Number of bytes to inspect the image for geometry information 1.969 + (`10000') 1.970 + 1.971 + -- Variable: yahtml:img-default-alt-format 1.972 + format of img entity's ALT attributes. %x: width, %y: height, %s: 1.973 + size in bytes, %c: first comment string, %f: filename 1.974 + (`"%xx%y(%sbytes)"') 1.975 + 1.976 + -- Variable: yahtml-escape-chars 1.977 + When, completing href-s, Escape reserved characters to URL-encoding 1.978 + or not. Nil for never, t for everytime, and 'ask for inquiring at 1.979 + each reserved chars. (`'ask') 1.980 + 1.981 + -- Variable: yahtml-use-font-lock 1.982 + Use font-lock to fontify buffer or not (`(featurep 'font-lock)') 1.983 + 1.984 + -- Variable: yahtml-use-hilit19 1.985 + Use hilit19 to highlight buffer or not (`(featurep 'hilit19)') 1.986 + 1.987 + -- Variable: yahtml-indentation-boundary 1.988 + Boundary regexp for indentation calculation. (`"^\\s *<h[1-3]>"') 1.989 + 1.990 + 1.991 + 1.992 +File: yahtmle, Node: Hook variables, Prev: All customizable variables, Up: Customizations 1.993 + 1.994 +hook variables 1.995 +============== 1.996 + 1.997 + 1.998 + 1.999 + 1.1000 +File: yahtmle, Node: Copying, Next: Concept Index, Prev: Customizations, Up: Top 1.1001 + 1.1002 +Copying 1.1003 +******* 1.1004 + 1.1005 +This program is distributed as freesoftware. The author will take no 1.1006 +responsibility to any damages due to the usage of this software 1.1007 +whatsoever. There are no restrictions to its redistribution, just use 1.1008 +common sense. Mail me your thoughts on this program and I will be more 1.1009 +than willing to help. 1.1010 + 1.1011 +Complaints, requests, bug reports and comments are welcome. Make contacts 1.1012 +to yuuji@yatex.org@(as of December 2000) 1.1013 + 1.1014 +If you like this program and use it on a regular basis, please join the 1.1015 +mailing list "fj Wild Bird Society". Procedures can be found in the "etc" 1.1016 +section of `docs/htmlqa.eng' in this package. 1.1017 + 1.1018 + 1.1019 + HIROSE, Yuuji 1.1020 + 1.1021 + 1.1022 + 1.1023 + 1.1024 +File: yahtmle, Node: Concept Index, Prev: Copying, Up: Top 1.1025 + 1.1026 +Index 1.1027 +***** 1.1028 + 1.1029 +* Menu: 1.1030 + 1.1031 +* Customize: Customizations. 4. 1.1032 +* Demacs: Intro. 4. 1.1033 +* Key Assign: Customizations. 4. 1.1034 +* LaTeX: Intro. 4. 1.1035 +* Mule: Intro. 4. 1.1036 +* yahtml: Intro. 4. 1.1037 + 1.1038 + 1.1039 + 1.1040 + 1.1041 +Tag table: 1.1042 +Node: Top151 1.1043 +Node: Intro728 1.1044 +Node: Installation1126 1.1045 +Node: Setting up yahtml1407 1.1046 +Node: Setting environments for weblint browsers and image viewers2198 1.1047 +Node: Setting environment variables for WWW pages2894 1.1048 +Node: Command Invocation3865 1.1049 +Node: Completion4293 1.1050 +Node: Jump5809 1.1051 +Node: Changing and Deleting6289 1.1052 +Node: Changing tags in pairs6573 1.1053 +Node: Changing entities7068 1.1054 +Node: URLencoding of strings within region7604 1.1055 +Node: td-enclosure/tr-enclosure7905 1.1056 +Node: CSS Support8871 1.1057 +Node: CSS-class completion9097 1.1058 +Node: Reread CSS definition9950 1.1059 +Node: Customizations10225 1.1060 +Node: All customizable variables10501 1.1061 +Node: Hook variables14269 1.1062 +Node: Copying14395 1.1063 +Node: Concept Index15186 1.1064 + 1.1065 +End tag table