1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/docs/yahtmle	Sun Sep 27 13:04:14 2009 +0000
     1.3 @@ -0,0 +1,459 @@
     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.32 of 19 November 1993.
     1.8 +
     1.9 +
    1.10 +
    1.11 +
    1.12 +
    1.13 +File: yahtmle, Node: Top, Next: Intro, Prev: (dir), Up: (dir)
    1.14 +
    1.15 +* Menu:
    1.16 +
    1.17 +* Intro::                       Introduction
    1.18 +* Installation::                Installing yahtml
    1.19 +* Command Invocation::          Using External Commands
    1.20 +* Completion::                  Input with Completion
    1.21 +* Jump::                        Moving the Cursor
    1.22 +* Changing and Deleting::       Changing and Deleting
    1.23 +* CSS Support::                 Style Sheet Support
    1.24 +* Customizations::              List of Customize Variables
    1.25 +* Copying::                     Copyright
    1.26 +* Concept Index::               Index
    1.27 +
    1.28 +
    1.29 +File: yahtmle, Node: Intro, Next: Installation, Prev: Top, Up: Top
    1.30 +
    1.31 +Introduction
    1.32 +************
    1.33 +
    1.34 +yahtml is a package to support creating HTML documents on Emacsens.  Easy
    1.35 +input of elements (tags) by completion, syntax checking with programs like
    1.36 +weblint, and invoking the appropriate browser or image viewer depending on
    1.37 +the cursor position is its main features.
    1.38 +
    1.39 +(This Info is still incomplete)
    1.40 +
    1.41 +
    1.42 +File: yahtmle, Node: Installation, Next: Command Invocation, Prev: Intro, Up: Top
    1.43 +
    1.44 +Installing yahtml
    1.45 +*****************
    1.46 +* Menu:
    1.47 +
    1.48 +* Setting up yahtml::           
    1.49 +* Setting environments for weblint browsers and image viewers::  
    1.50 +* Setting environment variables for WWW pages::  
    1.51 +
    1.52 +
    1.53 +File: yahtmle, Node: Setting up yahtml, Next: Setting environments for weblint browsers and image viewers, Prev: Installation, Up: Installation
    1.54 +
    1.55 +Setting up yahtml
    1.56 +=================
    1.57 +
    1.58 +
    1.59 +Add the following to `~/.emacs'
    1.60 +
    1.61 +     (setq auto-mode-alist
    1.62 +           (cons (cons "\\.html$" 'yahtml-mode) auto-mode-alist))
    1.63 +     (autoload 'yahtml-mode "yahtml" "Yet Another HTML mode" t)
    1.64 +
    1.65 +Next, add to load-path the directory with the yahtml files (`yahtml.el',
    1.66 +`yatexlib.el', `yatexprc.el').  For example, if you put them in
    1.67 +`~/src/emacs/yahtml',
    1.68 +
    1.69 +     (setq load-path (cons (expand-file-name "~/src/emacs/yahtml") load-path))
    1.70 +
    1.71 +is what you add.
    1.72 +
    1.73 +By this, yahtml will be automatically loaded when editing files with .html
    1.74 +extensions.  "yahtml" will be displayed on the mode line if no errors
    1.75 +occurred.
    1.76 +
    1.77 +
    1.78 +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.79 +
    1.80 +Setting environments for weblint, browsers, and image viewers
    1.81 +=============================================================
    1.82 +
    1.83 +Check the variables for invoking external commands and modify as needed.
    1.84 +Defaults are in parenthesis.
    1.85 +
    1.86 +`yahtml-www-browser'
    1.87 +             ... browser command name (netscape)
    1.88 +`yahtml-image-viewer'
    1.89 +             ... image viewer command name (xv)
    1.90 +`yahtml-lint-program'
    1.91 +             ... syntax check programs command name (jweblint)
    1.92 +`yahtml-kanji-code'
    1.93 +             ... kanji code for HTML files
    1.94 +
    1.95 +
    1.96 +File: yahtmle, Node: Setting environment variables for WWW pages, Prev: Setting environments for weblint browsers and image viewers, Up: Installation
    1.97 +
    1.98 +Setting environment variables for WWW pages
    1.99 +===========================================
   1.100 +
   1.101 +Variables regarding path names for files that will be your home page.
   1.102 +`yahtml-path-url-alist'
   1.103 +             ... list of matching path name on file system and URLs
   1.104 +`yahtml-directory-index'
   1.105 +             ... index file displayed when none is given in URL.  Usually
   1.106 +             `index.html' on NCSA type httpd and `Welcome.html' on
   1.107 +             CERN types.
   1.108 +
   1.109 +Examples for `yahtml-path-url-alist'.  If `/home/yuuji/http/' is
   1.110 +`http://localhost/~yuuji' at home and `/usr/home/yuuji/www/' is
   1.111 +`http://www.keio.ac.jp/~yuuji/' at work, then
   1.112 +
   1.113 +     (setq yahtml-path-url-alist
   1.114 +           '(("/home/yuuji/http" . "http://localhost/~yuuji")
   1.115 +             ("/usr/home/yuuji/www" . "http://www.keio.ac.jp/~yuuji")))
   1.116 +
   1.117 +Any number of additions can be made to this list.
   1.118 +
   1.119 +
   1.120 +File: yahtmle, Node: Command Invocation, Next: Completion, Prev: Installation, Up: Top
   1.121 +
   1.122 +Invoking external commands
   1.123 +**************************
   1.124 +
   1.125 +For easy use of commands that are handy when editing HTML files.
   1.126 +`[prefix] t j'
   1.127 +             ... Invoke HTML syntax checker (jweblint)
   1.128 +`[prefix] t p'
   1.129 +             ... Display current page in browser
   1.130 +`[prefix] t r'
   1.131 +             ... Reload current page if browser is already running
   1.132 +
   1.133 +
   1.134 +File: yahtmle, Node: Completion, Next: Jump, Prev: Command Invocation, Up: Top
   1.135 +
   1.136 +Completion Input
   1.137 +****************
   1.138 +
   1.139 +Completion input of HTML elements is done through the same key strokes as
   1.140 +YaTeX's begin-type completion, section-type completion, large-type
   1.141 +completion, maketitle-type completion, and accent completion.
   1.142 +Corresponding elements in this order is; elements that span multiple
   1.143 +lines, empty elements such as img, tags that start and end in a single
   1.144 +line, elements with no attributes or contents, and special or symbol
   1.145 +entities.
   1.146 +
   1.147 +`[prefix] b (YaTeX begin-type completion)'
   1.148 +     ...
   1.149 +          <ul>
   1.150 +          </ul>
   1.151 +
   1.152 +     Completion for elements that the start tag and the end tag span
   1.153 +     multiple lines. Mostly block-level elements.
   1.154 +
   1.155 +`[prefix] s (YateX section-type completion)'
   1.156 +     ...
   1.157 +          <img src="foo.gif" alt="photo">
   1.158 +
   1.159 +     Completion for elements that do not have end tags and require only
   1.160 +     attributes.  Possible completions are, <img>, <input>.
   1.161 +
   1.162 +`[prefix] l (YaTeX large-type completion)'
   1.163 +     ... 
   1.164 +
   1.165 +          <big> 〜 </big>
   1.166 +
   1.167 +     Similar to begin-type completion but used for elements that start and
   1.168 +     end on a single line.
   1.169 +
   1.170 +
   1.171 +`[prefix] m (YaTeX maketitle-type completion)'
   1.172 +     ... Completion for elements without attributes or contents.  Possible
   1.173 +     completion is <br>
   1.174 +
   1.175 +`[prefix] a (YaTeX accent completion)'
   1.176 +     ... Used to enter special or symbol entities.  By default completion
   1.177 +     for < (&lt;), > (&gt;), & (&amp;), " (&quot;), ' (&apos;), blank
   1.178 +     (&nbsp;) is possible.
   1.179 +
   1.180 +
   1.181 +File: yahtmle, Node: Jump, Next: Changing and Deleting, Prev: Completion, Up: Top
   1.182 +
   1.183 +Cursor Movement
   1.184 +***************
   1.185 +By using
   1.186 +
   1.187 +`[prefix] g'
   1.188 +             ... move to corresponding object
   1.189 +
   1.190 +the cursor will go to the corresponding object according to the context.
   1.191 +Recognized contexts are
   1.192 +
   1.193 +   * `<TAG>' <--> `</TAG>'
   1.194 +   * `<img src="image.file">' -> invoke viewer
   1.195 +   * `<a href="link.to.somewhere">' -> move cursor to linked target
   1.196 +   * `<applet code="program">' -> open Java source
   1.197 +
   1.198 +
   1.199 +File: yahtmle, Node: Changing and Deleting, Next: CSS Support, Prev: Jump, Up: Top
   1.200 +
   1.201 +Changing and Deleting
   1.202 +*********************
   1.203 +
   1.204 +* Menu:
   1.205 +
   1.206 +* Changing tags in pairs::      
   1.207 +* Changing entities::           
   1.208 +* URLencoding of strings within region::  
   1.209 +
   1.210 +
   1.211 +File: yahtmle, Node: Changing tags in pairs, Next: Changing entities, Prev: Changing and Deleting, Up: Changing and Deleting
   1.212 +
   1.213 +Changing tags in pairs
   1.214 +======================
   1.215 +By using
   1.216 +
   1.217 +`[prefix] c'
   1.218 +             ... change tags in matching pairs
   1.219 +
   1.220 +the content can be changed according to the context of the HTML document
   1.221 +where the cursor is located.
   1.222 +
   1.223 +   * `<TAG>'〜`</TAG>'
   1.224 +     ... change `TAG' element name
   1.225 +   * attributes such as `<img src="image.file" alt="photo">'
   1.226 +     ... change attributes
   1.227 +
   1.228 +
   1.229 +File: yahtmle, Node: Changing entities, Next: URLencoding of strings within region, Prev: Changing tags in pairs, Up: Changing and Deleting
   1.230 +
   1.231 +Changing entities
   1.232 +=================
   1.233 +Special characters such as < or > must be written as &lt; and &gt;.  Easy
   1.234 +conversion of these characters can be done when importing text from non
   1.235 +HTML files.
   1.236 +
   1.237 +
   1.238 +`[prefix] ;'
   1.239 +             ... convert char to special entity in marked region
   1.240 +`[prefix] :'
   1.241 +             ... convert special entity to original char in marked region
   1.242 +             (reverse of [prefix] ;)
   1.243 +
   1.244 +
   1.245 +
   1.246 +File: yahtmle, Node: URLencoding of strings within region, Prev: Changing entities, Up: Changing and Deleting
   1.247 +
   1.248 +URLencoding of strings within region
   1.249 +====================================
   1.250 +
   1.251 +`[prefix] #'
   1.252 +     	... encode chars that needs to be URLencoded within region
   1.253 +
   1.254 +
   1.255 +File: yahtmle, Node: CSS Support, Next: Customizations, Prev: Changing and Deleting, Up: Top
   1.256 +
   1.257 +CSS(Style Sheets) Support
   1.258 +*************************
   1.259 +
   1.260 +* Menu:
   1.261 +
   1.262 +* CSS-class completion::        
   1.263 +* Reread CSS definition::       
   1.264 +
   1.265 +
   1.266 +File: yahtmle, Node: CSS-class completion, Next: Reread CSS definition, Prev: CSS Support, Up: CSS Support
   1.267 +
   1.268 +CSS class-name completion
   1.269 +=========================
   1.270 +You can input a class name in your CSS definition with completion.  If you
   1.271 +have CSS defined as below;
   1.272 +
   1.273 +      h1.foo, h2.foo { background-color: 0xffffff; }
   1.274 +      h1.bar, h2.bar { font-size: 120%; }
   1.275 +
   1.276 +when you input h1(or h2) tag with completing-read by [prefix] b or
   1.277 +[prefix] l, yahtml prompts you to input class name with completion from
   1.278 +the words which are effective to h1 or h2.  And if you defined global
   1.279 +class like this;
   1.280 +
   1.281 +      .caution { font-size: 120%; background-color: 0xc00000;}
   1.282 +
   1.283 +when you input any tags via completing-read, yahtml prompts you to input
   1.284 +class name.  If this is bothering, typing `C-j' instead of `RET' (or
   1.285 +`C-m') cancels the next prompt to class name completion.
   1.286 +
   1.287 +
   1.288 +File: yahtmle, Node: Reread CSS definition, Prev: CSS-class completion, Up: CSS Support
   1.289 +
   1.290 +Re-reading CSS definition
   1.291 +=========================
   1.292 +If you add some class to your CSS file and you want yahtml to load new
   1.293 +definitions, type `M-x yahtml-mode RET' to make yahtml do.
   1.294 +
   1.295 +
   1.296 +File: yahtmle, Node: Customizations, Next: Copying, Prev: CSS Support, Up: Top
   1.297 +
   1.298 +Customizations
   1.299 +**************
   1.300 +
   1.301 +Variables that modify yahtml's behavior.
   1.302 +
   1.303 +* Menu:
   1.304 +
   1.305 +* All customizable variables::  List of customizable variables
   1.306 +* Hook variables::              hook variables
   1.307 +
   1.308 +
   1.309 +File: yahtmle, Node: All customizable variables, Next: Hook variables, Prev: Customizations, Up: Customizations
   1.310 +
   1.311 +List of customizable variables.  Defaults in parenthesis
   1.312 +========================================================
   1.313 +
   1.314 + -- Variable: yahtml-prefix
   1.315 +     Prefix key for yahtml-mode.  (`\C-c')
   1.316 +
   1.317 + -- Variable: yahtml-image-viewer
   1.318 +     Command to view image files refered by img. (xv)
   1.319 +
   1.320 + -- Variable: yahtml-www-browser
   1.321 +     Browser to view external pages with `[prefix]g'. (netscape)
   1.322 +
   1.323 + -- Variable: yahtml-kanji-code
   1.324 +     Default kanji code. 1=sjis, 2=jis, 3=euc (2) If
   1.325 +           AddType "text/html; charset=xxx" .html is written in .htaccess,
   1.326 +     this will override yahtml-kanji-code.
   1.327 +
   1.328 + -- Variable: yahtml-fill-column
   1.329 +     Columns to auto-fill (72)
   1.330 +
   1.331 + -- Variable: yahtml-fill-prefix
   1.332 +     fill-prefix specific to yahtml-mode. (`nil')
   1.333 +
   1.334 + -- Variable: yahtml-path-url-alist
   1.335 +     Matching list of URL and full path name on OS's file system.
   1.336 +
   1.337 + -- Variable: yahtml-directory-index
   1.338 +     Default index filed opened when accessing a server without a
   1.339 +     filename, usually index.html. (`"index.html"')
   1.340 +
   1.341 + -- Variable: yahtml-lint-program
   1.342 +     HTML syntax check program. (`"jweblint"')
   1.343 +
   1.344 + -- Variable: yahtml-hate-too-deep-indentation
   1.345 +     setq to t when indentations for nested enumerate elements are too
   1.346 +     deep.  (`nil')
   1.347 +
   1.348 + -- Variable: yahtml-always-/p
   1.349 +     setq to t if you always want `</p>' after `</p>'. `nil'
   1.350 +
   1.351 + -- Variable: yahtml-p-prefered-env-regexp
   1.352 +     Elements that `<p>' will be automatically inserted.
   1.353 +     (`"^\\(body\\|dl\\|blockquote\\)"')
   1.354 +
   1.355 + -- Variable: yahtml-template-file
   1.356 +     File to automatically insert when editing a new HTML file.
   1.357 +     `"~/http/template.html"'
   1.358 +
   1.359 + -- Variable: yahtml-prefer-upcases
   1.360 +     Use uppercase for tags. `nil'
   1.361 +
   1.362 + -- Variable: yahtml-prefer-upcase-attributes
   1.363 +     Use uppercase for attributes. `nil'
   1.364 +
   1.365 + -- Variable: yahtml-server-type
   1.366 +     setq to 'apache if using a Apache server, and will refer ./.htaccess.
   1.367 +     `'apache'
   1.368 +
   1.369 + -- Variable: yahtml-apache-access-file
   1.370 +     When `yahtml-server-type' is `'apache', define name of access
   1.371 +     restriction file. `".htaccess"'
   1.372 +
   1.373 + -- Variable: yahtml-shell-command-option
   1.374 +     Options needed to invoke shell commands.
   1.375 +
   1.376 + -- Variable: yahtml-translate-hyphens-when-comment-region
   1.377 +     Whether to change hyphens to `&#45;' when commenting out region.
   1.378 +     (`t')
   1.379 +
   1.380 + -- Variable: yahtml-entity-reference-chars-alist
   1.381 +     alist of characters that needs to be written by Entity Reference.
   1.382 +     Enter as `'(?char . "EntityReference")'.  By default, `<', `>', `&',
   1.383 +     `'', is set.  Add as needed.  Do not include `&' at beginning and `;'
   1.384 +     at end of cdr portion of `"EntityReference"'.
   1.385 +
   1.386 + -- Variable: yahtml-faithful-to-htmllint
   1.387 +     When using htmllint to check syntax, it will complain about excess
   1.388 +     spaces.  setq to `t' to avoid this.
   1.389 +
   1.390 + -- Variable: yahtml-use-css
   1.391 +     Use style-sheet support or not (`t')
   1.392 +
   1.393 + -- Variable: yahtml-image-inspection-bytes
   1.394 +     Number of bytes to inspect the image for geometry information
   1.395 +     (`10000')
   1.396 +
   1.397 + -- Variable: yahtml:img-default-alt-format
   1.398 +     format of img entity's ALT attributes.  %x: width, %y: height, %s:
   1.399 +     size in bytes, %c: first comment string, %f: filename
   1.400 +     (`"%xx%y(%sbytes)"')
   1.401 +
   1.402 + -- Variable: yahtml-escape-chars
   1.403 +     When, completing href-s, Escape reserved characters to URL-encoding
   1.404 +     or not.  Nil for never, t for everytime, and 'ask for inquiring at
   1.405 +     each reserved chars. (`'ask')
   1.406 +
   1.407 + -- Variable: yahtml-use-font-lock
   1.408 +     Use font-lock to fontify buffer or not (`(featurep 'font-lock)')
   1.409 +
   1.410 + -- Variable: yahtml-use-hilit19
   1.411 +     Use hilit19 to highlight buffer or not (`(featurep 'hilit19)')
   1.412 +
   1.413 + -- Variable: yahtml-indentation-boundary
   1.414 +     Boundary regexp for indentation calculation.  (`"^\\s *<h[1-3]>"')
   1.415 +
   1.416 +
   1.417 +File: yahtmle, Node: Hook variables, Prev: All customizable variables, Up: Customizations
   1.418 +
   1.419 +hook variables
   1.420 +==============
   1.421 +
   1.422 +
   1.423 +
   1.424 +File: yahtmle, Node: Copying, Next: Concept Index, Prev: Customizations, Up: Top
   1.425 +
   1.426 +Copying
   1.427 +*******
   1.428 +
   1.429 +This program is distributed as freesoftware.  The author will take no
   1.430 +responsibility to any damages due to the usage of this software
   1.431 +whatsoever.  There are no restrictions to its redistribution, just use
   1.432 +common sense.  Mail me your thoughts on this program and I will be more
   1.433 +than willing to help.
   1.434 +
   1.435 +Complaints, requests, bug reports and comments are welcome.  Make contacts
   1.436 +to yuuji@yatex.org　(as of December 2000)
   1.437 +
   1.438 +If you like this program and use it on a regular basis, please join the
   1.439 +mailing list "fj Wild Bird Society".  Procedures can be found in the "etc"
   1.440 +section of `docs/htmlqa.eng' in this package.
   1.441 +
   1.442 +
   1.443 +                                                             HIROSE, Yuuji
   1.444 +
   1.445 +
   1.446 +
   1.447 +File: yahtmle, Node: Concept Index, Prev: Copying, Up: Top
   1.448 +
   1.449 +Index
   1.450 +*****
   1.451 +
   1.452 +* Menu:
   1.453 +
   1.454 +* Customize:                    Customizations.         4.
   1.455 +* Demacs:                       Intro.                  4.
   1.456 +* Key Assign:                   Customizations.         4.
   1.457 +* LaTeX:                        Intro.                  4.
   1.458 +* Mule:                         Intro.                  4.
   1.459 +* yahtml:                       Intro.                  4.
   1.460 +
   1.461 +
   1.462 +