yuuji@271: Info file: yahtmle, -*-Text-*- yuuji@271: produced by `texinfo-format-buffer' yuuji@271: from file `yahtmle.tex' yuuji@445: using `texinfmt.el' version 2.42 of 7 Jul 2006. yuuji@271: yuuji@272: START-INFO-DIR-ENTRY yuuji@272: * yahtml-e: (yahtmle). Yet Another html-mode for Emacs (English). yuuji@272: END-INFO-DIR-ENTRY yuuji@272: yuuji@271: yuuji@271: yuuji@271: yuuji@271: yuuji@271:  yuuji@271: File: yahtmle, Node: Top, Next: Intro, Prev: (dir), Up: (dir) yuuji@271: yuuji@271: * Menu: yuuji@271: yuuji@271: * Intro:: Introduction yuuji@271: * Installation:: Installing yahtml yuuji@271: * Command Invocation:: Using External Commands yuuji@271: * Completion:: Input with Completion yuuji@271: * Jump:: Moving the Cursor yuuji@271: * Changing and Deleting:: Changing and Deleting yuuji@271: * CSS Support:: Style Sheet Support yuuji@271: * Customizations:: List of Customize Variables yuuji@271: * Copying:: Copyright yuuji@271: * Concept Index:: Index yuuji@271: yuuji@271: yuuji@271:  yuuji@271: File: yahtmle, Node: Intro, Next: Installation, Prev: Top, Up: Top yuuji@271: yuuji@271: Introduction yuuji@271: ************ yuuji@271: yuuji@271: yahtml is a package to support creating HTML documents on Emacsens. Easy yuuji@271: input of elements (tags) by completion, syntax checking with programs like yuuji@271: weblint, and invoking the appropriate browser or image viewer depending on yuuji@271: the cursor position is its main features. yuuji@271: yuuji@271: (This Info is still incomplete) yuuji@271: yuuji@271: yuuji@271:  yuuji@271: File: yahtmle, Node: Installation, Next: Command Invocation, Prev: Intro, Up: Top yuuji@271: yuuji@271: Installing yahtml yuuji@271: ***************** yuuji@271: * Menu: yuuji@271: yuuji@445: * Setting up yahtml:: yuuji@445: * Setting environments for weblint browsers and image viewers:: yuuji@445: * Setting environment variables for WWW pages:: yuuji@271: yuuji@271: yuuji@271:  yuuji@271: File: yahtmle, Node: Setting up yahtml, Next: Setting environments for weblint browsers and image viewers, Prev: Installation, Up: Installation yuuji@271: yuuji@271: Setting up yahtml yuuji@271: ================= yuuji@271: yuuji@271: yuuji@271: Add the following to `~/.emacs' yuuji@271: yuuji@271: (setq auto-mode-alist yuuji@271: (cons (cons "\\.html$" 'yahtml-mode) auto-mode-alist)) yuuji@271: (autoload 'yahtml-mode "yahtml" "Yet Another HTML mode" t) yuuji@271: yuuji@271: Next, add to load-path the directory with the yahtml files (`yahtml.el', yuuji@271: `yatexlib.el', `yatexprc.el'). For example, if you put them in yuuji@271: `~/src/emacs/yahtml', yuuji@271: yuuji@271: (setq load-path (cons (expand-file-name "~/src/emacs/yahtml") load-path)) yuuji@271: yuuji@271: is what you add. yuuji@271: yuuji@271: By this, yahtml will be automatically loaded when editing files with .html yuuji@271: extensions. "yahtml" will be displayed on the mode line if no errors yuuji@271: occurred. yuuji@271: yuuji@271: yuuji@271:  yuuji@271: 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@271: yuuji@271: Setting environments for weblint, browsers, and image viewers yuuji@271: ============================================================= yuuji@271: yuuji@271: Check the variables for invoking external commands and modify as needed. yuuji@271: Defaults are in parenthesis. yuuji@271: yuuji@271: `yahtml-www-browser' yuuji@271: ... browser command name (netscape) yuuji@271: `yahtml-image-viewer' yuuji@271: ... image viewer command name (xv) yuuji@271: `yahtml-lint-program' yuuji@271: ... syntax check programs command name (jweblint) yuuji@271: `yahtml-kanji-code' yuuji@271: ... kanji code for HTML files yuuji@271: yuuji@271: yuuji@271:  yuuji@271: File: yahtmle, Node: Setting environment variables for WWW pages, Prev: Setting environments for weblint browsers and image viewers, Up: Installation yuuji@271: yuuji@271: Setting environment variables for WWW pages yuuji@271: =========================================== yuuji@271: yuuji@271: Variables regarding path names for files that will be your home page. yuuji@271: `yahtml-path-url-alist' yuuji@271: ... list of matching path name on file system and URLs yuuji@271: `yahtml-directory-index' yuuji@271: ... index file displayed when none is given in URL. Usually yuuji@445: `index.html' on NCSA type httpd and `Welcome.html' on CERN yuuji@445: types. yuuji@271: yuuji@271: Examples for `yahtml-path-url-alist'. If `/home/yuuji/http/' is yuuji@271: `http://localhost/~yuuji' at home and `/usr/home/yuuji/www/' is yuuji@271: `http://www.keio.ac.jp/~yuuji/' at work, then yuuji@271: yuuji@271: (setq yahtml-path-url-alist yuuji@271: '(("/home/yuuji/http" . "http://localhost/~yuuji") yuuji@271: ("/usr/home/yuuji/www" . "http://www.keio.ac.jp/~yuuji"))) yuuji@271: yuuji@271: Any number of additions can be made to this list. yuuji@271: yuuji@271: yuuji@271:  yuuji@271: File: yahtmle, Node: Command Invocation, Next: Completion, Prev: Installation, Up: Top yuuji@271: yuuji@271: Invoking external commands yuuji@271: ************************** yuuji@271: yuuji@271: For easy use of commands that are handy when editing HTML files. yuuji@271: `[prefix] t j' yuuji@271: ... Invoke HTML syntax checker (jweblint) yuuji@271: `[prefix] t p' yuuji@271: ... Display current page in browser yuuji@271: `[prefix] t r' yuuji@271: ... Reload current page if browser is already running yuuji@271: yuuji@271: yuuji@271:  yuuji@271: File: yahtmle, Node: Completion, Next: Jump, Prev: Command Invocation, Up: Top yuuji@271: yuuji@271: Completion Input yuuji@271: **************** yuuji@271: yuuji@271: Completion input of HTML elements is done through the same key strokes as yuuji@271: YaTeX's begin-type completion, section-type completion, large-type yuuji@271: completion, maketitle-type completion, and accent completion. yuuji@271: Corresponding elements in this order is; elements that span multiple yuuji@271: lines, empty elements such as img, tags that start and end in a single yuuji@271: line, elements with no attributes or contents, and special or symbol yuuji@271: entities. yuuji@271: yuuji@271: `[prefix] b (YaTeX begin-type completion)' yuuji@271: ... yuuji@271: yuuji@271: yuuji@271: Completion for elements that the start tag and the end tag span yuuji@271: multiple lines. Mostly block-level elements. yuuji@271: yuuji@271: `[prefix] s (YateX section-type completion)' yuuji@271: ... yuuji@271: photo yuuji@271: yuuji@271: Completion for elements that do not have end tags and require only yuuji@271: attributes. Possible completions are, , . yuuji@271: yuuji@271: `[prefix] l (YaTeX large-type completion)' yuuji@271: ... yuuji@271: yuuji@271: ` yuuji@271: yuuji@271: Similar to begin-type completion but used for elements that start and yuuji@271: end on a single line. yuuji@271: yuuji@271: yuuji@271: `[prefix] m (YaTeX maketitle-type completion)' yuuji@271: ... Completion for elements without attributes or contents. Possible yuuji@271: completion is
yuuji@271: yuuji@271: `[prefix] a (YaTeX accent completion)' yuuji@271: ... Used to enter special or symbol entities. By default completion yuuji@271: for < (<), > (>), & (&), " ("), ' ('), blank yuuji@271: ( ) is possible. yuuji@271: yuuji@271: yuuji@271:  yuuji@271: File: yahtmle, Node: Jump, Next: Changing and Deleting, Prev: Completion, Up: Top yuuji@271: yuuji@271: Cursor Movement yuuji@271: *************** yuuji@271: By using yuuji@271: yuuji@271: `[prefix] g' yuuji@271: ... move to corresponding object yuuji@271: yuuji@271: the cursor will go to the corresponding object according to the context. yuuji@271: Recognized contexts are yuuji@271: yuuji@271: * `' <--> `' yuuji@271: * `' -> invoke viewer yuuji@271: * `' -> move cursor to linked target yuuji@271: * `' -> open Java source yuuji@271: yuuji@271: yuuji@271:  yuuji@271: File: yahtmle, Node: Changing and Deleting, Next: CSS Support, Prev: Jump, Up: Top yuuji@271: yuuji@271: Changing and Deleting yuuji@271: ********************* yuuji@271: yuuji@271: * Menu: yuuji@271: yuuji@445: * Changing tags in pairs:: yuuji@445: * Changing entities:: yuuji@445: * URLencoding of strings within region:: yuuji@445: * td-enclosure/tr-enclosure:: yuuji@271: yuuji@271: yuuji@271:  yuuji@271: File: yahtmle, Node: Changing tags in pairs, Next: Changing entities, Prev: Changing and Deleting, Up: Changing and Deleting yuuji@271: yuuji@271: Changing tags in pairs yuuji@271: ====================== yuuji@271: By using yuuji@271: yuuji@271: `[prefix] c' yuuji@271: ... change tags in matching pairs yuuji@271: yuuji@271: the content can be changed according to the context of the HTML document yuuji@271: where the cursor is located. yuuji@271: yuuji@271: * `'``' yuuji@271: ... change `TAG' element name yuuji@271: * attributes such as `photo' yuuji@271: ... change attributes yuuji@271: yuuji@271: yuuji@271:  yuuji@271: File: yahtmle, Node: Changing entities, Next: URLencoding of strings within region, Prev: Changing tags in pairs, Up: Changing and Deleting yuuji@271: yuuji@271: Changing entities yuuji@271: ================= yuuji@271: Special characters such as < or > must be written as < and >. Easy yuuji@271: conversion of these characters can be done when importing text from non yuuji@271: HTML files. yuuji@271: yuuji@271: yuuji@271: `[prefix] ;' yuuji@271: ... convert char to special entity in marked region yuuji@271: `[prefix] :' yuuji@271: ... convert special entity to original char in marked region yuuji@445: (reverse of [prefix] ;) yuuji@271: yuuji@271: yuuji@271: yuuji@271:  yuuji@271: File: yahtmle, Node: URLencoding of strings within region, Next: td-enclosure/tr-enclosure, Prev: Changing entities, Up: Changing and Deleting yuuji@271: yuuji@271: URLencoding of strings within region yuuji@271: ==================================== yuuji@271: yuuji@271: `[prefix] #' yuuji@445: ... encode chars that needs to be URLencoded within region yuuji@271: yuuji@271: yuuji@271:  yuuji@271: File: yahtmle, Node: td-enclosure/tr-enclosure, Prev: URLencoding of strings within region, Up: Changing and Deleting yuuji@271: yuuji@271: td-enclosure/tr-enclosure yuuji@271: ========================= yuuji@271: If you wan to convert series of field into ... repetitions for yuuji@271: table element, td-enclosure or tr-enclosure is convenient. yuuji@271: yuuji@271: `[prefix] }' yuuji@445: yuuji@445: ... Enclose each field in a region into ...'s. yuuji@271: `[prefix] ]' yuuji@445: yuuji@445: ... Enclose each line in a region into ...'s, with every yuuji@445: line converted to ... repetition. They presume yuuji@445: white space as field separator by default. To change this, yuuji@445: enter other delimiting character for a query. You can yuuji@445: convert CSV, for example, into table by specifying comma(,) yuuji@445: as a delimiter. yuuji@271: yuuji@271: If you want to enclose fields with th, call with universal-argument yuuji@271: (`C-u'). Enter `th' to enclose fields with .... The special yuuji@271: answer `thd' means that enclose the only first column with th, and the yuuji@271: rest with td. yuuji@271: yuuji@271: yuuji@271:  yuuji@271: File: yahtmle, Node: CSS Support, Next: Customizations, Prev: Changing and Deleting, Up: Top yuuji@271: yuuji@271: CSS(Style Sheets) Support yuuji@271: ************************* yuuji@271: yuuji@271: * Menu: yuuji@271: yuuji@445: * CSS-class completion:: yuuji@445: * Reread CSS definition:: yuuji@271: yuuji@271: yuuji@271:  yuuji@271: File: yahtmle, Node: CSS-class completion, Next: Reread CSS definition, Prev: CSS Support, Up: CSS Support yuuji@271: yuuji@271: CSS class-name completion yuuji@271: ========================= yuuji@271: You can input a class name in your CSS definition with completion. If you yuuji@271: have CSS defined as below; yuuji@271: yuuji@271: h1.foo, h2.foo { background-color: 0xffffff; } yuuji@271: h1.bar, h2.bar { font-size: 120%; } yuuji@271: yuuji@271: when you input h1(or h2) tag with completing-read by [prefix] b or yuuji@271: [prefix] l, yahtml prompts you to input class name with completion from yuuji@271: the words which are effective to h1 or h2. And if you defined global yuuji@271: class like this; yuuji@271: yuuji@271: .caution { font-size: 120%; background-color: 0xc00000;} yuuji@271: yuuji@271: when you input any tags via completing-read, yahtml prompts you to input yuuji@445: class name. If this is bothering, typing `C-j' instead of yuuji@445: `RET' (or `C-m') cancels the next prompt to class name completion. yuuji@271: yuuji@271: yuuji@271:  yuuji@271: File: yahtmle, Node: Reread CSS definition, Prev: CSS-class completion, Up: CSS Support yuuji@271: yuuji@271: Re-reading CSS definition yuuji@271: ========================= yuuji@271: If you add some class to your CSS file and you want yahtml to load new yuuji@271: definitions, type `M-x yahtml-mode RET' to make yahtml do. yuuji@271: yuuji@271: yuuji@271:  yuuji@271: File: yahtmle, Node: Customizations, Next: Copying, Prev: CSS Support, Up: Top yuuji@271: yuuji@271: Customizations yuuji@271: ************** yuuji@271: yuuji@271: Variables that modify yahtml's behavior. yuuji@271: yuuji@271: * Menu: yuuji@271: yuuji@271: * All customizable variables:: List of customizable variables yuuji@271: * Hook variables:: hook variables yuuji@271: yuuji@271: yuuji@271:  yuuji@271: File: yahtmle, Node: All customizable variables, Next: Hook variables, Prev: Customizations, Up: Customizations yuuji@271: yuuji@271: List of customizable variables. Defaults in parenthesis yuuji@271: ======================================================== yuuji@271: yuuji@271: -- Variable: yahtml-prefix yuuji@271: Prefix key for yahtml-mode. (`\C-c') yuuji@271: yuuji@271: -- Variable: yahtml-image-viewer yuuji@271: Command to view image files refered by img. (xv) yuuji@271: yuuji@271: -- Variable: yahtml-www-browser yuuji@271: Browser to view external pages with `[prefix]g'. (netscape) yuuji@271: yuuji@271: -- Variable: yahtml-kanji-code yuuji@271: Default kanji code. 1=sjis, 2=jis, 3=euc, 4=utf-8 (2) If AddType yuuji@445: "text/html; charset=xxx" .html is written in .htaccess, this yuuji@445: will override yahtml-kanji-code. yuuji@271: yuuji@271: -- Variable: yahtml-fill-column yuuji@271: Columns to auto-fill (72) yuuji@271: yuuji@271: -- Variable: yahtml-fill-prefix yuuji@271: fill-prefix specific to yahtml-mode. (`nil') yuuji@271: yuuji@271: -- Variable: yahtml-path-url-alist yuuji@271: Matching list of URL and full path name on OS's file system. yuuji@271: yuuji@271: -- Variable: yahtml-directory-index yuuji@271: Default index filed opened when accessing a server without a yuuji@271: filename, usually index.html. (`"index.html"') yuuji@271: yuuji@271: -- Variable: yahtml-lint-program yuuji@271: HTML syntax check program. (`"jweblint"') yuuji@271: yuuji@271: -- Variable: yahtml-hate-too-deep-indentation yuuji@271: setq to t when indentations for nested enumerate elements are too yuuji@271: deep. (`nil') yuuji@271: yuuji@271: -- Variable: yahtml-always-/p yuuji@271: setq to t if you always want `

' after `

'. `nil' yuuji@271: yuuji@271: -- Variable: yahtml-p-prefered-env-regexp yuuji@271: Elements that `

' will be automatically inserted. yuuji@271: (`"^\\(body\\|dl\\|blockquote\\)"') yuuji@271: yuuji@271: -- Variable: yahtml-template-file yuuji@271: File to automatically insert when editing a new HTML file. yuuji@271: `"~/http/template.html"' yuuji@271: yuuji@271: -- Variable: yahtml-prefer-upcases yuuji@271: Use uppercase for tags. `nil' yuuji@271: yuuji@271: -- Variable: yahtml-prefer-upcase-attributes yuuji@271: Use uppercase for attributes. `nil' yuuji@271: yuuji@271: -- Variable: yahtml-server-type yuuji@271: setq to 'apache if using a Apache server, and will refer ./.htaccess. yuuji@271: `'apache' yuuji@271: yuuji@271: -- Variable: yahtml-apache-access-file yuuji@271: When `yahtml-server-type' is `'apache', define name of access yuuji@271: restriction file. `".htaccess"' yuuji@271: yuuji@271: -- Variable: yahtml-shell-command-option yuuji@271: Options needed to invoke shell commands. yuuji@271: yuuji@271: -- Variable: yahtml-translate-hyphens-when-comment-region yuuji@271: Whether to change hyphens to `-' when commenting out region. yuuji@271: (`t') yuuji@271: yuuji@271: -- Variable: yahtml-entity-reference-chars-alist yuuji@271: alist of characters that needs to be written by Entity Reference. yuuji@271: Enter as `'(?char . "EntityReference")'. By default, `<', `>', `&', yuuji@271: `'', is set. Add as needed. Do not include `&' at beginning and `;' yuuji@271: at end of cdr portion of `"EntityReference"'. yuuji@271: yuuji@271: -- Variable: yahtml-faithful-to-htmllint yuuji@271: When using htmllint to check syntax, it will complain about excess yuuji@271: spaces. setq to `t' to avoid this. yuuji@271: yuuji@271: -- Variable: yahtml-use-css yuuji@271: Use style-sheet support or not (`t') yuuji@271: yuuji@271: -- Variable: yahtml-image-inspection-bytes yuuji@271: Number of bytes to inspect the image for geometry information yuuji@271: (`10000') yuuji@271: yuuji@271: -- Variable: yahtml:img-default-alt-format yuuji@271: format of img entity's ALT attributes. %x: width, %y: height, %s: yuuji@271: size in bytes, %c: first comment string, %f: filename yuuji@271: (`"%xx%y(%sbytes)"') yuuji@271: yuuji@271: -- Variable: yahtml-escape-chars yuuji@271: When, completing href-s, Escape reserved characters to URL-encoding yuuji@271: or not. Nil for never, t for everytime, and 'ask for inquiring at yuuji@271: each reserved chars. (`'ask') yuuji@271: yuuji@271: -- Variable: yahtml-use-font-lock yuuji@271: Use font-lock to fontify buffer or not (`(featurep 'font-lock)') yuuji@271: yuuji@271: -- Variable: yahtml-use-hilit19 yuuji@271: Use hilit19 to highlight buffer or not (`(featurep 'hilit19)') yuuji@271: yuuji@271: -- Variable: yahtml-indentation-boundary yuuji@271: Boundary regexp for indentation calculation. (`"^\\s *"') yuuji@271: yuuji@271: yuuji@271:  yuuji@271: File: yahtmle, Node: Hook variables, Prev: All customizable variables, Up: Customizations yuuji@271: yuuji@271: hook variables yuuji@271: ============== yuuji@271: yuuji@271: yuuji@271: yuuji@271:  yuuji@271: File: yahtmle, Node: Copying, Next: Concept Index, Prev: Customizations, Up: Top yuuji@271: yuuji@271: Copying yuuji@271: ******* yuuji@271: yuuji@271: This program is distributed as freesoftware. The author will take no yuuji@271: responsibility to any damages due to the usage of this software yuuji@271: whatsoever. There are no restrictions to its redistribution, just use yuuji@271: common sense. Mail me your thoughts on this program and I will be more yuuji@271: than willing to help. yuuji@271: yuuji@271: Complaints, requests, bug reports and comments are welcome. Make contacts yuuji@271: to yuuji@yatex.org@(as of December 2000) yuuji@271: yuuji@271: If you like this program and use it on a regular basis, please join the yuuji@271: mailing list "fj Wild Bird Society". Procedures can be found in the "etc" yuuji@271: section of `docs/htmlqa.eng' in this package. yuuji@271: yuuji@271: yuuji@271: HIROSE, Yuuji yuuji@271: yuuji@271: yuuji@271: yuuji@271:  yuuji@271: File: yahtmle, Node: Concept Index, Prev: Copying, Up: Top yuuji@271: yuuji@271: Index yuuji@271: ***** yuuji@271: yuuji@271: * Menu: yuuji@271: yuuji@445: * Customize: Customizations. (line 5) yuuji@445: * Demacs: Intro. (line 5) yuuji@445: * Key Assign: Customizations. (line 5) yuuji@445: * LaTeX: Intro. (line 5) yuuji@445: * Mule: Intro. (line 5) yuuji@445: * yahtml: Intro. (line 5) yuuji@271:  yuuji@271: Tag table: yuuji@445: Node: Top259 yuuji@445: Node: Intro836 yuuji@445: Node: Installation1234 yuuji@445: Node: Setting up yahtml1500 yuuji@445: Node: Setting environments for weblint browsers and image viewers2291 yuuji@445: Node: Setting environment variables for WWW pages2987 yuuji@445: Node: Command Invocation3979 yuuji@445: Node: Completion4407 yuuji@445: Node: Jump5923 yuuji@445: Node: Changing and Deleting6403 yuuji@445: Node: Changing tags in pairs6665 yuuji@445: Node: Changing entities7160 yuuji@445: Node: URLencoding of strings within region7704 yuuji@445: Node: td-enclosure/tr-enclosure8007 yuuji@445: Node: CSS Support9032 yuuji@445: Node: CSS-class completion9243 yuuji@445: Node: Reread CSS definition10096 yuuji@445: Node: Customizations10371 yuuji@445: Node: All customizable variables10647 yuuji@445: Node: Hook variables14427 yuuji@445: Node: Copying14553 yuuji@445: Node: Concept Index15344 yuuji@271:  yuuji@271: End tag table