From f9265fec8cd9f23a16bf2f3219411e78a8ba4b17 Mon Sep 17 00:00:00 2001 From: Chris Mann Date: Tue, 28 Oct 2008 21:26:40 +1030 Subject: [PATCH] * wesnoth-mode.texi: New file. * Makefile: Build documentation. Default to info; added support for PDF. --- Makefile | 9 +- wesnoth-mode.texi | 326 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 334 insertions(+), 1 deletion(-) create mode 100644 wesnoth-mode.texi diff --git a/Makefile b/Makefile index 061bd8e..28cbabd 100644 --- a/Makefile +++ b/Makefile @@ -1,13 +1,20 @@ ELISP = wesnoth-mode.el wesnoth-update.el +DOC = wesnoth-mode.texi BYTECOMPILED = wesnoth-mode.elc wesnoth-update.elc EMACS = emacs FLAGS = -q --eval "(add-to-list 'load-path default-directory)" \ --batch -f batch-byte-compile -all: wesnoth-mode +all: wesnoth-mode info wesnoth-mode : $(EMACS) $(FLAGS) $(ELISP) +info : + makeinfo $(DOC) + +pdf : + texi2dvi --pdf -c $(DOC) + .PHONY: clean clean: diff --git a/wesnoth-mode.texi b/wesnoth-mode.texi new file mode 100644 index 0000000..05b7f36 --- /dev/null +++ b/wesnoth-mode.texi @@ -0,0 +1,326 @@ +\input texinfo +@c %**start of header +@setfilename wesnoth-mode.info +@settitle Wesnoth Mode Manual + +@set VERSION 1.3.2 +@set DATE October 2008 + +@dircategory Emacs +@direntry +* Wesnoth Mode: (wesnoth-mode). Major-mode for editing WML +@end direntry + +@c Contact information +@set MAINTAINERSITE @uref{http://www.wesnoth.org/forum/viewtopic.php?t=13798} +@set AUTHOR Chris Mann +@c %**end of header +@finalout + +@c Subheadings inside a table. +@macro tsubheading{text} +@ifinfo +@subsubheading \text\ +@end ifinfo +@ifnotinfo +@item @b{\text\} +@end ifnotinfo +@end macro + +@copying +This manual is for Wesnoth Mode (version @value{VERSION}). + +Copyright @copyright{} 2006, 2007, 2008 Chris Mann +@end copying + +@titlepage +@title Wesnoth Mode Manual +@subtitle Version @value{VERSION} +@author by Chris Mann + +@page + +@vskip 0pt plus 1fill +@insertcopying +@end titlepage + +@contents +@ifnottex +@node Top, Introduction, (dir), (dir) +@top Wesnoth Mode Manual + +@insertcopying +@end ifnottex + +@menu +* Introduction:: Getting started +* Navigation:: Moving around within WML +* Inserting Elements:: +* Completion:: Tab-completion for elements +* Checking WML:: +* Configuration:: Available customisation options +* Updating WML:: How to update WML information +* Index:: Documentation Index +* Key Index:: Index for Key-Bindings + +@detailmenu + --- Detailed Node Listing --- + +Introduction + +* Summary:: +* Getting Started:: +* Basic Usage:: +* Getting Wesnoth Mode + +Navigation + +* Moving Across Elements:: +* Matching Elements:: + +Inserting Elements + +* Inserting Tags:: +* Inserting Attributes:: +* Inserting Macros:: +* Inserting Preprocessor Statements:: +* Wrapping Around Elements:: + +Completion + +* Tab-Completion Summary:: +* Wrapping Around Elements:: + +Checking WML + +* Summary:: +* Capabilities:: + +Updating WML + +* Updating Basics:: +* Update Customisation:: + +Configuration + +* Indentation:: +* Wesnoth Update:: + +@end detailmenu +@end menu + +@node Introduction, Navigation, Top, Top +@comment node-name, next, previous, up +@chapter Introduction +@cindex Introduction + +@menu +* Summary:: +* Getting Started:: +* Basic Usage:: +* Getting Wesnoth Mode:: +@end menu + +@node Summary, Getting Started, Introduction, Introduction +@comment node-name, next, previous, up +@section Summary +@cindex summary + +Wesnoth-mode is a major mode for Emacs which assists in the editing of the +markup language extensively used in Wesnoth, a turn-based fantasy strategy +game. From the Wesnoth Wiki: "The Wesnoth Markup Language (WML) is used to +code almost everything in Wesnoth, including scenarios, units, savefiles, and +the user interface layout." @footnote{@uref{http://www.wesnoth.org/wiki/ReferenceWML}} + +Wesnoth-mode is supported under GNU Emacs 22 and 21 and (with some minor +limitations) XEmacs 21 and adds support for syntax highlighting, automatic +indentation, context-sensitive completion, checking and much more for WML. + +The following documentation attempts to provide a comprehensive guide to +functionality available within wesnoth-mode, and assumes you are +familiar with basic usage, terminology and customisation of Emacs. For +more information, please refer to the Emacs +manual. @footnote{@uref{http://www.gnu.org/software/emacs/manual/html_node/emacs/}} + +@node Getting Started, Basic Usage, Summary, Introduction +@comment node-name, next, previous, up +@section Getting Started +@cindex Getting Started + +To use wesnoth-mode, add the following to your @file{.emacs}: +@lisp + (add-to-list 'load-path "path/to/wesnoth-mode") + (autoload 'wesnoth-mode "wesnoth-mode" "Major mode for editing WML." t) +@end lisp +Optionally adding: +@lisp + (add-to-list 'auto-mode-alist '("\\.cfg\\'" . wesnoth-mode)) +@end lisp +to automatically load wesnoth-mode for all files with a '.cfg' extension. + +@c TODO: Add more here. + +@node Basic Usage, Getting Wesnoth Mode, Getting Started, Introduction +@comment node-name, next, previous, up +@section Basic Usage +@cindex Basic Usage + +@node Getting Wesnoth Mode, , Basic Usage, Introduction +@comment node-name, next, previous, up +@section Getting Wesnoth Mode +@cindex Getting Wesnoth Mode + +For the latest version of Wesnoth Mode, visit +@uref{http://www.wesnoth.org/forum/viewtopic.php?t=13798}. + +@node Navigation, Inserting Elements, Introduction, Top +@comment node-name, next, previous, up +@chapter Navigation +@cindex Navigation + +@menu +* Moving Across Elements:: +* Matching Elements:: +@end menu + +@node Moving Across Elements, Matching Elements, Navigation, Navigation +@comment node-name, next, previous, up +@section Moving Across Elements +@cindex Moving Across Elements + +@node Matching Elements, , Moving Across Elements, Navigation +@comment node-name, next, previous, up +@section Matching Elements +@cindex Matching Elements + +@node Inserting Elements, Completion, Navigation, Top +@comment node-name, next, previous, up +@chapter Inserting Elements +@cindex Inserting Elements + +@menu +* Inserting Tags:: +* Inserting Attributes:: +* Inserting Macros:: +* Inserting Preprocessor Statements:: +* Wrapping Around Elements:: +@end menu + +@node Inserting Tags, Inserting Attributes, Inserting Elements, Inserting Elements +@comment node-name, next, previous, up +@section Inserting Tags +@cindex Inserting Tags + +@node Inserting Attributes, Inserting Macros, Inserting Tags, Inserting Elements +@comment node-name, next, previous, up +@section Inserting Attributes +@cindex Inserting Attributes + +@node Inserting Macros, Inserting Preprocessor Statements, Inserting Attributes, Inserting Elements +@comment node-name, next, previous, up +@section Inserting Macros +@cindex Inserting Macros + +@node Inserting Preprocessor Statements, , Inserting Macros, Inserting Elements +@comment node-name, next, previous, up +@section Inserting Preprocessor Statements +@cindex Inserting Preprocessor Statements + +@node Completion, Checking WML, Inserting Elements, Top +@comment node-name, next, previous, up +@chapter Completion +@cindex Completion + +@menu +* Tab-Completion Summary:: +* Wrapping Around Elements:: +@end menu + +@node Tab-Completion Summary, Wrapping Around Elements, Completion, Completion +@comment node-name, next, previous, up +@section Tab-Completion Summary +@cindex Tab-Completion Summary + +@node Wrapping Around Elements, , Tab-Completion Summary, Completion +@comment node-name, next, previous, up +@section Wrapping Around Elements +@cindex Wrapping Around Elements + +@node Checking WML, Updating WML, Completion, Top +@comment node-name, next, previous, up +@chapter Checking WML +@cindex Checking WML + +@menu +* Usage:: +* Capabilities:: +@end menu + +@node Usage, Capabilities, Checking WML, Checking WML +@comment node-name, next, previous, up +@section Usage +@cindex Usage + +@node Capabilities, , Usage, Checking WML +@comment node-name, next, previous, up +@section Capabilities +@cindex Capabilities + +@node Updating WML, Configuration, Checking WML, Top +@comment node-name, next, previous, up +@chapter Updating WML +@cindex Updating WML + +@menu +* Updating Basics:: +* Update Customisation:: +@end menu + +@node Updating Basics, Update Customisation, Updating WML, Updating WML +@comment node-name, next, previous, up +@section Updating Basics +@cindex Updating Basics + +@node Update Customisation, , Updating Basics, Updating WML +@comment node-name, next, previous, up +@section Update Customisation +@cindex Update Customisation + +@node Configuration, Index, Updating WML, Top +@comment node-name, next, previous, up +@chapter Configuration +@cindex Configuration + +@menu +* Indentation:: +* Wesnoth Update:: +@end menu + +@node Indentation, Wesnoth Update, Configuration, Configuration +@comment node-name, next, previous, up +@section Indentation +@cindex Indentation + +@node Wesnoth Update, , Indentation, Configuration +@comment node-name, next, previous, up +@section Wesnoth Update +@cindex Wesnoth Update + +@node Index, Key Index, Configuration, Top +@comment node-name, next, previous, up +@chapter Index +@printindex cp + +@node Key Index, , Index, Top +@comment node-name, next, previous, up +@unnumbered Key Index +@chapter Key Index + +@printindex ky + +@bye + +@c Local Variables: +@c mode: texinfo +@c TeX-master: t +@c End: -- 2.11.4.GIT