yuuji@83: Info file: yahtmle,    -*-Text-*-
yuuji@83: produced by `texinfo-format-buffer'
yuuji@83: from file `yahtmle.tex'
yuuji@124: using `texinfmt.el' version 2.32 of 19 November 1993.
yuuji@124: 
yuuji@124: 
yuuji@124: 
yuuji@83: 
yuuji@83: 
yuuji@83: File: yahtmle, Node: Top, Next: Intro, Prev: (dir), Up: (dir)
yuuji@83: 
yuuji@83: * Menu:
yuuji@83: 
yuuji@83: * Intro::                       Introduction
yuuji@83: * Installation::                Installing yahtml
yuuji@83: * Command Invocation::          Using External Commands
yuuji@83: * Completion::                  Input with Completion
yuuji@83: * Jump::                        Moving the Cursor
yuuji@83: * Changing and Deleting::       Changing and Deleting
yuuji@83: * CSS Support::                 Style Sheet Support
yuuji@83: * Customizations::              List of Customize Variables
yuuji@83: * Copying::                     Copyright
yuuji@83: * Concept Index::               Index
yuuji@83: 
yuuji@83: 
yuuji@83: File: yahtmle, Node: Intro, Next: Installation, Prev: Top, Up: Top
yuuji@83: 
yuuji@83: Introduction
yuuji@83: ************
yuuji@83: 
yuuji@83: yahtml is a package to support creating HTML documents on Emacsens.  Easy
yuuji@83: input of elements (tags) by completion, syntax checking with programs like
yuuji@83: weblint, and invoking the appropriate browser or image viewer depending on
yuuji@83: the cursor position is its main features.
yuuji@83: 
yuuji@83: (This Info is still incomplete)
yuuji@83: 
yuuji@83: 
yuuji@83: File: yahtmle, Node: Installation, Next: Command Invocation, Prev: Intro, Up: Top
yuuji@83: 
yuuji@83: Installing yahtml
yuuji@83: *****************
yuuji@83: * Menu:
yuuji@83: 
yuuji@124: * Setting up yahtml::           
yuuji@124: * Setting environments for weblint browsers and image viewers::  
yuuji@124: * Setting environment variables for WWW pages::  
yuuji@83: 
yuuji@83: 
yuuji@83: File: yahtmle, Node: Setting up yahtml, Next: Setting environments for weblint browsers and image viewers, Prev: Installation, Up: Installation
yuuji@83: 
yuuji@83: Setting up yahtml
yuuji@83: =================
yuuji@83: 
yuuji@83: 
yuuji@83: Add the following to `~/.emacs'
yuuji@83: 
yuuji@83:      (setq auto-mode-alist
yuuji@83:            (cons (cons "\\.html$" 'yahtml-mode) auto-mode-alist))
yuuji@83:      (autoload 'yahtml-mode "yahtml" "Yet Another HTML mode" t)
yuuji@83: 
yuuji@83: Next, add to load-path the directory with the yahtml files (`yahtml.el',
yuuji@83: `yatexlib.el', `yatexprc.el').  For example, if you put them in
yuuji@83: `~/src/emacs/yahtml',
yuuji@83: 
yuuji@83:      (setq load-path (cons (expand-file-name "~/src/emacs/yahtml") load-path))
yuuji@83: 
yuuji@83: is what you add.
yuuji@83: 
yuuji@83: By this, yahtml will be automatically loaded when editing files with .html
yuuji@83: extensions.  "yahtml" will be displayed on the mode line if no errors
yuuji@83: occurred.
yuuji@83: 
yuuji@83: 
yuuji@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
yuuji@83: 
yuuji@83: Setting environments for weblint, browsers, and image viewers
yuuji@83: =============================================================
yuuji@83: 
yuuji@83: Check the variables for invoking external commands and modify as needed.
yuuji@83: Defaults are in parenthesis.
yuuji@83: 
yuuji@83: `yahtml-www-browser'
yuuji@83:              ... browser command name (netscape)
yuuji@83: `yahtml-image-viewer'
yuuji@83:              ... image viewer command name (xv)
yuuji@83: `yahtml-lint-program'
yuuji@83:              ... syntax check programs command name (jweblint)
yuuji@83: `yahtml-kanji-code'
yuuji@83:              ... kanji code for HTML files
yuuji@83: 
yuuji@83: 
yuuji@83: File: yahtmle, Node: Setting environment variables for WWW pages, Prev: Setting environments for weblint browsers and image viewers, Up: Installation
yuuji@83: 
yuuji@83: Setting environment variables for WWW pages
yuuji@83: ===========================================
yuuji@83: 
yuuji@83: Variables regarding path names for files that will be your home page.
yuuji@83: `yahtml-path-url-alist'
yuuji@83:              ... list of matching path name on file system and URLs
yuuji@83: `yahtml-directory-index'
yuuji@83:              ... index file displayed when none is given in URL.  Usually
yuuji@124:              `index.html' on NCSA type httpd and `Welcome.html' on
yuuji@124:              CERN types.
yuuji@83: 
yuuji@83: Examples for `yahtml-path-url-alist'.  If `/home/yuuji/http/' is
yuuji@83: `http://localhost/~yuuji' at home and `/usr/home/yuuji/www/' is
yuuji@83: `http://www.keio.ac.jp/~yuuji/' at work, then
yuuji@83: 
yuuji@83:      (setq yahtml-path-url-alist
yuuji@83:            '(("/home/yuuji/http" . "http://localhost/~yuuji")
yuuji@83:              ("/usr/home/yuuji/www" . "http://www.keio.ac.jp/~yuuji")))
yuuji@83: 
yuuji@83: Any number of additions can be made to this list.
yuuji@83: 
yuuji@83: 
yuuji@83: File: yahtmle, Node: Command Invocation, Next: Completion, Prev: Installation, Up: Top
yuuji@83: 
yuuji@83: Invoking external commands
yuuji@83: **************************
yuuji@83: 
yuuji@83: For easy use of commands that are handy when editing HTML files.
yuuji@83: `[prefix] t j'
yuuji@83:              ... Invoke HTML syntax checker (jweblint)
yuuji@83: `[prefix] t p'
yuuji@83:              ... Display current page in browser
yuuji@83: `[prefix] t r'
yuuji@83:              ... Reload current page if browser is already running
yuuji@83: 
yuuji@83: 
yuuji@83: File: yahtmle, Node: Completion, Next: Jump, Prev: Command Invocation, Up: Top
yuuji@83: 
yuuji@83: Completion Input
yuuji@83: ****************
yuuji@83: 
yuuji@83: Completion input of HTML elements is done through the same key strokes as
yuuji@83: YaTeX's begin-type completion, section-type completion, large-type
yuuji@83: completion, maketitle-type completion, and accent completion.
yuuji@83: Corresponding elements in this order is; elements that span multiple
yuuji@83: lines, empty elements such as img, tags that start and end in a single
yuuji@83: line, elements with no attributes or contents, and special or symbol
yuuji@83: entities.
yuuji@83: 
yuuji@83: `[prefix] b (YaTeX begin-type completion)'
yuuji@83:      ...
yuuji@83:           <ul>
yuuji@83:           </ul>
yuuji@83: 
yuuji@83:      Completion for elements that the start tag and the end tag span
yuuji@83:      multiple lines. Mostly block-level elements.
yuuji@83: 
yuuji@83: `[prefix] s (YateX section-type completion)'
yuuji@83:      ...
yuuji@83:           <img src="foo.gif" alt="photo">
yuuji@83: 
yuuji@83:      Completion for elements that do not have end tags and require only
yuuji@83:      attributes.  Possible completions are, <img>, <input>.
yuuji@83: 
yuuji@83: `[prefix] l (YaTeX large-type completion)'
yuuji@124:      ... 
yuuji@83: 
yuuji@83:           <big> 〜 </big>
yuuji@83: 
yuuji@83:      Similar to begin-type completion but used for elements that start and
yuuji@83:      end on a single line.
yuuji@83: 
yuuji@83: 
yuuji@83: `[prefix] m (YaTeX maketitle-type completion)'
yuuji@83:      ... Completion for elements without attributes or contents.  Possible
yuuji@83:      completion is <br>
yuuji@83: 
yuuji@83: `[prefix] a (YaTeX accent completion)'
yuuji@83:      ... Used to enter special or symbol entities.  By default completion
yuuji@83:      for < (&lt;), > (&gt;), & (&amp;), " (&quot;), ' (&apos;), blank
yuuji@83:      (&nbsp;) is possible.
yuuji@83: 
yuuji@83: 
yuuji@83: File: yahtmle, Node: Jump, Next: Changing and Deleting, Prev: Completion, Up: Top
yuuji@83: 
yuuji@83: Cursor Movement
yuuji@83: ***************
yuuji@83: By using
yuuji@83: 
yuuji@83: `[prefix] g'
yuuji@83:              ... move to corresponding object
yuuji@83: 
yuuji@83: the cursor will go to the corresponding object according to the context.
yuuji@83: Recognized contexts are
yuuji@83: 
yuuji@83:    * `<TAG>' <--> `</TAG>'
yuuji@83:    * `<img src="image.file">' -> invoke viewer
yuuji@83:    * `<a href="link.to.somewhere">' -> move cursor to linked target
yuuji@83:    * `<applet code="program">' -> open Java source
yuuji@83: 
yuuji@83: 
yuuji@83: File: yahtmle, Node: Changing and Deleting, Next: CSS Support, Prev: Jump, Up: Top
yuuji@83: 
yuuji@83: Changing and Deleting
yuuji@83: *********************
yuuji@83: 
yuuji@83: * Menu:
yuuji@83: 
yuuji@124: * Changing tags in pairs::      
yuuji@124: * Changing entities::           
yuuji@124: * URLencoding of strings within region::  
yuuji@83: 
yuuji@83: 
yuuji@83: File: yahtmle, Node: Changing tags in pairs, Next: Changing entities, Prev: Changing and Deleting, Up: Changing and Deleting
yuuji@83: 
yuuji@83: Changing tags in pairs
yuuji@83: ======================
yuuji@83: By using
yuuji@83: 
yuuji@83: `[prefix] c'
yuuji@83:              ... change tags in matching pairs
yuuji@83: 
yuuji@83: the content can be changed according to the context of the HTML document
yuuji@83: where the cursor is located.
yuuji@83: 
yuuji@83:    * `<TAG>'〜`</TAG>'
yuuji@83:      ... change `TAG' element name
yuuji@83:    * attributes such as `<img src="image.file" alt="photo">'
yuuji@83:      ... change attributes
yuuji@83: 
yuuji@83: 
yuuji@83: File: yahtmle, Node: Changing entities, Next: URLencoding of strings within region, Prev: Changing tags in pairs, Up: Changing and Deleting
yuuji@83: 
yuuji@83: Changing entities
yuuji@83: =================
yuuji@83: Special characters such as < or > must be written as &lt; and &gt;.  Easy
yuuji@83: conversion of these characters can be done when importing text from non
yuuji@83: HTML files.
yuuji@83: 
yuuji@83: 
yuuji@83: `[prefix] ;'
yuuji@83:              ... convert char to special entity in marked region
yuuji@83: `[prefix] :'
yuuji@83:              ... convert special entity to original char in marked region
yuuji@124:              (reverse of [prefix] ;)
yuuji@83: 
yuuji@83: 
yuuji@83: 
yuuji@83: File: yahtmle, Node: URLencoding of strings within region, Prev: Changing entities, Up: Changing and Deleting
yuuji@83: 
yuuji@83: URLencoding of strings within region
yuuji@83: ====================================
yuuji@83: 
yuuji@83: `[prefix] #'
yuuji@124:      	... encode chars that needs to be URLencoded within region
yuuji@83: 
yuuji@83: 
yuuji@83: File: yahtmle, Node: CSS Support, Next: Customizations, Prev: Changing and Deleting, Up: Top
yuuji@83: 
yuuji@83: CSS(Style Sheets) Support
yuuji@83: *************************
yuuji@83: 
yuuji@83: * Menu:
yuuji@83: 
yuuji@124: * CSS-class completion::        
yuuji@124: * Reread CSS definition::       
yuuji@83: 
yuuji@83: 
yuuji@83: File: yahtmle, Node: CSS-class completion, Next: Reread CSS definition, Prev: CSS Support, Up: CSS Support
yuuji@83: 
yuuji@83: CSS class-name completion
yuuji@83: =========================
yuuji@83: You can input a class name in your CSS definition with completion.  If you
yuuji@83: have CSS defined as below;
yuuji@83: 
yuuji@83:       h1.foo, h2.foo { background-color: 0xffffff; }
yuuji@83:       h1.bar, h2.bar { font-size: 120%; }
yuuji@83: 
yuuji@83: when you input h1(or h2) tag with completing-read by [prefix] b or
yuuji@83: [prefix] l, yahtml prompts you to input class name with completion from
yuuji@83: the words which are effective to h1 or h2.  And if you defined global
yuuji@83: class like this;
yuuji@83: 
yuuji@83:       .caution { font-size: 120%; background-color: 0xc00000;}
yuuji@83: 
yuuji@83: when you input any tags via completing-read, yahtml prompts you to input
yuuji@124: class name.  If this is bothering, typing `C-j' instead of `RET' (or
yuuji@124: `C-m') cancels the next prompt to class name completion.
yuuji@83: 
yuuji@83: 
yuuji@83: File: yahtmle, Node: Reread CSS definition, Prev: CSS-class completion, Up: CSS Support
yuuji@83: 
yuuji@83: Re-reading CSS definition
yuuji@83: =========================
yuuji@83: If you add some class to your CSS file and you want yahtml to load new
yuuji@83: definitions, type `M-x yahtml-mode RET' to make yahtml do.
yuuji@83: 
yuuji@83: 
yuuji@83: File: yahtmle, Node: Customizations, Next: Copying, Prev: CSS Support, Up: Top
yuuji@83: 
yuuji@83: Customizations
yuuji@83: **************
yuuji@83: 
yuuji@83: Variables that modify yahtml's behavior.
yuuji@83: 
yuuji@83: * Menu:
yuuji@83: 
yuuji@83: * All customizable variables::  List of customizable variables
yuuji@83: * Hook variables::              hook variables
yuuji@83: 
yuuji@83: 
yuuji@83: File: yahtmle, Node: All customizable variables, Next: Hook variables, Prev: Customizations, Up: Customizations
yuuji@83: 
yuuji@83: List of customizable variables.  Defaults in parenthesis
yuuji@83: ========================================================
yuuji@83: 
yuuji@83:  -- Variable: yahtml-prefix
yuuji@83:      Prefix key for yahtml-mode.  (`\C-c')
yuuji@83: 
yuuji@83:  -- Variable: yahtml-image-viewer
yuuji@83:      Command to view image files refered by img. (xv)
yuuji@83: 
yuuji@83:  -- Variable: yahtml-www-browser
yuuji@83:      Browser to view external pages with `[prefix]g'. (netscape)
yuuji@83: 
yuuji@83:  -- Variable: yahtml-kanji-code
yuuji@124:      Default kanji code. 1=sjis, 2=jis, 3=euc, 4=utf-8 (2) If
yuuji@124:            AddType "text/html; charset=xxx" .html is written in .htaccess,
yuuji@124:      this will override yahtml-kanji-code.
yuuji@83: 
yuuji@83:  -- Variable: yahtml-fill-column
yuuji@83:      Columns to auto-fill (72)
yuuji@83: 
yuuji@83:  -- Variable: yahtml-fill-prefix
yuuji@83:      fill-prefix specific to yahtml-mode. (`nil')
yuuji@83: 
yuuji@83:  -- Variable: yahtml-path-url-alist
yuuji@83:      Matching list of URL and full path name on OS's file system.
yuuji@83: 
yuuji@83:  -- Variable: yahtml-directory-index
yuuji@83:      Default index filed opened when accessing a server without a
yuuji@83:      filename, usually index.html. (`"index.html"')
yuuji@83: 
yuuji@83:  -- Variable: yahtml-lint-program
yuuji@83:      HTML syntax check program. (`"jweblint"')
yuuji@83: 
yuuji@83:  -- Variable: yahtml-hate-too-deep-indentation
yuuji@83:      setq to t when indentations for nested enumerate elements are too
yuuji@83:      deep.  (`nil')
yuuji@83: 
yuuji@83:  -- Variable: yahtml-always-/p
yuuji@83:      setq to t if you always want `</p>' after `</p>'. `nil'
yuuji@83: 
yuuji@83:  -- Variable: yahtml-p-prefered-env-regexp
yuuji@83:      Elements that `<p>' will be automatically inserted.
yuuji@83:      (`"^\\(body\\|dl\\|blockquote\\)"')
yuuji@83: 
yuuji@83:  -- Variable: yahtml-template-file
yuuji@83:      File to automatically insert when editing a new HTML file.
yuuji@83:      `"~/http/template.html"'
yuuji@83: 
yuuji@83:  -- Variable: yahtml-prefer-upcases
yuuji@83:      Use uppercase for tags. `nil'
yuuji@83: 
yuuji@83:  -- Variable: yahtml-prefer-upcase-attributes
yuuji@83:      Use uppercase for attributes. `nil'
yuuji@83: 
yuuji@83:  -- Variable: yahtml-server-type
yuuji@83:      setq to 'apache if using a Apache server, and will refer ./.htaccess.
yuuji@83:      `'apache'
yuuji@83: 
yuuji@83:  -- Variable: yahtml-apache-access-file
yuuji@83:      When `yahtml-server-type' is `'apache', define name of access
yuuji@83:      restriction file. `".htaccess"'
yuuji@83: 
yuuji@83:  -- Variable: yahtml-shell-command-option
yuuji@83:      Options needed to invoke shell commands.
yuuji@83: 
yuuji@83:  -- Variable: yahtml-translate-hyphens-when-comment-region
yuuji@83:      Whether to change hyphens to `&#45;' when commenting out region.
yuuji@83:      (`t')
yuuji@83: 
yuuji@83:  -- Variable: yahtml-entity-reference-chars-alist
yuuji@83:      alist of characters that needs to be written by Entity Reference.
yuuji@83:      Enter as `'(?char . "EntityReference")'.  By default, `<', `>', `&',
yuuji@83:      `'', is set.  Add as needed.  Do not include `&' at beginning and `;'
yuuji@83:      at end of cdr portion of `"EntityReference"'.
yuuji@83: 
yuuji@83:  -- Variable: yahtml-faithful-to-htmllint
yuuji@83:      When using htmllint to check syntax, it will complain about excess
yuuji@83:      spaces.  setq to `t' to avoid this.
yuuji@83: 
yuuji@83:  -- Variable: yahtml-use-css
yuuji@83:      Use style-sheet support or not (`t')
yuuji@83: 
yuuji@83:  -- Variable: yahtml-image-inspection-bytes
yuuji@83:      Number of bytes to inspect the image for geometry information
yuuji@83:      (`10000')
yuuji@83: 
yuuji@83:  -- Variable: yahtml:img-default-alt-format
yuuji@83:      format of img entity's ALT attributes.  %x: width, %y: height, %s:
yuuji@83:      size in bytes, %c: first comment string, %f: filename
yuuji@83:      (`"%xx%y(%sbytes)"')
yuuji@83: 
yuuji@83:  -- Variable: yahtml-escape-chars
yuuji@83:      When, completing href-s, Escape reserved characters to URL-encoding
yuuji@83:      or not.  Nil for never, t for everytime, and 'ask for inquiring at
yuuji@83:      each reserved chars. (`'ask')
yuuji@83: 
yuuji@83:  -- Variable: yahtml-use-font-lock
yuuji@83:      Use font-lock to fontify buffer or not (`(featurep 'font-lock)')
yuuji@83: 
yuuji@83:  -- Variable: yahtml-use-hilit19
yuuji@83:      Use hilit19 to highlight buffer or not (`(featurep 'hilit19)')
yuuji@83: 
yuuji@83:  -- Variable: yahtml-indentation-boundary
yuuji@83:      Boundary regexp for indentation calculation.  (`"^\\s *<h[1-3]>"')
yuuji@83: 
yuuji@83: 
yuuji@83: File: yahtmle, Node: Hook variables, Prev: All customizable variables, Up: Customizations
yuuji@83: 
yuuji@83: hook variables
yuuji@83: ==============
yuuji@83: 
yuuji@83: 
yuuji@83: 
yuuji@83: File: yahtmle, Node: Copying, Next: Concept Index, Prev: Customizations, Up: Top
yuuji@83: 
yuuji@83: Copying
yuuji@83: *******
yuuji@83: 
yuuji@83: This program is distributed as freesoftware.  The author will take no
yuuji@83: responsibility to any damages due to the usage of this software
yuuji@83: whatsoever.  There are no restrictions to its redistribution, just use
yuuji@83: common sense.  Mail me your thoughts on this program and I will be more
yuuji@83: than willing to help.
yuuji@83: 
yuuji@83: Complaints, requests, bug reports and comments are welcome.  Make contacts
yuuji@83: to yuuji@yatex.org　(as of December 2000)
yuuji@83: 
yuuji@83: If you like this program and use it on a regular basis, please join the
yuuji@83: mailing list "fj Wild Bird Society".  Procedures can be found in the "etc"
yuuji@83: section of `docs/htmlqa.eng' in this package.
yuuji@83: 
yuuji@83: 
yuuji@83:                                                              HIROSE, Yuuji
yuuji@83: 
yuuji@83: 
yuuji@83: 
yuuji@83: File: yahtmle, Node: Concept Index, Prev: Copying, Up: Top
yuuji@83: 
yuuji@83: Index
yuuji@83: *****
yuuji@83: 
yuuji@83: * Menu:
yuuji@83: 
yuuji@124: * Customize:                    Customizations.         4.
yuuji@124: * Demacs:                       Intro.                  4.
yuuji@124: * Key Assign:                   Customizations.         4.
yuuji@124: * LaTeX:                        Intro.                  4.
yuuji@124: * Mule:                         Intro.                  4.
yuuji@124: * yahtml:                       Intro.                  4.
yuuji@124: 
yuuji@124: 
yuuji@124: