diff --git a/.gitmodules b/.gitmodules
new file mode 100644
index 00000000..e6077a69
--- /dev/null
+++ b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "_embed/public/ace"]
+ path = _embed/public/ace
+ url = https://github.com/ajaxorg/ace-builds
diff --git a/.travis.yml b/.travis.yml
index 863e0567..081942e5 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -12,7 +12,6 @@ install:
script:
- diff <(echo -n) <(gofmt -s -d .)
- - go generate
- sed -i 's/\_ \"github.com\/mholt\/caddy\/caddyhttp\"/\_ \"github.com\/mholt\/caddy\/caddyhttp\"\n\_ \"github.com\/hacdias\/caddy-filemanager\"/g' $GOPATH/src/github.com/mholt/caddy/caddy/caddymain/run.go
- go build github.com/mholt/caddy/caddy
- ineffassign .
diff --git a/_embed/public/ace/ChangeLog.txt b/_embed/public/ace/ChangeLog.txt
new file mode 100644
index 00000000..dcaa33da
--- /dev/null
+++ b/_embed/public/ace/ChangeLog.txt
@@ -0,0 +1,372 @@
+2016.12.03 Version 1.2.6
+
+* Fixed IME handling on new Chrome
+* Support for php 7 in the syntax checker
+
+2016.08.16 Version 1.2.5
+
+* Fixed regression in noconflict mode
+
+2016.07.27 Version 1.2.4
+
+* Maintenance release with several new modes and small bugfixes
+
+2016.01.17 Version 1.2.3
+
+* Bugfixes
+ - fix memory leak in setSession (Tyler Stalder)
+ - double click not working on linux/mac
+
+* new language modes
+ - reStructuredText (Robin Jarry)
+ - NSIS (Jan T. Sott)
+
+
+2015.10.28 Version 1.2.1
+
+* new language modes
+ - Swift
+ - JSX
+
+2015.07.11 Version 1.2.0
+
+* New Features
+ - Indented soft wrap (danyaPostfactum)
+ - Rounded borders on selections
+
+* API Changes
+ - unified delta types `{start, end, action, lines}` (Alden Daniels https://github.com/ajaxorg/ace/pull/1745)
+ - "change" event listeners on session and editor get delta objects directly
+
+* new language modes
+ - SQLServer (Morgan Yarbrough)
+
+2015.04.03 Version 1.1.9
+
+ - Small Enhancements and Bugfixes
+
+2014.11.08 Version 1.1.8
+
+* API Changes
+ - `editor.commands.commandKeyBinding` now contains direct map from keys to commands instead of grouping them by hashid
+
+* New Features
+ - Improved autoindent for html and php modes (Adam Jimenez)
+ - Find All from searchbox (Colton Voege)
+
+* new language modes
+ - Elixir, Elm
+
+2014.09.21 Version 1.1.7
+
+* Bugfixes
+ - fix several bugs in autocompletion
+ - workaround for inaccurate getBoundingClientRect on chrome 37
+
+2014.08.17 Version 1.1.6
+
+* Bugfixes
+ - fix regression in double tap to highlight
+ - Improved Latex Mode (Daniel Felder)
+
+* API Changes
+ - editor.destroy destroys editor.session too (call editor.setSession(null) to prevent that)
+
+* new language modes
+ - Praat (José Joaquín Atria)
+ - Eiffel (Victorien Elvinger)
+ - G-code (Adam Joseph Cook)
+
+2014.07.09 Version 1.1.5
+
+* Bugfixes
+ - fix regression in autocomplete popup
+
+* new language modes
+ - gitignore (Devon Carew)
+
+2014.07.01 Version 1.1.4
+
+* New Features
+ - Highlight matching tags (Adam Jimenez)
+ - Improved jump to matching command (Adam Jimenez)
+
+* new language modes
+ - AppleScript (Yaogang Lian)
+ - Vala
+
+2014.03.08 Version 1.1.3
+
+* New Features
+ - Allow syntax checkers to be loaded from CDN (Derk-Jan Hartman)
+ - Add ColdFusion behavior (Abram Adams)
+ - add showLineNumbers option
+ - Add html syntax checker (danyaPostfactum)
+
+* new language modes
+ - Gherkin (Patrick Nevels)
+ - Smarty
+
+2013.12.02 Version 1.1.2
+
+* New Features
+ - Accessibility Theme for Ace (Peter Xiao)
+ - use snipetManager for expanding emmet snippets
+ - update jshint to 2.1.4
+ - improve php syntax checker (jdalegonzalez)
+ - add option for autoresizing
+ - add option for autohiding vertical scrollbar
+ - improvements to highlighting of xml like languages (danyaPostfactum)
+ - add support for autocompletion and snippets (gjtorikyan danyaPostfactum and others)
+ - add option to merge similar changes in undo history
+ - add scrollPastEnd option
+ - use html5 dragndrop for text dragging (danyaPostfactum)
+
+* API Changes
+ - fixed typo in HashHandler commmandManager
+
+* new language modes
+ - Nix (Zef Hemel)
+ - Protobuf (Zef Hemel)
+ - Soy
+ - Handlebars
+
+2013.06.04 Version 1.1.1
+
+ - Improved emacs keybindings (Robert Krahn)
+ - Added markClean, isClean methods to UndoManager (Joonsoo Jeon)
+ - Do not allow `Toggle comments` command to remove spaces from indentation
+ - Softer colors for indent guides in dark themes
+
+* new language modes
+ - Ada
+ - Assembly_x86
+ - Cobol
+ - D
+ - ejs
+ - MATLAB
+ - MySQL
+ - Twig
+ - Verilog
+
+2013.05.01, Version 1.1.0
+
+* API Changes
+ - Default position of the editor container is changed to relative. Add `.ace_editor {position: absolute}` css rule to restore old behavior
+ - Changed default line-height to `normal` to not conflict with bootstrap. Use `line-height: inherit` for old behavior.
+ - Changed marker types accepted by session.addMarker. It now accepts "text"|"line"|"fullLine"|"screenLine"
+ - Internal classnames used by editor were made more consistent
+ - Introduced `editor.setOption/getOption/setOptions/getOptions` methods
+ - Introduced positionToIndex, indexToPosition methods
+
+* New Features
+ - Improved emacs mode (chetstone)
+ with Incremental search and Occur modes (Robert Krahn)
+
+ - Improved ime handling
+ - Searchbox (Vlad Zinculescu)
+
+ - Added elastic tabstops lite extension (Garen Torikian)
+ - Added extension for whitespace manipulation
+ - Added extension for enabling spellchecking from contextmenu
+ - Added extension for displaying available keyboard shortcuts (Matthew Christopher Kastor-Inare III)
+ - Added extension for displaying options panel (Matthew Christopher Kastor-Inare III)
+ - Added modelist extension (Matthew Christopher Kastor-Inare III)
+
+ - Improved toggleCommentLines and added ToggleCommentBlock command
+ - `:;` pairing in CSS mode (danyaPostfactum)
+
+ - Added suppoert for Delete and SelectAll from context menu (danyaPostfactum)
+
+ - Make wrapping behavior optional
+ - Selective bracket insertion/skipping
+
+ - Added commands for increase/decrease numbers, sort lines (Vlad Zinculescu)
+ - Folding for Markdown, Lua, LaTeX
+ - Selective bracket insertion/skipping for C-like languages
+
+* Many new languages
+ - Scheme (Mu Lei)
+ - Dot (edwardsp)
+ - FreeMarker (nguillaumin)
+ - Tiny Mushcode (h3rb)
+ - Velocity (Ryan Griffith)
+ - TOML (Garen Torikian)
+ - LSL (Nemurimasu Neiro, Builders Brewery)
+ - Curly (Libo Cannici)
+ - vbScript (Jan Jongboom)
+ - R (RStudio)
+ - ABAP
+ - Lucene (Graham Scott)
+ - Haml (Garen Torikian)
+ - Objective-C (Garen Torikian)
+ - Makefile (Garen Torikian)
+ - TypeScript (Garen Torikian)
+ - Lisp (Garen Torikian)
+ - Stylus (Garen Torikian)
+ - Dart (Garen Torikian)
+
+* Live syntax checks
+ - PHP (danyaPostfactum)
+ - Lua
+
+* New Themes
+ - Chaos
+ - Terminal
+
+2012.09.17, Version 1.0.0
+
+* New Features
+ - Multiple cursors and selections (https://c9.io/site/blog/2012/08/be-an-armenian-warrior-with-block-selection-on-steroids/)
+ - Fold buttons displayed in the gutter
+ - Indent Guides
+ - Completely reworked vim mode (Sergi Mansilla)
+ - Improved emacs keybindings
+ - Autoclosing of html tags (danyaPostfactum)
+
+* 20 New language modes
+ - Coldfusion (Russ)
+ - Diff
+ - GLSL (Ed Mackey)
+ - Go (Davide Saurino)
+ - Haxe (Jason O'Neil)
+ - Jade (Garen Torikian)
+ - jsx (Syu Kato)
+ - LaTeX (James Allen)
+ - Less (John Roepke)
+ - Liquid (Bernie Telles)
+ - Lua (Lee Gao)
+ - LuaPage (Choonster)
+ - Markdown (Chris Spencer)
+ - PostgreSQL (John DeSoi)
+ - Powershell (John Kane)
+ - Sh (Richo Healey)
+ - SQL (Jonathan Camile)
+ - Tcl (Cristoph Hochreiner)
+ - XQuery (William Candillion)
+ - Yaml (Meg Sharkey)
+
+ * Live syntax checks
+ - for XQuery and JSON
+
+* New Themes
+ - Ambiance (Irakli Gozalishvili)
+ - Dreamweaver (Adam Jimenez)
+ - Github (bootstraponline)
+ - Tommorrow themes (https://github.com/chriskempson/tomorrow-theme)
+ - XCode
+
+* Many Small Enhancements and Bugfixes
+
+2011.08.02, Version 0.2.0
+
+* Split view (Julian Viereck)
+ - split editor area horizontally or vertivally to show two files at the same
+ time
+
+* Code Folding (Julian Viereck)
+ - Unstructured code folding
+ - Will be the basis for language aware folding
+
+* Mode behaviours (Chris Spencer)
+ - Adds mode specific hooks which allow transformations of entered text
+ - Autoclosing of braces, paranthesis and quotation marks in C style modes
+ - Autoclosing of angular brackets in XML style modes
+
+* New language modes
+ - Clojure (Carin Meier)
+ - C# (Rob Conery)
+ - Groovy (Ben Tilford)
+ - Scala (Ben Tilford)
+ - JSON
+ - OCaml (Sergi Mansilla)
+ - Perl (Panagiotis Astithas)
+ - SCSS/SASS (Andreas Madsen)
+ - SVG
+ - Textile (Kelley van Evert)
+ - SCAD (Jacob Hansson)
+
+* Live syntax checks
+ - Lint for CSS using CSS Lint
+ - CoffeeScript
+
+* New Themes
+ - Crimson Editor (iebuggy)
+ - Merbivore (Michael Schwartz)
+ - Merbivore soft (Michael Schwartz)
+ - Solarized dark/light (David Alan Hjelle)
+ - Vibrant Ink (Michael Schwartz)
+
+* Small Features/Enhancements
+ - Lots of render performance optimizations (Harutyun Amirjanyan)
+ - Improved Ruby highlighting (Chris Wanstrath, Trent Ogren)
+ - Improved PHP highlighting (Thomas Hruska)
+ - Improved CSS highlighting (Sean Kellogg)
+ - Clicks which cause the editor to be focused don't reset the selection
+ - Make padding text layer specific so that print margin and active line
+ highlight are not affected (Irakli Gozalishvili)
+ - Added setFontSize method
+ - Improved vi keybindings (Trent Ogren)
+ - When unfocused make cursor transparent instead of removing it (Harutyun Amirjanyan)
+ - Support for matching groups in tokenizer with arrays of tokens (Chris Spencer)
+
+* Bug fixes
+ - Add support for the new OSX scroll bars
+ - Properly highlight JavaScript regexp literals
+ - Proper handling of unicode characters in JavaScript identifiers
+ - Fix remove lines command on last line (Harutyun Amirjanyan)
+ - Fix scroll wheel sluggishness in Safari
+ - Make keyboard infrastructure route keys like []^$ the right way (Julian Viereck)
+
+2011.02.14, Version 0.1.6
+
+* Floating Anchors
+ - An Anchor is a floating pointer in the document.
+ - Whenever text is inserted or deleted before the cursor, the position of
+ the cursor is updated
+ - Usesd for the cursor and selection
+ - Basis for bookmarks, multiple cursors and snippets in the future
+* Extensive support for Cocoa style keybindings on the Mac
+* New commands:
+ - center selection in viewport
+ - remove to end/start of line
+ - split line
+ - transpose letters
+* Refator markers
+ - Custom code can be used to render markers
+ - Markers can be in front or behind the text
+ - Markers are now stored in the session (was in the renderer)
+* Lots of IE8 fixes including copy, cut and selections
+* Unit tests can also be run in the browser
+
+* Soft wrap can adapt to the width of the editor (Mike Ratcliffe, Joe Cheng)
+* Add minimal node server server.js to run the Ace demo in Chrome
+* The top level editor.html demo has been renamed to index.html
+* Bug fixes
+ - Fixed gotoLine to consider wrapped lines when calculating where to scroll to (James Allen)
+ - Fixed isues when the editor was scrolled in the web page (Eric Allam)
+ - Highlighting of Python string literals
+ - Syntax rule for PHP comments
+
+2011.02.08, Version 0.1.5
+
+* Add Coffeescript Mode (Satoshi Murakami)
+* Fix word wrap bug (Julian Viereck)
+* Fix packaged version of the Eclipse mode
+* Loading of workers is more robust
+* Fix "click selection"
+* Allow tokizing empty lines (Daniel Krech)
+* Make PageUp/Down behavior more consistent with native OS (Joe Cheng)
+
+2011.02.04, Version 0.1.4
+
+* Add C/C++ mode contributed by Gastón Kleiman
+* Fix exception in key input
+
+2011.02.04, Version 0.1.3
+
+* Let the packaged version play nice with requireJS
+* Add Ruby mode contributed by Shlomo Zalman Heigh
+* Add Java mode contributed by Tom Tasche
+* Fix annotation bug
+* Changing a document added a new empty line at the end
diff --git a/_embed/public/ace/LICENSE b/_embed/public/ace/LICENSE
new file mode 100644
index 00000000..4760be2a
--- /dev/null
+++ b/_embed/public/ace/LICENSE
@@ -0,0 +1,24 @@
+Copyright (c) 2010, Ajax.org B.V.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+ * Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+ * Neither the name of Ajax.org B.V. nor the
+ names of its contributors may be used to endorse or promote products
+ derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL AJAX.ORG B.V. BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/_embed/public/ace/README.md b/_embed/public/ace/README.md
new file mode 100644
index 00000000..fab8497a
--- /dev/null
+++ b/_embed/public/ace/README.md
@@ -0,0 +1,22 @@
+Ace (Ajax.org Cloud9 Editor)
+============================
+[](https://cdnjs.com/libraries/ace)
+
+Ace is a code editor written in JavaScript.
+
+This repository has only generated files.
+If you want to work on ace please go to https://github.com/ajaxorg/ace instead.
+
+
+here you can find pre-built files for convenience of embedding.
+it contains 4 versions
+ * [src](https://github.com/ajaxorg/ace-builds/tree/master/src) concatenated but not minified
+ * [src-min](https://github.com/ajaxorg/ace-builds/tree/master/src-min) concatenated and minified with uglify.js
+ * [src-noconflict](https://github.com/ajaxorg/ace-builds/tree/master/src-noconflict) uses ace.require instead of require
+ * [src-min-noconflict](https://github.com/ajaxorg/ace-builds/tree/master/src-min-noconflict) concatenated, minified with uglify.js, and uses ace.require instead of require
+
+
+For a simple way of embedding ace into webpage see [editor.html](https://github.com/ajaxorg/ace-builds/blob/master/editor.html) or list of other [simple examples](https://github.com/ajaxorg/ace-builds/tree/master/demo)
+To see ace in action go to [kitchen-sink-demo](http://ajaxorg.github.com/ace-builds/kitchen-sink.html), [scrollable-page-demo](http://ajaxorg.github.com/ace-builds/demo/scrollable-page.html) or [minimal demo](http://ajaxorg.github.com/ace-builds/editor.html),
+
+
diff --git a/_embed/public/ace/bower.json b/_embed/public/ace/bower.json
new file mode 100644
index 00000000..b1949a38
--- /dev/null
+++ b/_embed/public/ace/bower.json
@@ -0,0 +1,21 @@
+{
+ "name": "ace-builds",
+ "version": "1.2.6",
+ "description": "Ace (Ajax.org Cloud9 Editor)",
+ "scripts": {
+ "test": "echo \"Error: no test specified\" && exit 1"
+ },
+ "ignore": [
+ "demo"
+ ],
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/ajaxorg/ace-builds.git"
+ },
+ "author": "",
+ "license": "BSD",
+ "bugs": {
+ "url": "https://github.com/ajaxorg/ace-builds/issues"
+ },
+ "homepage": "https://github.com/ajaxorg/ace-builds"
+}
diff --git a/_embed/public/ace/demo/autocompletion.html b/_embed/public/ace/demo/autocompletion.html
new file mode 100644
index 00000000..956f5842
--- /dev/null
+++ b/_embed/public/ace/demo/autocompletion.html
@@ -0,0 +1,45 @@
+
+
+
+
+ ACE Autocompletion demo
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/_embed/public/ace/demo/autoresize.html b/_embed/public/ace/demo/autoresize.html
new file mode 100644
index 00000000..e1a7a2a1
--- /dev/null
+++ b/_embed/public/ace/demo/autoresize.html
@@ -0,0 +1,64 @@
+
+
+
+
+
+ Editor
+
+
+
+
autoresizing editor
+
+
minHeight = 2 lines
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/_embed/public/ace/demo/bookmarklet/images/ace.png b/_embed/public/ace/demo/bookmarklet/images/ace.png
new file mode 100644
index 00000000..9b7c40c8
Binary files /dev/null and b/_embed/public/ace/demo/bookmarklet/images/ace.png differ
diff --git a/_embed/public/ace/demo/bookmarklet/images/background.png b/_embed/public/ace/demo/bookmarklet/images/background.png
new file mode 100644
index 00000000..c6ee9313
Binary files /dev/null and b/_embed/public/ace/demo/bookmarklet/images/background.png differ
diff --git a/_embed/public/ace/demo/bookmarklet/images/body_background.png b/_embed/public/ace/demo/bookmarklet/images/body_background.png
new file mode 100644
index 00000000..2101cdfa
Binary files /dev/null and b/_embed/public/ace/demo/bookmarklet/images/body_background.png differ
diff --git a/_embed/public/ace/demo/bookmarklet/images/bottombar.png b/_embed/public/ace/demo/bookmarklet/images/bottombar.png
new file mode 100644
index 00000000..2e76bf84
Binary files /dev/null and b/_embed/public/ace/demo/bookmarklet/images/bottombar.png differ
diff --git a/_embed/public/ace/demo/bookmarklet/images/fork_on_github.png b/_embed/public/ace/demo/bookmarklet/images/fork_on_github.png
new file mode 100644
index 00000000..e8ddb66e
Binary files /dev/null and b/_embed/public/ace/demo/bookmarklet/images/fork_on_github.png differ
diff --git a/_embed/public/ace/demo/bookmarklet/images/logo.png b/_embed/public/ace/demo/bookmarklet/images/logo.png
new file mode 100644
index 00000000..6af129d9
Binary files /dev/null and b/_embed/public/ace/demo/bookmarklet/images/logo.png differ
diff --git a/_embed/public/ace/demo/bookmarklet/images/logo_half.png b/_embed/public/ace/demo/bookmarklet/images/logo_half.png
new file mode 100644
index 00000000..f99b0c4b
Binary files /dev/null and b/_embed/public/ace/demo/bookmarklet/images/logo_half.png differ
diff --git a/_embed/public/ace/demo/bookmarklet/index.html b/_embed/public/ace/demo/bookmarklet/index.html
new file mode 100644
index 00000000..f3d95ee7
--- /dev/null
+++ b/_embed/public/ace/demo/bookmarklet/index.html
@@ -0,0 +1,112 @@
+
+
+
+
+
+
+ Ace Bookmarklet Builder
+
+
+
+
';
+ if (!regArgs) {
+ for (var registerName in registers) {
+ var text = registers[registerName].toString();
+ if (text.length) {
+ regInfo += '"' + registerName + ' ' + text + ' ';
+ }
+ }
+ } else {
+ var registerName;
+ regArgs = regArgs.join('');
+ for (var i = 0; i < regArgs.length; i++) {
+ registerName = regArgs.charAt(i);
+ if (!vimGlobalState.registerController.isValidRegister(registerName)) {
+ continue;
+ }
+ var register = registers[registerName] || new Register();
+ regInfo += '"' + registerName + ' ' + register.toString() + ' ';
+ }
+ }
+ showConfirm(cm, regInfo);
+ },
+ sort: function(cm, params) {
+ var reverse, ignoreCase, unique, number;
+ function parseArgs() {
+ if (params.argString) {
+ var args = new CodeMirror.StringStream(params.argString);
+ if (args.eat('!')) { reverse = true; }
+ if (args.eol()) { return; }
+ if (!args.eatSpace()) { return 'Invalid arguments'; }
+ var opts = args.match(/[a-z]+/);
+ if (opts) {
+ opts = opts[0];
+ ignoreCase = opts.indexOf('i') != -1;
+ unique = opts.indexOf('u') != -1;
+ var decimal = opts.indexOf('d') != -1 && 1;
+ var hex = opts.indexOf('x') != -1 && 1;
+ var octal = opts.indexOf('o') != -1 && 1;
+ if (decimal + hex + octal > 1) { return 'Invalid arguments'; }
+ number = decimal && 'decimal' || hex && 'hex' || octal && 'octal';
+ }
+ if (args.match(/\/.*\//)) { return 'patterns not supported'; }
+ }
+ }
+ var err = parseArgs();
+ if (err) {
+ showConfirm(cm, err + ': ' + params.argString);
+ return;
+ }
+ var lineStart = params.line || cm.firstLine();
+ var lineEnd = params.lineEnd || params.line || cm.lastLine();
+ if (lineStart == lineEnd) { return; }
+ var curStart = Pos(lineStart, 0);
+ var curEnd = Pos(lineEnd, lineLength(cm, lineEnd));
+ var text = cm.getRange(curStart, curEnd).split('\n');
+ var numberRegex = (number == 'decimal') ? /(-?)([\d]+)/ :
+ (number == 'hex') ? /(-?)(?:0x)?([0-9a-f]+)/i :
+ (number == 'octal') ? /([0-7]+)/ : null;
+ var radix = (number == 'decimal') ? 10 : (number == 'hex') ? 16 : (number == 'octal') ? 8 : null;
+ var numPart = [], textPart = [];
+ if (number) {
+ for (var i = 0; i < text.length; i++) {
+ if (numberRegex.exec(text[i])) {
+ numPart.push(text[i]);
+ } else {
+ textPart.push(text[i]);
+ }
+ }
+ } else {
+ textPart = text;
+ }
+ function compareFn(a, b) {
+ if (reverse) { var tmp; tmp = a; a = b; b = tmp; }
+ if (ignoreCase) { a = a.toLowerCase(); b = b.toLowerCase(); }
+ var anum = number && numberRegex.exec(a);
+ var bnum = number && numberRegex.exec(b);
+ if (!anum) { return a < b ? -1 : 1; }
+ anum = parseInt((anum[1] + anum[2]).toLowerCase(), radix);
+ bnum = parseInt((bnum[1] + bnum[2]).toLowerCase(), radix);
+ return anum - bnum;
+ }
+ numPart.sort(compareFn);
+ textPart.sort(compareFn);
+ text = (!reverse) ? textPart.concat(numPart) : numPart.concat(textPart);
+ if (unique) { // Remove duplicate lines
+ var textOld = text;
+ var lastLine;
+ text = [];
+ for (var i = 0; i < textOld.length; i++) {
+ if (textOld[i] != lastLine) {
+ text.push(textOld[i]);
+ }
+ lastLine = textOld[i];
+ }
+ }
+ cm.replaceRange(text.join('\n'), curStart, curEnd);
+ },
+ global: function(cm, params) {
+ var argString = params.argString;
+ if (!argString) {
+ showConfirm(cm, 'Regular Expression missing from global');
+ return;
+ }
+ var lineStart = (params.line !== undefined) ? params.line : cm.firstLine();
+ var lineEnd = params.lineEnd || params.line || cm.lastLine();
+ var tokens = splitBySlash(argString);
+ var regexPart = argString, cmd;
+ if (tokens.length) {
+ regexPart = tokens[0];
+ cmd = tokens.slice(1, tokens.length).join('/');
+ }
+ if (regexPart) {
+ try {
+ updateSearchQuery(cm, regexPart, true /** ignoreCase */,
+ true /** smartCase */);
+ } catch (e) {
+ showConfirm(cm, 'Invalid regex: ' + regexPart);
+ return;
+ }
+ }
+ var query = getSearchState(cm).getQuery();
+ var matchedLines = [], content = '';
+ for (var i = lineStart; i <= lineEnd; i++) {
+ var matched = query.test(cm.getLine(i));
+ if (matched) {
+ matchedLines.push(i+1);
+ content+= cm.getLine(i) + ' ';
+ }
+ }
+ if (!cmd) {
+ showConfirm(cm, content);
+ return;
+ }
+ var index = 0;
+ var nextCommand = function() {
+ if (index < matchedLines.length) {
+ var command = matchedLines[index] + cmd;
+ exCommandDispatcher.processCommand(cm, command, {
+ callback: nextCommand
+ });
+ }
+ index++;
+ };
+ nextCommand();
+ },
+ substitute: function(cm, params) {
+ if (!cm.getSearchCursor) {
+ throw new Error('Search feature not available. Requires searchcursor.js or ' +
+ 'any other getSearchCursor implementation.');
+ }
+ var argString = params.argString;
+ var tokens = argString ? splitBySlash(argString) : [];
+ var regexPart, replacePart = '', trailing, flagsPart, count;
+ var confirm = false; // Whether to confirm each replace.
+ var global = false; // True to replace all instances on a line, false to replace only 1.
+ if (tokens.length) {
+ regexPart = tokens[0];
+ replacePart = tokens[1];
+ if (replacePart !== undefined) {
+ if (getOption('pcre')) {
+ replacePart = unescapeRegexReplace(replacePart);
+ } else {
+ replacePart = translateRegexReplace(replacePart);
+ }
+ vimGlobalState.lastSubstituteReplacePart = replacePart;
+ }
+ trailing = tokens[2] ? tokens[2].split(' ') : [];
+ } else {
+ if (argString && argString.length) {
+ showConfirm(cm, 'Substitutions should be of the form ' +
+ ':s/pattern/replace/');
+ return;
+ }
+ }
+ if (trailing) {
+ flagsPart = trailing[0];
+ count = parseInt(trailing[1]);
+ if (flagsPart) {
+ if (flagsPart.indexOf('c') != -1) {
+ confirm = true;
+ flagsPart.replace('c', '');
+ }
+ if (flagsPart.indexOf('g') != -1) {
+ global = true;
+ flagsPart.replace('g', '');
+ }
+ regexPart = regexPart + '/' + flagsPart;
+ }
+ }
+ if (regexPart) {
+ try {
+ updateSearchQuery(cm, regexPart, true /** ignoreCase */,
+ true /** smartCase */);
+ } catch (e) {
+ showConfirm(cm, 'Invalid regex: ' + regexPart);
+ return;
+ }
+ }
+ replacePart = replacePart || vimGlobalState.lastSubstituteReplacePart;
+ if (replacePart === undefined) {
+ showConfirm(cm, 'No previous substitute regular expression');
+ return;
+ }
+ var state = getSearchState(cm);
+ var query = state.getQuery();
+ var lineStart = (params.line !== undefined) ? params.line : cm.getCursor().line;
+ var lineEnd = params.lineEnd || lineStart;
+ if (lineStart == cm.firstLine() && lineEnd == cm.lastLine()) {
+ lineEnd = Infinity;
+ }
+ if (count) {
+ lineStart = lineEnd;
+ lineEnd = lineStart + count - 1;
+ }
+ var startPos = clipCursorToContent(cm, Pos(lineStart, 0));
+ var cursor = cm.getSearchCursor(query, startPos);
+ doReplace(cm, confirm, global, lineStart, lineEnd, cursor, query, replacePart, params.callback);
+ },
+ redo: CodeMirror.commands.redo,
+ undo: CodeMirror.commands.undo,
+ write: function(cm) {
+ if (CodeMirror.commands.save) {
+ CodeMirror.commands.save(cm);
+ } else {
+ cm.save();
+ }
+ },
+ nohlsearch: function(cm) {
+ clearSearchHighlight(cm);
+ },
+ delmarks: function(cm, params) {
+ if (!params.argString || !trim(params.argString)) {
+ showConfirm(cm, 'Argument required');
+ return;
+ }
+
+ var state = cm.state.vim;
+ var stream = new CodeMirror.StringStream(trim(params.argString));
+ while (!stream.eol()) {
+ stream.eatSpace();
+ var count = stream.pos;
+
+ if (!stream.match(/[a-zA-Z]/, false)) {
+ showConfirm(cm, 'Invalid argument: ' + params.argString.substring(count));
+ return;
+ }
+
+ var sym = stream.next();
+ if (stream.match('-', true)) {
+ if (!stream.match(/[a-zA-Z]/, false)) {
+ showConfirm(cm, 'Invalid argument: ' + params.argString.substring(count));
+ return;
+ }
+
+ var startMark = sym;
+ var finishMark = stream.next();
+ if (isLowerCase(startMark) && isLowerCase(finishMark) ||
+ isUpperCase(startMark) && isUpperCase(finishMark)) {
+ var start = startMark.charCodeAt(0);
+ var finish = finishMark.charCodeAt(0);
+ if (start >= finish) {
+ showConfirm(cm, 'Invalid argument: ' + params.argString.substring(count));
+ return;
+ }
+ for (var j = 0; j <= finish - start; j++) {
+ var mark = String.fromCharCode(start + j);
+ delete state.marks[mark];
+ }
+ } else {
+ showConfirm(cm, 'Invalid argument: ' + startMark + '-');
+ return;
+ }
+ } else {
+ delete state.marks[sym];
+ }
+ }
+ }
+ };
+
+ var exCommandDispatcher = new ExCommandDispatcher();
+ function doReplace(cm, confirm, global, lineStart, lineEnd, searchCursor, query,
+ replaceWith, callback) {
+ cm.state.vim.exMode = true;
+ var done = false;
+ var lastPos = searchCursor.from();
+ function replaceAll() {
+ cm.operation(function() {
+ while (!done) {
+ replace();
+ next();
+ }
+ stop();
+ });
+ }
+ function replace() {
+ var text = cm.getRange(searchCursor.from(), searchCursor.to());
+ var newText = text.replace(query, replaceWith);
+ searchCursor.replace(newText);
+ }
+ function next() {
+ while(searchCursor.findNext() &&
+ isInRange(searchCursor.from(), lineStart, lineEnd)) {
+ if (!global && lastPos && searchCursor.from().line == lastPos.line) {
+ continue;
+ }
+ cm.scrollIntoView(searchCursor.from(), 30);
+ cm.setSelection(searchCursor.from(), searchCursor.to());
+ lastPos = searchCursor.from();
+ done = false;
+ return;
+ }
+ done = true;
+ }
+ function stop(close) {
+ if (close) { close(); }
+ cm.focus();
+ if (lastPos) {
+ cm.setCursor(lastPos);
+ var vim = cm.state.vim;
+ vim.exMode = false;
+ vim.lastHPos = vim.lastHSPos = lastPos.ch;
+ }
+ if (callback) { callback(); }
+ }
+ function onPromptKeyDown(e, _value, close) {
+ CodeMirror.e_stop(e);
+ var keyName = CodeMirror.keyName(e);
+ switch (keyName) {
+ case 'Y':
+ replace(); next(); break;
+ case 'N':
+ next(); break;
+ case 'A':
+ var savedCallback = callback;
+ callback = undefined;
+ cm.operation(replaceAll);
+ callback = savedCallback;
+ break;
+ case 'L':
+ replace();
+ case 'Q':
+ case 'Esc':
+ case 'Ctrl-C':
+ case 'Ctrl-[':
+ stop(close);
+ break;
+ }
+ if (done) { stop(close); }
+ return true;
+ }
+ next();
+ if (done) {
+ showConfirm(cm, 'No matches for ' + query.source);
+ return;
+ }
+ if (!confirm) {
+ replaceAll();
+ if (callback) { callback(); }
+ return;
+ }
+ showPrompt(cm, {
+ prefix: 'replace with ' + replaceWith + ' (y/n/a/q/l)',
+ onKeyDown: onPromptKeyDown
+ });
+ }
+
+ CodeMirror.keyMap.vim = {
+ attach: attachVimMap,
+ detach: detachVimMap,
+ call: cmKey
+ };
+
+ function exitInsertMode(cm) {
+ var vim = cm.state.vim;
+ var macroModeState = vimGlobalState.macroModeState;
+ var insertModeChangeRegister = vimGlobalState.registerController.getRegister('.');
+ var isPlaying = macroModeState.isPlaying;
+ var lastChange = macroModeState.lastInsertModeChanges;
+ var text = [];
+ if (!isPlaying) {
+ var selLength = lastChange.inVisualBlock ? vim.lastSelection.visualBlock.height : 1;
+ var changes = lastChange.changes;
+ var text = [];
+ var i = 0;
+ while (i < changes.length) {
+ text.push(changes[i]);
+ if (changes[i] instanceof InsertModeKey) {
+ i++;
+ } else {
+ i+= selLength;
+ }
+ }
+ lastChange.changes = text;
+ cm.off('change', onChange);
+ CodeMirror.off(cm.getInputField(), 'keydown', onKeyEventTargetKeyDown);
+ }
+ if (!isPlaying && vim.insertModeRepeat > 1) {
+ repeatLastEdit(cm, vim, vim.insertModeRepeat - 1,
+ true /** repeatForInsert */);
+ vim.lastEditInputState.repeatOverride = vim.insertModeRepeat;
+ }
+ delete vim.insertModeRepeat;
+ vim.insertMode = false;
+ cm.setCursor(cm.getCursor().line, cm.getCursor().ch-1);
+ cm.setOption('keyMap', 'vim');
+ cm.setOption('disableInput', true);
+ cm.toggleOverwrite(false); // exit replace mode if we were in it.
+ insertModeChangeRegister.setText(lastChange.changes.join(''));
+ CodeMirror.signal(cm, "vim-mode-change", {mode: "normal"});
+ if (macroModeState.isRecording) {
+ logInsertModeChange(macroModeState);
+ }
+ }
+
+ function _mapCommand(command) {
+ defaultKeymap.unshift(command);
+ }
+
+ function mapCommand(keys, type, name, args, extra) {
+ var command = {keys: keys, type: type};
+ command[type] = name;
+ command[type + "Args"] = args;
+ for (var key in extra)
+ command[key] = extra[key];
+ _mapCommand(command);
+ }
+ defineOption('insertModeEscKeysTimeout', 200, 'number');
+
+ CodeMirror.keyMap['vim-insert'] = {
+ 'Ctrl-N': 'autocomplete',
+ 'Ctrl-P': 'autocomplete',
+ 'Enter': function(cm) {
+ var fn = CodeMirror.commands.newlineAndIndentContinueComment ||
+ CodeMirror.commands.newlineAndIndent;
+ fn(cm);
+ },
+ fallthrough: ['default'],
+ attach: attachVimMap,
+ detach: detachVimMap,
+ call: cmKey
+ };
+
+ CodeMirror.keyMap['vim-replace'] = {
+ 'Backspace': 'goCharLeft',
+ fallthrough: ['vim-insert'],
+ attach: attachVimMap,
+ detach: detachVimMap,
+ call: cmKey
+ };
+
+ function executeMacroRegister(cm, vim, macroModeState, registerName) {
+ var register = vimGlobalState.registerController.getRegister(registerName);
+ if (registerName == ':') {
+ if (register.keyBuffer[0]) {
+ exCommandDispatcher.processCommand(cm, register.keyBuffer[0]);
+ }
+ macroModeState.isPlaying = false;
+ return;
+ }
+ var keyBuffer = register.keyBuffer;
+ var imc = 0;
+ macroModeState.isPlaying = true;
+ macroModeState.replaySearchQueries = register.searchQueries.slice(0);
+ for (var i = 0; i < keyBuffer.length; i++) {
+ var text = keyBuffer[i];
+ var match, key;
+ while (text) {
+ match = (/<\w+-.+?>|<\w+>|./).exec(text);
+ key = match[0];
+ text = text.substring(match.index + key.length);
+ CodeMirror.Vim.handleKey(cm, key, 'macro');
+ if (vim.insertMode) {
+ var changes = register.insertModeChanges[imc++].changes;
+ vimGlobalState.macroModeState.lastInsertModeChanges.changes =
+ changes;
+ repeatInsertModeChanges(cm, changes, 1);
+ exitInsertMode(cm);
+ }
+ }
+ }
+ macroModeState.isPlaying = false;
+ }
+
+ function logKey(macroModeState, key) {
+ if (macroModeState.isPlaying) { return; }
+ var registerName = macroModeState.latestRegister;
+ var register = vimGlobalState.registerController.getRegister(registerName);
+ if (register) {
+ register.pushText(key);
+ }
+ }
+
+ function logInsertModeChange(macroModeState) {
+ if (macroModeState.isPlaying) { return; }
+ var registerName = macroModeState.latestRegister;
+ var register = vimGlobalState.registerController.getRegister(registerName);
+ if (register && register.pushInsertModeChanges) {
+ register.pushInsertModeChanges(macroModeState.lastInsertModeChanges);
+ }
+ }
+
+ function logSearchQuery(macroModeState, query) {
+ if (macroModeState.isPlaying) { return; }
+ var registerName = macroModeState.latestRegister;
+ var register = vimGlobalState.registerController.getRegister(registerName);
+ if (register && register.pushSearchQuery) {
+ register.pushSearchQuery(query);
+ }
+ }
+ function onChange(_cm, changeObj) {
+ var macroModeState = vimGlobalState.macroModeState;
+ var lastChange = macroModeState.lastInsertModeChanges;
+ if (!macroModeState.isPlaying) {
+ while(changeObj) {
+ lastChange.expectCursorActivityForChange = true;
+ if (changeObj.origin == '+input' || changeObj.origin == 'paste'
+ || changeObj.origin === undefined /* only in testing */) {
+ var text = changeObj.text.join('\n');
+ if (lastChange.maybeReset) {
+ lastChange.changes = [];
+ lastChange.maybeReset = false;
+ }
+ lastChange.changes.push(text);
+ }
+ changeObj = changeObj.next;
+ }
+ }
+ }
+ function onCursorActivity(cm) {
+ var vim = cm.state.vim;
+ if (vim.insertMode) {
+ var macroModeState = vimGlobalState.macroModeState;
+ if (macroModeState.isPlaying) { return; }
+ var lastChange = macroModeState.lastInsertModeChanges;
+ if (lastChange.expectCursorActivityForChange) {
+ lastChange.expectCursorActivityForChange = false;
+ } else {
+ lastChange.maybeReset = true;
+ }
+ } else if (!cm.curOp.isVimOp) {
+ handleExternalSelection(cm, vim);
+ }
+ if (vim.visualMode) {
+ updateFakeCursor(cm);
+ }
+ }
+ function updateFakeCursor(cm) {
+ var vim = cm.state.vim;
+ var from = clipCursorToContent(cm, copyCursor(vim.sel.head));
+ var to = offsetCursor(from, 0, 1);
+ if (vim.fakeCursor) {
+ vim.fakeCursor.clear();
+ }
+ vim.fakeCursor = cm.markText(from, to, {className: 'cm-animate-fat-cursor'});
+ }
+ function handleExternalSelection(cm, vim) {
+ var anchor = cm.getCursor('anchor');
+ var head = cm.getCursor('head');
+ if (vim.visualMode && !cm.somethingSelected()) {
+ exitVisualMode(cm, false);
+ } else if (!vim.visualMode && !vim.insertMode && cm.somethingSelected()) {
+ vim.visualMode = true;
+ vim.visualLine = false;
+ CodeMirror.signal(cm, "vim-mode-change", {mode: "visual"});
+ }
+ if (vim.visualMode) {
+ var headOffset = !cursorIsBefore(head, anchor) ? -1 : 0;
+ var anchorOffset = cursorIsBefore(head, anchor) ? -1 : 0;
+ head = offsetCursor(head, 0, headOffset);
+ anchor = offsetCursor(anchor, 0, anchorOffset);
+ vim.sel = {
+ anchor: anchor,
+ head: head
+ };
+ updateMark(cm, vim, '<', cursorMin(head, anchor));
+ updateMark(cm, vim, '>', cursorMax(head, anchor));
+ } else if (!vim.insertMode) {
+ vim.lastHPos = cm.getCursor().ch;
+ }
+ }
+ function InsertModeKey(keyName) {
+ this.keyName = keyName;
+ }
+ function onKeyEventTargetKeyDown(e) {
+ var macroModeState = vimGlobalState.macroModeState;
+ var lastChange = macroModeState.lastInsertModeChanges;
+ var keyName = CodeMirror.keyName(e);
+ if (!keyName) { return; }
+ function onKeyFound() {
+ if (lastChange.maybeReset) {
+ lastChange.changes = [];
+ lastChange.maybeReset = false;
+ }
+ lastChange.changes.push(new InsertModeKey(keyName));
+ return true;
+ }
+ if (keyName.indexOf('Delete') != -1 || keyName.indexOf('Backspace') != -1) {
+ CodeMirror.lookupKey(keyName, 'vim-insert', onKeyFound);
+ }
+ }
+ function repeatLastEdit(cm, vim, repeat, repeatForInsert) {
+ var macroModeState = vimGlobalState.macroModeState;
+ macroModeState.isPlaying = true;
+ var isAction = !!vim.lastEditActionCommand;
+ var cachedInputState = vim.inputState;
+ function repeatCommand() {
+ if (isAction) {
+ commandDispatcher.processAction(cm, vim, vim.lastEditActionCommand);
+ } else {
+ commandDispatcher.evalInput(cm, vim);
+ }
+ }
+ function repeatInsert(repeat) {
+ if (macroModeState.lastInsertModeChanges.changes.length > 0) {
+ repeat = !vim.lastEditActionCommand ? 1 : repeat;
+ var changeObject = macroModeState.lastInsertModeChanges;
+ repeatInsertModeChanges(cm, changeObject.changes, repeat);
+ }
+ }
+ vim.inputState = vim.lastEditInputState;
+ if (isAction && vim.lastEditActionCommand.interlaceInsertRepeat) {
+ for (var i = 0; i < repeat; i++) {
+ repeatCommand();
+ repeatInsert(1);
+ }
+ } else {
+ if (!repeatForInsert) {
+ repeatCommand();
+ }
+ repeatInsert(repeat);
+ }
+ vim.inputState = cachedInputState;
+ if (vim.insertMode && !repeatForInsert) {
+ exitInsertMode(cm);
+ }
+ macroModeState.isPlaying = false;
+ }
+
+ function repeatInsertModeChanges(cm, changes, repeat) {
+ function keyHandler(binding) {
+ if (typeof binding == 'string') {
+ CodeMirror.commands[binding](cm);
+ } else {
+ binding(cm);
+ }
+ return true;
+ }
+ var head = cm.getCursor('head');
+ var inVisualBlock = vimGlobalState.macroModeState.lastInsertModeChanges.inVisualBlock;
+ if (inVisualBlock) {
+ var vim = cm.state.vim;
+ var lastSel = vim.lastSelection;
+ var offset = getOffset(lastSel.anchor, lastSel.head);
+ selectForInsert(cm, head, offset.line + 1);
+ repeat = cm.listSelections().length;
+ cm.setCursor(head);
+ }
+ for (var i = 0; i < repeat; i++) {
+ if (inVisualBlock) {
+ cm.setCursor(offsetCursor(head, i, 0));
+ }
+ for (var j = 0; j < changes.length; j++) {
+ var change = changes[j];
+ if (change instanceof InsertModeKey) {
+ CodeMirror.lookupKey(change.keyName, 'vim-insert', keyHandler);
+ } else {
+ var cur = cm.getCursor();
+ cm.replaceRange(change, cur, cur);
+ }
+ }
+ }
+ if (inVisualBlock) {
+ cm.setCursor(offsetCursor(head, 0, 1));
+ }
+ }
+
+ resetVimGlobalState();
+ CodeMirror.Vim = Vim();
+
+ Vim = CodeMirror.Vim;
+
+ var specialKey = {'return':'CR',backspace:'BS','delete':'Del',esc:'Esc',
+ left:'Left',right:'Right',up:'Up',down:'Down',space: 'Space',
+ home:'Home',end:'End',pageup:'PageUp',pagedown:'PageDown', enter: 'CR'
+ };
+ function lookupKey(hashId, key, e) {
+ if (key.length > 1 && key[0] == "n") {
+ key = key.replace("numpad", "");
+ }
+ key = specialKey[key] || key;
+ var name = '';
+ if (e.ctrlKey) { name += 'C-'; }
+ if (e.altKey) { name += 'A-'; }
+ if (e.shiftKey) { name += 'S-'; }
+
+ name += key;
+ if (name.length > 1) { name = '<' + name + '>'; }
+ return name;
+ }
+ var handleKey = Vim.handleKey.bind(Vim);
+ Vim.handleKey = function(cm, key, origin) {
+ return cm.operation(function() {
+ return handleKey(cm, key, origin);
+ }, true);
+ }
+ function cloneVimState(state) {
+ var n = new state.constructor();
+ Object.keys(state).forEach(function(key) {
+ var o = state[key];
+ if (Array.isArray(o))
+ o = o.slice();
+ else if (o && typeof o == "object" && o.constructor != Object)
+ o = cloneVimState(o);
+ n[key] = o;
+ });
+ if (state.sel) {
+ n.sel = {
+ head: state.sel.head && copyCursor(state.sel.head),
+ anchor: state.sel.anchor && copyCursor(state.sel.anchor)
+ };
+ }
+ return n;
+ }
+ function multiSelectHandleKey(cm, key, origin) {
+ var isHandled = false;
+ var vim = Vim.maybeInitVimState_(cm);
+ var visualBlock = vim.visualBlock || vim.wasInVisualBlock;
+ if (vim.wasInVisualBlock && !cm.ace.inMultiSelectMode) {
+ vim.wasInVisualBlock = false;
+ } else if (cm.ace.inMultiSelectMode && vim.visualBlock) {
+ vim.wasInVisualBlock = true;
+ }
+
+ if (key == '' && !vim.insertMode && !vim.visualMode && cm.ace.inMultiSelectMode) {
+ cm.ace.exitMultiSelectMode();
+ } else if (visualBlock || !cm.ace.inMultiSelectMode || cm.ace.inVirtualSelectionMode) {
+ isHandled = Vim.handleKey(cm, key, origin);
+ } else {
+ var old = cloneVimState(vim);
+ cm.operation(function() {
+ cm.ace.forEachSelection(function() {
+ var sel = cm.ace.selection;
+ cm.state.vim.lastHPos = sel.$desiredColumn == null ? sel.lead.column : sel.$desiredColumn;
+ var head = cm.getCursor("head");
+ var anchor = cm.getCursor("anchor");
+ var headOffset = !cursorIsBefore(head, anchor) ? -1 : 0;
+ var anchorOffset = cursorIsBefore(head, anchor) ? -1 : 0;
+ head = offsetCursor(head, 0, headOffset);
+ anchor = offsetCursor(anchor, 0, anchorOffset);
+ cm.state.vim.sel.head = head;
+ cm.state.vim.sel.anchor = anchor;
+
+ isHandled = handleKey(cm, key, origin);
+ sel.$desiredColumn = cm.state.vim.lastHPos == -1 ? null : cm.state.vim.lastHPos;
+ if (cm.virtualSelectionMode()) {
+ cm.state.vim = cloneVimState(old);
+ }
+ });
+ if (cm.curOp.cursorActivity && !isHandled)
+ cm.curOp.cursorActivity = false;
+ }, true);
+ }
+ return isHandled;
+ }
+ exports.CodeMirror = CodeMirror;
+ var getVim = Vim.maybeInitVimState_;
+ exports.handler = {
+ $id: "ace/keyboard/vim",
+ drawCursor: function(style, pixelPos, config, sel, session) {
+ var vim = this.state.vim || {};
+ var w = config.characterWidth;
+ var h = config.lineHeight;
+ var top = pixelPos.top;
+ var left = pixelPos.left;
+ if (!vim.insertMode) {
+ var isbackwards = !sel.cursor
+ ? session.selection.isBackwards() || session.selection.isEmpty()
+ : Range.comparePoints(sel.cursor, sel.start) <= 0;
+ if (!isbackwards && left > w)
+ left -= w;
+ }
+ if (!vim.insertMode && vim.status) {
+ h = h / 2;
+ top += h;
+ }
+ style.left = left + "px";
+ style.top = top + "px";
+ style.width = w + "px";
+ style.height = h + "px";
+ },
+ handleKeyboard: function(data, hashId, key, keyCode, e) {
+ var editor = data.editor;
+ var cm = editor.state.cm;
+ var vim = getVim(cm);
+ if (keyCode == -1) return;
+
+ if (key == "c" && hashId == 1) { // key == "ctrl-c"
+ if (!useragent.isMac && editor.getCopyText()) {
+ editor.once("copy", function() {
+ editor.selection.clearSelection();
+ });
+ return {command: "null", passEvent: true};
+ }
+ } else if (!vim.insertMode) {
+ if (useragent.isMac && this.handleMacRepeat(data, hashId, key)) {
+ hashId = -1;
+ key = data.inputChar;
+ }
+ }
+
+ if (hashId == -1 || hashId & 1 || hashId === 0 && key.length > 1) {
+ var insertMode = vim.insertMode;
+ var name = lookupKey(hashId, key, e || {});
+ if (vim.status == null)
+ vim.status = "";
+ var isHandled = multiSelectHandleKey(cm, name, 'user');
+ vim = getVim(cm); // may be changed by multiSelectHandleKey
+ if (isHandled && vim.status != null)
+ vim.status += name;
+ else if (vim.status == null)
+ vim.status = "";
+ cm._signal("changeStatus");
+ if (!isHandled && (hashId != -1 || insertMode))
+ return;
+ return {command: "null", passEvent: !isHandled};
+ }
+ },
+ attach: function(editor) {
+ if (!editor.state) editor.state = {};
+ var cm = new CodeMirror(editor);
+ editor.state.cm = cm;
+ editor.$vimModeHandler = this;
+ CodeMirror.keyMap.vim.attach(cm);
+ getVim(cm).status = null;
+ cm.on('vim-command-done', function() {
+ if (cm.virtualSelectionMode()) return;
+ getVim(cm).status = null;
+ cm.ace._signal("changeStatus");
+ cm.ace.session.markUndoGroup();
+ });
+ cm.on("changeStatus", function() {
+ cm.ace.renderer.updateCursor();
+ cm.ace._signal("changeStatus");
+ });
+ cm.on("vim-mode-change", function() {
+ if (cm.virtualSelectionMode()) return;
+ cm.ace.renderer.setStyle("normal-mode", !getVim(cm).insertMode);
+ cm._signal("changeStatus");
+ });
+ cm.ace.renderer.setStyle("normal-mode", !getVim(cm).insertMode);
+ editor.renderer.$cursorLayer.drawCursor = this.drawCursor.bind(cm);
+ this.updateMacCompositionHandlers(editor, true);
+ },
+ detach: function(editor) {
+ var cm = editor.state.cm;
+ CodeMirror.keyMap.vim.detach(cm);
+ cm.destroy();
+ editor.state.cm = null;
+ editor.$vimModeHandler = null;
+ editor.renderer.$cursorLayer.drawCursor = null;
+ editor.renderer.setStyle("normal-mode", false);
+ this.updateMacCompositionHandlers(editor, false);
+ },
+ getStatusText: function(editor) {
+ var cm = editor.state.cm;
+ var vim = getVim(cm);
+ if (vim.insertMode)
+ return "INSERT";
+ var status = "";
+ if (vim.visualMode) {
+ status += "VISUAL";
+ if (vim.visualLine)
+ status += " LINE";
+ if (vim.visualBlock)
+ status += " BLOCK";
+ }
+ if (vim.status)
+ status += (status ? " " : "") + vim.status;
+ return status;
+ },
+ handleMacRepeat: function(data, hashId, key) {
+ if (hashId == -1) {
+ data.inputChar = key;
+ data.lastEvent = "input";
+ } else if (data.inputChar && data.$lastHash == hashId && data.$lastKey == key) {
+ if (data.lastEvent == "input") {
+ data.lastEvent = "input1";
+ } else if (data.lastEvent == "input1") {
+ return true;
+ }
+ } else {
+ data.$lastHash = hashId;
+ data.$lastKey = key;
+ data.lastEvent = "keypress";
+ }
+ },
+ updateMacCompositionHandlers: function(editor, enable) {
+ var onCompositionUpdateOverride = function(text) {
+ var cm = editor.state.cm;
+ var vim = getVim(cm);
+ if (!vim.insertMode) {
+ var el = this.textInput.getElement();
+ el.blur();
+ el.focus();
+ el.value = text;
+ } else {
+ this.onCompositionUpdateOrig(text);
+ }
+ };
+ var onCompositionStartOverride = function(text) {
+ var cm = editor.state.cm;
+ var vim = getVim(cm);
+ if (!vim.insertMode) {
+ this.onCompositionStartOrig(text);
+ }
+ };
+ if (enable) {
+ if (!editor.onCompositionUpdateOrig) {
+ editor.onCompositionUpdateOrig = editor.onCompositionUpdate;
+ editor.onCompositionUpdate = onCompositionUpdateOverride;
+ editor.onCompositionStartOrig = editor.onCompositionStart;
+ editor.onCompositionStart = onCompositionStartOverride;
+ }
+ } else {
+ if (editor.onCompositionUpdateOrig) {
+ editor.onCompositionUpdate = editor.onCompositionUpdateOrig;
+ editor.onCompositionUpdateOrig = null;
+ editor.onCompositionStart = editor.onCompositionStartOrig;
+ editor.onCompositionStartOrig = null;
+ }
+ }
+ }
+ };
+ var renderVirtualNumbers = {
+ getText: function(session, row) {
+ return (Math.abs(session.selection.lead.row - row) || (row + 1 + (row < 9? "\xb7" : "" ))) + "";
+ },
+ getWidth: function(session, lastLineNumber, config) {
+ return session.getLength().toString().length * config.characterWidth;
+ },
+ update: function(e, editor) {
+ editor.renderer.$loop.schedule(editor.renderer.CHANGE_GUTTER);
+ },
+ attach: function(editor) {
+ editor.renderer.$gutterLayer.$renderer = this;
+ editor.on("changeSelection", this.update);
+ },
+ detach: function(editor) {
+ editor.renderer.$gutterLayer.$renderer = null;
+ editor.off("changeSelection", this.update);
+ }
+ };
+ Vim.defineOption({
+ name: "wrap",
+ set: function(value, cm) {
+ if (cm) {cm.ace.setOption("wrap", value)}
+ },
+ type: "boolean"
+ }, false);
+ Vim.defineEx('write', 'w', function() {
+ console.log(':write is not implemented')
+ });
+ defaultKeymap.push(
+ { keys: 'zc', type: 'action', action: 'fold', actionArgs: { open: false } },
+ { keys: 'zC', type: 'action', action: 'fold', actionArgs: { open: false, all: true } },
+ { keys: 'zo', type: 'action', action: 'fold', actionArgs: { open: true } },
+ { keys: 'zO', type: 'action', action: 'fold', actionArgs: { open: true, all: true } },
+ { keys: 'za', type: 'action', action: 'fold', actionArgs: { toggle: true } },
+ { keys: 'zA', type: 'action', action: 'fold', actionArgs: { toggle: true, all: true } },
+ { keys: 'zf', type: 'action', action: 'fold', actionArgs: { open: true, all: true } },
+ { keys: 'zd', type: 'action', action: 'fold', actionArgs: { open: true, all: true } },
+
+ { keys: '', type: 'action', action: 'aceCommand', actionArgs: { name: "addCursorAbove" } },
+ { keys: '', type: 'action', action: 'aceCommand', actionArgs: { name: "addCursorBelow" } },
+ { keys: '', type: 'action', action: 'aceCommand', actionArgs: { name: "addCursorAboveSkipCurrent" } },
+ { keys: '', type: 'action', action: 'aceCommand', actionArgs: { name: "addCursorBelowSkipCurrent" } },
+ { keys: '', type: 'action', action: 'aceCommand', actionArgs: { name: "selectMoreBefore" } },
+ { keys: '', type: 'action', action: 'aceCommand', actionArgs: { name: "selectMoreAfter" } },
+ { keys: '', type: 'action', action: 'aceCommand', actionArgs: { name: "selectNextBefore" } },
+ { keys: '', type: 'action', action: 'aceCommand', actionArgs: { name: "selectNextAfter" } }
+ );
+ actions.aceCommand = function(cm, actionArgs, vim) {
+ cm.vimCmd = actionArgs;
+ if (cm.ace.inVirtualSelectionMode)
+ cm.ace.on("beforeEndOperation", delayedExecAceCommand);
+ else
+ delayedExecAceCommand(null, cm.ace);
+ };
+ function delayedExecAceCommand(op, ace) {
+ ace.off("beforeEndOperation", delayedExecAceCommand);
+ var cmd = ace.state.cm.vimCmd;
+ if (cmd) {
+ ace.execCommand(cmd.exec ? cmd : cmd.name, cmd.args);
+ }
+ ace.curOp = ace.prevOp;
+ }
+ actions.fold = function(cm, actionArgs, vim) {
+ cm.ace.execCommand(['toggleFoldWidget', 'toggleFoldWidget', 'foldOther', 'unfoldall'
+ ][(actionArgs.all ? 2 : 0) + (actionArgs.open ? 1 : 0)]);
+ };
+
+ exports.handler.defaultKeymap = defaultKeymap;
+ exports.handler.actions = actions;
+ exports.Vim = Vim;
+
+ Vim.map("Y", "yy", "normal");
+});
+
+define("ace/ext/statusbar",["require","exports","module","ace/lib/dom","ace/lib/lang"], function(require, exports, module) {
+"use strict";
+var dom = require("ace/lib/dom");
+var lang = require("ace/lib/lang");
+
+var StatusBar = function(editor, parentNode) {
+ this.element = dom.createElement("div");
+ this.element.className = "ace_status-indicator";
+ this.element.style.cssText = "display: inline-block;";
+ parentNode.appendChild(this.element);
+
+ var statusUpdate = lang.delayedCall(function(){
+ this.updateStatus(editor)
+ }.bind(this)).schedule.bind(null, 100);
+
+ editor.on("changeStatus", statusUpdate);
+ editor.on("changeSelection", statusUpdate);
+ editor.on("keyboardActivity", statusUpdate);
+};
+
+(function(){
+ this.updateStatus = function(editor) {
+ var status = [];
+ function add(str, separator) {
+ str && status.push(str, separator || "|");
+ }
+
+ add(editor.keyBinding.getStatusText(editor));
+ if (editor.commands.recording)
+ add("REC");
+
+ var sel = editor.selection;
+ var c = sel.lead;
+
+ if (!sel.isEmpty()) {
+ var r = editor.getSelectionRange();
+ add("(" + (r.end.row - r.start.row) + ":" +(r.end.column - r.start.column) + ")", " ");
+ }
+ add(c.row + ":" + c.column, " ");
+ if (sel.rangeCount)
+ add("[" + sel.rangeCount + "]", " ");
+ status.pop();
+ this.element.textContent = status.join("");
+ };
+}).call(StatusBar.prototype);
+
+exports.StatusBar = StatusBar;
+
+});
+
+define("ace/snippets",["require","exports","module","ace/lib/oop","ace/lib/event_emitter","ace/lib/lang","ace/range","ace/anchor","ace/keyboard/hash_handler","ace/tokenizer","ace/lib/dom","ace/editor"], function(require, exports, module) {
+"use strict";
+var oop = require("./lib/oop");
+var EventEmitter = require("./lib/event_emitter").EventEmitter;
+var lang = require("./lib/lang");
+var Range = require("./range").Range;
+var Anchor = require("./anchor").Anchor;
+var HashHandler = require("./keyboard/hash_handler").HashHandler;
+var Tokenizer = require("./tokenizer").Tokenizer;
+var comparePoints = Range.comparePoints;
+
+var SnippetManager = function() {
+ this.snippetMap = {};
+ this.snippetNameMap = {};
+};
+
+(function() {
+ oop.implement(this, EventEmitter);
+
+ this.getTokenizer = function() {
+ function TabstopToken(str, _, stack) {
+ str = str.substr(1);
+ if (/^\d+$/.test(str) && !stack.inFormatString)
+ return [{tabstopId: parseInt(str, 10)}];
+ return [{text: str}];
+ }
+ function escape(ch) {
+ return "(?:[^\\\\" + ch + "]|\\\\.)";
+ }
+ SnippetManager.$tokenizer = new Tokenizer({
+ start: [
+ {regex: /:/, onMatch: function(val, state, stack) {
+ if (stack.length && stack[0].expectIf) {
+ stack[0].expectIf = false;
+ stack[0].elseBranch = stack[0];
+ return [stack[0]];
+ }
+ return ":";
+ }},
+ {regex: /\\./, onMatch: function(val, state, stack) {
+ var ch = val[1];
+ if (ch == "}" && stack.length) {
+ val = ch;
+ }else if ("`$\\".indexOf(ch) != -1) {
+ val = ch;
+ } else if (stack.inFormatString) {
+ if (ch == "n")
+ val = "\n";
+ else if (ch == "t")
+ val = "\n";
+ else if ("ulULE".indexOf(ch) != -1) {
+ val = {changeCase: ch, local: ch > "a"};
+ }
+ }
+
+ return [val];
+ }},
+ {regex: /}/, onMatch: function(val, state, stack) {
+ return [stack.length ? stack.shift() : val];
+ }},
+ {regex: /\$(?:\d+|\w+)/, onMatch: TabstopToken},
+ {regex: /\$\{[\dA-Z_a-z]+/, onMatch: function(str, state, stack) {
+ var t = TabstopToken(str.substr(1), state, stack);
+ stack.unshift(t[0]);
+ return t;
+ }, next: "snippetVar"},
+ {regex: /\n/, token: "newline", merge: false}
+ ],
+ snippetVar: [
+ {regex: "\\|" + escape("\\|") + "*\\|", onMatch: function(val, state, stack) {
+ stack[0].choices = val.slice(1, -1).split(",");
+ }, next: "start"},
+ {regex: "/(" + escape("/") + "+)/(?:(" + escape("/") + "*)/)(\\w*):?",
+ onMatch: function(val, state, stack) {
+ var ts = stack[0];
+ ts.fmtString = val;
+
+ val = this.splitRegex.exec(val);
+ ts.guard = val[1];
+ ts.fmt = val[2];
+ ts.flag = val[3];
+ return "";
+ }, next: "start"},
+ {regex: "`" + escape("`") + "*`", onMatch: function(val, state, stack) {
+ stack[0].code = val.splice(1, -1);
+ return "";
+ }, next: "start"},
+ {regex: "\\?", onMatch: function(val, state, stack) {
+ if (stack[0])
+ stack[0].expectIf = true;
+ }, next: "start"},
+ {regex: "([^:}\\\\]|\\\\.)*:?", token: "", next: "start"}
+ ],
+ formatString: [
+ {regex: "/(" + escape("/") + "+)/", token: "regex"},
+ {regex: "", onMatch: function(val, state, stack) {
+ stack.inFormatString = true;
+ }, next: "start"}
+ ]
+ });
+ SnippetManager.prototype.getTokenizer = function() {
+ return SnippetManager.$tokenizer;
+ };
+ return SnippetManager.$tokenizer;
+ };
+
+ this.tokenizeTmSnippet = function(str, startState) {
+ return this.getTokenizer().getLineTokens(str, startState).tokens.map(function(x) {
+ return x.value || x;
+ });
+ };
+
+ this.$getDefaultValue = function(editor, name) {
+ if (/^[A-Z]\d+$/.test(name)) {
+ var i = name.substr(1);
+ return (this.variables[name[0] + "__"] || {})[i];
+ }
+ if (/^\d+$/.test(name)) {
+ return (this.variables.__ || {})[name];
+ }
+ name = name.replace(/^TM_/, "");
+
+ if (!editor)
+ return;
+ var s = editor.session;
+ switch(name) {
+ case "CURRENT_WORD":
+ var r = s.getWordRange();
+ case "SELECTION":
+ case "SELECTED_TEXT":
+ return s.getTextRange(r);
+ case "CURRENT_LINE":
+ return s.getLine(editor.getCursorPosition().row);
+ case "PREV_LINE": // not possible in textmate
+ return s.getLine(editor.getCursorPosition().row - 1);
+ case "LINE_INDEX":
+ return editor.getCursorPosition().column;
+ case "LINE_NUMBER":
+ return editor.getCursorPosition().row + 1;
+ case "SOFT_TABS":
+ return s.getUseSoftTabs() ? "YES" : "NO";
+ case "TAB_SIZE":
+ return s.getTabSize();
+ case "FILENAME":
+ case "FILEPATH":
+ return "";
+ case "FULLNAME":
+ return "Ace";
+ }
+ };
+ this.variables = {};
+ this.getVariableValue = function(editor, varName) {
+ if (this.variables.hasOwnProperty(varName))
+ return this.variables[varName](editor, varName) || "";
+ return this.$getDefaultValue(editor, varName) || "";
+ };
+ this.tmStrFormat = function(str, ch, editor) {
+ var flag = ch.flag || "";
+ var re = ch.guard;
+ re = new RegExp(re, flag.replace(/[^gi]/, ""));
+ var fmtTokens = this.tokenizeTmSnippet(ch.fmt, "formatString");
+ var _self = this;
+ var formatted = str.replace(re, function() {
+ _self.variables.__ = arguments;
+ var fmtParts = _self.resolveVariables(fmtTokens, editor);
+ var gChangeCase = "E";
+ for (var i = 0; i < fmtParts.length; i++) {
+ var ch = fmtParts[i];
+ if (typeof ch == "object") {
+ fmtParts[i] = "";
+ if (ch.changeCase && ch.local) {
+ var next = fmtParts[i + 1];
+ if (next && typeof next == "string") {
+ if (ch.changeCase == "u")
+ fmtParts[i] = next[0].toUpperCase();
+ else
+ fmtParts[i] = next[0].toLowerCase();
+ fmtParts[i + 1] = next.substr(1);
+ }
+ } else if (ch.changeCase) {
+ gChangeCase = ch.changeCase;
+ }
+ } else if (gChangeCase == "U") {
+ fmtParts[i] = ch.toUpperCase();
+ } else if (gChangeCase == "L") {
+ fmtParts[i] = ch.toLowerCase();
+ }
+ }
+ return fmtParts.join("");
+ });
+ this.variables.__ = null;
+ return formatted;
+ };
+
+ this.resolveVariables = function(snippet, editor) {
+ var result = [];
+ for (var i = 0; i < snippet.length; i++) {
+ var ch = snippet[i];
+ if (typeof ch == "string") {
+ result.push(ch);
+ } else if (typeof ch != "object") {
+ continue;
+ } else if (ch.skip) {
+ gotoNext(ch);
+ } else if (ch.processed < i) {
+ continue;
+ } else if (ch.text) {
+ var value = this.getVariableValue(editor, ch.text);
+ if (value && ch.fmtString)
+ value = this.tmStrFormat(value, ch);
+ ch.processed = i;
+ if (ch.expectIf == null) {
+ if (value) {
+ result.push(value);
+ gotoNext(ch);
+ }
+ } else {
+ if (value) {
+ ch.skip = ch.elseBranch;
+ } else
+ gotoNext(ch);
+ }
+ } else if (ch.tabstopId != null) {
+ result.push(ch);
+ } else if (ch.changeCase != null) {
+ result.push(ch);
+ }
+ }
+ function gotoNext(ch) {
+ var i1 = snippet.indexOf(ch, i + 1);
+ if (i1 != -1)
+ i = i1;
+ }
+ return result;
+ };
+
+ this.insertSnippetForSelection = function(editor, snippetText) {
+ var cursor = editor.getCursorPosition();
+ var line = editor.session.getLine(cursor.row);
+ var tabString = editor.session.getTabString();
+ var indentString = line.match(/^\s*/)[0];
+
+ if (cursor.column < indentString.length)
+ indentString = indentString.slice(0, cursor.column);
+
+ snippetText = snippetText.replace(/\r/g, "");
+ var tokens = this.tokenizeTmSnippet(snippetText);
+ tokens = this.resolveVariables(tokens, editor);
+ tokens = tokens.map(function(x) {
+ if (x == "\n")
+ return x + indentString;
+ if (typeof x == "string")
+ return x.replace(/\t/g, tabString);
+ return x;
+ });
+ var tabstops = [];
+ tokens.forEach(function(p, i) {
+ if (typeof p != "object")
+ return;
+ var id = p.tabstopId;
+ var ts = tabstops[id];
+ if (!ts) {
+ ts = tabstops[id] = [];
+ ts.index = id;
+ ts.value = "";
+ }
+ if (ts.indexOf(p) !== -1)
+ return;
+ ts.push(p);
+ var i1 = tokens.indexOf(p, i + 1);
+ if (i1 === -1)
+ return;
+
+ var value = tokens.slice(i + 1, i1);
+ var isNested = value.some(function(t) {return typeof t === "object"});
+ if (isNested && !ts.value) {
+ ts.value = value;
+ } else if (value.length && (!ts.value || typeof ts.value !== "string")) {
+ ts.value = value.join("");
+ }
+ });
+ tabstops.forEach(function(ts) {ts.length = 0});
+ var expanding = {};
+ function copyValue(val) {
+ var copy = [];
+ for (var i = 0; i < val.length; i++) {
+ var p = val[i];
+ if (typeof p == "object") {
+ if (expanding[p.tabstopId])
+ continue;
+ var j = val.lastIndexOf(p, i - 1);
+ p = copy[j] || {tabstopId: p.tabstopId};
+ }
+ copy[i] = p;
+ }
+ return copy;
+ }
+ for (var i = 0; i < tokens.length; i++) {
+ var p = tokens[i];
+ if (typeof p != "object")
+ continue;
+ var id = p.tabstopId;
+ var i1 = tokens.indexOf(p, i + 1);
+ if (expanding[id]) {
+ if (expanding[id] === p)
+ expanding[id] = null;
+ continue;
+ }
+
+ var ts = tabstops[id];
+ var arg = typeof ts.value == "string" ? [ts.value] : copyValue(ts.value);
+ arg.unshift(i + 1, Math.max(0, i1 - i));
+ arg.push(p);
+ expanding[id] = p;
+ tokens.splice.apply(tokens, arg);
+
+ if (ts.indexOf(p) === -1)
+ ts.push(p);
+ }
+ var row = 0, column = 0;
+ var text = "";
+ tokens.forEach(function(t) {
+ if (typeof t === "string") {
+ var lines = t.split("\n");
+ if (lines.length > 1){
+ column = lines[lines.length - 1].length;
+ row += lines.length - 1;
+ } else
+ column += t.length;
+ text += t;
+ } else {
+ if (!t.start)
+ t.start = {row: row, column: column};
+ else
+ t.end = {row: row, column: column};
+ }
+ });
+ var range = editor.getSelectionRange();
+ var end = editor.session.replace(range, text);
+
+ var tabstopManager = new TabstopManager(editor);
+ var selectionId = editor.inVirtualSelectionMode && editor.selection.index;
+ tabstopManager.addTabstops(tabstops, range.start, end, selectionId);
+ };
+
+ this.insertSnippet = function(editor, snippetText) {
+ var self = this;
+ if (editor.inVirtualSelectionMode)
+ return self.insertSnippetForSelection(editor, snippetText);
+
+ editor.forEachSelection(function() {
+ self.insertSnippetForSelection(editor, snippetText);
+ }, null, {keepOrder: true});
+
+ if (editor.tabstopManager)
+ editor.tabstopManager.tabNext();
+ };
+
+ this.$getScope = function(editor) {
+ var scope = editor.session.$mode.$id || "";
+ scope = scope.split("/").pop();
+ if (scope === "html" || scope === "php") {
+ if (scope === "php" && !editor.session.$mode.inlinePhp)
+ scope = "html";
+ var c = editor.getCursorPosition();
+ var state = editor.session.getState(c.row);
+ if (typeof state === "object") {
+ state = state[0];
+ }
+ if (state.substring) {
+ if (state.substring(0, 3) == "js-")
+ scope = "javascript";
+ else if (state.substring(0, 4) == "css-")
+ scope = "css";
+ else if (state.substring(0, 4) == "php-")
+ scope = "php";
+ }
+ }
+
+ return scope;
+ };
+
+ this.getActiveScopes = function(editor) {
+ var scope = this.$getScope(editor);
+ var scopes = [scope];
+ var snippetMap = this.snippetMap;
+ if (snippetMap[scope] && snippetMap[scope].includeScopes) {
+ scopes.push.apply(scopes, snippetMap[scope].includeScopes);
+ }
+ scopes.push("_");
+ return scopes;
+ };
+
+ this.expandWithTab = function(editor, options) {
+ var self = this;
+ var result = editor.forEachSelection(function() {
+ return self.expandSnippetForSelection(editor, options);
+ }, null, {keepOrder: true});
+ if (result && editor.tabstopManager)
+ editor.tabstopManager.tabNext();
+ return result;
+ };
+
+ this.expandSnippetForSelection = function(editor, options) {
+ var cursor = editor.getCursorPosition();
+ var line = editor.session.getLine(cursor.row);
+ var before = line.substring(0, cursor.column);
+ var after = line.substr(cursor.column);
+
+ var snippetMap = this.snippetMap;
+ var snippet;
+ this.getActiveScopes(editor).some(function(scope) {
+ var snippets = snippetMap[scope];
+ if (snippets)
+ snippet = this.findMatchingSnippet(snippets, before, after);
+ return !!snippet;
+ }, this);
+ if (!snippet)
+ return false;
+ if (options && options.dryRun)
+ return true;
+ editor.session.doc.removeInLine(cursor.row,
+ cursor.column - snippet.replaceBefore.length,
+ cursor.column + snippet.replaceAfter.length
+ );
+
+ this.variables.M__ = snippet.matchBefore;
+ this.variables.T__ = snippet.matchAfter;
+ this.insertSnippetForSelection(editor, snippet.content);
+
+ this.variables.M__ = this.variables.T__ = null;
+ return true;
+ };
+
+ this.findMatchingSnippet = function(snippetList, before, after) {
+ for (var i = snippetList.length; i--;) {
+ var s = snippetList[i];
+ if (s.startRe && !s.startRe.test(before))
+ continue;
+ if (s.endRe && !s.endRe.test(after))
+ continue;
+ if (!s.startRe && !s.endRe)
+ continue;
+
+ s.matchBefore = s.startRe ? s.startRe.exec(before) : [""];
+ s.matchAfter = s.endRe ? s.endRe.exec(after) : [""];
+ s.replaceBefore = s.triggerRe ? s.triggerRe.exec(before)[0] : "";
+ s.replaceAfter = s.endTriggerRe ? s.endTriggerRe.exec(after)[0] : "";
+ return s;
+ }
+ };
+
+ this.snippetMap = {};
+ this.snippetNameMap = {};
+ this.register = function(snippets, scope) {
+ var snippetMap = this.snippetMap;
+ var snippetNameMap = this.snippetNameMap;
+ var self = this;
+
+ if (!snippets)
+ snippets = [];
+
+ function wrapRegexp(src) {
+ if (src && !/^\^?\(.*\)\$?$|^\\b$/.test(src))
+ src = "(?:" + src + ")";
+
+ return src || "";
+ }
+ function guardedRegexp(re, guard, opening) {
+ re = wrapRegexp(re);
+ guard = wrapRegexp(guard);
+ if (opening) {
+ re = guard + re;
+ if (re && re[re.length - 1] != "$")
+ re = re + "$";
+ } else {
+ re = re + guard;
+ if (re && re[0] != "^")
+ re = "^" + re;
+ }
+ return new RegExp(re);
+ }
+
+ function addSnippet(s) {
+ if (!s.scope)
+ s.scope = scope || "_";
+ scope = s.scope;
+ if (!snippetMap[scope]) {
+ snippetMap[scope] = [];
+ snippetNameMap[scope] = {};
+ }
+
+ var map = snippetNameMap[scope];
+ if (s.name) {
+ var old = map[s.name];
+ if (old)
+ self.unregister(old);
+ map[s.name] = s;
+ }
+ snippetMap[scope].push(s);
+
+ if (s.tabTrigger && !s.trigger) {
+ if (!s.guard && /^\w/.test(s.tabTrigger))
+ s.guard = "\\b";
+ s.trigger = lang.escapeRegExp(s.tabTrigger);
+ }
+
+ if (!s.trigger && !s.guard && !s.endTrigger && !s.endGuard)
+ return;
+
+ s.startRe = guardedRegexp(s.trigger, s.guard, true);
+ s.triggerRe = new RegExp(s.trigger, "", true);
+
+ s.endRe = guardedRegexp(s.endTrigger, s.endGuard, true);
+ s.endTriggerRe = new RegExp(s.endTrigger, "", true);
+ }
+
+ if (snippets && snippets.content)
+ addSnippet(snippets);
+ else if (Array.isArray(snippets))
+ snippets.forEach(addSnippet);
+
+ this._signal("registerSnippets", {scope: scope});
+ };
+ this.unregister = function(snippets, scope) {
+ var snippetMap = this.snippetMap;
+ var snippetNameMap = this.snippetNameMap;
+
+ function removeSnippet(s) {
+ var nameMap = snippetNameMap[s.scope||scope];
+ if (nameMap && nameMap[s.name]) {
+ delete nameMap[s.name];
+ var map = snippetMap[s.scope||scope];
+ var i = map && map.indexOf(s);
+ if (i >= 0)
+ map.splice(i, 1);
+ }
+ }
+ if (snippets.content)
+ removeSnippet(snippets);
+ else if (Array.isArray(snippets))
+ snippets.forEach(removeSnippet);
+ };
+ this.parseSnippetFile = function(str) {
+ str = str.replace(/\r/g, "");
+ var list = [], snippet = {};
+ var re = /^#.*|^({[\s\S]*})\s*$|^(\S+) (.*)$|^((?:\n*\t.*)+)/gm;
+ var m;
+ while (m = re.exec(str)) {
+ if (m[1]) {
+ try {
+ snippet = JSON.parse(m[1]);
+ list.push(snippet);
+ } catch (e) {}
+ } if (m[4]) {
+ snippet.content = m[4].replace(/^\t/gm, "");
+ list.push(snippet);
+ snippet = {};
+ } else {
+ var key = m[2], val = m[3];
+ if (key == "regex") {
+ var guardRe = /\/((?:[^\/\\]|\\.)*)|$/g;
+ snippet.guard = guardRe.exec(val)[1];
+ snippet.trigger = guardRe.exec(val)[1];
+ snippet.endTrigger = guardRe.exec(val)[1];
+ snippet.endGuard = guardRe.exec(val)[1];
+ } else if (key == "snippet") {
+ snippet.tabTrigger = val.match(/^\S*/)[0];
+ if (!snippet.name)
+ snippet.name = val;
+ } else {
+ snippet[key] = val;
+ }
+ }
+ }
+ return list;
+ };
+ this.getSnippetByName = function(name, editor) {
+ var snippetMap = this.snippetNameMap;
+ var snippet;
+ this.getActiveScopes(editor).some(function(scope) {
+ var snippets = snippetMap[scope];
+ if (snippets)
+ snippet = snippets[name];
+ return !!snippet;
+ }, this);
+ return snippet;
+ };
+
+}).call(SnippetManager.prototype);
+
+
+var TabstopManager = function(editor) {
+ if (editor.tabstopManager)
+ return editor.tabstopManager;
+ editor.tabstopManager = this;
+ this.$onChange = this.onChange.bind(this);
+ this.$onChangeSelection = lang.delayedCall(this.onChangeSelection.bind(this)).schedule;
+ this.$onChangeSession = this.onChangeSession.bind(this);
+ this.$onAfterExec = this.onAfterExec.bind(this);
+ this.attach(editor);
+};
+(function() {
+ this.attach = function(editor) {
+ this.index = 0;
+ this.ranges = [];
+ this.tabstops = [];
+ this.$openTabstops = null;
+ this.selectedTabstop = null;
+
+ this.editor = editor;
+ this.editor.on("change", this.$onChange);
+ this.editor.on("changeSelection", this.$onChangeSelection);
+ this.editor.on("changeSession", this.$onChangeSession);
+ this.editor.commands.on("afterExec", this.$onAfterExec);
+ this.editor.keyBinding.addKeyboardHandler(this.keyboardHandler);
+ };
+ this.detach = function() {
+ this.tabstops.forEach(this.removeTabstopMarkers, this);
+ this.ranges = null;
+ this.tabstops = null;
+ this.selectedTabstop = null;
+ this.editor.removeListener("change", this.$onChange);
+ this.editor.removeListener("changeSelection", this.$onChangeSelection);
+ this.editor.removeListener("changeSession", this.$onChangeSession);
+ this.editor.commands.removeListener("afterExec", this.$onAfterExec);
+ this.editor.keyBinding.removeKeyboardHandler(this.keyboardHandler);
+ this.editor.tabstopManager = null;
+ this.editor = null;
+ };
+
+ this.onChange = function(delta) {
+ var changeRange = delta;
+ var isRemove = delta.action[0] == "r";
+ var start = delta.start;
+ var end = delta.end;
+ var startRow = start.row;
+ var endRow = end.row;
+ var lineDif = endRow - startRow;
+ var colDiff = end.column - start.column;
+
+ if (isRemove) {
+ lineDif = -lineDif;
+ colDiff = -colDiff;
+ }
+ if (!this.$inChange && isRemove) {
+ var ts = this.selectedTabstop;
+ var changedOutside = ts && !ts.some(function(r) {
+ return comparePoints(r.start, start) <= 0 && comparePoints(r.end, end) >= 0;
+ });
+ if (changedOutside)
+ return this.detach();
+ }
+ var ranges = this.ranges;
+ for (var i = 0; i < ranges.length; i++) {
+ var r = ranges[i];
+ if (r.end.row < start.row)
+ continue;
+
+ if (isRemove && comparePoints(start, r.start) < 0 && comparePoints(end, r.end) > 0) {
+ this.removeRange(r);
+ i--;
+ continue;
+ }
+
+ if (r.start.row == startRow && r.start.column > start.column)
+ r.start.column += colDiff;
+ if (r.end.row == startRow && r.end.column >= start.column)
+ r.end.column += colDiff;
+ if (r.start.row >= startRow)
+ r.start.row += lineDif;
+ if (r.end.row >= startRow)
+ r.end.row += lineDif;
+
+ if (comparePoints(r.start, r.end) > 0)
+ this.removeRange(r);
+ }
+ if (!ranges.length)
+ this.detach();
+ };
+ this.updateLinkedFields = function() {
+ var ts = this.selectedTabstop;
+ if (!ts || !ts.hasLinkedRanges)
+ return;
+ this.$inChange = true;
+ var session = this.editor.session;
+ var text = session.getTextRange(ts.firstNonLinked);
+ for (var i = ts.length; i--;) {
+ var range = ts[i];
+ if (!range.linked)
+ continue;
+ var fmt = exports.snippetManager.tmStrFormat(text, range.original);
+ session.replace(range, fmt);
+ }
+ this.$inChange = false;
+ };
+ this.onAfterExec = function(e) {
+ if (e.command && !e.command.readOnly)
+ this.updateLinkedFields();
+ };
+ this.onChangeSelection = function() {
+ if (!this.editor)
+ return;
+ var lead = this.editor.selection.lead;
+ var anchor = this.editor.selection.anchor;
+ var isEmpty = this.editor.selection.isEmpty();
+ for (var i = this.ranges.length; i--;) {
+ if (this.ranges[i].linked)
+ continue;
+ var containsLead = this.ranges[i].contains(lead.row, lead.column);
+ var containsAnchor = isEmpty || this.ranges[i].contains(anchor.row, anchor.column);
+ if (containsLead && containsAnchor)
+ return;
+ }
+ this.detach();
+ };
+ this.onChangeSession = function() {
+ this.detach();
+ };
+ this.tabNext = function(dir) {
+ var max = this.tabstops.length;
+ var index = this.index + (dir || 1);
+ index = Math.min(Math.max(index, 1), max);
+ if (index == max)
+ index = 0;
+ this.selectTabstop(index);
+ if (index === 0)
+ this.detach();
+ };
+ this.selectTabstop = function(index) {
+ this.$openTabstops = null;
+ var ts = this.tabstops[this.index];
+ if (ts)
+ this.addTabstopMarkers(ts);
+ this.index = index;
+ ts = this.tabstops[this.index];
+ if (!ts || !ts.length)
+ return;
+
+ this.selectedTabstop = ts;
+ if (!this.editor.inVirtualSelectionMode) {
+ var sel = this.editor.multiSelect;
+ sel.toSingleRange(ts.firstNonLinked.clone());
+ for (var i = ts.length; i--;) {
+ if (ts.hasLinkedRanges && ts[i].linked)
+ continue;
+ sel.addRange(ts[i].clone(), true);
+ }
+ if (sel.ranges[0])
+ sel.addRange(sel.ranges[0].clone());
+ } else {
+ this.editor.selection.setRange(ts.firstNonLinked);
+ }
+
+ this.editor.keyBinding.addKeyboardHandler(this.keyboardHandler);
+ };
+ this.addTabstops = function(tabstops, start, end) {
+ if (!this.$openTabstops)
+ this.$openTabstops = [];
+ if (!tabstops[0]) {
+ var p = Range.fromPoints(end, end);
+ moveRelative(p.start, start);
+ moveRelative(p.end, start);
+ tabstops[0] = [p];
+ tabstops[0].index = 0;
+ }
+
+ var i = this.index;
+ var arg = [i + 1, 0];
+ var ranges = this.ranges;
+ tabstops.forEach(function(ts, index) {
+ var dest = this.$openTabstops[index] || ts;
+
+ for (var i = ts.length; i--;) {
+ var p = ts[i];
+ var range = Range.fromPoints(p.start, p.end || p.start);
+ movePoint(range.start, start);
+ movePoint(range.end, start);
+ range.original = p;
+ range.tabstop = dest;
+ ranges.push(range);
+ if (dest != ts)
+ dest.unshift(range);
+ else
+ dest[i] = range;
+ if (p.fmtString) {
+ range.linked = true;
+ dest.hasLinkedRanges = true;
+ } else if (!dest.firstNonLinked)
+ dest.firstNonLinked = range;
+ }
+ if (!dest.firstNonLinked)
+ dest.hasLinkedRanges = false;
+ if (dest === ts) {
+ arg.push(dest);
+ this.$openTabstops[index] = dest;
+ }
+ this.addTabstopMarkers(dest);
+ }, this);
+
+ if (arg.length > 2) {
+ if (this.tabstops.length)
+ arg.push(arg.splice(2, 1)[0]);
+ this.tabstops.splice.apply(this.tabstops, arg);
+ }
+ };
+
+ this.addTabstopMarkers = function(ts) {
+ var session = this.editor.session;
+ ts.forEach(function(range) {
+ if (!range.markerId)
+ range.markerId = session.addMarker(range, "ace_snippet-marker", "text");
+ });
+ };
+ this.removeTabstopMarkers = function(ts) {
+ var session = this.editor.session;
+ ts.forEach(function(range) {
+ session.removeMarker(range.markerId);
+ range.markerId = null;
+ });
+ };
+ this.removeRange = function(range) {
+ var i = range.tabstop.indexOf(range);
+ range.tabstop.splice(i, 1);
+ i = this.ranges.indexOf(range);
+ this.ranges.splice(i, 1);
+ this.editor.session.removeMarker(range.markerId);
+ if (!range.tabstop.length) {
+ i = this.tabstops.indexOf(range.tabstop);
+ if (i != -1)
+ this.tabstops.splice(i, 1);
+ if (!this.tabstops.length)
+ this.detach();
+ }
+ };
+
+ this.keyboardHandler = new HashHandler();
+ this.keyboardHandler.bindKeys({
+ "Tab": function(ed) {
+ if (exports.snippetManager && exports.snippetManager.expandWithTab(ed)) {
+ return;
+ }
+
+ ed.tabstopManager.tabNext(1);
+ },
+ "Shift-Tab": function(ed) {
+ ed.tabstopManager.tabNext(-1);
+ },
+ "Esc": function(ed) {
+ ed.tabstopManager.detach();
+ },
+ "Return": function(ed) {
+ return false;
+ }
+ });
+}).call(TabstopManager.prototype);
+
+
+
+var changeTracker = {};
+changeTracker.onChange = Anchor.prototype.onChange;
+changeTracker.setPosition = function(row, column) {
+ this.pos.row = row;
+ this.pos.column = column;
+};
+changeTracker.update = function(pos, delta, $insertRight) {
+ this.$insertRight = $insertRight;
+ this.pos = pos;
+ this.onChange(delta);
+};
+
+var movePoint = function(point, diff) {
+ if (point.row == 0)
+ point.column += diff.column;
+ point.row += diff.row;
+};
+
+var moveRelative = function(point, start) {
+ if (point.row == start.row)
+ point.column -= start.column;
+ point.row -= start.row;
+};
+
+
+require("./lib/dom").importCssString("\
+.ace_snippet-marker {\
+ -moz-box-sizing: border-box;\
+ box-sizing: border-box;\
+ background: rgba(194, 193, 208, 0.09);\
+ border: 1px dotted rgba(211, 208, 235, 0.62);\
+ position: absolute;\
+}");
+
+exports.snippetManager = new SnippetManager();
+
+
+var Editor = require("./editor").Editor;
+(function() {
+ this.insertSnippet = function(content, options) {
+ return exports.snippetManager.insertSnippet(this, content, options);
+ };
+ this.expandSnippet = function(options) {
+ return exports.snippetManager.expandWithTab(this, options);
+ };
+}).call(Editor.prototype);
+
+});
+
+define("ace/ext/emmet",["require","exports","module","ace/keyboard/hash_handler","ace/editor","ace/snippets","ace/range","resources","resources","tabStops","resources","utils","actions","ace/config","ace/config"], function(require, exports, module) {
+"use strict";
+var HashHandler = require("ace/keyboard/hash_handler").HashHandler;
+var Editor = require("ace/editor").Editor;
+var snippetManager = require("ace/snippets").snippetManager;
+var Range = require("ace/range").Range;
+var emmet, emmetPath;
+function AceEmmetEditor() {}
+
+AceEmmetEditor.prototype = {
+ setupContext: function(editor) {
+ this.ace = editor;
+ this.indentation = editor.session.getTabString();
+ if (!emmet)
+ emmet = window.emmet;
+ var resources = emmet.resources || emmet.require("resources");
+ resources.setVariable("indentation", this.indentation);
+ this.$syntax = null;
+ this.$syntax = this.getSyntax();
+ },
+ getSelectionRange: function() {
+ var range = this.ace.getSelectionRange();
+ var doc = this.ace.session.doc;
+ return {
+ start: doc.positionToIndex(range.start),
+ end: doc.positionToIndex(range.end)
+ };
+ },
+ createSelection: function(start, end) {
+ var doc = this.ace.session.doc;
+ this.ace.selection.setRange({
+ start: doc.indexToPosition(start),
+ end: doc.indexToPosition(end)
+ });
+ },
+ getCurrentLineRange: function() {
+ var ace = this.ace;
+ var row = ace.getCursorPosition().row;
+ var lineLength = ace.session.getLine(row).length;
+ var index = ace.session.doc.positionToIndex({row: row, column: 0});
+ return {
+ start: index,
+ end: index + lineLength
+ };
+ },
+ getCaretPos: function(){
+ var pos = this.ace.getCursorPosition();
+ return this.ace.session.doc.positionToIndex(pos);
+ },
+ setCaretPos: function(index){
+ var pos = this.ace.session.doc.indexToPosition(index);
+ this.ace.selection.moveToPosition(pos);
+ },
+ getCurrentLine: function() {
+ var row = this.ace.getCursorPosition().row;
+ return this.ace.session.getLine(row);
+ },
+ replaceContent: function(value, start, end, noIndent) {
+ if (end == null)
+ end = start == null ? this.getContent().length : start;
+ if (start == null)
+ start = 0;
+
+ var editor = this.ace;
+ var doc = editor.session.doc;
+ var range = Range.fromPoints(doc.indexToPosition(start), doc.indexToPosition(end));
+ editor.session.remove(range);
+
+ range.end = range.start;
+
+ value = this.$updateTabstops(value);
+ snippetManager.insertSnippet(editor, value);
+ },
+ getContent: function(){
+ return this.ace.getValue();
+ },
+ getSyntax: function() {
+ if (this.$syntax)
+ return this.$syntax;
+ var syntax = this.ace.session.$modeId.split("/").pop();
+ if (syntax == "html" || syntax == "php") {
+ var cursor = this.ace.getCursorPosition();
+ var state = this.ace.session.getState(cursor.row);
+ if (typeof state != "string")
+ state = state[0];
+ if (state) {
+ state = state.split("-");
+ if (state.length > 1)
+ syntax = state[0];
+ else if (syntax == "php")
+ syntax = "html";
+ }
+ }
+ return syntax;
+ },
+ getProfileName: function() {
+ var resources = emmet.resources || emmet.require("resources");
+ switch (this.getSyntax()) {
+ case "css": return "css";
+ case "xml":
+ case "xsl":
+ return "xml";
+ case "html":
+ var profile = resources.getVariable("profile");
+ if (!profile)
+ profile = this.ace.session.getLines(0,2).join("").search(/]+XHTML/i) != -1 ? "xhtml": "html";
+ return profile;
+ default:
+ var mode = this.ace.session.$mode;
+ return mode.emmetConfig && mode.emmetConfig.profile || "xhtml";
+ }
+ },
+ prompt: function(title) {
+ return prompt(title);
+ },
+ getSelection: function() {
+ return this.ace.session.getTextRange();
+ },
+ getFilePath: function() {
+ return "";
+ },
+ $updateTabstops: function(value) {
+ var base = 1000;
+ var zeroBase = 0;
+ var lastZero = null;
+ var ts = emmet.tabStops || emmet.require('tabStops');
+ var resources = emmet.resources || emmet.require("resources");
+ var settings = resources.getVocabulary("user");
+ var tabstopOptions = {
+ tabstop: function(data) {
+ var group = parseInt(data.group, 10);
+ var isZero = group === 0;
+ if (isZero)
+ group = ++zeroBase;
+ else
+ group += base;
+
+ var placeholder = data.placeholder;
+ if (placeholder) {
+ placeholder = ts.processText(placeholder, tabstopOptions);
+ }
+
+ var result = '${' + group + (placeholder ? ':' + placeholder : '') + '}';
+
+ if (isZero) {
+ lastZero = [data.start, result];
+ }
+
+ return result;
+ },
+ escape: function(ch) {
+ if (ch == '$') return '\\$';
+ if (ch == '\\') return '\\\\';
+ return ch;
+ }
+ };
+
+ value = ts.processText(value, tabstopOptions);
+
+ if (settings.variables['insert_final_tabstop'] && !/\$\{0\}$/.test(value)) {
+ value += '${0}';
+ } else if (lastZero) {
+ var common = emmet.utils ? emmet.utils.common : emmet.require('utils');
+ value = common.replaceSubstring(value, '${0}', lastZero[0], lastZero[1]);
+ }
+
+ return value;
+ }
+};
+
+
+var keymap = {
+ expand_abbreviation: {"mac": "ctrl+alt+e", "win": "alt+e"},
+ match_pair_outward: {"mac": "ctrl+d", "win": "ctrl+,"},
+ match_pair_inward: {"mac": "ctrl+j", "win": "ctrl+shift+0"},
+ matching_pair: {"mac": "ctrl+alt+j", "win": "alt+j"},
+ next_edit_point: "alt+right",
+ prev_edit_point: "alt+left",
+ toggle_comment: {"mac": "command+/", "win": "ctrl+/"},
+ split_join_tag: {"mac": "shift+command+'", "win": "shift+ctrl+`"},
+ remove_tag: {"mac": "command+'", "win": "shift+ctrl+;"},
+ evaluate_math_expression: {"mac": "shift+command+y", "win": "shift+ctrl+y"},
+ increment_number_by_1: "ctrl+up",
+ decrement_number_by_1: "ctrl+down",
+ increment_number_by_01: "alt+up",
+ decrement_number_by_01: "alt+down",
+ increment_number_by_10: {"mac": "alt+command+up", "win": "shift+alt+up"},
+ decrement_number_by_10: {"mac": "alt+command+down", "win": "shift+alt+down"},
+ select_next_item: {"mac": "shift+command+.", "win": "shift+ctrl+."},
+ select_previous_item: {"mac": "shift+command+,", "win": "shift+ctrl+,"},
+ reflect_css_value: {"mac": "shift+command+r", "win": "shift+ctrl+r"},
+
+ encode_decode_data_url: {"mac": "shift+ctrl+d", "win": "ctrl+'"},
+ expand_abbreviation_with_tab: "Tab",
+ wrap_with_abbreviation: {"mac": "shift+ctrl+a", "win": "shift+ctrl+a"}
+};
+
+var editorProxy = new AceEmmetEditor();
+exports.commands = new HashHandler();
+exports.runEmmetCommand = function runEmmetCommand(editor) {
+ try {
+ editorProxy.setupContext(editor);
+ var actions = emmet.actions || emmet.require("actions");
+
+ if (this.action == "expand_abbreviation_with_tab") {
+ if (!editor.selection.isEmpty())
+ return false;
+ var pos = editor.selection.lead;
+ var token = editor.session.getTokenAt(pos.row, pos.column);
+ if (token && /\btag\b/.test(token.type))
+ return false;
+ }
+
+ if (this.action == "wrap_with_abbreviation") {
+ return setTimeout(function() {
+ actions.run("wrap_with_abbreviation", editorProxy);
+ }, 0);
+ }
+
+ var result = actions.run(this.action, editorProxy);
+ } catch(e) {
+ if (!emmet) {
+ load(runEmmetCommand.bind(this, editor));
+ return true;
+ }
+ editor._signal("changeStatus", typeof e == "string" ? e : e.message);
+ console.log(e);
+ result = false;
+ }
+ return result;
+};
+
+for (var command in keymap) {
+ exports.commands.addCommand({
+ name: "emmet:" + command,
+ action: command,
+ bindKey: keymap[command],
+ exec: exports.runEmmetCommand,
+ multiSelectAction: "forEach"
+ });
+}
+
+exports.updateCommands = function(editor, enabled) {
+ if (enabled) {
+ editor.keyBinding.addKeyboardHandler(exports.commands);
+ } else {
+ editor.keyBinding.removeKeyboardHandler(exports.commands);
+ }
+};
+
+exports.isSupportedMode = function(mode) {
+ if (!mode) return false;
+ if (mode.emmetConfig) return true;
+ var id = mode.$id || mode;
+ return /css|less|scss|sass|stylus|html|php|twig|ejs|handlebars/.test(id);
+};
+
+exports.isAvailable = function(editor, command) {
+ if (/(evaluate_math_expression|expand_abbreviation)$/.test(command))
+ return true;
+ var mode = editor.session.$mode;
+ var isSupported = exports.isSupportedMode(mode);
+ if (isSupported && mode.$modes) {
+ try {
+ editorProxy.setupContext(editor);
+ if (/js|php/.test(editorProxy.getSyntax()))
+ isSupported = false;
+ } catch(e) {}
+ }
+ return isSupported;
+}
+
+var onChangeMode = function(e, target) {
+ var editor = target;
+ if (!editor)
+ return;
+ var enabled = exports.isSupportedMode(editor.session.$mode);
+ if (e.enableEmmet === false)
+ enabled = false;
+ if (enabled)
+ load();
+ exports.updateCommands(editor, enabled);
+};
+
+var load = function(cb) {
+ if (typeof emmetPath == "string") {
+ require("ace/config").loadModule(emmetPath, function() {
+ emmetPath = null;
+ cb && cb();
+ });
+ }
+};
+
+exports.AceEmmetEditor = AceEmmetEditor;
+require("ace/config").defineOptions(Editor.prototype, "editor", {
+ enableEmmet: {
+ set: function(val) {
+ this[val ? "on" : "removeListener"]("changeMode", onChangeMode);
+ onChangeMode({enableEmmet: !!val}, this);
+ },
+ value: true
+ }
+});
+
+exports.setCore = function(e) {
+ if (typeof e == "string")
+ emmetPath = e;
+ else
+ emmet = e;
+};
+});
+
+define("ace/autocomplete/popup",["require","exports","module","ace/virtual_renderer","ace/editor","ace/range","ace/lib/event","ace/lib/lang","ace/lib/dom"], function(require, exports, module) {
+"use strict";
+
+var Renderer = require("../virtual_renderer").VirtualRenderer;
+var Editor = require("../editor").Editor;
+var Range = require("../range").Range;
+var event = require("../lib/event");
+var lang = require("../lib/lang");
+var dom = require("../lib/dom");
+
+var $singleLineEditor = function(el) {
+ var renderer = new Renderer(el);
+
+ renderer.$maxLines = 4;
+
+ var editor = new Editor(renderer);
+
+ editor.setHighlightActiveLine(false);
+ editor.setShowPrintMargin(false);
+ editor.renderer.setShowGutter(false);
+ editor.renderer.setHighlightGutterLine(false);
+
+ editor.$mouseHandler.$focusWaitTimout = 0;
+ editor.$highlightTagPending = true;
+
+ return editor;
+};
+
+var AcePopup = function(parentNode) {
+ var el = dom.createElement("div");
+ var popup = new $singleLineEditor(el);
+
+ if (parentNode)
+ parentNode.appendChild(el);
+ el.style.display = "none";
+ popup.renderer.content.style.cursor = "default";
+ popup.renderer.setStyle("ace_autocomplete");
+
+ popup.setOption("displayIndentGuides", false);
+ popup.setOption("dragDelay", 150);
+
+ var noop = function(){};
+
+ popup.focus = noop;
+ popup.$isFocused = true;
+
+ popup.renderer.$cursorLayer.restartTimer = noop;
+ popup.renderer.$cursorLayer.element.style.opacity = 0;
+
+ popup.renderer.$maxLines = 8;
+ popup.renderer.$keepTextAreaAtCursor = false;
+
+ popup.setHighlightActiveLine(false);
+ popup.session.highlight("");
+ popup.session.$searchHighlight.clazz = "ace_highlight-marker";
+
+ popup.on("mousedown", function(e) {
+ var pos = e.getDocumentPosition();
+ popup.selection.moveToPosition(pos);
+ selectionMarker.start.row = selectionMarker.end.row = pos.row;
+ e.stop();
+ });
+
+ var lastMouseEvent;
+ var hoverMarker = new Range(-1,0,-1,Infinity);
+ var selectionMarker = new Range(-1,0,-1,Infinity);
+ selectionMarker.id = popup.session.addMarker(selectionMarker, "ace_active-line", "fullLine");
+ popup.setSelectOnHover = function(val) {
+ if (!val) {
+ hoverMarker.id = popup.session.addMarker(hoverMarker, "ace_line-hover", "fullLine");
+ } else if (hoverMarker.id) {
+ popup.session.removeMarker(hoverMarker.id);
+ hoverMarker.id = null;
+ }
+ };
+ popup.setSelectOnHover(false);
+ popup.on("mousemove", function(e) {
+ if (!lastMouseEvent) {
+ lastMouseEvent = e;
+ return;
+ }
+ if (lastMouseEvent.x == e.x && lastMouseEvent.y == e.y) {
+ return;
+ }
+ lastMouseEvent = e;
+ lastMouseEvent.scrollTop = popup.renderer.scrollTop;
+ var row = lastMouseEvent.getDocumentPosition().row;
+ if (hoverMarker.start.row != row) {
+ if (!hoverMarker.id)
+ popup.setRow(row);
+ setHoverMarker(row);
+ }
+ });
+ popup.renderer.on("beforeRender", function() {
+ if (lastMouseEvent && hoverMarker.start.row != -1) {
+ lastMouseEvent.$pos = null;
+ var row = lastMouseEvent.getDocumentPosition().row;
+ if (!hoverMarker.id)
+ popup.setRow(row);
+ setHoverMarker(row, true);
+ }
+ });
+ popup.renderer.on("afterRender", function() {
+ var row = popup.getRow();
+ var t = popup.renderer.$textLayer;
+ var selected = t.element.childNodes[row - t.config.firstRow];
+ if (selected == t.selectedNode)
+ return;
+ if (t.selectedNode)
+ dom.removeCssClass(t.selectedNode, "ace_selected");
+ t.selectedNode = selected;
+ if (selected)
+ dom.addCssClass(selected, "ace_selected");
+ });
+ var hideHoverMarker = function() { setHoverMarker(-1) };
+ var setHoverMarker = function(row, suppressRedraw) {
+ if (row !== hoverMarker.start.row) {
+ hoverMarker.start.row = hoverMarker.end.row = row;
+ if (!suppressRedraw)
+ popup.session._emit("changeBackMarker");
+ popup._emit("changeHoverMarker");
+ }
+ };
+ popup.getHoveredRow = function() {
+ return hoverMarker.start.row;
+ };
+
+ event.addListener(popup.container, "mouseout", hideHoverMarker);
+ popup.on("hide", hideHoverMarker);
+ popup.on("changeSelection", hideHoverMarker);
+
+ popup.session.doc.getLength = function() {
+ return popup.data.length;
+ };
+ popup.session.doc.getLine = function(i) {
+ var data = popup.data[i];
+ if (typeof data == "string")
+ return data;
+ return (data && data.value) || "";
+ };
+
+ var bgTokenizer = popup.session.bgTokenizer;
+ bgTokenizer.$tokenizeRow = function(row) {
+ var data = popup.data[row];
+ var tokens = [];
+ if (!data)
+ return tokens;
+ if (typeof data == "string")
+ data = {value: data};
+ if (!data.caption)
+ data.caption = data.value || data.name;
+
+ var last = -1;
+ var flag, c;
+ for (var i = 0; i < data.caption.length; i++) {
+ c = data.caption[i];
+ flag = data.matchMask & (1 << i) ? 1 : 0;
+ if (last !== flag) {
+ tokens.push({type: data.className || "" + ( flag ? "completion-highlight" : ""), value: c});
+ last = flag;
+ } else {
+ tokens[tokens.length - 1].value += c;
+ }
+ }
+
+ if (data.meta) {
+ var maxW = popup.renderer.$size.scrollerWidth / popup.renderer.layerConfig.characterWidth;
+ var metaData = data.meta;
+ if (metaData.length + data.caption.length > maxW - 2) {
+ metaData = metaData.substr(0, maxW - data.caption.length - 3) + "\u2026"
+ }
+ tokens.push({type: "rightAlignedText", value: metaData});
+ }
+ return tokens;
+ };
+ bgTokenizer.$updateOnChange = noop;
+ bgTokenizer.start = noop;
+
+ popup.session.$computeWidth = function() {
+ return this.screenWidth = 0;
+ };
+
+ popup.$blockScrolling = Infinity;
+ popup.isOpen = false;
+ popup.isTopdown = false;
+
+ popup.data = [];
+ popup.setData = function(list) {
+ popup.setValue(lang.stringRepeat("\n", list.length), -1);
+ popup.data = list || [];
+ popup.setRow(0);
+ };
+ popup.getData = function(row) {
+ return popup.data[row];
+ };
+
+ popup.getRow = function() {
+ return selectionMarker.start.row;
+ };
+ popup.setRow = function(line) {
+ line = Math.max(0, Math.min(this.data.length, line));
+ if (selectionMarker.start.row != line) {
+ popup.selection.clearSelection();
+ selectionMarker.start.row = selectionMarker.end.row = line || 0;
+ popup.session._emit("changeBackMarker");
+ popup.moveCursorTo(line || 0, 0);
+ if (popup.isOpen)
+ popup._signal("select");
+ }
+ };
+
+ popup.on("changeSelection", function() {
+ if (popup.isOpen)
+ popup.setRow(popup.selection.lead.row);
+ popup.renderer.scrollCursorIntoView();
+ });
+
+ popup.hide = function() {
+ this.container.style.display = "none";
+ this._signal("hide");
+ popup.isOpen = false;
+ };
+ popup.show = function(pos, lineHeight, topdownOnly) {
+ var el = this.container;
+ var screenHeight = window.innerHeight;
+ var screenWidth = window.innerWidth;
+ var renderer = this.renderer;
+ var maxH = renderer.$maxLines * lineHeight * 1.4;
+ var top = pos.top + this.$borderSize;
+ var allowTopdown = top > screenHeight / 2 && !topdownOnly;
+ if (allowTopdown && top + lineHeight + maxH > screenHeight) {
+ renderer.$maxPixelHeight = top - 2 * this.$borderSize;
+ el.style.top = "";
+ el.style.bottom = screenHeight - top + "px";
+ popup.isTopdown = false;
+ } else {
+ top += lineHeight;
+ renderer.$maxPixelHeight = screenHeight - top - 0.2 * lineHeight;
+ el.style.top = top + "px";
+ el.style.bottom = "";
+ popup.isTopdown = true;
+ }
+
+ el.style.display = "";
+ this.renderer.$textLayer.checkForSizeChanges();
+
+ var left = pos.left;
+ if (left + el.offsetWidth > screenWidth)
+ left = screenWidth - el.offsetWidth;
+
+ el.style.left = left + "px";
+
+ this._signal("show");
+ lastMouseEvent = null;
+ popup.isOpen = true;
+ };
+
+ popup.getTextLeftOffset = function() {
+ return this.$borderSize + this.renderer.$padding + this.$imageSize;
+ };
+
+ popup.$imageSize = 0;
+ popup.$borderSize = 1;
+
+ return popup;
+};
+
+dom.importCssString("\
+.ace_editor.ace_autocomplete .ace_marker-layer .ace_active-line {\
+ background-color: #CAD6FA;\
+ z-index: 1;\
+}\
+.ace_editor.ace_autocomplete .ace_line-hover {\
+ border: 1px solid #abbffe;\
+ margin-top: -1px;\
+ background: rgba(233,233,253,0.4);\
+}\
+.ace_editor.ace_autocomplete .ace_line-hover {\
+ position: absolute;\
+ z-index: 2;\
+}\
+.ace_editor.ace_autocomplete .ace_scroller {\
+ background: none;\
+ border: none;\
+ box-shadow: none;\
+}\
+.ace_rightAlignedText {\
+ color: gray;\
+ display: inline-block;\
+ position: absolute;\
+ right: 4px;\
+ text-align: right;\
+ z-index: -1;\
+}\
+.ace_editor.ace_autocomplete .ace_completion-highlight{\
+ color: #000;\
+ text-shadow: 0 0 0.01em;\
+}\
+.ace_editor.ace_autocomplete {\
+ width: 280px;\
+ z-index: 200000;\
+ background: #fbfbfb;\
+ color: #444;\
+ border: 1px lightgray solid;\
+ position: fixed;\
+ box-shadow: 2px 3px 5px rgba(0,0,0,.2);\
+ line-height: 1.4;\
+}");
+
+exports.AcePopup = AcePopup;
+
+});
+
+define("ace/autocomplete/util",["require","exports","module"], function(require, exports, module) {
+"use strict";
+
+exports.parForEach = function(array, fn, callback) {
+ var completed = 0;
+ var arLength = array.length;
+ if (arLength === 0)
+ callback();
+ for (var i = 0; i < arLength; i++) {
+ fn(array[i], function(result, err) {
+ completed++;
+ if (completed === arLength)
+ callback(result, err);
+ });
+ }
+};
+
+var ID_REGEX = /[a-zA-Z_0-9\$\-\u00A2-\uFFFF]/;
+
+exports.retrievePrecedingIdentifier = function(text, pos, regex) {
+ regex = regex || ID_REGEX;
+ var buf = [];
+ for (var i = pos-1; i >= 0; i--) {
+ if (regex.test(text[i]))
+ buf.push(text[i]);
+ else
+ break;
+ }
+ return buf.reverse().join("");
+};
+
+exports.retrieveFollowingIdentifier = function(text, pos, regex) {
+ regex = regex || ID_REGEX;
+ var buf = [];
+ for (var i = pos; i < text.length; i++) {
+ if (regex.test(text[i]))
+ buf.push(text[i]);
+ else
+ break;
+ }
+ return buf;
+};
+
+exports.getCompletionPrefix = function (editor) {
+ var pos = editor.getCursorPosition();
+ var line = editor.session.getLine(pos.row);
+ var prefix;
+ editor.completers.forEach(function(completer) {
+ if (completer.identifierRegexps) {
+ completer.identifierRegexps.forEach(function(identifierRegex) {
+ if (!prefix && identifierRegex)
+ prefix = this.retrievePrecedingIdentifier(line, pos.column, identifierRegex);
+ }.bind(this));
+ }
+ }.bind(this));
+ return prefix || this.retrievePrecedingIdentifier(line, pos.column);
+};
+
+});
+
+define("ace/autocomplete",["require","exports","module","ace/keyboard/hash_handler","ace/autocomplete/popup","ace/autocomplete/util","ace/lib/event","ace/lib/lang","ace/lib/dom","ace/snippets"], function(require, exports, module) {
+"use strict";
+
+var HashHandler = require("./keyboard/hash_handler").HashHandler;
+var AcePopup = require("./autocomplete/popup").AcePopup;
+var util = require("./autocomplete/util");
+var event = require("./lib/event");
+var lang = require("./lib/lang");
+var dom = require("./lib/dom");
+var snippetManager = require("./snippets").snippetManager;
+
+var Autocomplete = function() {
+ this.autoInsert = false;
+ this.autoSelect = true;
+ this.exactMatch = false;
+ this.gatherCompletionsId = 0;
+ this.keyboardHandler = new HashHandler();
+ this.keyboardHandler.bindKeys(this.commands);
+
+ this.blurListener = this.blurListener.bind(this);
+ this.changeListener = this.changeListener.bind(this);
+ this.mousedownListener = this.mousedownListener.bind(this);
+ this.mousewheelListener = this.mousewheelListener.bind(this);
+
+ this.changeTimer = lang.delayedCall(function() {
+ this.updateCompletions(true);
+ }.bind(this));
+
+ this.tooltipTimer = lang.delayedCall(this.updateDocTooltip.bind(this), 50);
+};
+
+(function() {
+
+ this.$init = function() {
+ this.popup = new AcePopup(document.body || document.documentElement);
+ this.popup.on("click", function(e) {
+ this.insertMatch();
+ e.stop();
+ }.bind(this));
+ this.popup.focus = this.editor.focus.bind(this.editor);
+ this.popup.on("show", this.tooltipTimer.bind(null, null));
+ this.popup.on("select", this.tooltipTimer.bind(null, null));
+ this.popup.on("changeHoverMarker", this.tooltipTimer.bind(null, null));
+ return this.popup;
+ };
+
+ this.getPopup = function() {
+ return this.popup || this.$init();
+ };
+
+ this.openPopup = function(editor, prefix, keepPopupPosition) {
+ if (!this.popup)
+ this.$init();
+
+ this.popup.setData(this.completions.filtered);
+
+ editor.keyBinding.addKeyboardHandler(this.keyboardHandler);
+
+ var renderer = editor.renderer;
+ this.popup.setRow(this.autoSelect ? 0 : -1);
+ if (!keepPopupPosition) {
+ this.popup.setTheme(editor.getTheme());
+ this.popup.setFontSize(editor.getFontSize());
+
+ var lineHeight = renderer.layerConfig.lineHeight;
+
+ var pos = renderer.$cursorLayer.getPixelPosition(this.base, true);
+ pos.left -= this.popup.getTextLeftOffset();
+
+ var rect = editor.container.getBoundingClientRect();
+ pos.top += rect.top - renderer.layerConfig.offset;
+ pos.left += rect.left - editor.renderer.scrollLeft;
+ pos.left += renderer.gutterWidth;
+
+ this.popup.show(pos, lineHeight);
+ } else if (keepPopupPosition && !prefix) {
+ this.detach();
+ }
+ };
+
+ this.detach = function() {
+ this.editor.keyBinding.removeKeyboardHandler(this.keyboardHandler);
+ this.editor.off("changeSelection", this.changeListener);
+ this.editor.off("blur", this.blurListener);
+ this.editor.off("mousedown", this.mousedownListener);
+ this.editor.off("mousewheel", this.mousewheelListener);
+ this.changeTimer.cancel();
+ this.hideDocTooltip();
+
+ this.gatherCompletionsId += 1;
+ if (this.popup && this.popup.isOpen)
+ this.popup.hide();
+
+ if (this.base)
+ this.base.detach();
+ this.activated = false;
+ this.completions = this.base = null;
+ };
+
+ this.changeListener = function(e) {
+ var cursor = this.editor.selection.lead;
+ if (cursor.row != this.base.row || cursor.column < this.base.column) {
+ this.detach();
+ }
+ if (this.activated)
+ this.changeTimer.schedule();
+ else
+ this.detach();
+ };
+
+ this.blurListener = function(e) {
+ if (e.relatedTarget && e.relatedTarget.nodeName == "A" && e.relatedTarget.href) {
+ window.open(e.relatedTarget.href, "_blank");
+ }
+ var el = document.activeElement;
+ var text = this.editor.textInput.getElement();
+ var fromTooltip = e.relatedTarget && e.relatedTarget == this.tooltipNode;
+ var container = this.popup && this.popup.container;
+ if (el != text && el.parentNode != container && !fromTooltip
+ && el != this.tooltipNode && e.relatedTarget != text
+ ) {
+ this.detach();
+ }
+ };
+
+ this.mousedownListener = function(e) {
+ this.detach();
+ };
+
+ this.mousewheelListener = function(e) {
+ this.detach();
+ };
+
+ this.goTo = function(where) {
+ var row = this.popup.getRow();
+ var max = this.popup.session.getLength() - 1;
+
+ switch(where) {
+ case "up": row = row <= 0 ? max : row - 1; break;
+ case "down": row = row >= max ? -1 : row + 1; break;
+ case "start": row = 0; break;
+ case "end": row = max; break;
+ }
+
+ this.popup.setRow(row);
+ };
+
+ this.insertMatch = function(data, options) {
+ if (!data)
+ data = this.popup.getData(this.popup.getRow());
+ if (!data)
+ return false;
+
+ if (data.completer && data.completer.insertMatch) {
+ data.completer.insertMatch(this.editor, data);
+ } else {
+ if (this.completions.filterText) {
+ var ranges = this.editor.selection.getAllRanges();
+ for (var i = 0, range; range = ranges[i]; i++) {
+ range.start.column -= this.completions.filterText.length;
+ this.editor.session.remove(range);
+ }
+ }
+ if (data.snippet)
+ snippetManager.insertSnippet(this.editor, data.snippet);
+ else
+ this.editor.execCommand("insertstring", data.value || data);
+ }
+ this.detach();
+ };
+
+
+ this.commands = {
+ "Up": function(editor) { editor.completer.goTo("up"); },
+ "Down": function(editor) { editor.completer.goTo("down"); },
+ "Ctrl-Up|Ctrl-Home": function(editor) { editor.completer.goTo("start"); },
+ "Ctrl-Down|Ctrl-End": function(editor) { editor.completer.goTo("end"); },
+
+ "Esc": function(editor) { editor.completer.detach(); },
+ "Return": function(editor) { return editor.completer.insertMatch(); },
+ "Shift-Return": function(editor) { editor.completer.insertMatch(null, {deleteSuffix: true}); },
+ "Tab": function(editor) {
+ var result = editor.completer.insertMatch();
+ if (!result && !editor.tabstopManager)
+ editor.completer.goTo("down");
+ else
+ return result;
+ },
+
+ "PageUp": function(editor) { editor.completer.popup.gotoPageUp(); },
+ "PageDown": function(editor) { editor.completer.popup.gotoPageDown(); }
+ };
+
+ this.gatherCompletions = function(editor, callback) {
+ var session = editor.getSession();
+ var pos = editor.getCursorPosition();
+
+ var line = session.getLine(pos.row);
+ var prefix = util.getCompletionPrefix(editor);
+
+ this.base = session.doc.createAnchor(pos.row, pos.column - prefix.length);
+ this.base.$insertRight = true;
+
+ var matches = [];
+ var total = editor.completers.length;
+ editor.completers.forEach(function(completer, i) {
+ completer.getCompletions(editor, session, pos, prefix, function(err, results) {
+ if (!err && results)
+ matches = matches.concat(results);
+ var pos = editor.getCursorPosition();
+ var line = session.getLine(pos.row);
+ callback(null, {
+ prefix: prefix,
+ matches: matches,
+ finished: (--total === 0)
+ });
+ });
+ });
+ return true;
+ };
+
+ this.showPopup = function(editor) {
+ if (this.editor)
+ this.detach();
+
+ this.activated = true;
+
+ this.editor = editor;
+ if (editor.completer != this) {
+ if (editor.completer)
+ editor.completer.detach();
+ editor.completer = this;
+ }
+
+ editor.on("changeSelection", this.changeListener);
+ editor.on("blur", this.blurListener);
+ editor.on("mousedown", this.mousedownListener);
+ editor.on("mousewheel", this.mousewheelListener);
+
+ this.updateCompletions();
+ };
+
+ this.updateCompletions = function(keepPopupPosition) {
+ if (keepPopupPosition && this.base && this.completions) {
+ var pos = this.editor.getCursorPosition();
+ var prefix = this.editor.session.getTextRange({start: this.base, end: pos});
+ if (prefix == this.completions.filterText)
+ return;
+ this.completions.setFilter(prefix);
+ if (!this.completions.filtered.length)
+ return this.detach();
+ if (this.completions.filtered.length == 1
+ && this.completions.filtered[0].value == prefix
+ && !this.completions.filtered[0].snippet)
+ return this.detach();
+ this.openPopup(this.editor, prefix, keepPopupPosition);
+ return;
+ }
+ var _id = this.gatherCompletionsId;
+ this.gatherCompletions(this.editor, function(err, results) {
+ var detachIfFinished = function() {
+ if (!results.finished) return;
+ return this.detach();
+ }.bind(this);
+
+ var prefix = results.prefix;
+ var matches = results && results.matches;
+
+ if (!matches || !matches.length)
+ return detachIfFinished();
+ if (prefix.indexOf(results.prefix) !== 0 || _id != this.gatherCompletionsId)
+ return;
+
+ this.completions = new FilteredList(matches);
+
+ if (this.exactMatch)
+ this.completions.exactMatch = true;
+
+ this.completions.setFilter(prefix);
+ var filtered = this.completions.filtered;
+ if (!filtered.length)
+ return detachIfFinished();
+ if (filtered.length == 1 && filtered[0].value == prefix && !filtered[0].snippet)
+ return detachIfFinished();
+ if (this.autoInsert && filtered.length == 1 && results.finished)
+ return this.insertMatch(filtered[0]);
+
+ this.openPopup(this.editor, prefix, keepPopupPosition);
+ }.bind(this));
+ };
+
+ this.cancelContextMenu = function() {
+ this.editor.$mouseHandler.cancelContextMenu();
+ };
+
+ this.updateDocTooltip = function() {
+ var popup = this.popup;
+ var all = popup.data;
+ var selected = all && (all[popup.getHoveredRow()] || all[popup.getRow()]);
+ var doc = null;
+ if (!selected || !this.editor || !this.popup.isOpen)
+ return this.hideDocTooltip();
+ this.editor.completers.some(function(completer) {
+ if (completer.getDocTooltip)
+ doc = completer.getDocTooltip(selected);
+ return doc;
+ });
+ if (!doc)
+ doc = selected;
+
+ if (typeof doc == "string")
+ doc = {docText: doc};
+ if (!doc || !(doc.docHTML || doc.docText))
+ return this.hideDocTooltip();
+ this.showDocTooltip(doc);
+ };
+
+ this.showDocTooltip = function(item) {
+ if (!this.tooltipNode) {
+ this.tooltipNode = dom.createElement("div");
+ this.tooltipNode.className = "ace_tooltip ace_doc-tooltip";
+ this.tooltipNode.style.margin = 0;
+ this.tooltipNode.style.pointerEvents = "auto";
+ this.tooltipNode.tabIndex = -1;
+ this.tooltipNode.onblur = this.blurListener.bind(this);
+ }
+
+ var tooltipNode = this.tooltipNode;
+ if (item.docHTML) {
+ tooltipNode.innerHTML = item.docHTML;
+ } else if (item.docText) {
+ tooltipNode.textContent = item.docText;
+ }
+
+ if (!tooltipNode.parentNode)
+ document.body.appendChild(tooltipNode);
+ var popup = this.popup;
+ var rect = popup.container.getBoundingClientRect();
+ tooltipNode.style.top = popup.container.style.top;
+ tooltipNode.style.bottom = popup.container.style.bottom;
+
+ if (window.innerWidth - rect.right < 320) {
+ tooltipNode.style.right = window.innerWidth - rect.left + "px";
+ tooltipNode.style.left = "";
+ } else {
+ tooltipNode.style.left = (rect.right + 1) + "px";
+ tooltipNode.style.right = "";
+ }
+ tooltipNode.style.display = "block";
+ };
+
+ this.hideDocTooltip = function() {
+ this.tooltipTimer.cancel();
+ if (!this.tooltipNode) return;
+ var el = this.tooltipNode;
+ if (!this.editor.isFocused() && document.activeElement == el)
+ this.editor.focus();
+ this.tooltipNode = null;
+ if (el.parentNode)
+ el.parentNode.removeChild(el);
+ };
+
+}).call(Autocomplete.prototype);
+
+Autocomplete.startCommand = {
+ name: "startAutocomplete",
+ exec: function(editor) {
+ if (!editor.completer)
+ editor.completer = new Autocomplete();
+ editor.completer.autoInsert = false;
+ editor.completer.autoSelect = true;
+ editor.completer.showPopup(editor);
+ editor.completer.cancelContextMenu();
+ },
+ bindKey: "Ctrl-Space|Ctrl-Shift-Space|Alt-Space"
+};
+
+var FilteredList = function(array, filterText) {
+ this.all = array;
+ this.filtered = array;
+ this.filterText = filterText || "";
+ this.exactMatch = false;
+};
+(function(){
+ this.setFilter = function(str) {
+ if (str.length > this.filterText && str.lastIndexOf(this.filterText, 0) === 0)
+ var matches = this.filtered;
+ else
+ var matches = this.all;
+
+ this.filterText = str;
+ matches = this.filterCompletions(matches, this.filterText);
+ matches = matches.sort(function(a, b) {
+ return b.exactMatch - a.exactMatch || b.score - a.score;
+ });
+ var prev = null;
+ matches = matches.filter(function(item){
+ var caption = item.snippet || item.caption || item.value;
+ if (caption === prev) return false;
+ prev = caption;
+ return true;
+ });
+
+ this.filtered = matches;
+ };
+ this.filterCompletions = function(items, needle) {
+ var results = [];
+ var upper = needle.toUpperCase();
+ var lower = needle.toLowerCase();
+ loop: for (var i = 0, item; item = items[i]; i++) {
+ var caption = item.value || item.caption || item.snippet;
+ if (!caption) continue;
+ var lastIndex = -1;
+ var matchMask = 0;
+ var penalty = 0;
+ var index, distance;
+
+ if (this.exactMatch) {
+ if (needle !== caption.substr(0, needle.length))
+ continue loop;
+ }else{
+ for (var j = 0; j < needle.length; j++) {
+ var i1 = caption.indexOf(lower[j], lastIndex + 1);
+ var i2 = caption.indexOf(upper[j], lastIndex + 1);
+ index = (i1 >= 0) ? ((i2 < 0 || i1 < i2) ? i1 : i2) : i2;
+ if (index < 0)
+ continue loop;
+ distance = index - lastIndex - 1;
+ if (distance > 0) {
+ if (lastIndex === -1)
+ penalty += 10;
+ penalty += distance;
+ }
+ matchMask = matchMask | (1 << index);
+ lastIndex = index;
+ }
+ }
+ item.matchMask = matchMask;
+ item.exactMatch = penalty ? 0 : 1;
+ item.score = (item.score || 0) - penalty;
+ results.push(item);
+ }
+ return results;
+ };
+}).call(FilteredList.prototype);
+
+exports.Autocomplete = Autocomplete;
+exports.FilteredList = FilteredList;
+
+});
+
+define("ace/autocomplete/text_completer",["require","exports","module","ace/range"], function(require, exports, module) {
+ var Range = require("../range").Range;
+
+ var splitRegex = /[^a-zA-Z_0-9\$\-\u00C0-\u1FFF\u2C00-\uD7FF\w]+/;
+
+ function getWordIndex(doc, pos) {
+ var textBefore = doc.getTextRange(Range.fromPoints({row: 0, column:0}, pos));
+ return textBefore.split(splitRegex).length - 1;
+ }
+ function wordDistance(doc, pos) {
+ var prefixPos = getWordIndex(doc, pos);
+ var words = doc.getValue().split(splitRegex);
+ var wordScores = Object.create(null);
+
+ var currentWord = words[prefixPos];
+
+ words.forEach(function(word, idx) {
+ if (!word || word === currentWord) return;
+
+ var distance = Math.abs(prefixPos - idx);
+ var score = words.length - distance;
+ if (wordScores[word]) {
+ wordScores[word] = Math.max(score, wordScores[word]);
+ } else {
+ wordScores[word] = score;
+ }
+ });
+ return wordScores;
+ }
+
+ exports.getCompletions = function(editor, session, pos, prefix, callback) {
+ var wordScore = wordDistance(session, pos, prefix);
+ var wordList = Object.keys(wordScore);
+ callback(null, wordList.map(function(word) {
+ return {
+ caption: word,
+ value: word,
+ score: wordScore[word],
+ meta: "local"
+ };
+ }));
+ };
+});
+
+define("ace/ext/language_tools",["require","exports","module","ace/snippets","ace/autocomplete","ace/config","ace/lib/lang","ace/autocomplete/util","ace/autocomplete/text_completer","ace/editor","ace/config"], function(require, exports, module) {
+"use strict";
+
+var snippetManager = require("../snippets").snippetManager;
+var Autocomplete = require("../autocomplete").Autocomplete;
+var config = require("../config");
+var lang = require("../lib/lang");
+var util = require("../autocomplete/util");
+
+var textCompleter = require("../autocomplete/text_completer");
+var keyWordCompleter = {
+ getCompletions: function(editor, session, pos, prefix, callback) {
+ if (session.$mode.completer) {
+ return session.$mode.completer.getCompletions(editor, session, pos, prefix, callback);
+ }
+ var state = editor.session.getState(pos.row);
+ var completions = session.$mode.getCompletions(state, session, pos, prefix);
+ callback(null, completions);
+ }
+};
+
+var snippetCompleter = {
+ getCompletions: function(editor, session, pos, prefix, callback) {
+ var snippetMap = snippetManager.snippetMap;
+ var completions = [];
+ snippetManager.getActiveScopes(editor).forEach(function(scope) {
+ var snippets = snippetMap[scope] || [];
+ for (var i = snippets.length; i--;) {
+ var s = snippets[i];
+ var caption = s.name || s.tabTrigger;
+ if (!caption)
+ continue;
+ completions.push({
+ caption: caption,
+ snippet: s.content,
+ meta: s.tabTrigger && !s.name ? s.tabTrigger + "\u21E5 " : "snippet",
+ type: "snippet"
+ });
+ }
+ }, this);
+ callback(null, completions);
+ },
+ getDocTooltip: function(item) {
+ if (item.type == "snippet" && !item.docHTML) {
+ item.docHTML = [
+ "", lang.escapeHTML(item.caption), "", "",
+ lang.escapeHTML(item.snippet)
+ ].join("");
+ }
+ }
+};
+
+var completers = [snippetCompleter, textCompleter, keyWordCompleter];
+exports.setCompleters = function(val) {
+ completers.length = 0;
+ if (val) completers.push.apply(completers, val);
+};
+exports.addCompleter = function(completer) {
+ completers.push(completer);
+};
+exports.textCompleter = textCompleter;
+exports.keyWordCompleter = keyWordCompleter;
+exports.snippetCompleter = snippetCompleter;
+
+var expandSnippet = {
+ name: "expandSnippet",
+ exec: function(editor) {
+ return snippetManager.expandWithTab(editor);
+ },
+ bindKey: "Tab"
+};
+
+var onChangeMode = function(e, editor) {
+ loadSnippetsForMode(editor.session.$mode);
+};
+
+var loadSnippetsForMode = function(mode) {
+ var id = mode.$id;
+ if (!snippetManager.files)
+ snippetManager.files = {};
+ loadSnippetFile(id);
+ if (mode.modes)
+ mode.modes.forEach(loadSnippetsForMode);
+};
+
+var loadSnippetFile = function(id) {
+ if (!id || snippetManager.files[id])
+ return;
+ var snippetFilePath = id.replace("mode", "snippets");
+ snippetManager.files[id] = {};
+ config.loadModule(snippetFilePath, function(m) {
+ if (m) {
+ snippetManager.files[id] = m;
+ if (!m.snippets && m.snippetText)
+ m.snippets = snippetManager.parseSnippetFile(m.snippetText);
+ snippetManager.register(m.snippets || [], m.scope);
+ if (m.includeScopes) {
+ snippetManager.snippetMap[m.scope].includeScopes = m.includeScopes;
+ m.includeScopes.forEach(function(x) {
+ loadSnippetFile("ace/mode/" + x);
+ });
+ }
+ }
+ });
+};
+
+var doLiveAutocomplete = function(e) {
+ var editor = e.editor;
+ var hasCompleter = editor.completer && editor.completer.activated;
+ if (e.command.name === "backspace") {
+ if (hasCompleter && !util.getCompletionPrefix(editor))
+ editor.completer.detach();
+ }
+ else if (e.command.name === "insertstring") {
+ var prefix = util.getCompletionPrefix(editor);
+ if (prefix && !hasCompleter) {
+ if (!editor.completer) {
+ editor.completer = new Autocomplete();
+ }
+ editor.completer.autoInsert = false;
+ editor.completer.showPopup(editor);
+ }
+ }
+};
+
+var Editor = require("../editor").Editor;
+require("../config").defineOptions(Editor.prototype, "editor", {
+ enableBasicAutocompletion: {
+ set: function(val) {
+ if (val) {
+ if (!this.completers)
+ this.completers = Array.isArray(val)? val: completers;
+ this.commands.addCommand(Autocomplete.startCommand);
+ } else {
+ this.commands.removeCommand(Autocomplete.startCommand);
+ }
+ },
+ value: false
+ },
+ enableLiveAutocompletion: {
+ set: function(val) {
+ if (val) {
+ if (!this.completers)
+ this.completers = Array.isArray(val)? val: completers;
+ this.commands.on('afterExec', doLiveAutocomplete);
+ } else {
+ this.commands.removeListener('afterExec', doLiveAutocomplete);
+ }
+ },
+ value: false
+ },
+ enableSnippets: {
+ set: function(val) {
+ if (val) {
+ this.commands.addCommand(expandSnippet);
+ this.on("changeMode", onChangeMode);
+ onChangeMode(null, this);
+ } else {
+ this.commands.removeCommand(expandSnippet);
+ this.off("changeMode", onChangeMode);
+ }
+ },
+ value: false
+ }
+});
+});
+
+define("ace/ext/beautify/php_rules",["require","exports","module","ace/token_iterator"], function(require, exports, module) {
+"use strict";
+var TokenIterator = require("ace/token_iterator").TokenIterator;
+exports.newLines = [{
+ type: 'support.php_tag',
+ value: ''
+}, {
+ type: 'paren.lparen',
+ value: '{',
+ indent: true
+}, {
+ type: 'paren.rparen',
+ breakBefore: true,
+ value: '}',
+ indent: false
+}, {
+ type: 'paren.rparen',
+ breakBefore: true,
+ value: '})',
+ indent: false,
+ dontBreak: true
+}, {
+ type: 'comment'
+}, {
+ type: 'text',
+ value: ';'
+}, {
+ type: 'text',
+ value: ':',
+ context: 'php'
+}, {
+ type: 'keyword',
+ value: 'case',
+ indent: true,
+ dontBreak: true
+}, {
+ type: 'keyword',
+ value: 'default',
+ indent: true,
+ dontBreak: true
+}, {
+ type: 'keyword',
+ value: 'break',
+ indent: false,
+ dontBreak: true
+}, {
+ type: 'punctuation.doctype.end',
+ value: '>'
+}, {
+ type: 'meta.tag.punctuation.end',
+ value: '>'
+}, {
+ type: 'meta.tag.punctuation.begin',
+ value: '<',
+ blockTag: true,
+ indent: true,
+ dontBreak: true
+}, {
+ type: 'meta.tag.punctuation.begin',
+ value: '' ){
+ context = 'php';
+ }
+ else if( token.type == 'support.php_tag' && token.value == '?>' ){
+ context = 'html';
+ }
+ else if( token.type == 'meta.tag.name.style' && context != 'css' ){
+ context = 'css';
+ }
+ else if( token.type == 'meta.tag.name.style' && context == 'css' ){
+ context = 'html';
+ }
+ else if( token.type == 'meta.tag.name.script' && context != 'js' ){
+ context = 'js';
+ }
+ else if( token.type == 'meta.tag.name.script' && context == 'js' ){
+ context = 'html';
+ }
+
+ nextToken = iterator.stepForward();
+ if (nextToken && nextToken.type.indexOf('meta.tag.name') == 0) {
+ nextTag = nextToken.value;
+ }
+ if ( lastToken.type == 'support.php_tag' && lastToken.value == '' ) {
+ dontBreak = false;
+ }
+ lastTag = tag;
+
+ lastToken = token;
+
+ token = nextToken;
+
+ if (token===null) {
+ break;
+ }
+ }
+
+ return code;
+};
+
+
+
+});
+
+define("ace/ext/beautify",["require","exports","module","ace/token_iterator","ace/ext/beautify/php_rules"], function(require, exports, module) {
+"use strict";
+var TokenIterator = require("ace/token_iterator").TokenIterator;
+
+var phpTransform = require("./beautify/php_rules").transform;
+
+exports.beautify = function(session) {
+ var iterator = new TokenIterator(session, 0, 0);
+ var token = iterator.getCurrentToken();
+
+ var context = session.$modeId.split("/").pop();
+
+ var code = phpTransform(iterator, context);
+ session.doc.setValue(code);
+};
+
+exports.commands = [{
+ name: "beautify",
+ exec: function(editor) {
+ exports.beautify(editor.session);
+ },
+ bindKey: "Ctrl-Shift-B"
+}]
+
+});
+
+define("kitchen-sink/demo",["require","exports","module","ace/lib/fixoldbrowsers","ace/multi_select","ace/ext/spellcheck","kitchen-sink/inline_editor","kitchen-sink/dev_util","kitchen-sink/file_drop","ace/config","ace/lib/dom","ace/lib/net","ace/lib/lang","ace/lib/useragent","ace/lib/event","ace/theme/textmate","ace/edit_session","ace/undomanager","ace/keyboard/hash_handler","ace/virtual_renderer","ace/editor","ace/ext/whitespace","kitchen-sink/doclist","ace/ext/modelist","ace/ext/themelist","kitchen-sink/layout","kitchen-sink/token_tooltip","kitchen-sink/util","ace/ext/elastic_tabstops_lite","ace/incremental_search","ace/worker/worker_client","ace/split","ace/keyboard/vim","ace/ext/statusbar","ace/ext/emmet","ace/snippets","ace/ext/language_tools","ace/ext/beautify","ace/keyboard/keybinding","ace/commands/command_manager"], function(require, exports, module) {
+"use strict";
+
+require("ace/lib/fixoldbrowsers");
+
+require("ace/multi_select");
+require("ace/ext/spellcheck");
+require("./inline_editor");
+require("./dev_util");
+require("./file_drop");
+
+var config = require("ace/config");
+config.init();
+var env = {};
+
+var dom = require("ace/lib/dom");
+var net = require("ace/lib/net");
+var lang = require("ace/lib/lang");
+var useragent = require("ace/lib/useragent");
+
+var event = require("ace/lib/event");
+var theme = require("ace/theme/textmate");
+var EditSession = require("ace/edit_session").EditSession;
+var UndoManager = require("ace/undomanager").UndoManager;
+
+var HashHandler = require("ace/keyboard/hash_handler").HashHandler;
+
+var Renderer = require("ace/virtual_renderer").VirtualRenderer;
+var Editor = require("ace/editor").Editor;
+
+var whitespace = require("ace/ext/whitespace");
+
+
+
+var doclist = require("./doclist");
+var modelist = require("ace/ext/modelist");
+var themelist = require("ace/ext/themelist");
+var layout = require("./layout");
+var TokenTooltip = require("./token_tooltip").TokenTooltip;
+var util = require("./util");
+var saveOption = util.saveOption;
+var fillDropdown = util.fillDropdown;
+var bindCheckbox = util.bindCheckbox;
+var bindDropdown = util.bindDropdown;
+
+var ElasticTabstopsLite = require("ace/ext/elastic_tabstops_lite").ElasticTabstopsLite;
+
+var IncrementalSearch = require("ace/incremental_search").IncrementalSearch;
+
+
+var workerModule = require("ace/worker/worker_client");
+if (location.href.indexOf("noworker") !== -1) {
+ workerModule.WorkerClient = workerModule.UIWorkerClient;
+}
+var container = document.getElementById("editor-container");
+var Split = require("ace/split").Split;
+var split = new Split(container, theme, 1);
+env.editor = split.getEditor(0);
+split.on("focus", function(editor) {
+ env.editor = editor;
+ updateUIEditorOptions();
+});
+env.split = split;
+window.env = env;
+
+
+var consoleEl = dom.createElement("div");
+container.parentNode.appendChild(consoleEl);
+consoleEl.style.cssText = "position:fixed; bottom:1px; right:0;\
+border:1px solid #baf; z-index:100";
+
+var cmdLine = new layout.singleLineEditor(consoleEl);
+cmdLine.editor = env.editor;
+env.editor.cmdLine = cmdLine;
+
+env.editor.showCommandLine = function(val) {
+ this.cmdLine.focus();
+ if (typeof val == "string")
+ this.cmdLine.setValue(val, 1);
+};
+env.editor.commands.addCommands([{
+ name: "gotoline",
+ bindKey: {win: "Ctrl-L", mac: "Command-L"},
+ exec: function(editor, line) {
+ if (typeof line == "object") {
+ var arg = this.name + " " + editor.getCursorPosition().row;
+ editor.cmdLine.setValue(arg, 1);
+ editor.cmdLine.focus();
+ return;
+ }
+ line = parseInt(line, 10);
+ if (!isNaN(line))
+ editor.gotoLine(line);
+ },
+ readOnly: true
+}, {
+ name: "snippet",
+ bindKey: {win: "Alt-C", mac: "Command-Alt-C"},
+ exec: function(editor, needle) {
+ if (typeof needle == "object") {
+ editor.cmdLine.setValue("snippet ", 1);
+ editor.cmdLine.focus();
+ return;
+ }
+ var s = snippetManager.getSnippetByName(needle, editor);
+ if (s)
+ snippetManager.insertSnippet(editor, s.content);
+ },
+ readOnly: true
+}, {
+ name: "focusCommandLine",
+ bindKey: "shift-esc|ctrl-`",
+ exec: function(editor, needle) { editor.cmdLine.focus(); },
+ readOnly: true
+}, {
+ name: "nextFile",
+ bindKey: "Ctrl-tab",
+ exec: function(editor) { doclist.cycleOpen(editor, 1); },
+ readOnly: true
+}, {
+ name: "previousFile",
+ bindKey: "Ctrl-shift-tab",
+ exec: function(editor) { doclist.cycleOpen(editor, -1); },
+ readOnly: true
+}, {
+ name: "execute",
+ bindKey: "ctrl+enter",
+ exec: function(editor) {
+ try {
+ var r = window.eval(editor.getCopyText() || editor.getValue());
+ } catch(e) {
+ r = e;
+ }
+ editor.cmdLine.setValue(r + "");
+ },
+ readOnly: true
+}, {
+ name: "showKeyboardShortcuts",
+ bindKey: {win: "Ctrl-Alt-h", mac: "Command-Alt-h"},
+ exec: function(editor) {
+ config.loadModule("ace/ext/keybinding_menu", function(module) {
+ module.init(editor);
+ editor.showKeyboardShortcuts();
+ });
+ }
+}, {
+ name: "increaseFontSize",
+ bindKey: "Ctrl-=|Ctrl-+",
+ exec: function(editor) {
+ var size = parseInt(editor.getFontSize(), 10) || 12;
+ editor.setFontSize(size + 1);
+ }
+}, {
+ name: "decreaseFontSize",
+ bindKey: "Ctrl+-|Ctrl-_",
+ exec: function(editor) {
+ var size = parseInt(editor.getFontSize(), 10) || 12;
+ editor.setFontSize(Math.max(size - 1 || 1));
+ }
+}, {
+ name: "resetFontSize",
+ bindKey: "Ctrl+0|Ctrl-Numpad0",
+ exec: function(editor) {
+ editor.setFontSize(12);
+ }
+}]);
+
+
+env.editor.commands.addCommands(whitespace.commands);
+
+cmdLine.commands.bindKeys({
+ "Shift-Return|Ctrl-Return|Alt-Return": function(cmdLine) { cmdLine.insert("\n"); },
+ "Esc|Shift-Esc": function(cmdLine){ cmdLine.editor.focus(); },
+ "Return": function(cmdLine){
+ var command = cmdLine.getValue().split(/\s+/);
+ var editor = cmdLine.editor;
+ editor.commands.exec(command[0], editor, command[1]);
+ editor.focus();
+ }
+});
+
+cmdLine.commands.removeCommands(["find", "gotoline", "findall", "replace", "replaceall"]);
+
+var commands = env.editor.commands;
+commands.addCommand({
+ name: "save",
+ bindKey: {win: "Ctrl-S", mac: "Command-S"},
+ exec: function(arg) {
+ var session = env.editor.session;
+ var name = session.name.match(/[^\/]+$/);
+ localStorage.setItem(
+ "saved_file:" + name,
+ session.getValue()
+ );
+ env.editor.cmdLine.setValue("saved "+ name);
+ }
+});
+
+commands.addCommand({
+ name: "load",
+ bindKey: {win: "Ctrl-O", mac: "Command-O"},
+ exec: function(arg) {
+ var session = env.editor.session;
+ var name = session.name.match(/[^\/]+$/);
+ var value = localStorage.getItem("saved_file:" + name);
+ if (typeof value == "string") {
+ session.setValue(value);
+ env.editor.cmdLine.setValue("loaded "+ name);
+ } else {
+ env.editor.cmdLine.setValue("no previuos value saved for "+ name);
+ }
+ }
+});
+
+var keybindings = {
+ ace: null, // Null = use "default" keymapping
+ vim: require("ace/keyboard/vim").handler,
+ emacs: "ace/keyboard/emacs",
+ custom: new HashHandler({
+ "gotoright": "Tab",
+ "indent": "]",
+ "outdent": "[",
+ "gotolinestart": "^",
+ "gotolineend": "$"
+ })
+};
+var consoleHeight = 20;
+function onResize() {
+ var left = env.split.$container.offsetLeft;
+ var width = document.documentElement.clientWidth - left;
+ container.style.width = width + "px";
+ container.style.height = document.documentElement.clientHeight - consoleHeight + "px";
+ env.split.resize();
+
+ consoleEl.style.width = width + "px";
+ cmdLine.resize();
+}
+
+window.onresize = onResize;
+onResize();
+var docEl = document.getElementById("doc");
+var modeEl = document.getElementById("mode");
+var wrapModeEl = document.getElementById("soft_wrap");
+var themeEl = document.getElementById("theme");
+var foldingEl = document.getElementById("folding");
+var selectStyleEl = document.getElementById("select_style");
+var highlightActiveEl = document.getElementById("highlight_active");
+var showHiddenEl = document.getElementById("show_hidden");
+var showGutterEl = document.getElementById("show_gutter");
+var showPrintMarginEl = document.getElementById("show_print_margin");
+var highlightSelectedWordE = document.getElementById("highlight_selected_word");
+var showHScrollEl = document.getElementById("show_hscroll");
+var showVScrollEl = document.getElementById("show_vscroll");
+var animateScrollEl = document.getElementById("animate_scroll");
+var softTabEl = document.getElementById("soft_tab");
+var behavioursEl = document.getElementById("enable_behaviours");
+
+fillDropdown(docEl, doclist.all);
+
+fillDropdown(modeEl, modelist.modes);
+var modesByName = modelist.modesByName;
+bindDropdown("mode", function(value) {
+ env.editor.session.setMode(modesByName[value].mode || modesByName.text.mode);
+ env.editor.session.modeName = value;
+});
+
+doclist.history = doclist.docs.map(function(doc) {
+ return doc.name;
+});
+doclist.history.index = 0;
+doclist.cycleOpen = function(editor, dir) {
+ var h = this.history;
+ h.index += dir;
+ if (h.index >= h.length)
+ h.index = 0;
+ else if (h.index <= 0)
+ h.index = h.length - 1;
+ var s = h[h.index];
+ docEl.value = s;
+ docEl.onchange();
+};
+doclist.addToHistory = function(name) {
+ var h = this.history;
+ var i = h.indexOf(name);
+ if (i != h.index) {
+ if (i != -1)
+ h.splice(i, 1);
+ h.index = h.push(name);
+ }
+};
+
+bindDropdown("doc", function(name) {
+ doclist.loadDoc(name, function(session) {
+ if (!session)
+ return;
+ doclist.addToHistory(session.name);
+ session = env.split.setSession(session);
+ whitespace.detectIndentation(session);
+ updateUIEditorOptions();
+ env.editor.focus();
+ });
+});
+
+
+function updateUIEditorOptions() {
+ var editor = env.editor;
+ var session = editor.session;
+
+ session.setFoldStyle(foldingEl.value);
+
+ saveOption(docEl, session.name);
+ saveOption(modeEl, session.modeName || "text");
+ saveOption(wrapModeEl, session.getUseWrapMode() ? session.getWrapLimitRange().min || "free" : "off");
+
+ saveOption(selectStyleEl, editor.getSelectionStyle() == "line");
+ saveOption(themeEl, editor.getTheme());
+ saveOption(highlightActiveEl, editor.getHighlightActiveLine());
+ saveOption(showHiddenEl, editor.getShowInvisibles());
+ saveOption(showGutterEl, editor.renderer.getShowGutter());
+ saveOption(showPrintMarginEl, editor.renderer.getShowPrintMargin());
+ saveOption(highlightSelectedWordE, editor.getHighlightSelectedWord());
+ saveOption(showHScrollEl, editor.renderer.getHScrollBarAlwaysVisible());
+ saveOption(animateScrollEl, editor.getAnimatedScroll());
+ saveOption(softTabEl, session.getUseSoftTabs());
+ saveOption(behavioursEl, editor.getBehavioursEnabled());
+}
+
+themelist.themes.forEach(function(x){ x.value = x.theme });
+fillDropdown(themeEl, {
+ Bright: themelist.themes.filter(function(x){return !x.isDark}),
+ Dark: themelist.themes.filter(function(x){return x.isDark})
+});
+
+event.addListener(themeEl, "mouseover", function(e){
+ themeEl.desiredValue = e.target.value;
+ if (!themeEl.$timer)
+ themeEl.$timer = setTimeout(themeEl.updateTheme);
+});
+
+event.addListener(themeEl, "mouseout", function(e){
+ themeEl.desiredValue = null;
+ if (!themeEl.$timer)
+ themeEl.$timer = setTimeout(themeEl.updateTheme, 20);
+});
+
+themeEl.updateTheme = function(){
+ env.split.setTheme((themeEl.desiredValue || themeEl.selectedValue));
+ themeEl.$timer = null;
+};
+
+bindDropdown("theme", function(value) {
+ if (!value)
+ return;
+ env.editor.setTheme(value);
+ themeEl.selectedValue = value;
+});
+
+bindDropdown("keybinding", function(value) {
+ env.editor.setKeyboardHandler(keybindings[value]);
+});
+
+bindDropdown("fontsize", function(value) {
+ env.split.setFontSize(value);
+});
+
+bindDropdown("folding", function(value) {
+ env.editor.session.setFoldStyle(value);
+ env.editor.setShowFoldWidgets(value !== "manual");
+});
+
+bindDropdown("soft_wrap", function(value) {
+ env.editor.setOption("wrap", value);
+});
+
+bindCheckbox("select_style", function(checked) {
+ env.editor.setOption("selectionStyle", checked ? "line" : "text");
+});
+
+bindCheckbox("highlight_active", function(checked) {
+ env.editor.setHighlightActiveLine(checked);
+});
+
+bindCheckbox("show_hidden", function(checked) {
+ env.editor.setShowInvisibles(checked);
+});
+
+bindCheckbox("display_indent_guides", function(checked) {
+ env.editor.setDisplayIndentGuides(checked);
+});
+
+bindCheckbox("show_gutter", function(checked) {
+ env.editor.renderer.setShowGutter(checked);
+});
+
+bindCheckbox("show_print_margin", function(checked) {
+ env.editor.renderer.setShowPrintMargin(checked);
+});
+
+bindCheckbox("highlight_selected_word", function(checked) {
+ env.editor.setHighlightSelectedWord(checked);
+});
+
+bindCheckbox("show_hscroll", function(checked) {
+ env.editor.setOption("hScrollBarAlwaysVisible", checked);
+});
+
+bindCheckbox("show_vscroll", function(checked) {
+ env.editor.setOption("vScrollBarAlwaysVisible", checked);
+});
+
+bindCheckbox("animate_scroll", function(checked) {
+ env.editor.setAnimatedScroll(checked);
+});
+
+bindCheckbox("soft_tab", function(checked) {
+ env.editor.session.setUseSoftTabs(checked);
+});
+
+bindCheckbox("enable_behaviours", function(checked) {
+ env.editor.setBehavioursEnabled(checked);
+});
+
+bindCheckbox("fade_fold_widgets", function(checked) {
+ env.editor.setFadeFoldWidgets(checked);
+});
+bindCheckbox("read_only", function(checked) {
+ env.editor.setReadOnly(checked);
+});
+bindCheckbox("scrollPastEnd", function(checked) {
+ env.editor.setOption("scrollPastEnd", checked);
+});
+
+bindDropdown("split", function(value) {
+ var sp = env.split;
+ if (value == "none") {
+ sp.setSplits(1);
+ } else {
+ var newEditor = (sp.getSplits() == 1);
+ sp.setOrientation(value == "below" ? sp.BELOW : sp.BESIDE);
+ sp.setSplits(2);
+
+ if (newEditor) {
+ var session = sp.getEditor(0).session;
+ var newSession = sp.setSession(session, 1);
+ newSession.name = session.name;
+ }
+ }
+});
+
+
+bindCheckbox("elastic_tabstops", function(checked) {
+ env.editor.setOption("useElasticTabstops", checked);
+});
+
+var iSearchCheckbox = bindCheckbox("isearch", function(checked) {
+ env.editor.setOption("useIncrementalSearch", checked);
+});
+
+env.editor.addEventListener('incrementalSearchSettingChanged', function(event) {
+ iSearchCheckbox.checked = event.isEnabled;
+});
+
+
+function synchroniseScrolling() {
+ var s1 = env.split.$editors[0].session;
+ var s2 = env.split.$editors[1].session;
+ s1.on('changeScrollTop', function(pos) {s2.setScrollTop(pos)});
+ s2.on('changeScrollTop', function(pos) {s1.setScrollTop(pos)});
+ s1.on('changeScrollLeft', function(pos) {s2.setScrollLeft(pos)});
+ s2.on('changeScrollLeft', function(pos) {s1.setScrollLeft(pos)});
+}
+
+bindCheckbox("highlight_token", function(checked) {
+ var editor = env.editor;
+ if (editor.tokenTooltip && !checked) {
+ editor.tokenTooltip.destroy();
+ delete editor.tokenTooltip;
+ } else if (checked) {
+ editor.tokenTooltip = new TokenTooltip(editor);
+ }
+});
+
+var StatusBar = require("ace/ext/statusbar").StatusBar;
+new StatusBar(env.editor, cmdLine.container);
+
+
+var Emmet = require("ace/ext/emmet");
+net.loadScript("https://cloud9ide.github.io/emmet-core/emmet.js", function() {
+ Emmet.setCore(window.emmet);
+ env.editor.setOption("enableEmmet", true);
+});
+
+var snippetManager = require("ace/snippets").snippetManager;
+
+env.editSnippets = function() {
+ var sp = env.split;
+ if (sp.getSplits() == 2) {
+ sp.setSplits(1);
+ return;
+ }
+ sp.setSplits(1);
+ sp.setSplits(2);
+ sp.setOrientation(sp.BESIDE);
+ var editor = sp.$editors[1];
+ var id = sp.$editors[0].session.$mode.$id || "";
+ var m = snippetManager.files[id];
+ if (!doclist["snippets/" + id]) {
+ var text = m.snippetText;
+ var s = doclist.initDoc(text, "", {});
+ s.setMode("ace/mode/snippets");
+ doclist["snippets/" + id] = s;
+ }
+ editor.on("blur", function() {
+ m.snippetText = editor.getValue();
+ snippetManager.unregister(m.snippets);
+ m.snippets = snippetManager.parseSnippetFile(m.snippetText, m.scope);
+ snippetManager.register(m.snippets);
+ });
+ sp.$editors[0].once("changeMode", function() {
+ sp.setSplits(1);
+ });
+ editor.setSession(doclist["snippets/" + id], 1);
+ editor.focus();
+};
+
+require("ace/ext/language_tools");
+env.editor.setOptions({
+ enableBasicAutocompletion: true,
+ enableLiveAutocompletion: false,
+ enableSnippets: true
+});
+
+var beautify = require("ace/ext/beautify");
+env.editor.commands.addCommands(beautify.commands);
+
+var KeyBinding = require("ace/keyboard/keybinding").KeyBinding;
+var CommandManager = require("ace/commands/command_manager").CommandManager;
+var commandManager = new CommandManager();
+var kb = new KeyBinding({
+ commands: commandManager,
+ fake: true
+});
+event.addCommandKeyListener(document.documentElement, kb.onCommandKey.bind(kb));
+event.addListener(document.documentElement, "keyup", function(e) {
+ if (e.keyCode === 18) // do not trigger browser menu on windows
+ e.preventDefault();
+});
+commandManager.addCommands([{
+ name: "window-left",
+ bindKey: {win: "cmd-alt-left", mac: "ctrl-cmd-left"},
+ exec: function() {
+ moveFocus("left");
+ }
+}, {
+ name: "window-right",
+ bindKey: {win: "cmd-alt-right", mac: "ctrl-cmd-right"},
+ exec: function() {
+ moveFocus("right");
+ }
+}, {
+ name: "window-up",
+ bindKey: {win: "cmd-alt-up", mac: "ctrl-cmd-up"},
+ exec: function() {
+ moveFocus("up");
+ }
+}, {
+ name: "window-down",
+ bindKey: {win: "cmd-alt-down", mac: "ctrl-cmd-down"},
+ exec: function() {
+ moveFocus("down");
+ }
+}]);
+
+function moveFocus() {
+ var el = document.activeElement;
+ if (el == env.editor.textInput.getElement())
+ env.editor.cmdLine.focus();
+ else
+ env.editor.focus();
+}
+
+});
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/.gitignore b/_embed/public/ace/demo/kitchen-sink/docs/.gitignore
new file mode 100644
index 00000000..56ec8fd9
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/.gitignore
@@ -0,0 +1,11 @@
+# A sample .gitignore file.
+
+.buildlog
+.DS_Store
+.svn
+
+# Negated patterns:
+!foo.bar
+
+# Also ignore user settings...
+/.settings
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/Dockerfile b/_embed/public/ace/demo/kitchen-sink/docs/Dockerfile
new file mode 100644
index 00000000..70270cbf
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/Dockerfile
@@ -0,0 +1,53 @@
+#
+# example Dockerfile for http://docs.docker.io/en/latest/examples/postgresql_service/
+#
+
+FROM ubuntu
+MAINTAINER SvenDowideit@docker.com
+
+# Add the PostgreSQL PGP key to verify their Debian packages.
+# It should be the same key as https://www.postgresql.org/media/keys/ACCC4CF8.asc
+RUN apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys B97B0AFCAA1A47F044F244A07FCC7D46ACCC4CF8
+
+# Add PostgreSQL's repository. It contains the most recent stable release
+# of PostgreSQL, ``9.3``.
+RUN echo "deb http://apt.postgresql.org/pub/repos/apt/ precise-pgdg main" > /etc/apt/sources.list.d/pgdg.list
+
+# Update the Ubuntu and PostgreSQL repository indexes
+RUN apt-get update
+
+# Install ``python-software-properties``, ``software-properties-common`` and PostgreSQL 9.3
+# There are some warnings (in red) that show up during the build. You can hide
+# them by prefixing each apt-get statement with DEBIAN_FRONTEND=noninteractive
+RUN apt-get -y -q install python-software-properties software-properties-common
+RUN apt-get -y -q install postgresql-9.3 postgresql-client-9.3 postgresql-contrib-9.3
+
+# Note: The official Debian and Ubuntu images automatically ``apt-get clean``
+# after each ``apt-get``
+
+# Run the rest of the commands as the ``postgres`` user created by the ``postgres-9.3`` package when it was ``apt-get installed``
+USER postgres
+
+# Create a PostgreSQL role named ``docker`` with ``docker`` as the password and
+# then create a database `docker` owned by the ``docker`` role.
+# Note: here we use ``&&\`` to run commands one after the other - the ``\``
+# allows the RUN command to span multiple lines.
+RUN /etc/init.d/postgresql start &&\
+ psql --command "CREATE USER docker WITH SUPERUSER PASSWORD 'docker';" &&\
+ createdb -O docker docker
+
+# Adjust PostgreSQL configuration so that remote connections to the
+# database are possible.
+RUN echo "host all all 0.0.0.0/0 md5" >> /etc/postgresql/9.3/main/pg_hba.conf
+
+# And add ``listen_addresses`` to ``/etc/postgresql/9.3/main/postgresql.conf``
+RUN echo "listen_addresses='*'" >> /etc/postgresql/9.3/main/postgresql.conf
+
+# Expose the PostgreSQL port
+EXPOSE 5432
+
+# Add VOLUMEs to allow backup of config, logs and databases
+VOLUME ["/etc/postgresql", "/var/log/postgresql", "/var/lib/postgresql"]
+
+# Set the default command to run when starting the container
+CMD ["/usr/lib/postgresql/9.3/bin/postgres", "-D", "/var/lib/postgresql/9.3/main", "-c", "config_file=/etc/postgresql/9.3/main/postgresql.conf"]
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/Haxe.hx b/_embed/public/ace/demo/kitchen-sink/docs/Haxe.hx
new file mode 100644
index 00000000..ab205bba
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/Haxe.hx
@@ -0,0 +1,17 @@
+class Haxe
+{
+ public static function main()
+ {
+ // Say Hello!
+ var greeting:String = "Hello World";
+ trace(greeting);
+
+ var targets:Array = ["Flash","Javascript","PHP","Neko","C++","iOS","Android","webOS"];
+ trace("Haxe is a great language that can target:");
+ for (target in targets)
+ {
+ trace (" - " + target);
+ }
+ trace("And many more!");
+ }
+}
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/Jack.jack b/_embed/public/ace/demo/kitchen-sink/docs/Jack.jack
new file mode 100644
index 00000000..15acf743
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/Jack.jack
@@ -0,0 +1,247 @@
+vars it, p
+
+p = {label, value|
+ print("\n" + label)
+ print(inspect(value))
+}
+-- Create an array from 0 to 15
+p("range", i-collect(range(5)))
+
+-- Create an array from 0 to 15 and break up in chunks of 4
+p("chunked range", i-collect(i-chunk(4, range(16))))
+
+-- Check if all or none items in stream pass test.
+p("all < 60 in range(60)", i-all?({i|i<60}, range(60)))
+p("any < 60 in range(60)", i-any?({i|i>60}, range(60)))
+p("all < 60 in range(70)", i-all?({i|i<60}, range(70)))
+p("any < 60 in range(70)", i-any?({i|i>60}, range(70)))
+
+-- Zip three different collections together
+p("zipped", i-collect(i-zip(
+ range(10),
+ [1,2,3,4,5],
+ i-map({i|i*i}, range(10))
+)))
+
+vars names, person, i, doubles, lengths, cubeRange
+names = ["Thorin", "Dwalin", "Balin", "Bifur", "Bofur", "Bombur", "Oin",
+ "Gloin", "Ori", "Nori", "Dori", "Fili", "Kili", "Bilbo", "Gandalf"]
+
+for name in names {
+ if name != "Bilbo" && name != "Gandalf" {
+ print(name)
+ }
+}
+
+person = {name: "Tim", age: 30}
+for key, value in person {
+ print(key + " = " + value)
+}
+
+i = 0
+while i < 10 {
+ i = i + 1
+ print(i)
+}
+
+print("range")
+for i in range(10) {
+ print(i + 1)
+}
+for i in range(10) {
+ print(10 - i)
+}
+
+-- Dynamic object that gives the first 10 doubles
+doubles = {
+ @len: {| 10 }
+ @get: {key|
+ if key is Integer { key * key }
+ }
+}
+print("#doubles", #doubles)
+
+print("Doubles")
+for k, v in doubles {
+ print([k, v])
+}
+
+-- Dynamic object that has names list as keys and string lenth as values
+lengths = {
+ @keys: {| names }
+ @get: {key|
+ if key is String { #key }
+ }
+}
+
+print ("Lengths")
+for k, v in lengths {
+ print([k, v])
+}
+
+
+cubeRange = {n|
+ vars i, v
+ i = 0
+ {
+ @call: {|
+ v = i
+ i = i + 1
+ if v < n { v * v * v }
+ }
+ }
+}
+
+print("Cubes")
+for k, v in cubeRange(5) {
+ print([k, v])
+}
+print("String")
+for k, v in "Hello World" {
+ print([k, v])
+}
+
+
+print([i for i in range(10)])
+print([i for i in range(20) if i % 3])
+
+
+
+-- Example showing how to do parallel work using split..and
+base = {bootstrap, target-dir|
+ split {
+ copy("res", target-dir)
+ } and {
+ if newer("src/*.less", target-dir + "/style.css") {
+ lessc("src/" + bootstrap + ".less", target-dir + "/style.css")
+ }
+ } and {
+ build("src/" + bootstrap + ".js", target-dir + "/app.js")
+ }
+}
+
+
+vars Dragon, pet
+
+Dragon = {name|
+ vars asleep, stuff-in-belly, stuff-in-intestine,
+ feed, walk, put-to-bed, toss, rock,
+ hungry?, poopy?, passage-of-time
+
+ asleep = false
+ stuff-in-belly = 10 -- He's full.
+ stuff-in-intestine = 0 -- He doesn't need to go.
+
+ print(name + ' is born.')
+
+ feed = {|
+ print('You feed ' + name + '.')
+ stuff-in-belly = 10
+ passage-of-time()
+ }
+
+ walk = {|
+ print('You walk ' + name + ".")
+ stuff-in-intestine = 0
+ passage-of-time
+ }
+
+ put-to-bed = {|
+ print('You put ' + name + ' to bed.')
+ asleep = true
+ for i in range(3) {
+ if asleep {
+ passage-of-time()
+ }
+ if asleep {
+ print(name + ' snores, filling the room with smoke.')
+ }
+ }
+ if asleep {
+ asleep = false
+ print(name + ' wakes up slowly.')
+ }
+ }
+
+ toss = {|
+ print('You toss ' + name + ' up into the air.')
+ print('He giggles, which singes your eyebrows.')
+ passage-of-time()
+ }
+
+ rock = {|
+ print('You rock ' + name + ' gently.')
+ asleep = true
+ print('He briefly dozes off...')
+ passage-of-time()
+ if asleep {
+ asleep = false
+ print('...but wakes when you stop.')
+ }
+ }
+
+ hungry? = {|
+ stuff-in-belly <= 2
+ }
+
+ poopy? = {|
+ stuff-in-intestine >= 8
+ }
+
+ passage-of-time = {|
+ if stuff-in-belly > 0 {
+ -- Move food from belly to intestine
+ stuff-in-belly = stuff-in-belly - 1
+ stuff-in-intestine = stuff-in-intestine + 1
+ } else { -- Our dragon is starving!
+ if asleep {
+ asleep = false
+ print('He wakes up suddenly!')
+ }
+ print(name + ' is starving! In desperation, he ate YOU!')
+ abort "died"
+ }
+
+ if stuff-in-intestine >= 10 {
+ stuff-in-intestine = 0
+ print('Whoops! ' + name + ' had an accident...')
+ }
+
+ if hungry?() {
+ if asleep {
+ asleep = false
+ print('He wakes up suddenly!')
+ }
+ print(name + "'s stomach grumbles...")
+ }
+
+ if poopy?() {
+ if asleep {
+ asleep = false
+ print('He wakes up suddenly!')
+ }
+ print(name + ' does the potty dance...')
+ }
+ }
+
+ -- Export the public interface to this closure object.
+ {
+ feed: feed
+ walk: walk
+ put-to-bed: put-to-bed
+ toss: toss
+ rock: rock
+ }
+
+}
+
+pet = Dragon('Norbert')
+pet.feed()
+pet.toss()
+pet.walk()
+pet.put-to-bed()
+pet.rock()
+pet.put-to-bed()
+pet.put-to-bed()
+pet.put-to-bed()
+pet.put-to-bed()
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/Makefile b/_embed/public/ace/demo/kitchen-sink/docs/Makefile
new file mode 100644
index 00000000..9b0b31ac
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/Makefile
@@ -0,0 +1,122 @@
+.PHONY: apf ext worker mode theme package test
+
+default: apf worker
+
+update: worker
+
+# packages apf
+
+# This is the first line of a comment \
+and this is still part of the comment \
+as is this, since I keep ending each line \
+with a backslash character
+
+apf:
+ cd node_modules/packager; node package.js projects/apf_cloud9.apr
+ cd node_modules/packager; cat build/apf_release.js | sed 's/\(\/\*FILEHEAD(\).*//g' > ../../plugins-client/lib.apf/www/apf-packaged/apf_release.js
+
+# package debug version of apf
+apfdebug:
+ cd node_modules/packager/projects; cat apf_cloud9.apr | sed 's///g' > apf_cloud9_debug2.apr
+ cd node_modules/packager/projects; cat apf_cloud9_debug2.apr | sed 's/apf_release/apf_debug/g' > apf_cloud9_debug.apr; rm apf_cloud9_debug2.apr
+ cd node_modules/packager; node package.js projects/apf_cloud9_debug.apr
+ cd node_modules/packager; cat build/apf_debug.js | sed 's/\(\/\*FILEHEAD(\).*\/apf\/\(.*\)/\1\2/g' > ../../plugins-client/lib.apf/www/apf-packaged/apf_debug.js
+
+# package_apf--temporary fix for non-workering infra
+pack_apf:
+ mkdir -p build/src
+ mv plugins-client/lib.apf/www/apf-packaged/apf_release.js build/src/apf_release.js
+ node build/r.js -o name=./build/src/apf_release.js out=./plugins-client/lib.apf/www/apf-packaged/apf_release.js baseUrl=.
+
+# makes ace; at the moment, requires dryice@0.4.2
+ace:
+ cd node_modules/ace; make clean pre_build; ./Makefile.dryice.js minimal
+
+
+# packages core
+core: ace
+ mkdir -p build/src
+ node build/r.js -o build/core.build.js
+
+# generates packed template
+helper:
+ node build/packed_helper.js
+
+helper_clean:
+ mkdir -p build/src
+ node build/packed_helper.js 1
+
+# packages ext
+ext:
+ node build/r.js -o build/app.build.js
+
+# calls dryice on worker & packages it
+worker: plugins-client/lib.ace/www/worker/worker-language.js
+
+plugins-client/lib.ace/www/worker/worker-language.js plugins-client/lib.ace/www/worker/worker-javascript.js : \
+ $(wildcard node_modules/ace/*) $(wildcard node_modules/ace/*/*) $(wildcard node_modules/ace/*/*/mode/*) \
+ $(wildcard plugins-client/ext.language/*) \
+ $(wildcard plugins-client/ext.language/*/*) \
+ $(wildcard plugins-client/ext.linereport/*) \
+ $(wildcard plugins-client/ext.codecomplete/*) \
+ $(wildcard plugins-client/ext.codecomplete/*/*) \
+ $(wildcard plugins-client/ext.jslanguage/*) \
+ $(wildcard plugins-client/ext.jslanguage/*/*) \
+ $(wildcard plugins-client/ext.csslanguage/*) \
+ $(wildcard plugins-client/ext.csslanguage/*/*) \
+ $(wildcard plugins-client/ext.htmllanguage/*) \
+ $(wildcard plugins-client/ext.htmllanguage/*/*) \
+ $(wildcard plugins-client/ext.jsinfer/*) \
+ $(wildcard plugins-client/ext.jsinfer/*/*) \
+ $(wildcard node_modules/treehugger/lib/*) \
+ $(wildcard node_modules/treehugger/lib/*/*) \
+ $(wildcard node_modules/ace/lib/*) \
+ $(wildcard node_modules/ace/*/*) \
+ Makefile.dryice.js
+ mkdir -p plugins-client/lib.ace/www/worker
+ rm -rf /tmp/c9_worker_build
+ mkdir -p /tmp/c9_worker_build/ext
+ ln -s `pwd`/plugins-client/ext.language /tmp/c9_worker_build/ext/language
+ ln -s `pwd`/plugins-client/ext.codecomplete /tmp/c9_worker_build/ext/codecomplete
+ ln -s `pwd`/plugins-client/ext.jslanguage /tmp/c9_worker_build/ext/jslanguage
+ ln -s `pwd`/plugins-client/ext.csslanguage /tmp/c9_worker_build/ext/csslanguage
+ ln -s `pwd`/plugins-client/ext.htmllanguage /tmp/c9_worker_build/ext/htmllanguage
+ ln -s `pwd`/plugins-client/ext.linereport /tmp/c9_worker_build/ext/linereport
+ ln -s `pwd`/plugins-client/ext.linereport_php /tmp/c9_worker_build/ext/linereport_php
+ node Makefile.dryice.js worker
+ cp node_modules/ace/build/src/worker* plugins-client/lib.ace/www/worker
+
+define
+
+ifeq
+
+override
+
+# copies built ace modes
+mode:
+ mkdir -p plugins-client/lib.ace/www/mode
+ cp `find node_modules/ace/build/src | grep -E "mode-[a-zA-Z_0-9]+.js"` plugins-client/lib.ace/www/mode
+
+# copies built ace themes
+theme:
+ mkdir -p plugins-client/lib.ace/www/theme
+ cp `find node_modules/ace/build/src | grep -E "theme-[a-zA-Z_0-9]+.js"` plugins-client/lib.ace/www/theme
+
+gzip_safe:
+ for i in `ls ./plugins-client/lib.packed/www/*.js`; do \
+ gzip -9 -v -c -q -f $$i > $$i.gz ; \
+ done
+
+gzip:
+ for i in `ls ./plugins-client/lib.packed/www/*.js`; do \
+ gzip -9 -v -q -f $$i ; \
+ done
+
+c9core: apf ace core worker mode theme
+
+package_clean: helper_clean c9core ext
+
+package: helper c9core ext
+
+test check:
+ test/run-tests.sh
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/Nix.nix b/_embed/public/ace/demo/kitchen-sink/docs/Nix.nix
new file mode 100644
index 00000000..9476db3b
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/Nix.nix
@@ -0,0 +1,57 @@
+{
+ # Name of our deployment
+ network.description = "HelloWorld";
+ # Enable rolling back to previous versions of our infrastructure
+ network.enableRollback = true;
+
+ # It consists of a single server named 'helloserver'
+ helloserver =
+ # Every server gets passed a few arguments, including a reference
+ # to nixpkgs (pkgs)
+ { config, pkgs, ... }:
+ let
+ # We import our custom packages from ./default passing pkgs as argument
+ packages = import ./default.nix { pkgs = pkgs; };
+ # This is the nodejs version specified in default.nix
+ nodejs = packages.nodejs;
+ # And this is the application we'd like to deploy
+ app = packages.app;
+ in
+ {
+ # We'll be running our application on port 8080, because a regular
+ # user cannot bind to port 80
+ # Then, using some iptables magic we'll forward traffic designated to port 80 to 8080
+ networking.firewall.enable = true;
+ # We will open up port 22 (SSH) as well otherwise we're locking ourselves out
+ networking.firewall.allowedTCPPorts = [ 80 8080 22 ];
+ networking.firewall.allowPing = true;
+
+ # Port forwarding using iptables
+ networking.firewall.extraCommands = ''
+ iptables -t nat -A PREROUTING -p tcp --dport 80 -j REDIRECT --to-port 8080
+ '';
+
+ # To run our node.js program we're going to use a systemd service
+ # We can configure the service to automatically start on boot and to restart
+ # the process in case it crashes
+ systemd.services.helloserver = {
+ description = "Hello world application";
+ # Start the service after the network is available
+ after = [ "network.target" ];
+ # We're going to run it on port 8080 in production
+ environment = { PORT = "8080"; };
+ serviceConfig = {
+ # The actual command to run
+ ExecStart = "${nodejs}/bin/node ${app}/server.js";
+ # For security reasons we'll run this process as a special 'nodejs' user
+ User = "nodejs";
+ Restart = "always";
+ };
+ };
+
+ # And lastly we ensure the user we run our application as is created
+ users.extraUsers = {
+ nodejs = { };
+ };
+ };
+}
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/abap.abap b/_embed/public/ace/demo/kitchen-sink/docs/abap.abap
new file mode 100644
index 00000000..dad93f3b
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/abap.abap
@@ -0,0 +1,41 @@
+***************************************
+** Program: EXAMPLE **
+** Author: Joe Byte, 07-Jul-2007 **
+***************************************
+
+REPORT BOOKINGS.
+
+* Read flight bookings from the database
+SELECT * FROM FLIGHTINFO
+ WHERE CLASS = 'Y' "Y = economy
+ OR CLASS = 'C'. "C = business
+(...)
+
+REPORT TEST.
+WRITE 'Hello World'.
+
+USERPROMPT = 'Please double-click on a line in the output list ' &
+ 'to see the complete details of the transaction.'.
+
+
+DATA LAST_EOM TYPE D. "last end-of-month date
+
+* Start from today's date
+ LAST_EOM = SY-DATUM.
+* Set characters 6 and 7 (0-relative) of the YYYYMMDD string to "01",
+* giving the first day of the current month
+ LAST_EOM+6(2) = '01'.
+* Subtract one day
+ LAST_EOM = LAST_EOM - 1.
+
+ WRITE: 'Last day of previous month was', LAST_EOM.
+
+DATA : BEGIN OF I_VBRK OCCURS 0,
+ VBELN LIKE VBRK-VBELN,
+ ZUONR LIKE VBRK-ZUONR,
+ END OF I_VBRK.
+
+SORT i_vbrk BY vbeln ASCENDING.
+SORT i_vbrk BY vbeln DESCENDING.
+
+RETURN.
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/abc.abc b/_embed/public/ace/demo/kitchen-sink/docs/abc.abc
new file mode 100644
index 00000000..e6683c3d
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/abc.abc
@@ -0,0 +1,171 @@
+%abc-2.1
+H:This file contains some example English tunes
+% note that the comments (like this one) are to highlight usages
+% and would not normally be included in such detail
+O:England % the origin of all tunes is England
+
+X:1 % tune no 1
+T:Dusty Miller, The % title
+T:Binny's Jig % an alternative title
+C:Trad. % traditional
+R:DH % double hornpipe
+M:3/4 % meter
+K:G % key
+B>cd BAG|FA Ac BA|B>cd BAG|DG GB AG:|
+Bdd gfg|aA Ac BA|Bdd gfa|gG GB AG:|
+BG G/2G/2G BG|FA Ac BA|BG G/2G/2G BG|DG GB AG:|
+W:Hey, the dusty miller, and his dusty coat;
+W:He will win a shilling, or he spend a groat.
+W:Dusty was the coat, dusty was the colour;
+W:Dusty was the kiss, that I got frae the miller.
+
+X:2
+T:Old Sir Simon the King
+C:Trad.
+S:Offord MSS % from Offord manuscript
+N:see also Playford % reference note
+M:9/8
+R:SJ % slip jig
+N:originally in C % transcription note
+K:G
+D|GFG GAG G2D|GFG GAG F2D|EFE EFE EFG|A2G F2E D2:|
+D|GAG GAB d2D|GAG GAB c2D|[1 EFE EFE EFG|[A2G] F2E D2:|\ % no line-break in score
+M:12/8 % change of meter
+[2 E2E EFE E2E EFG|\ % no line-break in score
+M:9/8 % change of meter
+A2G F2E D2|]
+
+X:3
+T:William and Nancy
+T:New Mown Hay
+T:Legacy, The
+C:Trad.
+O:England; Gloucs; Bledington % place of origin
+B:Sussex Tune Book % can be found in these books
+B:Mally's Cotswold Morris vol.1 2
+D:Morris On % can be heard on this record
+P:(AB)2(AC)2A % play the parts in this order
+M:6/8
+K:G
+[P:A] D|"G"G2G GBd|"C"e2e "G"dBG|"D7"A2d "G"BAG|"C"E2"D7"F "G"G2:|
+[P:B] d|"G"e2d B2d|"C"gfe "G"d2d| "G"e2d B2d|"C"gfe "D7"d2c|
+ "G"B2B Bcd|"C"e2e "G"dBG|"D7"A2d "G"BAG|"C"E2"D7"F "G"G2:|
+% changes of meter, using inline fields
+[T:Slows][M:4/4][L:1/4][P:C]"G"d2|"C"e2 "G"d2|B2 d2|"Em"gf "A7"e2|"D7"d2 "G"d2|\
+ "C"e2 "G"d2|[M:3/8][L:1/8] "G"B2 d |[M:6/8] "C"gfe "D7"d2c|
+ "G"B2B Bcd|"C"e2e "G"dBG|"D7"A2d "G"BAG|"C"E2"D7"F "G"G2:|
+
+X:4
+T:South Downs Jig
+R:jig
+S:Robert Harbron
+M:6/8
+L:1/8
+K:G
+|: d | dcA G3 | EFG AFE | DEF GAB | cde d2d |
+dcA G3 | EFG AFE | DEF GAB | cAF G2 :|
+B | Bcd e2c | d2B c2A | Bcd e2c | [M:9/8]d2B c2B A3 |
+[M:6/8]DGF E3 | cBA FED | DEF GAB |1 cAF G2 :|2 cAF G3 |]
+
+X:5
+T:Atholl Brose
+% in this example, which reproduces Highland Bagpipe gracing,
+% the large number of grace notes mean that it is more convenient to be specific about
+% score line-breaks (using the $ symbol), rather than using code line breaks to indicate them
+I:linebreak $
+K:D
+{gcd}c<{e}A {gAGAG}A2 {gef}e>A {gAGAG}Ad|
+{gcd}c<{e}A {gAGAG}A>e {ag}a>f {gef}e>d|
+{gcd}c<{e}A {gAGAG}A2 {gef}e>A {gAGAG}Ad|
+{g}c/d/e {g}G>{d}B {gf}gG {dc}d>B:|$
+{g}ce {ag}a>e {gf}g>e|
+{g}ce {ag}a2 {GdG}a>d|
+{g}ce {ag}a>e {gf}g>f|
+{gef}e>d {gf}g>d {gBd}B<{e}G {dc}d>B|
+{g}ce {ag}a>e {gf}g>e|
+{g}ce {ag}a2 {GdG}ad|
+{g}c<{GdG}e {gf}ga {f}g>e {g}f>d|
+{g}e/f/g {Gdc}d>c {gBd}B<{e}G {dc}d2|]
+
+X:6
+T:Untitled Reel
+C:Trad.
+K:D
+eg|a2ab ageg|agbg agef|g2g2 fgag|f2d2 d2:|\
+ed|cecA B2ed|cAcA E2ed|cecA B2ed|c2A2 A2:|
+K:G
+AB|cdec BcdB|ABAF GFE2|cdec BcdB|c2A2 A2:|
+
+X:7
+T:Kitchen Girl
+C:Trad.
+K:D
+[c4a4] [B4g4]|efed c2cd|e2f2 gaba|g2e2 e2fg|
+a4 g4|efed cdef|g2d2 efed|c2A2 A4:|
+K:G
+ABcA BAGB|ABAG EDEG|A2AB c2d2|e3f edcB|ABcA BAGB|
+ABAG EGAB|cBAc BAG2|A4 A4:|
+
+%abc-2.1
+%%pagewidth 21cm
+%%pageheight 29.7cm
+%%topspace 0.5cm
+%%topmargin 1cm
+%%botmargin 0cm
+%%leftmargin 1cm
+%%rightmargin 1cm
+%%titlespace 0cm
+%%titlefont Times-Bold 32
+%%subtitlefont Times-Bold 24
+%%composerfont Times 16
+%%vocalfont Times-Roman 14
+%%staffsep 60pt
+%%sysstaffsep 20pt
+%%musicspace 1cm
+%%vocalspace 5pt
+%%measurenb 0
+%%barsperstaff 5
+%%scale 0.7
+X: 1
+T: Canzonetta a tre voci
+C: Claudio Monteverdi (1567-1643)
+M: C
+L: 1/4
+Q: "Andante mosso" 1/4 = 110
+%%score [1 2 3]
+V: 1 clef=treble name="Soprano"sname="A"
+V: 2 clef=treble name="Alto" sname="T"
+V: 3 clef=bass middle=d name="Tenor" sname="B"
+%%MIDI program 1 75 % recorder
+%%MIDI program 2 75
+%%MIDI program 3 75
+K: Eb
+% 1 - 4
+[V: 1] |:z4 |z4 |f2ec |_ddcc |
+w: Son que-sti~i cre-spi cri-ni~e
+w: Que-sti son gli~oc-chi che mi-
+[V: 2] |:c2BG|AAGc|(F/G/A/B/)c=A|B2AA |
+w: Son que-sti~i cre-spi cri-ni~e que - - - - sto~il vi-so e
+w: Que-sti son~gli oc-chi che mi-ran - - - - do fi-so mi-
+[V: 3] |:z4 |f2ec|_ddcf |(B/c/_d/e/)ff|
+w: Son que-sti~i cre-spi cri-ni~e que - - - - sto~il
+w: Que-sti son~gli oc-chi che mi-ran - - - - do
+% 5 - 9
+[V: 1] cAB2 |cAAA |c3B|G2!fermata!Gz ::e4|
+w: que-sto~il vi-so ond' io ri-man-go~uc-ci-so. Deh,
+w: ran-do fi-so, tut-to re-stai con-qui-so.
+[V: 2] AAG2 |AFFF |A3F|=E2!fermata!Ez::c4|
+w: que-sto~il vi-so ond' io ri-man-go~uc-ci-so. Deh,
+w: ran-do fi-so tut-to re-stai con-qui-so.
+[V: 3] (ag/f/e2)|A_ddd|A3B|c2!fermata!cz ::A4|
+w: vi - - - so ond' io ti-man-go~uc-ci-so. Deh,
+w: fi - - - so tut-to re-stai con-qui-so.
+% 10 - 15
+[V: 1] f_dec |B2c2|zAGF |\
+w: dim-me-lo ben mi-o, che que-sto\
+=EFG2 |1F2z2:|2F8|] % more notes
+w: sol de-si-o_. % more lyrics
+[V: 2] ABGA |G2AA|GF=EF |(GF3/2=E//D//E)|1F2z2:|2F8|]
+w: dim-me-lo ben mi-o, che que-sto sol de-si - - - - o_.
+[V: 3] _dBc>d|e2AF|=EFc_d|c4 |1F2z2:|2F8|]
+w: dim-me-lo ben mi-o, che que-sto sol de-si-o_.
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/actionscript.as b/_embed/public/ace/demo/kitchen-sink/docs/actionscript.as
new file mode 100644
index 00000000..ffe21fbf
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/actionscript.as
@@ -0,0 +1,51 @@
+package code
+{
+ /*****************************************
+ * based on textmate actionscript bundle
+ ****************************************/
+
+ import fl.events.SliderEvent;
+
+ public class Foo extends MovieClip
+ {
+ //*************************
+ // Properties:
+
+ public var activeSwatch:MovieClip;
+
+ // Color offsets
+ public var c1:Number = 0; // R
+
+ //*************************
+ // Constructor:
+
+ public function Foo()
+ {
+ // Respond to mouse events
+ swatch1_btn.addEventListener(MouseEvent.CLICK,swatchHandler,false,0,false);
+ previewBox_btn.addEventListener(MouseEvent.MOUSE_DOWN,dragPressHandler);
+
+ // Respond to drag events
+ red_slider.addEventListener(SliderEvent.THUMB_DRAG,sliderHandler);
+
+ // Draw a frame later
+ addEventListener(Event.ENTER_FRAME,draw);
+ }
+
+ protected function clickHandler(event:MouseEvent):void
+ {
+ car.transform.colorTransform = new ColorTransform(0,0,0,1,c1,c2,c3);
+ }
+
+ protected function changeRGBHandler(event:Event):void
+ {
+ c1 = Number(c1_txt.text);
+
+ if(!(c1>=0)){
+ c1 = 0;
+ }
+
+ updateSliders();
+ }
+ }
+}
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/ada.ada b/_embed/public/ace/demo/kitchen-sink/docs/ada.ada
new file mode 100644
index 00000000..90e027f0
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/ada.ada
@@ -0,0 +1,5 @@
+with Ada.Text_IO; use Ada.Text_IO;
+procedure Hello is
+begin
+ Put_Line("Hello, world!");
+end Hello;
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/asciidoc.asciidoc b/_embed/public/ace/demo/kitchen-sink/docs/asciidoc.asciidoc
new file mode 100644
index 00000000..8cddab5d
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/asciidoc.asciidoc
@@ -0,0 +1,6040 @@
+AsciiDoc User Guide
+===================
+Stuart Rackham
+:Author Initials: SJR
+:toc:
+:icons:
+:numbered:
+:website: http://www.methods.co.nz/asciidoc/
+
+AsciiDoc is a text document format for writing notes, documentation,
+articles, books, ebooks, slideshows, web pages, blogs and UNIX man
+pages. AsciiDoc files can be translated to many formats including
+HTML, PDF, EPUB, man page. AsciiDoc is highly configurable: both the
+AsciiDoc source file syntax and the backend output markups (which can
+be almost any type of SGML/XML markup) can be customized and extended
+by the user.
+
+.This document
+**********************************************************************
+This is an overly large document, it probably needs to be refactored
+into a Tutorial, Quick Reference and Formal Reference.
+
+If you're new to AsciiDoc read this section and the <> section and take a look at the example AsciiDoc (`*.txt`)
+source files in the distribution `doc` directory.
+**********************************************************************
+
+
+Introduction
+------------
+AsciiDoc is a plain text human readable/writable document format that
+can be translated to DocBook or HTML using the asciidoc(1) command.
+You can then either use asciidoc(1) generated HTML directly or run
+asciidoc(1) DocBook output through your favorite DocBook toolchain or
+use the AsciiDoc a2x(1) toolchain wrapper to produce PDF, EPUB, DVI,
+LaTeX, PostScript, man page, HTML and text formats.
+
+The AsciiDoc format is a useful presentation format in its own right:
+AsciiDoc markup is simple, intuitive and as such is easily proofed and
+edited.
+
+AsciiDoc is light weight: it consists of a single Python script and a
+bunch of configuration files. Apart from asciidoc(1) and a Python
+interpreter, no other programs are required to convert AsciiDoc text
+files to DocBook or HTML. See <>
+below.
+
+Text markup conventions tend to be a matter of (often strong) personal
+preference: if the default syntax is not to your liking you can define
+your own by editing the text based asciidoc(1) configuration files.
+You can also create configuration files to translate AsciiDoc
+documents to almost any SGML/XML markup.
+
+asciidoc(1) comes with a set of configuration files to translate
+AsciiDoc articles, books and man pages to HTML or DocBook backend
+formats.
+
+.My AsciiDoc Itch
+**********************************************************************
+DocBook has emerged as the de facto standard Open Source documentation
+format. But DocBook is a complex language, the markup is difficult to
+read and even more difficult to write directly -- I found I was
+spending more time typing markup tags, consulting reference manuals
+and fixing syntax errors, than I was writing the documentation.
+**********************************************************************
+
+
+[[X6]]
+Getting Started
+---------------
+Installing AsciiDoc
+~~~~~~~~~~~~~~~~~~~
+See the `README` and `INSTALL` files for install prerequisites and
+procedures. Packagers take a look at <>.
+
+[[X11]]
+Example AsciiDoc Documents
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+The best way to quickly get a feel for AsciiDoc is to view the
+AsciiDoc web site and/or distributed examples:
+
+- Take a look at the linked examples on the AsciiDoc web site home
+ page {website}. Press the 'Page Source' sidebar menu item to view
+ corresponding AsciiDoc source.
+- Read the `*.txt` source files in the distribution `./doc` directory
+ along with the corresponding HTML and DocBook XML files.
+
+
+AsciiDoc Document Types
+-----------------------
+There are three types of AsciiDoc documents: article, book and
+manpage. All document types share the same AsciiDoc format with some
+minor variations. If you are familiar with DocBook you will have
+noticed that AsciiDoc document types correspond to the same-named
+DocBook document types.
+
+Use the asciidoc(1) `-d` (`--doctype`) option to specify the AsciiDoc
+document type -- the default document type is 'article'.
+
+By convention the `.txt` file extension is used for AsciiDoc document
+source files.
+
+article
+~~~~~~~
+Used for short documents, articles and general documentation. See the
+AsciiDoc distribution `./doc/article.txt` example.
+
+AsciiDoc defines standard DocBook article frontmatter and backmatter
+<> (appendix, abstract, bibliography,
+glossary, index).
+
+book
+~~~~
+Books share the same format as articles, with the following
+differences:
+
+- The part titles in multi-part books are <>
+ (same level as book title).
+- Some sections are book specific e.g. preface and colophon.
+
+Book documents will normally be used to produce DocBook output since
+DocBook processors can automatically generate footnotes, table of
+contents, list of tables, list of figures, list of examples and
+indexes.
+
+AsciiDoc defines standard DocBook book frontmatter and backmatter
+<> (appendix, dedication, preface,
+bibliography, glossary, index, colophon).
+
+.Example book documents
+Book::
+ The `./doc/book.txt` file in the AsciiDoc distribution.
+
+Multi-part book::
+ The `./doc/book-multi.txt` file in the AsciiDoc distribution.
+
+manpage
+~~~~~~~
+Used to generate roff format UNIX manual pages. AsciiDoc manpage
+documents observe special header title and section naming conventions
+-- see the <> section for details.
+
+AsciiDoc defines the 'synopsis' <> to
+generate the DocBook `refsynopsisdiv` section.
+
+See also the asciidoc(1) man page source (`./doc/asciidoc.1.txt`) from
+the AsciiDoc distribution.
+
+
+[[X5]]
+AsciiDoc Backends
+-----------------
+The asciidoc(1) command translates an AsciiDoc formatted file to the
+backend format specified by the `-b` (`--backend`) command-line
+option. asciidoc(1) itself has little intrinsic knowledge of backend
+formats, all translation rules are contained in customizable cascading
+configuration files. Backend specific attributes are listed in the
+<> section.
+
+docbook45::
+ Outputs DocBook XML 4.5 markup.
+
+html4::
+ This backend generates plain HTML 4.01 Transitional markup.
+
+xhtml11::
+ This backend generates XHTML 1.1 markup styled with CSS2. Output
+ files have an `.html` extension.
+
+html5::
+ This backend generates HTML 5 markup, apart from the inclusion of
+ <> it is functionally identical to
+ the 'xhtml11' backend.
+
+slidy::
+ Use this backend to generate self-contained
+ http://www.w3.org/Talks/Tools/Slidy2/[Slidy] HTML slideshows for
+ your web browser from AsciiDoc documents. The Slidy backend is
+ documented in the distribution `doc/slidy.txt` file and
+ {website}slidy.html[online].
+
+wordpress::
+ A minor variant of the 'html4' backend to support
+ http://srackham.wordpress.com/blogpost1/[blogpost].
+
+latex::
+ Experimental LaTeX backend.
+
+Backend Aliases
+~~~~~~~~~~~~~~~
+Backend aliases are alternative names for AsciiDoc backends. AsciiDoc
+comes with two backend aliases: 'html' (aliased to 'xhtml11') and
+'docbook' (aliased to 'docbook45').
+
+You can assign (or reassign) backend aliases by setting an AsciiDoc
+attribute named like `backend-alias-` to an AsciiDoc backend
+name. For example, the following backend alias attribute definitions
+appear in the `[attributes]` section of the global `asciidoc.conf`
+configuration file:
+
+ backend-alias-html=xhtml11
+ backend-alias-docbook=docbook45
+
+[[X100]]
+Backend Plugins
+~~~~~~~~~~~~~~~
+The asciidoc(1) `--backend` option is also used to install and manage
+backend <>.
+
+- A backend plugin is used just like the built-in backends.
+- Backend plugins <> over built-in backends with
+ the same name.
+- You can use the `{asciidoc-confdir}` <> to
+ refer to the built-in backend configuration file location from
+ backend plugin configuration files.
+- You can use the `{backend-confdir}` <> to
+ refer to the backend plugin configuration file location.
+- By default backends plugins are installed in
+ `$HOME/.asciidoc/backends/` where `` is the
+ backend name.
+
+
+DocBook
+-------
+AsciiDoc generates 'article', 'book' and 'refentry'
+http://www.docbook.org/[DocBook] documents (corresponding to the
+AsciiDoc 'article', 'book' and 'manpage' document types).
+
+Most Linux distributions come with conversion tools (collectively
+called a toolchain) for <> to
+presentation formats such as Postscript, HTML, PDF, EPUB, DVI,
+PostScript, LaTeX, roff (the native man page format), HTMLHelp,
+JavaHelp and text. There are also programs that allow you to view
+DocBook files directly, for example http://live.gnome.org/Yelp[Yelp]
+(the GNOME help viewer).
+
+[[X12]]
+Converting DocBook to other file formats
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+DocBook files are validated, parsed and translated various
+presentation file formats using a combination of applications
+collectively called a DocBook 'tool chain'. The function of a tool
+chain is to read the DocBook markup (produced by AsciiDoc) and
+transform it to a presentation format (for example HTML, PDF, HTML
+Help, EPUB, DVI, PostScript, LaTeX).
+
+A wide range of user output format requirements coupled with a choice
+of available tools and stylesheets results in many valid tool chain
+combinations.
+
+[[X43]]
+a2x Toolchain Wrapper
+~~~~~~~~~~~~~~~~~~~~~
+One of the biggest hurdles for new users is installing, configuring
+and using a DocBook XML toolchain. `a2x(1)` can help -- it's a
+toolchain wrapper command that will generate XHTML (chunked and
+unchunked), PDF, EPUB, DVI, PS, LaTeX, man page, HTML Help and text
+file outputs from an AsciiDoc text file. `a2x(1)` does all the grunt
+work associated with generating and sequencing the toolchain commands
+and managing intermediate and output files. `a2x(1)` also optionally
+deploys admonition and navigation icons and a CSS stylesheet. See the
+`a2x(1)` man page for more details. In addition to `asciidoc(1)` you
+also need <>, <> and
+optionally: <> or <> (to generate PDF);
+`w3m(1)` or `lynx(1)` (to generate text).
+
+The following examples generate `doc/source-highlight-filter.pdf` from
+the AsciiDoc `doc/source-highlight-filter.txt` source file. The first
+example uses `dblatex(1)` (the default PDF generator) the second
+example forces FOP to be used:
+
+ $ a2x -f pdf doc/source-highlight-filter.txt
+ $ a2x -f pdf --fop doc/source-highlight-filter.txt
+
+See the `a2x(1)` man page for details.
+
+TIP: Use the `--verbose` command-line option to view executed
+toolchain commands.
+
+HTML generation
+~~~~~~~~~~~~~~~
+AsciiDoc produces nicely styled HTML directly without requiring a
+DocBook toolchain but there are also advantages in going the DocBook
+route:
+
+- HTML from DocBook can optionally include automatically generated
+ indexes, tables of contents, footnotes, lists of figures and tables.
+- DocBook toolchains can also (optionally) generate separate (chunked)
+ linked HTML pages for each document section.
+- Toolchain processing performs link and document validity checks.
+- If the DocBook 'lang' attribute is set then things like table of
+ contents, figure and table captions and admonition captions will be
+ output in the specified language (setting the AsciiDoc 'lang'
+ attribute sets the DocBook 'lang' attribute).
+
+On the other hand, HTML output directly from AsciiDoc is much faster,
+is easily customized and can be used in situations where there is no
+suitable DocBook toolchain (for example, see the {website}[AsciiDoc
+website]).
+
+PDF generation
+~~~~~~~~~~~~~~
+There are two commonly used tools to generate PDFs from DocBook,
+<> and <>.
+
+.dblatex or FOP?
+- 'dblatex' is easier to install, there's zero configuration
+ required and no Java VM to install -- it just works out of the box.
+- 'dblatex' source code highlighting and numbering is superb.
+- 'dblatex' is easier to use as it converts DocBook directly to PDF
+ whereas before using 'FOP' you have to convert DocBook to XML-FO
+ using <>.
+- 'FOP' is more feature complete (for example, callouts are processed
+ inside literal layouts) and arguably produces nicer looking output.
+
+HTML Help generation
+~~~~~~~~~~~~~~~~~~~~
+. Convert DocBook XML documents to HTML Help compiler source files
+ using <> and <>.
+. Convert the HTML Help source (`.hhp` and `.html`) files to HTML Help
+ (`.chm`) files using the <>.
+
+Toolchain components summary
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+AsciiDoc::
+ Converts AsciiDoc (`.txt`) files to DocBook XML (`.xml`) files.
+
+[[X13]]http://docbook.sourceforge.net/projects/xsl/[DocBook XSL Stylesheets]::
+ These are a set of XSL stylesheets containing rules for converting
+ DocBook XML documents to HTML, XSL-FO, manpage and HTML Help files.
+ The stylesheets are used in conjunction with an XML parser such as
+ <>.
+
+[[X40]]http://www.xmlsoft.org[xsltproc]::
+ An XML parser for applying XSLT stylesheets (in our case the
+ <>) to XML documents.
+
+[[X31]]http://dblatex.sourceforge.net/[dblatex]::
+ Generates PDF, DVI, PostScript and LaTeX formats directly from
+ DocBook source via the intermediate LaTeX typesetting language --
+ uses <>, <> and
+ `latex(1)`.
+
+[[X14]]http://xml.apache.org/fop/[FOP]::
+ The Apache Formatting Objects Processor converts XSL-FO (`.fo`)
+ files to PDF files. The XSL-FO files are generated from DocBook
+ source files using <> and
+ <>.
+
+[[X67]]Microsoft Help Compiler::
+ The Microsoft HTML Help Compiler (`hhc.exe`) is a command-line tool
+ that converts HTML Help source files to a single HTML Help (`.chm`)
+ file. It runs on MS Windows platforms and can be downloaded from
+ http://www.microsoft.com.
+
+AsciiDoc dblatex configuration files
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The AsciiDoc distribution `./dblatex` directory contains
+`asciidoc-dblatex.xsl` (customized XSL parameter settings) and
+`asciidoc-dblatex.sty` (customized LaTeX settings). These are examples
+of optional <> output customization and are used by
+<>.
+
+AsciiDoc DocBook XSL Stylesheets drivers
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+You will have noticed that the distributed HTML and HTML Help
+documentation files (for example `./doc/asciidoc.html`) are not the
+plain outputs produced using the default 'DocBook XSL Stylesheets'
+configuration. This is because they have been processed using
+customized DocBook XSL Stylesheets along with (in the case of HTML
+outputs) the custom `./stylesheets/docbook-xsl.css` CSS stylesheet.
+
+You'll find the customized DocBook XSL drivers along with additional
+documentation in the distribution `./docbook-xsl` directory. The
+examples that follow are executed from the distribution documentation
+(`./doc`) directory. These drivers are also used by <>.
+
+`common.xsl`::
+ Shared driver parameters. This file is not used directly but is
+ included in all the following drivers.
+
+`chunked.xsl`::
+ Generate chunked XHTML (separate HTML pages for each document
+ section) in the `./doc/chunked` directory. For example:
+
+ $ python ../asciidoc.py -b docbook asciidoc.txt
+ $ xsltproc --nonet ../docbook-xsl/chunked.xsl asciidoc.xml
+
+`epub.xsl`::
+ Used by <> to generate EPUB formatted documents.
+
+`fo.xsl`::
+ Generate XSL Formatting Object (`.fo`) files for subsequent PDF
+ file generation using FOP. For example:
+
+ $ python ../asciidoc.py -b docbook article.txt
+ $ xsltproc --nonet ../docbook-xsl/fo.xsl article.xml > article.fo
+ $ fop article.fo article.pdf
+
+`htmlhelp.xsl`::
+ Generate Microsoft HTML Help source files for the MS HTML Help
+ Compiler in the `./doc/htmlhelp` directory. This example is run on
+ MS Windows from a Cygwin shell prompt:
+
+ $ python ../asciidoc.py -b docbook asciidoc.txt
+ $ xsltproc --nonet ../docbook-xsl/htmlhelp.xsl asciidoc.xml
+ $ c:/Program\ Files/HTML\ Help\ Workshop/hhc.exe htmlhelp.hhp
+
+`manpage.xsl`::
+ Generate a `roff(1)` format UNIX man page from a DocBook XML
+ 'refentry' document. This example generates an `asciidoc.1` man
+ page file:
+
+ $ python ../asciidoc.py -d manpage -b docbook asciidoc.1.txt
+ $ xsltproc --nonet ../docbook-xsl/manpage.xsl asciidoc.1.xml
+
+`xhtml.xsl`::
+ Convert a DocBook XML file to a single XHTML file. For example:
+
+ $ python ../asciidoc.py -b docbook asciidoc.txt
+ $ xsltproc --nonet ../docbook-xsl/xhtml.xsl asciidoc.xml > asciidoc.html
+
+If you want to see how the complete documentation set is processed
+take a look at the A-A-P script `./doc/main.aap`.
+
+
+Generating Plain Text Files
+---------------------------
+AsciiDoc does not have a text backend (for most purposes AsciiDoc
+source text is fine), however you can convert AsciiDoc text files to
+formatted text using the AsciiDoc <> toolchain wrapper
+utility.
+
+
+[[X35]]
+HTML5 and XHTML 1.1
+-------------------
+The 'xhtml11' and 'html5' backends embed or link CSS and JavaScript
+files in their outputs, there is also a <> plugin
+framework.
+
+- If the AsciiDoc 'linkcss' attribute is defined then CSS and
+ JavaScript files are linked to the output document, otherwise they
+ are embedded (the default behavior).
+- The default locations for CSS and JavaScript files can be changed by
+ setting the AsciiDoc 'stylesdir' and 'scriptsdir' attributes
+ respectively.
+- The default locations for embedded and linked files differ and are
+ calculated at different times -- embedded files are loaded when
+ asciidoc(1) generates the output document, linked files are loaded
+ by the browser when the user views the output document.
+- Embedded files are automatically inserted in the output files but
+ you need to manually copy linked CSS and Javascript files from
+ AsciiDoc <> to the correct location
+ relative to the output document.
+
+.Stylesheet file locations
+[cols="3*",frame="topbot",options="header"]
+|====================================================================
+|'stylesdir' attribute
+|Linked location ('linkcss' attribute defined)
+|Embedded location ('linkcss' attribute undefined)
+
+|Undefined (default).
+|Same directory as the output document.
+|`stylesheets` subdirectory in the AsciiDoc configuration directory
+(the directory containing the backend conf file).
+
+|Absolute or relative directory name.
+|Absolute or relative to the output document.
+|Absolute or relative to the AsciiDoc configuration directory (the
+directory containing the backend conf file).
+
+|====================================================================
+
+.JavaScript file locations
+[cols="3*",frame="topbot",options="header"]
+|====================================================================
+|'scriptsdir' attribute
+|Linked location ('linkcss' attribute defined)
+|Embedded location ('linkcss' attribute undefined)
+
+|Undefined (default).
+|Same directory as the output document.
+|`javascripts` subdirectory in the AsciiDoc configuration directory
+(the directory containing the backend conf file).
+
+|Absolute or relative directory name.
+|Absolute or relative to the output document.
+|Absolute or relative to the AsciiDoc configuration directory (the
+directory containing the backend conf file).
+
+|====================================================================
+
+[[X99]]
+Themes
+~~~~~~
+The AsciiDoc 'theme' attribute is used to select an alternative CSS
+stylesheet and to optionally include additional JavaScript code.
+
+- Theme files reside in an AsciiDoc <>
+ named `themes//` (where `` is the the theme name set
+ by the 'theme' attribute). asciidoc(1) sets the 'themedir' attribute
+ to the theme directory path name.
+- The 'theme' attribute can also be set using the asciidoc(1)
+ `--theme` option, the `--theme` option can also be used to manage
+ theme <>.
+- AsciiDoc ships with two themes: 'flask' and 'volnitsky'.
+- The `.css` file replaces the default `asciidoc.css` CSS file.
+- The `.js` file is included in addition to the default
+ `asciidoc.js` JavaScript file.
+- If the <> attribute is defined then icons are loaded
+ from the theme `icons` sub-directory if it exists (i.e. the
+ 'iconsdir' attribute is set to theme `icons` sub-directory path).
+- Embedded theme files are automatically inserted in the output files
+ but you need to manually copy linked CSS and Javascript files to the
+ location of the output documents.
+- Linked CSS and JavaScript theme files are linked to the same linked
+ locations as <>.
+
+For example, the command-line option `--theme foo` (or `--attribute
+theme=foo`) will cause asciidoc(1) to search <<"X27","configuration
+file locations 1, 2 and 3">> for a sub-directory called `themes/foo`
+containing the stylesheet `foo.css` and optionally a JavaScript file
+name `foo.js`.
+
+
+Document Structure
+------------------
+An AsciiDoc document consists of a series of <>
+starting with an optional document Header, followed by an optional
+Preamble, followed by zero or more document Sections.
+
+Almost any combination of zero or more elements constitutes a valid
+AsciiDoc document: documents can range from a single sentence to a
+multi-part book.
+
+Block Elements
+~~~~~~~~~~~~~~
+Block elements consist of one or more lines of text and may contain
+other block elements.
+
+The AsciiDoc block structure can be informally summarized as follows
+footnote:[This is a rough structural guide, not a rigorous syntax
+definition]:
+
+ Document ::= (Header?,Preamble?,Section*)
+ Header ::= (Title,(AuthorInfo,RevisionInfo?)?)
+ AuthorInfo ::= (FirstName,(MiddleName?,LastName)?,EmailAddress?)
+ RevisionInfo ::= (RevisionNumber?,RevisionDate,RevisionRemark?)
+ Preamble ::= (SectionBody)
+ Section ::= (Title,SectionBody?,(Section)*)
+ SectionBody ::= ((BlockTitle?,Block)|BlockMacro)+
+ Block ::= (Paragraph|DelimitedBlock|List|Table)
+ List ::= (BulletedList|NumberedList|LabeledList|CalloutList)
+ BulletedList ::= (ListItem)+
+ NumberedList ::= (ListItem)+
+ CalloutList ::= (ListItem)+
+ LabeledList ::= (ListEntry)+
+ ListEntry ::= (ListLabel,ListItem)
+ ListLabel ::= (ListTerm+)
+ ListItem ::= (ItemText,(List|ListParagraph|ListContinuation)*)
+
+Where:
+
+- '?' implies zero or one occurrence, '+' implies one or more
+ occurrences, '*' implies zero or more occurrences.
+- All block elements are separated by line boundaries.
+- `BlockId`, `AttributeEntry` and `AttributeList` block elements (not
+ shown) can occur almost anywhere.
+- There are a number of document type and backend specific
+ restrictions imposed on the block syntax.
+- The following elements cannot contain blank lines: Header, Title,
+ Paragraph, ItemText.
+- A ListParagraph is a Paragraph with its 'listelement' option set.
+- A ListContinuation is a <>.
+
+[[X95]]
+Header
+~~~~~~
+The Header contains document meta-data, typically title plus optional
+authorship and revision information:
+
+- The Header is optional, but if it is used it must start with a
+ document <>.
+- Optional Author and Revision information immediately follows the
+ header title.
+- The document header must be separated from the remainder of the
+ document by one or more blank lines and cannot contain blank lines.
+- The header can include comments.
+- The header can include <>, typically
+ 'doctype', 'lang', 'encoding', 'icons', 'data-uri', 'toc',
+ 'numbered'.
+- Header attributes are overridden by command-line attributes.
+- If the header contains non-UTF-8 characters then the 'encoding' must
+ precede the header (either in the document or on the command-line).
+
+Here's an example AsciiDoc document header:
+
+ Writing Documentation using AsciiDoc
+ ====================================
+ Joe Bloggs
+ v2.0, February 2003:
+ Rewritten for version 2 release.
+
+The author information line contains the author's name optionally
+followed by the author's email address. The author's name is formatted
+like:
+
+ firstname[ [middlename ]lastname][ ]]
+
+i.e. a first name followed by optional middle and last names followed
+by an email address in that order. Multi-word first, middle and last
+names can be entered using the underscore as a word separator. The
+email address comes last and must be enclosed in angle <> brackets.
+Here a some examples of author information lines:
+
+ Joe Bloggs
+ Joe Bloggs
+ Vincent Willem van_Gogh
+
+If the author line does not match the above specification then the
+entire author line is treated as the first name.
+
+The optional revision information line follows the author information
+line. The revision information can be one of two formats:
+
+. An optional document revision number followed by an optional
+ revision date followed by an optional revision remark:
++
+--
+ * If the revision number is specified it must be followed by a
+ comma.
+ * The revision number must contain at least one numeric character.
+ * Any non-numeric characters preceding the first numeric character
+ will be dropped.
+ * If a revision remark is specified it must be preceded by a colon.
+ The revision remark extends from the colon up to the next blank
+ line, attribute entry or comment and is subject to normal text
+ substitutions.
+ * If a revision number or remark has been set but the revision date
+ has not been set then the revision date is set to the value of the
+ 'docdate' attribute.
+
+Examples:
+
+ v2.0, February 2003
+ February 2003
+ v2.0,
+ v2.0, February 2003: Rewritten for version 2 release.
+ February 2003: Rewritten for version 2 release.
+ v2.0,: Rewritten for version 2 release.
+ :Rewritten for version 2 release.
+--
+
+. The revision information line can also be an RCS/CVS/SVN $Id$
+ marker:
++
+--
+ * AsciiDoc extracts the 'revnumber', 'revdate', and 'author'
+ attributes from the $Id$ revision marker and displays them in the
+ document header.
+ * If an $Id$ revision marker is used the header author line can be
+ omitted.
+
+Example:
+
+ $Id: mydoc.txt,v 1.5 2009/05/17 17:58:44 jbloggs Exp $
+--
+
+You can override or set header parameters by passing 'revnumber',
+'revremark', 'revdate', 'email', 'author', 'authorinitials',
+'firstname' and 'lastname' attributes using the asciidoc(1) `-a`
+(`--attribute`) command-line option. For example:
+
+ $ asciidoc -a revdate=2004/07/27 article.txt
+
+Attribute entries can also be added to the header for substitution in
+the header template with <> elements.
+
+The 'title' element in HTML outputs is set to the AsciiDoc document
+title, you can set it to a different value by including a 'title'
+attribute entry in the document header.
+
+[[X87]]
+Additional document header information
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+AsciiDoc has two mechanisms for optionally including additional
+meta-data in the header of the output document:
+
+'docinfo' configuration file sections::
+If a <> section named 'docinfo' has been loaded
+then it will be included in the document header. Typically the
+'docinfo' section name will be prefixed with a '+' character so that it
+is appended to (rather than replace) other 'docinfo' sections.
+
+'docinfo' files::
+Two docinfo files are recognized: one named `docinfo` and a second
+named like the AsciiDoc source file with a `-docinfo` suffix. For
+example, if the source document is called `mydoc.txt` then the
+document information files would be `docinfo.xml` and
+`mydoc-docinfo.xml` (for DocBook outputs) and `docinfo.html` and
+`mydoc-docinfo.html` (for HTML outputs). The <> attributes control which docinfo files are included in
+the output files.
+
+The contents docinfo templates and files is dependent on the type of
+output:
+
+HTML::
+ Valid 'head' child elements. Typically 'style' and 'script' elements
+ for CSS and JavaScript inclusion.
+
+DocBook::
+ Valid 'articleinfo' or 'bookinfo' child elements. DocBook defines
+ numerous elements for document meta-data, for example: copyrights,
+ document history and authorship information. See the DocBook
+ `./doc/article-docinfo.xml` example that comes with the AsciiDoc
+ distribution. The rendering of meta-data elements (or not) is
+ DocBook processor dependent.
+
+
+[[X86]]
+Preamble
+~~~~~~~~
+The Preamble is an optional untitled section body between the document
+Header and the first Section title.
+
+Sections
+~~~~~~~~
+In addition to the document title (level 0), AsciiDoc supports four
+section levels: 1 (top) to 4 (bottom). Section levels are delimited
+by section <>. Sections are translated using
+configuration file <>. AsciiDoc
+generates the following <> specifically for
+use in section markup templates:
+
+level::
+The `level` attribute is the section level number, it is normally just
+the <> level number (1..4). However, if the `leveloffset`
+attribute is defined it will be added to the `level` attribute. The
+`leveloffset` attribute is useful for <>.
+
+sectnum::
+The `-n` (`--section-numbers`) command-line option generates the
+`sectnum` (section number) attribute. The `sectnum` attribute is used
+for section numbers in HTML outputs (DocBook section numbering are
+handled automatically by the DocBook toolchain commands).
+
+[[X93]]
+Section markup templates
+^^^^^^^^^^^^^^^^^^^^^^^^
+Section markup templates specify output markup and are defined in
+AsciiDoc configuration files. Section markup template names are
+derived as follows (in order of precedence):
+
+1. From the title's first positional attribute or 'template'
+ attribute. For example, the following three section titles are
+ functionally equivalent:
++
+.....................................................................
+[[terms]]
+[glossary]
+List of Terms
+-------------
+
+["glossary",id="terms"]
+List of Terms
+-------------
+
+[template="glossary",id="terms"]
+List of Terms
+-------------
+.....................................................................
+
+2. When the title text matches a configuration file
+ <> entry.
+3. If neither of the above the default `sect` template is used
+ (where `` is a number from 1 to 4).
+
+In addition to the normal section template names ('sect1', 'sect2',
+'sect3', 'sect4') AsciiDoc has the following templates for
+frontmatter, backmatter and other special sections: 'abstract',
+'preface', 'colophon', 'dedication', 'glossary', 'bibliography',
+'synopsis', 'appendix', 'index'. These special section templates
+generate the corresponding Docbook elements; for HTML outputs they
+default to the 'sect1' section template.
+
+Section IDs
+^^^^^^^^^^^
+If no explicit section ID is specified an ID will be synthesised from
+the section title. The primary purpose of this feature is to ensure
+persistence of table of contents links (permalinks): the missing
+section IDs are generated dynamically by the JavaScript TOC generator
+*after* the page is loaded. If you link to a dynamically generated TOC
+address the page will load but the browser will ignore the (as yet
+ungenerated) section ID.
+
+The IDs are generated by the following algorithm:
+
+- Replace all non-alphanumeric title characters with underscores.
+- Strip leading or trailing underscores.
+- Convert to lowercase.
+- Prepend the `idprefix` attribute (so there's no possibility of name
+ clashes with existing document IDs). Prepend an underscore if the
+ `idprefix` attribute is not defined.
+- A numbered suffix (`_2`, `_3` ...) is added if a same named
+ auto-generated section ID exists.
+- If the `ascii-ids` attribute is defined then non-ASCII characters
+ are replaced with ASCII equivalents. This attribute may be
+ deprecated in future releases and *should be avoided*, it's sole
+ purpose is to accommodate deficient downstream applications that
+ cannot process non-ASCII ID attributes.
+
+Example: the title 'Jim's House' would generate the ID `_jim_s_house`.
+
+Section ID synthesis can be disabled by undefining the `sectids`
+attribute.
+
+[[X16]]
+Special Section Titles
+^^^^^^^^^^^^^^^^^^^^^^
+AsciiDoc has a mechanism for mapping predefined section titles
+auto-magically to specific markup templates. For example a title
+'Appendix A: Code Reference' will automatically use the 'appendix'
+<>. The mappings from title to template
+name are specified in `[specialsections]` sections in the Asciidoc
+language configuration files (`lang-*.conf`). Section entries are
+formatted like:
+
+ =<template>
+
+`<title>` is a Python regular expression and `<template>` is the name
+of a configuration file markup template section. If the `<title>`
+matches an AsciiDoc document section title then the backend output is
+marked up using the `<template>` markup template (instead of the
+default `sect<level>` section template). The `{title}` attribute value
+is set to the value of the matched regular expression group named
+'title', if there is no 'title' group `{title}` defaults to the whole
+of the AsciiDoc section title. If `<template>` is blank then any
+existing entry with the same `<title>` will be deleted.
+
+.Special section titles vs. explicit template names
+*********************************************************************
+AsciiDoc has two mechanisms for specifying non-default section markup
+templates: you can specify the template name explicitly (using the
+'template' attribute) or indirectly (using 'special section titles').
+Specifying a <<X93,section template>> attribute explicitly is
+preferred. Auto-magical 'special section titles' have the following
+drawbacks:
+
+- They are non-obvious, you have to know the exact matching
+ title for each special section on a language by language basis.
+- Section titles are predefined and can only be customised with a
+ configuration change.
+- The implementation is complicated by multiple languages: every
+ special section title has to be defined for each language (in each
+ of the `lang-*.conf` files).
+
+Specifying special section template names explicitly does add more
+noise to the source document (the 'template' attribute declaration),
+but the intention is obvious and the syntax is consistent with other
+AsciiDoc elements c.f. bibliographic, Q&A and glossary lists.
+
+Special section titles have been deprecated but are retained for
+backward compatibility.
+
+*********************************************************************
+
+Inline Elements
+~~~~~~~~~~~~~~~
+<<X34,Inline document elements>> are used to format text and to
+perform various types of text substitution. Inline elements and inline
+element syntax is defined in the asciidoc(1) configuration files.
+
+Here is a list of AsciiDoc inline elements in the (default) order in
+which they are processed:
+
+Special characters::
+ These character sequences escape special characters used by
+ the backend markup (typically `<`, `>`, and `&` characters).
+ See `[specialcharacters]` configuration file sections.
+
+Quotes::
+ Elements that markup words and phrases; usually for character
+ formatting. See `[quotes]` configuration file sections.
+
+Special Words::
+ Word or word phrase patterns singled out for markup without
+ the need for further annotation. See `[specialwords]`
+ configuration file sections.
+
+Replacements::
+ Each replacement defines a word or word phrase pattern to
+ search for along with corresponding replacement text. See
+ `[replacements]` configuration file sections.
+
+Attribute references::
+ Document attribute names enclosed in braces are replaced by
+ the corresponding attribute value.
+
+Inline Macros::
+ Inline macros are replaced by the contents of parametrized
+ configuration file sections.
+
+
+Document Processing
+-------------------
+The AsciiDoc source document is read and processed as follows:
+
+1. The document 'Header' is parsed, header parameter values are
+ substituted into the configuration file `[header]` template section
+ which is then written to the output file.
+2. Each document 'Section' is processed and its constituent elements
+ translated to the output file.
+3. The configuration file `[footer]` template section is substituted
+ and written to the output file.
+
+When a block element is encountered asciidoc(1) determines the type of
+block by checking in the following order (first to last): (section)
+Titles, BlockMacros, Lists, DelimitedBlocks, Tables, AttributeEntrys,
+AttributeLists, BlockTitles, Paragraphs.
+
+The default paragraph definition `[paradef-default]` is last element
+to be checked.
+
+Knowing the parsing order will help you devise unambiguous macro, list
+and block syntax rules.
+
+Inline substitutions within block elements are performed in the
+following default order:
+
+1. Special characters
+2. Quotes
+3. Special words
+4. Replacements
+5. Attributes
+6. Inline Macros
+7. Replacements2
+
+The substitutions and substitution order performed on
+Title, Paragraph and DelimitedBlock elements is determined by
+configuration file parameters.
+
+
+Text Formatting
+---------------
+[[X51]]
+Quoted Text
+~~~~~~~~~~~
+Words and phrases can be formatted by enclosing inline text with
+quote characters:
+
+_Emphasized text_::
+ Word phrases \'enclosed in single quote characters' (acute
+ accents) or \_underline characters_ are emphasized.
+
+*Strong text*::
+ Word phrases \*enclosed in asterisk characters* are rendered
+ in a strong font (usually bold).
+
+[[X81]]+Monospaced text+::
+ Word phrases \+enclosed in plus characters+ are rendered in a
+ monospaced font. Word phrases \`enclosed in backtick
+ characters` (grave accents) are also rendered in a monospaced
+ font but in this case the enclosed text is rendered literally
+ and is not subject to further expansion (see <<X80,inline
+ literal passthrough>>).
+
+`Single quoted text'::
+ Phrases enclosed with a \`single grave accent to the left and
+ a single acute accent to the right' are rendered in single
+ quotation marks.
+
+``Double quoted text''::
+ Phrases enclosed with \\``two grave accents to the left and
+ two acute accents to the right'' are rendered in quotation
+ marks.
+
+#Unquoted text#::
+ Placing \#hashes around text# does nothing, it is a mechanism
+ to allow inline attributes to be applied to otherwise
+ unformatted text.
+
+New quote types can be defined by editing asciidoc(1) configuration
+files. See the <<X7,Configuration Files>> section for details.
+
+.Quoted text behavior
+- Quoting cannot be overlapped.
+- Different quoting types can be nested.
+- To suppress quoted text formatting place a backslash character
+ immediately in front of the leading quote character(s). In the case
+ of ambiguity between escaped and non-escaped text you will need to
+ escape both leading and trailing quotes, in the case of
+ multi-character quotes you may even need to escape individual
+ characters.
+
+[[X96]]
+Quoted text attributes
+^^^^^^^^^^^^^^^^^^^^^^
+Quoted text can be prefixed with an <<X21,attribute list>>. The first
+positional attribute ('role' attribute) is translated by AsciiDoc to
+an HTML 'span' element 'class' attribute or a DocBook 'phrase' element
+'role' attribute.
+
+DocBook XSL Stylesheets translate DocBook 'phrase' elements with
+'role' attributes to corresponding HTML 'span' elements with the same
+'class' attributes; CSS can then be used
+http://www.sagehill.net/docbookxsl/UsingCSS.html[to style the
+generated HTML]. Thus CSS styling can be applied to both DocBook and
+AsciiDoc generated HTML outputs. You can also specify multiple class
+names separated by spaces.
+
+CSS rules for text color, text background color, text size and text
+decorators are included in the distributed AsciiDoc CSS files and are
+used in conjunction with AsciiDoc 'xhtml11', 'html5' and 'docbook'
+outputs. The CSS class names are:
+
+- '<color>' (text foreground color).
+- '<color>-background' (text background color).
+- 'big' and 'small' (text size).
+- 'underline', 'overline' and 'line-through' (strike through) text
+ decorators.
+
+Where '<color>' can be any of the
+http://en.wikipedia.org/wiki/Web_colors#HTML_color_names[sixteen HTML
+color names]. Examples:
+
+ [red]#Obvious# and [big red yellow-background]*very obvious*.
+
+ [underline]#Underline text#, [overline]#overline text# and
+ [blue line-through]*bold blue and line-through*.
+
+is rendered as:
+
+[red]#Obvious# and [big red yellow-background]*very obvious*.
+
+[underline]#Underline text#, [overline]#overline text# and
+[bold blue line-through]*bold blue and line-through*.
+
+NOTE: Color and text decorator attributes are rendered for XHTML and
+HTML 5 outputs using CSS stylesheets. The mechanism to implement
+color and text decorator attributes is provided for DocBook toolchains
+via the DocBook 'phrase' element 'role' attribute, but the actual
+rendering is toolchain specific and is not part of the AsciiDoc
+distribution.
+
+[[X52]]
+Constrained and Unconstrained Quotes
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+There are actually two types of quotes:
+
+Constrained quotes
+++++++++++++++++++
+Quoted must be bounded by white space or commonly adjoining
+punctuation characters. These are the most commonly used type of
+quote.
+
+Unconstrained quotes
+++++++++++++++++++++
+Unconstrained quotes have no boundary constraints and can be placed
+anywhere within inline text. For consistency and to make them easier
+to remember unconstrained quotes are double-ups of the `_`, `*`, `+`
+and `#` constrained quotes:
+
+ __unconstrained emphasized text__
+ **unconstrained strong text**
+ ++unconstrained monospaced text++
+ ##unconstrained unquoted text##
+
+The following example emboldens the letter F:
+
+ **F**ile Open...
+
+Superscripts and Subscripts
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Put \^carets on either^ side of the text to be superscripted, put
+\~tildes on either side~ of text to be subscripted. For example, the
+following line:
+
+ e^πi^+1 = 0. H~2~O and x^10^. Some ^super text^
+ and ~some sub text~
+
+Is rendered like:
+
+e^πi^+1 = 0. H~2~O and x^10^. Some ^super text^
+and ~some sub text~
+
+Superscripts and subscripts are implemented as <<X52,unconstrained
+quotes>> and they can be escaped with a leading backslash and prefixed
+with with an attribute list.
+
+Line Breaks
+~~~~~~~~~~~
+A plus character preceded by at least one space character at the end
+of a non-blank line forces a line break. It generates a line break
+(`br`) tag for HTML outputs and a custom XML `asciidoc-br` processing
+instruction for DocBook outputs. The `asciidoc-br` processing
+instruction is handled by <<X43,a2x(1)>>.
+
+Page Breaks
+~~~~~~~~~~~
+A line of three or more less-than (`<<<`) characters will generate a
+hard page break in DocBook and printed HTML outputs. It uses the CSS
+`page-break-after` property for HTML outputs and a custom XML
+`asciidoc-pagebreak` processing instruction for DocBook outputs. The
+`asciidoc-pagebreak` processing instruction is handled by
+<<X43,a2x(1)>>. Hard page breaks are sometimes handy but as a general
+rule you should let your page processor generate page breaks for you.
+
+Rulers
+~~~~~~
+A line of three or more apostrophe characters will generate a ruler
+line. It generates a ruler (`hr`) tag for HTML outputs and a custom
+XML `asciidoc-hr` processing instruction for DocBook outputs. The
+`asciidoc-hr` processing instruction is handled by <<X43,a2x(1)>>.
+
+Tabs
+~~~~
+By default tab characters input files will translated to 8 spaces. Tab
+expansion is set with the 'tabsize' entry in the configuration file
+`[miscellaneous]` section and can be overridden in included files by
+setting a 'tabsize' attribute in the `include` macro's attribute list.
+For example:
+
+ include::addendum.txt[tabsize=2]
+
+The tab size can also be set using the attribute command-line option,
+for example `--attribute tabsize=4`
+
+Replacements
+~~~~~~~~~~~~
+The following replacements are defined in the default AsciiDoc
+configuration:
+
+ (C) copyright, (TM) trademark, (R) registered trademark,
+ -- em dash, ... ellipsis, -> right arrow, <- left arrow, => right
+ double arrow, <= left double arrow.
+
+Which are rendered as:
+
+(C) copyright, (TM) trademark, (R) registered trademark,
+-- em dash, ... ellipsis, -> right arrow, <- left arrow, => right
+double arrow, <= left double arrow.
+
+You can also include arbitrary entity references in the AsciiDoc
+source. Examples:
+
+ ➊ ¶
+
+renders:
+
+➊ ¶
+
+To render a replacement literally escape it with a leading back-slash.
+
+The <<X7,Configuration Files>> section explains how to configure your
+own replacements.
+
+Special Words
+~~~~~~~~~~~~~
+Words defined in `[specialwords]` configuration file sections are
+automatically marked up without having to be explicitly notated.
+
+The <<X7,Configuration Files>> section explains how to add and replace
+special words.
+
+
+[[X17]]
+Titles
+------
+Document and section titles can be in either of two formats:
+
+Two line titles
+~~~~~~~~~~~~~~~
+A two line title consists of a title line, starting hard against the
+left margin, and an underline. Section underlines consist a repeated
+character pairs spanning the width of the preceding title (give or
+take up to two characters):
+
+The default title underlines for each of the document levels are:
+
+
+ Level 0 (top level): ======================
+ Level 1: ----------------------
+ Level 2: ~~~~~~~~~~~~~~~~~~~~~~
+ Level 3: ^^^^^^^^^^^^^^^^^^^^^^
+ Level 4 (bottom level): ++++++++++++++++++++++
+
+Examples:
+
+ Level One Section Title
+ -----------------------
+
+ Level 2 Subsection Title
+ ~~~~~~~~~~~~~~~~~~~~~~~~
+
+[[X46]]
+One line titles
+~~~~~~~~~~~~~~~
+One line titles consist of a single line delimited on either side by
+one or more equals characters (the number of equals characters
+corresponds to the section level minus one). Here are some examples:
+
+ = Document Title (level 0) =
+ == Section title (level 1) ==
+ === Section title (level 2) ===
+ ==== Section title (level 3) ====
+ ===== Section title (level 4) =====
+
+[NOTE]
+=====================================================================
+- One or more spaces must fall between the title and the delimiters.
+- The trailing title delimiter is optional.
+- The one-line title syntax can be changed by editing the
+ configuration file `[titles]` section `sect0`...`sect4` entries.
+=====================================================================
+
+Floating titles
+~~~~~~~~~~~~~~~
+Setting the title's first positional attribute or 'style' attribute to
+'float' generates a free-floating title. A free-floating title is
+rendered just like a normal section title but is not formally
+associated with a text body and is not part of the regular section
+hierarchy so the normal ordering rules do not apply. Floating titles
+can also be used in contexts where section titles are illegal: for
+example sidebar and admonition blocks. Example:
+
+ [float]
+ The second day
+ ~~~~~~~~~~~~~~
+
+Floating titles do not appear in a document's table of contents.
+
+
+[[X42]]
+Block Titles
+------------
+A 'BlockTitle' element is a single line beginning with a period
+followed by the title text. A BlockTitle is applied to the immediately
+following Paragraph, DelimitedBlock, List, Table or BlockMacro. For
+example:
+
+........................
+.Notes
+- Note 1.
+- Note 2.
+........................
+
+is rendered as:
+
+.Notes
+- Note 1.
+- Note 2.
+
+
+[[X41]]
+BlockId Element
+---------------
+A 'BlockId' is a single line block element containing a unique
+identifier enclosed in double square brackets. It is used to assign an
+identifier to the ensuing block element. For example:
+
+ [[chapter-titles]]
+ Chapter titles can be ...
+
+The preceding example identifies the ensuing paragraph so it can be
+referenced from other locations, for example with
+`<<chapter-titles,chapter titles>>`.
+
+'BlockId' elements can be applied to Title, Paragraph, List,
+DelimitedBlock, Table and BlockMacro elements. The BlockId element
+sets the `{id}` attribute for substitution in the subsequent block's
+markup template. If a second positional argument is supplied it sets
+the `{reftext}` attribute which is used to set the DocBook `xreflabel`
+attribute.
+
+The 'BlockId' element has the same syntax and serves the same function
+to the <<X30,anchor inline macro>>.
+
+[[X79]]
+AttributeList Element
+---------------------
+An 'AttributeList' block element is an <<X21,attribute list>> on a
+line by itself:
+
+- 'AttributeList' attributes are only applied to the immediately
+ following block element -- the attributes are made available to the
+ block's markup template.
+- Multiple contiguous 'AttributeList' elements are additively combined
+ in the order they appear..
+- The first positional attribute in the list is often used to specify
+ the ensuing element's <<X23,style>>.
+
+Attribute value substitution
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+By default, only substitutions that take place inside attribute list
+values are attribute references, this is because not all attributes
+are destined to be marked up and rendered as text (for example the
+table 'cols' attribute). To perform normal inline text substitutions
+(special characters, quotes, macros, replacements) on an attribute
+value you need to enclose it in single quotes. In the following quote
+block the second attribute value in the AttributeList is quoted to
+ensure the 'http' macro is expanded to a hyperlink.
+
+---------------------------------------------------------------------
+[quote,'http://en.wikipedia.org/wiki/Samuel_Johnson[Samuel Johnson]']
+_____________________________________________________________________
+Sir, a woman's preaching is like a dog's walking on his hind legs. It
+is not done well; but you are surprised to find it done at all.
+_____________________________________________________________________
+---------------------------------------------------------------------
+
+Common attributes
+~~~~~~~~~~~~~~~~~
+Most block elements support the following attributes:
+
+[cols="1e,1,5a",frame="topbot",options="header"]
+|====================================================================
+|Name |Backends |Description
+
+|id |html4, html5, xhtml11, docbook |
+Unique identifier typically serve as link targets.
+Can also be set by the 'BlockId' element.
+
+|role |html4, html5, xhtml11, docbook |
+Role contains a string used to classify or subclassify an element and
+can be applied to AsciiDoc block elements. The AsciiDoc 'role'
+attribute is translated to the 'role' attribute in DocBook outputs and
+is included in the 'class' attribute in HTML outputs, in this respect
+it behaves like the <<X96,quoted text role attribute>>.
+
+DocBook XSL Stylesheets translate DocBook 'role' attributes to HTML
+'class' attributes; CSS can then be used
+http://www.sagehill.net/docbookxsl/UsingCSS.html[to style the
+generated HTML].
+
+|reftext |docbook |
+'reftext' is used to set the DocBook 'xreflabel' attribute.
+The 'reftext' attribute can an also be set by the 'BlockId' element.
+
+|====================================================================
+
+
+Paragraphs
+----------
+Paragraphs are blocks of text terminated by a blank line, the end of
+file, or the start of a delimited block or a list. There are three
+paragraph syntaxes: normal, indented (literal) and admonition which
+are rendered, by default, with the corresponding paragraph style.
+
+Each syntax has a default style, but you can explicitly apply any
+paragraph style to any paragraph syntax. You can also apply
+<<X104,delimited block>> styles to single paragraphs.
+
+The built-in paragraph styles are: 'normal', 'literal', 'verse',
+'quote', 'listing', 'TIP', 'NOTE', 'IMPORTANT', 'WARNING', 'CAUTION',
+'abstract', 'partintro', 'comment', 'example', 'sidebar', 'source',
+'music', 'latex', 'graphviz'.
+
+normal paragraph syntax
+~~~~~~~~~~~~~~~~~~~~~~~
+Normal paragraph syntax consists of one or more non-blank lines of
+text. The first line must start hard against the left margin (no
+intervening white space). The default processing expectation is that
+of a normal paragraph of text.
+
+[[X85]]
+literal paragraph syntax
+~~~~~~~~~~~~~~~~~~~~~~~~
+Literal paragraphs are rendered verbatim in a monospaced font without
+any distinguishing background or border. By default there is no text
+formatting or substitutions within Literal paragraphs apart from
+Special Characters and Callouts.
+
+The 'literal' style is applied implicitly to indented paragraphs i.e.
+where the first line of the paragraph is indented by one or more space
+or tab characters. For example:
+
+---------------------------------------------------------------------
+ Consul *necessitatibus* per id,
+ consetetur, eu pro everti postulant
+ homero verear ea mea, qui.
+---------------------------------------------------------------------
+
+Renders:
+
+ Consul *necessitatibus* per id,
+ consetetur, eu pro everti postulant
+ homero verear ea mea, qui.
+
+NOTE: Because <<X64,lists>> can be indented it's possible for your
+indented paragraph to be misinterpreted as a list -- in situations
+like this apply the 'literal' style to a normal paragraph.
+
+Instead of using a paragraph indent you could apply the 'literal'
+style explicitly, for example:
+
+---------------------------------------------------------------------
+[literal]
+Consul *necessitatibus* per id,
+consetetur, eu pro everti postulant
+homero verear ea mea, qui.
+---------------------------------------------------------------------
+
+Renders:
+
+[literal]
+Consul *necessitatibus* per id,
+consetetur, eu pro everti postulant
+homero verear ea mea, qui.
+
+[[X94]]
+quote and verse paragraph styles
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The optional 'attribution' and 'citetitle' attributes (positional
+attributes 2 and 3) specify the author and source respectively.
+
+The 'verse' style retains the line breaks, for example:
+
+---------------------------------------------------------------------
+[verse, William Blake, from Auguries of Innocence]
+To see a world in a grain of sand,
+And a heaven in a wild flower,
+Hold infinity in the palm of your hand,
+And eternity in an hour.
+---------------------------------------------------------------------
+
+Which is rendered as:
+
+[verse, William Blake, from Auguries of Innocence]
+To see a world in a grain of sand,
+And a heaven in a wild flower,
+Hold infinity in the palm of your hand,
+And eternity in an hour.
+
+The 'quote' style flows the text at left and right margins, for
+example:
+
+---------------------------------------------------------------------
+[quote, Bertrand Russell, The World of Mathematics (1956)]
+A good notation has subtlety and suggestiveness which at times makes
+it almost seem like a live teacher.
+---------------------------------------------------------------------
+
+Which is rendered as:
+
+[quote, Bertrand Russell, The World of Mathematics (1956)]
+A good notation has subtlety and suggestiveness which at times makes
+it almost seem like a live teacher.
+
+[[X28]]
+Admonition Paragraphs
+~~~~~~~~~~~~~~~~~~~~~
+'TIP', 'NOTE', 'IMPORTANT', 'WARNING' and 'CAUTION' admonishment
+paragraph styles are generated by placing `NOTE:`, `TIP:`,
+`IMPORTANT:`, `WARNING:` or `CAUTION:` as the first word of the
+paragraph. For example:
+
+ NOTE: This is an example note.
+
+Alternatively, you can specify the paragraph admonition style
+explicitly using an <<X79,AttributeList element>>. For example:
+
+ [NOTE]
+ This is an example note.
+
+Renders:
+
+NOTE: This is an example note.
+
+TIP: If your admonition requires more than a single paragraph use an
+<<X22,admonition block>> instead.
+
+[[X47]]
+Admonition Icons and Captions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+NOTE: Admonition customization with `icons`, `iconsdir`, `icon` and
+`caption` attributes does not apply when generating DocBook output. If
+you are going the DocBook route then the <<X43,a2x(1)>> `--no-icons`
+and `--icons-dir` options can be used to set the appropriate XSL
+Stylesheets parameters.
+
+By default the asciidoc(1) HTML backends generate text captions
+instead of admonition icon image links. To generate links to icon
+images define the <<X45,`icons`>> attribute, for example using the `-a
+icons` command-line option.
+
+The <<X44,`iconsdir`>> attribute sets the location of linked icon
+images.
+
+You can override the default icon image using the `icon` attribute to
+specify the path of the linked image. For example:
+
+ [icon="./images/icons/wink.png"]
+ NOTE: What lovely war.
+
+Use the `caption` attribute to customize the admonition captions (not
+applicable to `docbook` backend). The following example suppresses the
+icon image and customizes the caption of a 'NOTE' admonition
+(undefining the `icons` attribute with `icons=None` is only necessary
+if <<X45,admonition icons>> have been enabled):
+
+ [icons=None, caption="My Special Note"]
+ NOTE: This is my special note.
+
+This subsection also applies to <<X22,Admonition Blocks>>.
+
+
+[[X104]]
+Delimited Blocks
+----------------
+Delimited blocks are blocks of text enveloped by leading and trailing
+delimiter lines (normally a series of four or more repeated
+characters). The behavior of Delimited Blocks is specified by entries
+in configuration file `[blockdef-*]` sections.
+
+Predefined Delimited Blocks
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+AsciiDoc ships with a number of predefined DelimitedBlocks (see the
+`asciidoc.conf` configuration file in the asciidoc(1) program
+directory):
+
+Predefined delimited block underlines:
+
+ CommentBlock: //////////////////////////
+ PassthroughBlock: ++++++++++++++++++++++++++
+ ListingBlock: --------------------------
+ LiteralBlock: ..........................
+ SidebarBlock: **************************
+ QuoteBlock: __________________________
+ ExampleBlock: ==========================
+ OpenBlock: --
+
+.Default DelimitedBlock substitutions
+[cols="2e,7*^",frame="topbot",options="header,autowidth"]
+|=====================================================
+| |Attributes |Callouts |Macros | Quotes |Replacements
+|Special chars |Special words
+
+|PassthroughBlock |Yes |No |Yes |No |No |No |No
+|ListingBlock |No |Yes |No |No |No |Yes |No
+|LiteralBlock |No |Yes |No |No |No |Yes |No
+|SidebarBlock |Yes |No |Yes |Yes |Yes |Yes |Yes
+|QuoteBlock |Yes |No |Yes |Yes |Yes |Yes |Yes
+|ExampleBlock |Yes |No |Yes |Yes |Yes |Yes |Yes
+|OpenBlock |Yes |No |Yes |Yes |Yes |Yes |Yes
+|=====================================================
+
+Listing Blocks
+~~~~~~~~~~~~~~
+'ListingBlocks' are rendered verbatim in a monospaced font, they
+retain line and whitespace formatting and are often distinguished by a
+background or border. There is no text formatting or substitutions
+within Listing blocks apart from Special Characters and Callouts.
+Listing blocks are often used for computer output and file listings.
+
+Here's an example:
+
+[listing]
+......................................
+--------------------------------------
+#include <stdio.h>
+
+int main() {
+ printf("Hello World!\n");
+ exit(0);
+}
+--------------------------------------
+......................................
+
+Which will be rendered like:
+
+--------------------------------------
+#include <stdio.h>
+
+int main() {
+ printf("Hello World!\n");
+ exit(0);
+}
+--------------------------------------
+
+By convention <<X59,filter blocks>> use the listing block syntax and
+are implemented as distinct listing block styles.
+
+[[X65]]
+Literal Blocks
+~~~~~~~~~~~~~~
+'LiteralBlocks' are rendered just like <<X85,literal paragraphs>>.
+Example:
+
+---------------------------------------------------------------------
+...................................
+Consul *necessitatibus* per id,
+consetetur, eu pro everti postulant
+homero verear ea mea, qui.
+...................................
+---------------------------------------------------------------------
+
+Renders:
+...................................
+Consul *necessitatibus* per id,
+consetetur, eu pro everti postulant
+homero verear ea mea, qui.
+...................................
+
+If the 'listing' style is applied to a LiteralBlock it will be
+rendered as a ListingBlock (this is handy if you have a listing
+containing a ListingBlock).
+
+Sidebar Blocks
+~~~~~~~~~~~~~~
+A sidebar is a short piece of text presented outside the narrative
+flow of the main text. The sidebar is normally presented inside a
+bordered box to set it apart from the main text.
+
+The sidebar body is treated like a normal section body.
+
+Here's an example:
+
+---------------------------------------------------------------------
+.An Example Sidebar
+************************************************
+Any AsciiDoc SectionBody element (apart from
+SidebarBlocks) can be placed inside a sidebar.
+************************************************
+---------------------------------------------------------------------
+
+Which will be rendered like:
+
+.An Example Sidebar
+************************************************
+Any AsciiDoc SectionBody element (apart from
+SidebarBlocks) can be placed inside a sidebar.
+************************************************
+
+[[X26]]
+Comment Blocks
+~~~~~~~~~~~~~~
+The contents of 'CommentBlocks' are not processed; they are useful for
+annotations and for excluding new or outdated content that you don't
+want displayed. CommentBlocks are never written to output files.
+Example:
+
+---------------------------------------------------------------------
+//////////////////////////////////////////
+CommentBlock contents are not processed by
+asciidoc(1).
+//////////////////////////////////////////
+---------------------------------------------------------------------
+
+See also <<X25,Comment Lines>>.
+
+NOTE: System macros are executed inside comment blocks.
+
+[[X76]]
+Passthrough Blocks
+~~~~~~~~~~~~~~~~~~
+By default the block contents is subject only to 'attributes' and
+'macros' substitutions (use an explicit 'subs' attribute to apply
+different substitutions). PassthroughBlock content will often be
+backend specific. Here's an example:
+
+---------------------------------------------------------------------
+[subs="quotes"]
+++++++++++++++++++++++++++++++++++++++
+<table border="1"><tr>
+ <td>*Cell 1*</td>
+ <td>*Cell 2*</td>
+</tr></table>
+++++++++++++++++++++++++++++++++++++++
+---------------------------------------------------------------------
+
+The following styles can be applied to passthrough blocks:
+
+pass::
+ No substitutions are performed. This is equivalent to `subs="none"`.
+
+asciimath, latexmath::
+ By default no substitutions are performed, the contents are rendered
+ as <<X78,mathematical formulas>>.
+
+Quote Blocks
+~~~~~~~~~~~~
+'QuoteBlocks' are used for quoted passages of text. There are two
+styles: 'quote' and 'verse'. The style behavior is identical to
+<<X94,quote and verse paragraphs>> except that blocks can contain
+multiple paragraphs and, in the case of the 'quote' style, other
+section elements. The first positional attribute sets the style, if
+no attributes are specified the 'quote' style is used. The optional
+'attribution' and 'citetitle' attributes (positional attributes 2 and
+3) specify the quote's author and source. For example:
+
+---------------------------------------------------------------------
+[quote, Sir Arthur Conan Doyle, The Adventures of Sherlock Holmes]
+____________________________________________________________________
+As he spoke there was the sharp sound of horses' hoofs and
+grating wheels against the curb, followed by a sharp pull at the
+bell. Holmes whistled.
+
+"A pair, by the sound," said he. "Yes," he continued, glancing
+out of the window. "A nice little brougham and a pair of
+beauties. A hundred and fifty guineas apiece. There's money in
+this case, Watson, if there is nothing else."
+____________________________________________________________________
+---------------------------------------------------------------------
+
+Which is rendered as:
+
+[quote, Sir Arthur Conan Doyle, The Adventures of Sherlock Holmes]
+____________________________________________________________________
+As he spoke there was the sharp sound of horses' hoofs and
+grating wheels against the curb, followed by a sharp pull at the
+bell. Holmes whistled.
+
+"A pair, by the sound," said he. "Yes," he continued, glancing
+out of the window. "A nice little brougham and a pair of
+beauties. A hundred and fifty guineas apiece. There's money in
+this case, Watson, if there is nothing else."
+____________________________________________________________________
+
+[[X48]]
+Example Blocks
+~~~~~~~~~~~~~~
+'ExampleBlocks' encapsulate the DocBook Example element and are used
+for, well, examples. Example blocks can be titled by preceding them
+with a 'BlockTitle'. DocBook toolchains will normally automatically
+number examples and generate a 'List of Examples' backmatter section.
+
+Example blocks are delimited by lines of equals characters and can
+contain any block elements apart from Titles, BlockTitles and
+Sidebars) inside an example block. For example:
+
+---------------------------------------------------------------------
+.An example
+=====================================================================
+Qui in magna commodo, est labitur dolorum an. Est ne magna primis
+adolescens.
+=====================================================================
+---------------------------------------------------------------------
+
+Renders:
+
+.An example
+=====================================================================
+Qui in magna commodo, est labitur dolorum an. Est ne magna primis
+adolescens.
+=====================================================================
+
+A title prefix that can be inserted with the `caption` attribute
+(HTML backends). For example:
+
+---------------------------------------------------------------------
+[caption="Example 1: "]
+.An example with a custom caption
+=====================================================================
+Qui in magna commodo, est labitur dolorum an. Est ne magna primis
+adolescens.
+=====================================================================
+---------------------------------------------------------------------
+
+[[X22]]
+Admonition Blocks
+~~~~~~~~~~~~~~~~~
+The 'ExampleBlock' definition includes a set of admonition
+<<X23,styles>> ('NOTE', 'TIP', 'IMPORTANT', 'WARNING', 'CAUTION') for
+generating admonition blocks (admonitions containing more than a
+<<X28,single paragraph>>). Just precede the 'ExampleBlock' with an
+attribute list specifying the admonition style name. For example:
+
+---------------------------------------------------------------------
+[NOTE]
+.A NOTE admonition block
+=====================================================================
+Qui in magna commodo, est labitur dolorum an. Est ne magna primis
+adolescens.
+
+. Fusce euismod commodo velit.
+. Vivamus fringilla mi eu lacus.
+ .. Fusce euismod commodo velit.
+ .. Vivamus fringilla mi eu lacus.
+. Donec eget arcu bibendum
+ nunc consequat lobortis.
+=====================================================================
+---------------------------------------------------------------------
+
+Renders:
+
+[NOTE]
+.A NOTE admonition block
+=====================================================================
+Qui in magna commodo, est labitur dolorum an. Est ne magna primis
+adolescens.
+
+. Fusce euismod commodo velit.
+. Vivamus fringilla mi eu lacus.
+ .. Fusce euismod commodo velit.
+ .. Vivamus fringilla mi eu lacus.
+. Donec eget arcu bibendum
+ nunc consequat lobortis.
+=====================================================================
+
+See also <<X47,Admonition Icons and Captions>>.
+
+[[X29]]
+Open Blocks
+~~~~~~~~~~~
+Open blocks are special:
+
+- The open block delimiter is line containing two hyphen characters
+ (instead of four or more repeated characters).
+
+- They can be used to group block elements for <<X15,List item
+ continuation>>.
+
+- Open blocks can be styled to behave like any other type of delimited
+ block. The following built-in styles can be applied to open
+ blocks: 'literal', 'verse', 'quote', 'listing', 'TIP', 'NOTE',
+ 'IMPORTANT', 'WARNING', 'CAUTION', 'abstract', 'partintro',
+ 'comment', 'example', 'sidebar', 'source', 'music', 'latex',
+ 'graphviz'. For example, the following open block and listing block
+ are functionally identical:
+
+ [listing]
+ --
+ Lorum ipsum ...
+ --
+
+ ---------------
+ Lorum ipsum ...
+ ---------------
+
+- An unstyled open block groups section elements but otherwise does
+ nothing.
+
+Open blocks are used to generate document abstracts and book part
+introductions:
+
+- Apply the 'abstract' style to generate an abstract, for example:
+
+ [abstract]
+ --
+ In this paper we will ...
+ --
+
+. Apply the 'partintro' style to generate a book part introduction for
+ a multi-part book, for example:
+
+ [partintro]
+ .Optional part introduction title
+ --
+ Optional part introduction goes here.
+ --
+
+
+[[X64]]
+Lists
+-----
+.List types
+- Bulleted lists. Also known as itemized or unordered lists.
+- Numbered lists. Also called ordered lists.
+- Labeled lists. Sometimes called variable or definition lists.
+- Callout lists (a list of callout annotations).
+
+.List behavior
+- List item indentation is optional and does not determine nesting,
+ indentation does however make the source more readable.
+- Another list or a literal paragraph immediately following a list
+ item will be implicitly included in the list item; use <<X15, list
+ item continuation>> to explicitly append other block elements to a
+ list item.
+- A comment block or a comment line block macro element will terminate
+ a list -- use inline comment lines to put comments inside lists.
+- The `listindex` <<X60,intrinsic attribute>> is the current list item
+ index (1..). If this attribute is used outside a list then it's value
+ is the number of items in the most recently closed list. Useful for
+ displaying the number of items in a list.
+
+Bulleted Lists
+~~~~~~~~~~~~~~
+Bulleted list items start with a single dash or one to five asterisks
+followed by some white space then some text. Bulleted list syntaxes
+are:
+
+...................
+- List item.
+* List item.
+** List item.
+*** List item.
+**** List item.
+***** List item.
+...................
+
+Numbered Lists
+~~~~~~~~~~~~~~
+List item numbers are explicit or implicit.
+
+.Explicit numbering
+List items begin with a number followed by some white space then the
+item text. The numbers can be decimal (arabic), roman (upper or lower
+case) or alpha (upper or lower case). Decimal and alpha numbers are
+terminated with a period, roman numbers are terminated with a closing
+parenthesis. The different terminators are necessary to ensure 'i',
+'v' and 'x' roman numbers are are distinguishable from 'x', 'v' and
+'x' alpha numbers. Examples:
+
+.....................................................................
+1. Arabic (decimal) numbered list item.
+a. Lower case alpha (letter) numbered list item.
+F. Upper case alpha (letter) numbered list item.
+iii) Lower case roman numbered list item.
+IX) Upper case roman numbered list item.
+.....................................................................
+
+.Implicit numbering
+List items begin one to five period characters, followed by some white
+space then the item text. Examples:
+
+.....................................................................
+. Arabic (decimal) numbered list item.
+.. Lower case alpha (letter) numbered list item.
+... Lower case roman numbered list item.
+.... Upper case alpha (letter) numbered list item.
+..... Upper case roman numbered list item.
+.....................................................................
+
+You can use the 'style' attribute (also the first positional
+attribute) to specify an alternative numbering style. The numbered
+list style can be one of the following values: 'arabic', 'loweralpha',
+'upperalpha', 'lowerroman', 'upperroman'.
+
+Here are some examples of bulleted and numbered lists:
+
+---------------------------------------------------------------------
+- Praesent eget purus quis magna eleifend eleifend.
+ 1. Fusce euismod commodo velit.
+ a. Fusce euismod commodo velit.
+ b. Vivamus fringilla mi eu lacus.
+ c. Donec eget arcu bibendum nunc consequat lobortis.
+ 2. Vivamus fringilla mi eu lacus.
+ i) Fusce euismod commodo velit.
+ ii) Vivamus fringilla mi eu lacus.
+ 3. Donec eget arcu bibendum nunc consequat lobortis.
+ 4. Nam fermentum mattis ante.
+- Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
+ * Fusce euismod commodo velit.
+ ** Qui in magna commodo, est labitur dolorum an. Est ne magna primis
+ adolescens. Sit munere ponderum dignissim et. Minim luptatum et
+ vel.
+ ** Vivamus fringilla mi eu lacus.
+ * Donec eget arcu bibendum nunc consequat lobortis.
+- Nulla porttitor vulputate libero.
+ . Fusce euismod commodo velit.
+ . Vivamus fringilla mi eu lacus.
+[upperroman]
+ .. Fusce euismod commodo velit.
+ .. Vivamus fringilla mi eu lacus.
+ . Donec eget arcu bibendum nunc consequat lobortis.
+---------------------------------------------------------------------
+
+Which render as:
+
+- Praesent eget purus quis magna eleifend eleifend.
+ 1. Fusce euismod commodo velit.
+ a. Fusce euismod commodo velit.
+ b. Vivamus fringilla mi eu lacus.
+ c. Donec eget arcu bibendum nunc consequat lobortis.
+ 2. Vivamus fringilla mi eu lacus.
+ i) Fusce euismod commodo velit.
+ ii) Vivamus fringilla mi eu lacus.
+ 3. Donec eget arcu bibendum nunc consequat lobortis.
+ 4. Nam fermentum mattis ante.
+- Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
+ * Fusce euismod commodo velit.
+ ** Qui in magna commodo, est labitur dolorum an. Est ne magna primis
+ adolescens. Sit munere ponderum dignissim et. Minim luptatum et
+ vel.
+ ** Vivamus fringilla mi eu lacus.
+ * Donec eget arcu bibendum nunc consequat lobortis.
+- Nulla porttitor vulputate libero.
+ . Fusce euismod commodo velit.
+ . Vivamus fringilla mi eu lacus.
+[upperroman]
+ .. Fusce euismod commodo velit.
+ .. Vivamus fringilla mi eu lacus.
+ . Donec eget arcu bibendum nunc consequat lobortis.
+
+A predefined 'compact' option is available to bulleted and numbered
+lists -- this translates to the DocBook 'spacing="compact"' lists
+attribute which may or may not be processed by the DocBook toolchain.
+Example:
+
+ [options="compact"]
+ - Compact list item.
+ - Another compact list item.
+
+TIP: To apply the 'compact' option globally define a document-wide
+'compact-option' attribute, e.g. using the `-a compact-option`
+command-line option.
+
+You can set the list start number using the 'start' attribute (works
+for HTML outputs and DocBook outputs processed by DocBook XSL
+Stylesheets). Example:
+
+ [start=7]
+ . List item 7.
+ . List item 8.
+
+Labeled Lists
+~~~~~~~~~~~~~
+Labeled list items consist of one or more text labels followed by the
+text of the list item.
+
+An item label begins a line with an alphanumeric character hard
+against the left margin and ends with two, three or four colons or two
+semi-colons. A list item can have multiple labels, one per line.
+
+The list item text consists of one or more lines of text starting
+after the last label (either on the same line or a new line) and can
+be followed by nested List or ListParagraph elements. Item text can be
+optionally indented.
+
+Here are some examples:
+
+---------------------------------------------------------------------
+In::
+Lorem::
+ Fusce euismod commodo velit.
+
+ Fusce euismod commodo velit.
+
+Ipsum:: Vivamus fringilla mi eu lacus.
+ * Vivamus fringilla mi eu lacus.
+ * Donec eget arcu bibendum nunc consequat lobortis.
+Dolor::
+ Donec eget arcu bibendum nunc consequat lobortis.
+ Suspendisse;;
+ A massa id sem aliquam auctor.
+ Morbi;;
+ Pretium nulla vel lorem.
+ In;;
+ Dictum mauris in urna.
+ Vivamus::: Fringilla mi eu lacus.
+ Donec::: Eget arcu bibendum nunc consequat lobortis.
+---------------------------------------------------------------------
+
+Which render as:
+
+In::
+Lorem::
+ Fusce euismod commodo velit.
+
+ Fusce euismod commodo velit.
+
+Ipsum:: Vivamus fringilla mi eu lacus.
+ * Vivamus fringilla mi eu lacus.
+ * Donec eget arcu bibendum nunc consequat lobortis.
+Dolor::
+ Donec eget arcu bibendum nunc consequat lobortis.
+ Suspendisse;;
+ A massa id sem aliquam auctor.
+ Morbi;;
+ Pretium nulla vel lorem.
+ In;;
+ Dictum mauris in urna.
+ Vivamus::: Fringilla mi eu lacus.
+ Donec::: Eget arcu bibendum nunc consequat lobortis.
+
+Horizontal labeled list style
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The 'horizontal' labeled list style (also the first positional
+attribute) places the list text side-by-side with the label instead of
+under the label. Here is an example:
+
+---------------------------------------------------------------------
+[horizontal]
+*Lorem*:: Fusce euismod commodo velit. Qui in magna commodo, est
+labitur dolorum an. Est ne magna primis adolescens.
+
+ Fusce euismod commodo velit.
+
+*Ipsum*:: Vivamus fringilla mi eu lacus.
+- Vivamus fringilla mi eu lacus.
+- Donec eget arcu bibendum nunc consequat lobortis.
+
+*Dolor*::
+ - Vivamus fringilla mi eu lacus.
+ - Donec eget arcu bibendum nunc consequat lobortis.
+
+---------------------------------------------------------------------
+
+Which render as:
+
+[horizontal]
+*Lorem*:: Fusce euismod commodo velit. Qui in magna commodo, est
+labitur dolorum an. Est ne magna primis adolescens.
+
+ Fusce euismod commodo velit.
+
+*Ipsum*:: Vivamus fringilla mi eu lacus.
+- Vivamus fringilla mi eu lacus.
+- Donec eget arcu bibendum nunc consequat lobortis.
+
+*Dolor*::
+ - Vivamus fringilla mi eu lacus.
+ - Donec eget arcu bibendum nunc consequat lobortis.
+
+[NOTE]
+=====================================================================
+- Current PDF toolchains do not make a good job of determining
+ the relative column widths for horizontal labeled lists.
+- Nested horizontal labeled lists will generate DocBook validation
+ errors because the 'DocBook XML V4.2' DTD does not permit nested
+ informal tables (although <<X13,DocBook XSL Stylesheets>> and
+ <<X31,dblatex>> process them correctly).
+- The label width can be set as a percentage of the total width by
+ setting the 'width' attribute e.g. `width="10%"`
+=====================================================================
+
+Question and Answer Lists
+~~~~~~~~~~~~~~~~~~~~~~~~~
+AsciiDoc comes pre-configured with a 'qanda' style labeled list for generating
+DocBook question and answer (Q&A) lists. Example:
+
+---------------------------------------------------------------------
+[qanda]
+Question one::
+ Answer one.
+Question two::
+ Answer two.
+---------------------------------------------------------------------
+
+Renders:
+
+[qanda]
+Question one::
+ Answer one.
+Question two::
+ Answer two.
+
+Glossary Lists
+~~~~~~~~~~~~~~
+AsciiDoc comes pre-configured with a 'glossary' style labeled list for
+generating DocBook glossary lists. Example:
+
+---------------------------------------------------------------------
+[glossary]
+A glossary term::
+ The corresponding definition.
+A second glossary term::
+ The corresponding definition.
+---------------------------------------------------------------------
+
+For working examples see the `article.txt` and `book.txt` documents in
+the AsciiDoc `./doc` distribution directory.
+
+NOTE: To generate valid DocBook output glossary lists must be located
+in a section that uses the 'glossary' <<X93,section markup template>>.
+
+Bibliography Lists
+~~~~~~~~~~~~~~~~~~
+AsciiDoc comes with a predefined 'bibliography' bulleted list style
+generating DocBook bibliography entries. Example:
+
+---------------------------------------------------------------------
+[bibliography]
+.Optional list title
+- [[[taoup]]] Eric Steven Raymond. 'The Art of UNIX
+ Programming'. Addison-Wesley. ISBN 0-13-142901-9.
+- [[[walsh-muellner]]] Norman Walsh & Leonard Muellner.
+ 'DocBook - The Definitive Guide'. O'Reilly & Associates.
+ 1999. ISBN 1-56592-580-7.
+---------------------------------------------------------------------
+
+The `[[[<reference>]]]` syntax is a bibliography entry anchor, it
+generates an anchor named `<reference>` and additionally displays
+`[<reference>]` at the anchor position. For example `[[[taoup]]]`
+generates an anchor named `taoup` that displays `[taoup]` at the
+anchor position. Cite the reference from elsewhere your document using
+`<<taoup>>`, this displays a hyperlink (`[taoup]`) to the
+corresponding bibliography entry anchor.
+
+For working examples see the `article.txt` and `book.txt` documents in
+the AsciiDoc `./doc` distribution directory.
+
+NOTE: To generate valid DocBook output bibliography lists must be
+located in a <<X93,bibliography section>>.
+
+[[X15]]
+List Item Continuation
+~~~~~~~~~~~~~~~~~~~~~~
+Another list or a literal paragraph immediately following a list item
+is implicitly appended to the list item; to append other block
+elements to a list item you need to explicitly join them to the list
+item with a 'list continuation' (a separator line containing a single
+plus character). Multiple block elements can be appended to a list
+item using list continuations (provided they are legal list item
+children in the backend markup).
+
+Here are some examples of list item continuations: list item one
+contains multiple continuations; list item two is continued with an
+<<X29,OpenBlock>> containing multiple elements:
+
+---------------------------------------------------------------------
+1. List item one.
++
+List item one continued with a second paragraph followed by an
+Indented block.
++
+.................
+$ ls *.sh
+$ mv *.sh ~/tmp
+.................
++
+List item continued with a third paragraph.
+
+2. List item two continued with an open block.
++
+--
+This paragraph is part of the preceding list item.
+
+a. This list is nested and does not require explicit item continuation.
++
+This paragraph is part of the preceding list item.
+
+b. List item b.
+
+This paragraph belongs to item two of the outer list.
+--
+---------------------------------------------------------------------
+
+Renders:
+
+1. List item one.
++
+List item one continued with a second paragraph followed by an
+Indented block.
++
+.................
+$ ls *.sh
+$ mv *.sh ~/tmp
+.................
++
+List item continued with a third paragraph.
+
+2. List item two continued with an open block.
++
+--
+This paragraph is part of the preceding list item.
+
+a. This list is nested and does not require explicit item continuation.
++
+This paragraph is part of the preceding list item.
+
+b. List item b.
+
+This paragraph belongs to item two of the outer list.
+--
+
+
+[[X92]]
+Footnotes
+---------
+The shipped AsciiDoc configuration includes three footnote inline
+macros:
+
+`footnote:[<text>]`::
+ Generates a footnote with text `<text>`.
+
+`footnoteref:[<id>,<text>]`::
+ Generates a footnote with a reference ID `<id>` and text `<text>`.
+
+`footnoteref:[<id>]`::
+ Generates a reference to the footnote with ID `<id>`.
+
+The footnote text can span multiple lines.
+
+The 'xhtml11' and 'html5' backends render footnotes dynamically using
+JavaScript; 'html4' outputs do not use JavaScript and leave the
+footnotes inline; 'docbook' footnotes are processed by the downstream
+DocBook toolchain.
+
+Example footnotes:
+
+ A footnote footnote:[An example footnote.];
+ a second footnote with a reference ID footnoteref:[note2,Second footnote.];
+ finally a reference to the second footnote footnoteref:[note2].
+
+Renders:
+
+A footnote footnote:[An example footnote.];
+a second footnote with a reference ID footnoteref:[note2,Second footnote.];
+finally a reference to the second footnote footnoteref:[note2].
+
+
+Indexes
+-------
+The shipped AsciiDoc configuration includes the inline macros for
+generating DocBook index entries.
+
+`indexterm:[<primary>,<secondary>,<tertiary>]`::
+`(((<primary>,<secondary>,<tertiary>)))`::
+ This inline macro generates an index term (the `<secondary>` and
+ `<tertiary>` positional attributes are optional). Example:
+ `indexterm:[Tigers,Big cats]` (or, using the alternative syntax
+ `(((Tigers,Big cats)))`. Index terms that have secondary and
+ tertiary entries also generate separate index terms for the
+ secondary and tertiary entries. The index terms appear in the
+ index, not the primary text flow.
+
+`indexterm2:[<primary>]`::
+`((<primary>))`::
+ This inline macro generates an index term that appears in both the
+ index and the primary text flow. The `<primary>` should not be
+ padded to the left or right with white space characters.
+
+For working examples see the `article.txt` and `book.txt` documents in
+the AsciiDoc `./doc` distribution directory.
+
+NOTE: Index entries only really make sense if you are generating
+DocBook markup -- DocBook conversion programs automatically generate
+an index at the point an 'Index' section appears in source document.
+
+
+[[X105]]
+Callouts
+--------
+Callouts are a mechanism for annotating verbatim text (for example:
+source code, computer output and user input). Callout markers are
+placed inside the annotated text while the actual annotations are
+presented in a callout list after the annotated text. Here's an
+example:
+
+---------------------------------------------------------------------
+ .MS-DOS directory listing
+ -----------------------------------------------------
+ 10/17/97 9:04 <DIR> bin
+ 10/16/97 14:11 <DIR> DOS \<1>
+ 10/16/97 14:40 <DIR> Program Files
+ 10/16/97 14:46 <DIR> TEMP
+ 10/17/97 9:04 <DIR> tmp
+ 10/16/97 14:37 <DIR> WINNT
+ 10/16/97 14:25 119 AUTOEXEC.BAT \<2>
+ 2/13/94 6:21 54,619 COMMAND.COM \<2>
+ 10/16/97 14:25 115 CONFIG.SYS \<2>
+ 11/16/97 17:17 61,865,984 pagefile.sys
+ 2/13/94 6:21 9,349 WINA20.386 \<3>
+ -----------------------------------------------------
+
+ \<1> This directory holds MS-DOS.
+ \<2> System startup code for DOS.
+ \<3> Some sort of Windows 3.1 hack.
+---------------------------------------------------------------------
+
+Which renders:
+
+.MS-DOS directory listing
+-----------------------------------------------------
+10/17/97 9:04 <DIR> bin
+10/16/97 14:11 <DIR> DOS <1>
+10/16/97 14:40 <DIR> Program Files
+10/16/97 14:46 <DIR> TEMP
+10/17/97 9:04 <DIR> tmp
+10/16/97 14:37 <DIR> WINNT
+10/16/97 14:25 119 AUTOEXEC.BAT <2>
+ 2/13/94 6:21 54,619 COMMAND.COM <2>
+10/16/97 14:25 115 CONFIG.SYS <2>
+11/16/97 17:17 61,865,984 pagefile.sys
+ 2/13/94 6:21 9,349 WINA20.386 <3>
+-----------------------------------------------------
+
+<1> This directory holds MS-DOS.
+<2> System startup code for DOS.
+<3> Some sort of Windows 3.1 hack.
+
+.Explanation
+- The callout marks are whole numbers enclosed in angle brackets --
+ they refer to the correspondingly numbered item in the following
+ callout list.
+- By default callout marks are confined to 'LiteralParagraphs',
+ 'LiteralBlocks' and 'ListingBlocks' (although this is a
+ configuration file option and can be changed).
+- Callout list item numbering is fairly relaxed -- list items can
+ start with `<n>`, `n>` or `>` where `n` is the optional list item
+ number (in the latter case list items starting with a single `>`
+ character are implicitly numbered starting at one).
+- Callout lists should not be nested.
+- Callout lists start list items hard against the left margin.
+- If you want to present a number inside angle brackets you'll need to
+ escape it with a backslash to prevent it being interpreted as a
+ callout mark.
+
+NOTE: Define the AsciiDoc 'icons' attribute (for example using the `-a
+icons` command-line option) to display callout icons.
+
+Implementation Notes
+~~~~~~~~~~~~~~~~~~~~
+Callout marks are generated by the 'callout' inline macro while
+callout lists are generated using the 'callout' list definition. The
+'callout' macro and 'callout' list are special in that they work
+together. The 'callout' inline macro is not enabled by the normal
+'macros' substitutions option, instead it has its own 'callouts'
+substitution option.
+
+The following attributes are available during inline callout macro
+substitution:
+
+`{index}`::
+ The callout list item index inside the angle brackets.
+`{coid}`::
+ An identifier formatted like `CO<listnumber>-<index>` that
+ uniquely identifies the callout mark. For example `CO2-4`
+ identifies the fourth callout mark in the second set of callout
+ marks.
+
+The `{coids}` attribute can be used during callout list item
+substitution -- it is a space delimited list of callout IDs that refer
+to the explanatory list item.
+
+Including callouts in included code
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+You can annotate working code examples with callouts -- just remember
+to put the callouts inside source code comments. This example displays
+the `test.py` source file (containing a single callout) using the
+'source' (code highlighter) filter:
+
+.AsciiDoc source
+---------------------------------------------------------------------
+ [source,python]
+ -------------------------------------------
+ \include::test.py[]
+ -------------------------------------------
+
+ \<1> Print statement.
+---------------------------------------------------------------------
+
+.Included `test.py` source
+---------------------------------------------------------------------
+print 'Hello World!' # \<1>
+---------------------------------------------------------------------
+
+
+Macros
+------
+Macros are a mechanism for substituting parametrized text into output
+documents.
+
+Macros have a 'name', a single 'target' argument and an 'attribute
+list'. The usual syntax is `<name>:<target>[<attrlist>]` (for
+inline macros) and `<name>::<target>[<attrlist>]` (for block
+macros). Here are some examples:
+
+ http://www.docbook.org/[DocBook.org]
+ include::chapt1.txt[tabsize=2]
+ mailto:srackham@gmail.com[]
+
+.Macro behavior
+- `<name>` is the macro name. It can only contain letters, digits or
+ dash characters and cannot start with a dash.
+- The optional `<target>` cannot contain white space characters.
+- `<attrlist>` is a <<X21,list of attributes>> enclosed in square
+ brackets.
+- `]` characters inside attribute lists must be escaped with a
+ backslash.
+- Expansion of macro references can normally be escaped by prefixing a
+ backslash character (see the AsciiDoc 'FAQ' for examples of
+ exceptions to this rule).
+- Attribute references in block macros are expanded.
+- The substitutions performed prior to Inline macro macro expansion
+ are determined by the inline context.
+- Macros are processed in the order they appear in the configuration
+ file(s).
+- Calls to inline macros can be nested inside different inline macros
+ (an inline macro call cannot contain a nested call to itself).
+- In addition to `<name>`, `<target>` and `<attrlist>` the
+ `<passtext>` and `<subslist>` named groups are available to
+ <<X77,passthrough macros>>. A macro is a passthrough macro if the
+ definition includes a `<passtext>` named group.
+
+Inline Macros
+~~~~~~~~~~~~~
+Inline Macros occur in an inline element context. Predefined Inline
+macros include 'URLs', 'image' and 'link' macros.
+
+URLs
+^^^^
+'http', 'https', 'ftp', 'file', 'mailto' and 'callto' URLs are
+rendered using predefined inline macros.
+
+- If you don't need a custom link caption you can enter the 'http',
+ 'https', 'ftp', 'file' URLs and email addresses without any special
+ macro syntax.
+- If the `<attrlist>` is empty the URL is displayed.
+
+Here are some examples:
+
+ http://www.docbook.org/[DocBook.org]
+ http://www.docbook.org/
+ mailto:joe.bloggs@foobar.com[email Joe Bloggs]
+ joe.bloggs@foobar.com
+
+Which are rendered:
+
+http://www.docbook.org/[DocBook.org]
+
+http://www.docbook.org/
+
+mailto:joe.bloggs@foobar.com[email Joe Bloggs]
+
+joe.bloggs@foobar.com
+
+If the `<target>` necessitates space characters use `%20`, for example
+`large%20image.png`.
+
+Internal Cross References
+^^^^^^^^^^^^^^^^^^^^^^^^^
+Two AsciiDoc inline macros are provided for creating hypertext links
+within an AsciiDoc document. You can use either the standard macro
+syntax or the (preferred) alternative.
+
+[[X30]]
+anchor
+++++++
+Used to specify hypertext link targets:
+
+ [[<id>,<xreflabel>]]
+ anchor:<id>[<xreflabel>]
+
+The `<id>` is a unique string that conforms to the output markup's
+anchor syntax. The optional `<xreflabel>` is the text to be displayed
+by captionless 'xref' macros that refer to this anchor. The optional
+`<xreflabel>` is only really useful when generating DocBook output.
+Example anchor:
+
+ [[X1]]
+
+You may have noticed that the syntax of this inline element is the
+same as that of the <<X41,BlockId block element>>, this is no
+coincidence since they are functionally equivalent.
+
+xref
+++++
+Creates a hypertext link to a document anchor.
+
+ <<<id>,<caption>>>
+ xref:<id>[<caption>]
+
+The `<id>` refers to an anchor ID. The optional `<caption>` is the
+link's displayed text. Example:
+
+ <<X21,attribute lists>>
+
+If `<caption>` is not specified then the displayed text is
+auto-generated:
+
+- The AsciiDoc 'xhtml11' and 'html5' backends display the `<id>`
+ enclosed in square brackets.
+- If DocBook is produced the DocBook toolchain is responsible for the
+ displayed text which will normally be the referenced figure, table
+ or section title number followed by the element's title text.
+
+Here is an example:
+
+---------------------------------------------------------------------
+[[tiger_image]]
+.Tyger tyger
+image::tiger.png[]
+
+This can be seen in <<tiger_image>>.
+---------------------------------------------------------------------
+
+Linking to Local Documents
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+Hypertext links to files on the local file system are specified using
+the 'link' inline macro.
+
+ link:<target>[<caption>]
+
+The 'link' macro generates relative URLs. The link macro `<target>` is
+the target file name (relative to the file system location of the
+referring document). The optional `<caption>` is the link's displayed
+text. If `<caption>` is not specified then `<target>` is displayed.
+Example:
+
+ link:downloads/foo.zip[download foo.zip]
+
+You can use the `<filename>#<id>` syntax to refer to an anchor within
+a target document but this usually only makes sense when targeting
+HTML documents.
+
+[[X9]]
+Images
+^^^^^^
+Inline images are inserted into the output document using the 'image'
+macro. The inline syntax is:
+
+ image:<target>[<attributes>]
+
+The contents of the image file `<target>` is displayed. To display the
+image its file format must be supported by the target backend
+application. HTML and DocBook applications normally support PNG or JPG
+files.
+
+`<target>` file name paths are relative to the location of the
+referring document.
+
+[[X55]]
+.Image macro attributes
+- The optional 'alt' attribute is also the first positional attribute,
+ it specifies alternative text which is displayed if the output
+ application is unable to display the image file (see also
+ http://htmlhelp.com/feature/art3.htm[Use of ALT texts in IMGs]). For
+ example:
+
+ image:images/logo.png[Company Logo]
+
+- The optional 'title' attribute provides a title for the image. The
+ <<X49,block image macro>> renders the title alongside the image.
+ The inline image macro displays the title as a popup ``tooltip'' in
+ visual browsers (AsciiDoc HTML outputs only).
+
+- The optional `width` and `height` attributes scale the image size
+ and can be used in any combination. The units are pixels. The
+ following example scales the previous example to a height of 32
+ pixels:
+
+ image:images/logo.png["Company Logo",height=32]
+
+- The optional `link` attribute is used to link the image to an
+ external document. The following example links a screenshot
+ thumbnail to a full size version:
+
+ image:screen-thumbnail.png[height=32,link="screen.png"]
+
+- The optional `scaledwidth` attribute is only used in DocBook block
+ images (specifically for PDF documents). The following example
+ scales the images to 75% of the available print width:
+
+ image::images/logo.png[scaledwidth="75%",alt="Company Logo"]
+
+- The image `scale` attribute sets the DocBook `imagedata` element
+ `scale` attribute.
+
+- The optional `align` attribute is used for horizontal image
+ alignment. Allowed values are `center`, `left` and `right`. For
+ example:
+
+ image::images/tiger.png["Tiger image",align="left"]
+
+- The optional `float` attribute floats the image `left` or `right` on
+ the page (works with HTML outputs only, has no effect on DocBook
+ outputs). `float` and `align` attributes are mutually exclusive.
+ Use the `unfloat::[]` block macro to stop floating.
+
+Comment Lines
+^^^^^^^^^^^^^
+See <<X25,comment block macro>>.
+
+Block Macros
+~~~~~~~~~~~~
+A Block macro reference must be contained in a single line separated
+either side by a blank line or a block delimiter.
+
+Block macros behave just like Inline macros, with the following
+differences:
+
+- They occur in a block context.
+- The default syntax is `<name>::<target>[<attrlist>]` (two
+ colons, not one).
+- Markup template section names end in `-blockmacro` instead of
+ `-inlinemacro`.
+
+Block Identifier
+^^^^^^^^^^^^^^^^
+The Block Identifier macro sets the `id` attribute and has the same
+syntax as the <<X30,anchor inline macro>> since it performs
+essentially the same function -- block templates use the `id`
+attribute as a block element ID. For example:
+
+ [[X30]]
+
+This is equivalent to the `[id="X30"]` <<X79,AttributeList element>>).
+
+[[X49]]
+Images
+^^^^^^
+The 'image' block macro is used to display images in a block context.
+The syntax is:
+
+ image::<target>[<attributes>]
+
+The block `image` macro has the same <<X55,macro attributes>> as it's
+<<X9,inline image macro>> counterpart.
+
+Block images can be titled by preceding the 'image' macro with a
+'BlockTitle'. DocBook toolchains normally number titled block images
+and optionally list them in an automatically generated 'List of
+Figures' backmatter section.
+
+This example:
+
+ .Main circuit board
+ image::images/layout.png[J14P main circuit board]
+
+is equivalent to:
+
+ image::images/layout.png["J14P main circuit board",
+ title="Main circuit board"]
+
+A title prefix that can be inserted with the `caption` attribute
+(HTML backends). For example:
+
+ .Main circuit board
+ [caption="Figure 2: "]
+ image::images/layout.png[J14P main circuit board]
+
+[[X66]]
+.Embedding images in XHTML documents
+*********************************************************************
+If you define the `data-uri` attribute then images will be embedded in
+XHTML outputs using the
+http://en.wikipedia.org/wiki/Data:_URI_scheme[data URI scheme]. You
+can use the 'data-uri' attribute with the 'xhtml11' and 'html5'
+backends to produce single-file XHTML documents with embedded images
+and CSS, for example:
+
+ $ asciidoc -a data-uri mydocument.txt
+
+[NOTE]
+======
+- All current popular browsers support data URIs, although versions
+ of Internet Explorer prior to version 8 do not.
+- Some browsers limit the size of data URIs.
+======
+*********************************************************************
+
+[[X25]]
+Comment Lines
+^^^^^^^^^^^^^
+Single lines starting with two forward slashes hard up against the
+left margin are treated as comments. Comment lines do not appear in
+the output unless the 'showcomments' attribute is defined. Comment
+lines have been implemented as both block and inline macros so a
+comment line can appear as a stand-alone block or within block elements
+that support inline macro expansion. Example comment line:
+
+ // This is a comment.
+
+If the 'showcomments' attribute is defined comment lines are written
+to the output:
+
+- In DocBook the comment lines are enclosed by the 'remark' element
+ (which may or may not be rendered by your toolchain).
+- The 'showcomments' attribute does not expose <<X26,Comment Blocks>>.
+ Comment Blocks are never passed to the output.
+
+System Macros
+~~~~~~~~~~~~~
+System macros are block macros that perform a predefined task and are
+hardwired into the asciidoc(1) program.
+
+- You can escape system macros with a leading backslash character
+ (as you can with other macros).
+- The syntax and tasks performed by system macros is built into
+ asciidoc(1) so they don't appear in configuration files. You can
+ however customize the syntax by adding entries to a configuration
+ file `[macros]` section.
+
+[[X63]]
+Include Macros
+^^^^^^^^^^^^^^
+The `include` and `include1` system macros to include the contents of
+a named file into the source document.
+
+The `include` macro includes a file as if it were part of the parent
+document -- tabs are expanded and system macros processed. The
+contents of `include1` files are not subject to tab expansion or
+system macro processing nor are attribute or lower priority
+substitutions performed. The `include1` macro's intended use is to
+include verbatim embedded CSS or scripts into configuration file
+headers. Example:
+
+------------------------------------
+\include::chapter1.txt[tabsize=4]
+------------------------------------
+
+.Include macro behavior
+- If the included file name is specified with a relative path then the
+ path is relative to the location of the referring document.
+- Include macros can appear inside configuration files.
+- Files included from within 'DelimitedBlocks' are read to completion
+ to avoid false end-of-block underline termination.
+- Attribute references are expanded inside the include 'target'; if an
+ attribute is undefined then the included file is silently skipped.
+- The 'tabsize' macro attribute sets the number of space characters to
+ be used for tab expansion in the included file (not applicable to
+ `include1` macro).
+- The 'depth' macro attribute sets the maximum permitted number of
+ subsequent nested includes (not applicable to `include1` macro which
+ does not process nested includes). Setting 'depth' to '1' disables
+ nesting inside the included file. By default, nesting is limited to
+ a depth of ten.
+- If the he 'warnings' attribute is set to 'False' (or any other
+ Python literal that evaluates to boolean false) then no warning
+ message is printed if the included file does not exist. By default
+ 'warnings' are enabled.
+- Internally the `include1` macro is translated to the `include1`
+ system attribute which means it must be evaluated in a region where
+ attribute substitution is enabled. To inhibit nested substitution in
+ included files it is preferable to use the `include` macro and set
+ the attribute `depth=1`.
+
+Conditional Inclusion Macros
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Lines of text in the source document can be selectively included or
+excluded from processing based on the existence (or not) of a document
+attribute.
+
+Document text between the `ifdef` and `endif` macros is included if a
+document attribute is defined:
+
+ ifdef::<attribute>[]
+ :
+ endif::<attribute>[]
+
+Document text between the `ifndef` and `endif` macros is not included
+if a document attribute is defined:
+
+ ifndef::<attribute>[]
+ :
+ endif::<attribute>[]
+
+`<attribute>` is an attribute name which is optional in the trailing
+`endif` macro.
+
+If you only want to process a single line of text then the text can be
+put inside the square brackets and the `endif` macro omitted, for
+example:
+
+ ifdef::revnumber[Version number 42]
+
+Is equivalent to:
+
+ ifdef::revnumber[]
+ Version number 42
+ endif::revnumber[]
+
+'ifdef' and 'ifndef' macros also accept multiple attribute names:
+
+- Multiple ',' separated attribute names evaluate to defined if one
+ or more of the attributes is defined, otherwise it's value is
+ undefined.
+- Multiple '+' separated attribute names evaluate to defined if all
+ of the attributes is defined, otherwise it's value is undefined.
+
+Document text between the `ifeval` and `endif` macros is included if
+the Python expression inside the square brackets is true. Example:
+
+ ifeval::[{rs458}==2]
+ :
+ endif::[]
+
+- Document attribute references are expanded before the expression is
+ evaluated.
+- If an attribute reference is undefined then the expression is
+ considered false.
+
+Take a look at the `*.conf` configuration files in the AsciiDoc
+distribution for examples of conditional inclusion macro usage.
+
+Executable system macros
+^^^^^^^^^^^^^^^^^^^^^^^^
+The 'eval', 'sys' and 'sys2' block macros exhibit the same behavior as
+their same named <<X24, system attribute references>>. The difference
+is that system macros occur in a block macro context whereas system
+attributes are confined to inline contexts where attribute
+substitution is enabled.
+
+The following example displays a long directory listing inside a
+literal block:
+
+ ------------------
+ sys::[ls -l *.txt]
+ ------------------
+
+NOTE: There are no block macro versions of the 'eval3' and 'sys3'
+system attributes.
+
+Template System Macro
+^^^^^^^^^^^^^^^^^^^^^
+The `template` block macro allows the inclusion of one configuration
+file template section within another. The following example includes
+the `[admonitionblock]` section in the `[admonitionparagraph]`
+section:
+
+ [admonitionparagraph]
+ template::[admonitionblock]
+
+.Template macro behavior
+- The `template::[]` macro is useful for factoring configuration file
+ markup.
+- `template::[]` macros cannot be nested.
+- `template::[]` macro expansion is applied after all configuration
+ files have been read.
+
+
+[[X77]]
+Passthrough macros
+~~~~~~~~~~~~~~~~~~
+Passthrough macros are analogous to <<X76,passthrough blocks>> and are
+used to pass text directly to the output. The substitution performed
+on the text is determined by the macro definition but can be overridden
+by the `<subslist>`. The usual syntax is
+`<name>:<subslist>[<passtext>]` (for inline macros) and
+`<name>::<subslist>[<passtext>]` (for block macros). Passthroughs, by
+definition, take precedence over all other text substitutions.
+
+pass::
+ Inline and block. Passes text unmodified (apart from explicitly
+ specified substitutions). Examples:
+
+ pass:[<q>To be or not to be</q>]
+ pass:attributes,quotes[<u>the '{author}'</u>]
+
+asciimath, latexmath::
+ Inline and block. Passes text unmodified. Used for
+ <<X78,mathematical formulas>>.
+
+\+++::
+ Inline and block. The triple-plus passthrough is functionally
+ identical to the 'pass' macro but you don't have to escape `]`
+ characters and you can prefix with quoted attributes in the inline
+ version. Example:
+
+ Red [red]+++`sum_(i=1)\^n i=(n(n+1))/2`$+++ AsciiMathML formula
+
+$$::
+ Inline and block. The double-dollar passthrough is functionally
+ identical to the triple-plus passthrough with one exception: special
+ characters are escaped. Example:
+
+ $$`[[a,b],[c,d]]((n),(k))`$$
+
+[[X80]]`::
+ Text quoted with single backtick characters constitutes an 'inline
+ literal' passthrough. The enclosed text is rendered in a monospaced
+ font and is only subject to special character substitution. This
+ makes sense since monospace text is usually intended to be rendered
+ literally and often contains characters that would otherwise have to
+ be escaped. If you need monospaced text containing inline
+ substitutions use a <<X81,plus character instead of a backtick>>.
+
+Macro Definitions
+~~~~~~~~~~~~~~~~~
+Each entry in the configuration `[macros]` section is a macro
+definition which can take one of the following forms:
+
+`<pattern>=<name>[<subslist]`:: Inline macro definition.
+`<pattern>=#<name>[<subslist]`:: Block macro definition.
+`<pattern>=+<name>[<subslist]`:: System macro definition.
+`<pattern>`:: Delete the existing macro with this `<pattern>`.
+
+`<pattern>` is a Python regular expression and `<name>` is the name of
+a markup template. If `<name>` is omitted then it is the value of the
+regular expression match group named 'name'. The optional
+`[<subslist]` is a comma-separated list of substitution names enclosed
+in `[]` brackets, it sets the default substitutions for passthrough
+text, if omitted then no passthrough substitutions are performed.
+
+.Pattern named groups
+The following named groups can be used in macro `<pattern>` regular
+expressions and are available as markup template attributes:
+
+name::
+ The macro name.
+
+target::
+ The macro target.
+
+attrlist::
+ The macro attribute list.
+
+passtext::
+ Contents of this group are passed unmodified to the output subject
+ only to 'subslist' substitutions.
+
+subslist::
+ Processed as a comma-separated list of substitution names for
+ 'passtext' substitution, overrides the the macro definition
+ 'subslist'.
+
+.Here's what happens during macro substitution
+- Each contextually relevant macro 'pattern' from the `[macros]`
+ section is matched against the input source line.
+- If a match is found the text to be substituted is loaded from a
+ configuration markup template section named like
+ `<name>-inlinemacro` or `<name>-blockmacro` (depending on the macro
+ type).
+- Global and macro attribute list attributes are substituted in the
+ macro's markup template.
+- The substituted template replaces the macro reference in the output
+ document.
+
+
+[[X98]]
+HTML 5 audio and video block macros
+-----------------------------------
+The 'html5' backend 'audio' and 'video' block macros generate the HTML
+5 'audio' and 'video' elements respectively. They follow the usual
+AsciiDoc block macro syntax `<name>::<target>[<attrlist>]` where:
+
+[horizontal]
+`<name>`:: 'audio' or 'video'.
+`<target>`:: The URL or file name of the video or audio file.
+`<attrlist>`:: A list of named attributes (see below).
+
+.Audio macro attributes
+[options="header",cols="1,5",frame="topbot"]
+|====================================================================
+|Name | Value
+|options
+|A comma separated list of one or more of the following items:
+'autoplay', 'loop' which correspond to the same-named HTML 5 'audio'
+element boolean attributes. By default the player 'controls' are
+enabled, include the 'nocontrols' option value to hide them.
+|====================================================================
+
+.Video macro attributes
+[options="header",cols="1,5",frame="topbot"]
+|====================================================================
+|Name | Value
+|height | The height of the player in pixels.
+|width | The width of the player in pixels.
+|poster | The URL or file name of an image representing the video.
+|options
+|A comma separated list of one or more of the following items:
+'autoplay', 'loop' and 'nocontrols'. The 'autoplay' and 'loop' options
+correspond to the same-named HTML 5 'video' element boolean
+attributes. By default the player 'controls' are enabled, include the
+'nocontrols' option value to hide them.
+|====================================================================
+
+Examples:
+
+---------------------------------------------------------------------
+audio::images/example.ogg[]
+
+video::gizmo.ogv[width=200,options="nocontrols,autoplay"]
+
+.Example video
+video::gizmo.ogv[]
+
+video::http://www.808.dk/pics/video/gizmo.ogv[]
+---------------------------------------------------------------------
+
+If your needs are more complex put raw HTML 5 in a markup block, for
+example (from http://www.808.dk/?code-html-5-video):
+
+---------------------------------------------------------------------
+++++
+<video poster="pics/video/gizmo.jpg" id="video" style="cursor: pointer;" >
+ <source src="pics/video/gizmo.mp4" />
+ <source src="pics/video/gizmo.webm" type="video/webm" />
+ <source src="pics/video/gizmo.ogv" type="video/ogg" />
+ Video not playing? <a href="pics/video/gizmo.mp4">Download file</a> instead.
+</video>
+
+<script type="text/javascript">
+ var video = document.getElementById('video');
+ video.addEventListener('click',function(){
+ video.play();
+ },false);
+</script>
+++++
+---------------------------------------------------------------------
+
+
+Tables
+------
+The AsciiDoc table syntax looks and behaves like other delimited block
+types and supports standard <<X73,block configuration entries>>.
+Formatting is easy to read and, just as importantly, easy to enter.
+
+- Cells and columns can be formatted using built-in customizable styles.
+- Horizontal and vertical cell alignment can be set on columns and
+ cell.
+- Horizontal and vertical cell spanning is supported.
+
+.Use tables sparingly
+*********************************************************************
+When technical users first start creating documents, tables (complete
+with column spanning and table nesting) are often considered very
+important. The reality is that tables are seldom used, even in
+technical documentation.
+
+Try this exercise: thumb through your library of technical books,
+you'll be surprised just how seldom tables are actually used, even
+less seldom are tables containing block elements (such as paragraphs
+or lists) or spanned cells. This is no accident, like figures, tables
+are outside the normal document flow -- tables are for consulting not
+for reading.
+
+Tables are designed for, and should normally only be used for,
+displaying column oriented tabular data.
+*********************************************************************
+
+Example tables
+~~~~~~~~~~~~~~
+
+.Simple table
+[width="15%"]
+|=======
+|1 |2 |A
+|3 |4 |B
+|5 |6 |C
+|=======
+
+.AsciiDoc source
+---------------------------------------------------------------------
+[width="15%"]
+|=======
+|1 |2 |A
+|3 |4 |B
+|5 |6 |C
+|=======
+---------------------------------------------------------------------
+
+.Columns formatted with strong, monospaced and emphasis styles
+[width="50%",cols=">s,^m,e",frame="topbot",options="header,footer"]
+|==========================
+| 2+|Columns 2 and 3
+|1 |Item 1 |Item 1
+|2 |Item 2 |Item 2
+|3 |Item 3 |Item 3
+|4 |Item 4 |Item 4
+|footer 1|footer 2|footer 3
+|==========================
+
+.AsciiDoc source
+---------------------------------------------------------------------
+.An example table
+[width="50%",cols=">s,^m,e",frame="topbot",options="header,footer"]
+|==========================
+| 2+|Columns 2 and 3
+|1 |Item 1 |Item 1
+|2 |Item 2 |Item 2
+|3 |Item 3 |Item 3
+|4 |Item 4 |Item 4
+|footer 1|footer 2|footer 3
+|==========================
+---------------------------------------------------------------------
+
+.Horizontal and vertical source data
+[width="80%",cols="3,^2,^2,10",options="header"]
+|=========================================================
+|Date |Duration |Avg HR |Notes
+
+|22-Aug-08 |10:24 | 157 |
+Worked out MSHR (max sustainable heart rate) by going hard
+for this interval.
+
+|22-Aug-08 |23:03 | 152 |
+Back-to-back with previous interval.
+
+|24-Aug-08 |40:00 | 145 |
+Moderately hard interspersed with 3x 3min intervals (2min
+hard + 1min really hard taking the HR up to 160).
+
+|=========================================================
+
+Short cells can be entered horizontally, longer cells vertically. The
+default behavior is to strip leading and trailing blank lines within a
+cell. These characteristics aid readability and data entry.
+
+.AsciiDoc source
+---------------------------------------------------------------------
+.Windtrainer workouts
+[width="80%",cols="3,^2,^2,10",options="header"]
+|=========================================================
+|Date |Duration |Avg HR |Notes
+
+|22-Aug-08 |10:24 | 157 |
+Worked out MSHR (max sustainable heart rate) by going hard
+for this interval.
+
+|22-Aug-08 |23:03 | 152 |
+Back-to-back with previous interval.
+
+|24-Aug-08 |40:00 | 145 |
+Moderately hard interspersed with 3x 3min intervals (2min
+hard + 1min really hard taking the HR up to 160).
+
+|=========================================================
+---------------------------------------------------------------------
+
+.A table with externally sourced CSV data
+[format="csv",cols="^1,4*2",options="header"]
+|===================================================
+ID,Customer Name,Contact Name,Customer Address,Phone
+include::customers.csv[]
+|===================================================
+
+.AsciiDoc source
+---------------------------------------------------------------------
+[format="csv",cols="^1,4*2",options="header"]
+|===================================================
+ID,Customer Name,Contact Name,Customer Address,Phone
+\include::customers.csv[]
+|===================================================
+---------------------------------------------------------------------
+
+
+.Cell spans, alignments and styles
+[cols="e,m,^,>s",width="25%"]
+|============================
+|1 >s|2 |3 |4
+^|5 2.2+^.^|6 .3+<.>m|7
+^|8
+|9 2+>|10
+|============================
+
+.AsciiDoc source
+---------------------------------------------------------------------
+[cols="e,m,^,>s",width="25%"]
+|============================
+|1 >s|2 |3 |4
+^|5 2.2+^.^|6 .3+<.>m|7
+^|8
+|9 2+>|10
+|============================
+---------------------------------------------------------------------
+
+[[X68]]
+Table input data formats
+~~~~~~~~~~~~~~~~~~~~~~~~
+AsciiDoc table data can be 'psv', 'dsv' or 'csv' formatted. The
+default table format is 'psv'.
+
+AsciiDoc 'psv' ('Prefix Separated Values') and 'dsv' ('Delimiter
+Separated Values') formats are cell oriented -- the table is treated
+as a sequence of cells -- there are no explicit row separators.
+
+- 'psv' prefixes each cell with a separator whereas 'dsv' delimits
+ cells with a separator.
+- 'psv' and 'dsv' separators are Python regular expressions.
+- The default 'psv' separator contains <<X84, cell specifier>> related
+ named regular expression groups.
+- The default 'dsv' separator is `:|\n` (a colon or a new line
+ character).
+- 'psv' and 'dsv' cell separators can be escaped by preceding them
+ with a backslash character.
+
+Here are four 'psv' cells (the second item spans two columns; the
+last contains an escaped separator):
+
+ |One 2+|Two and three |A \| separator character
+
+'csv' is the quasi-standard row oriented 'Comma Separated Values
+(CSV)' format commonly used to import and export spreadsheet and
+database data.
+
+[[X69]]
+Table attributes
+~~~~~~~~~~~~~~~~
+Tables can be customized by the following attributes:
+
+format::
+'psv' (default), 'dsv' or 'csv' (See <<X68, Table Data Formats>>).
+
+separator::
+The cell separator. A Python regular expression ('psv' and 'dsv'
+formats) or a single character ('csv' format).
+
+frame::
+Defines the table border and can take the following values: 'topbot'
+(top and bottom), 'all' (all sides), 'none' and 'sides' (left and
+right sides). The default value is 'all'.
+
+grid::
+Defines which ruler lines are drawn between table rows and columns.
+The 'grid' attribute value can be any of the following values: 'none',
+'cols', 'rows' and 'all'. The default value is 'all'.
+
+align::
+Use the 'align' attribute to horizontally align the table on the
+page (works with HTML outputs only, has no effect on DocBook outputs).
+The following values are valid: 'left', 'right', and 'center'.
+
+float::
+Use the 'float' attribute to float the table 'left' or 'right' on the
+page (works with HTML outputs only, has no effect on DocBook outputs).
+Floating only makes sense in conjunction with a table 'width'
+attribute value of less than 100% (otherwise the table will take up
+all the available space). 'float' and 'align' attributes are mutually
+exclusive. Use the `unfloat::[]` block macro to stop floating.
+
+halign::
+Use the 'halign' attribute to horizontally align all cells in a table.
+The following values are valid: 'left', 'right', and 'center'
+(defaults to 'left'). Overridden by <<X70,Column specifiers>> and
+<<X84,Cell specifiers>>.
+
+valign::
+Use the 'valign' attribute to vertically align all cells in a table.
+The following values are valid: 'top', 'bottom', and 'middle'
+(defaults to 'top'). Overridden by <<X70,Column specifiers>> and
+<<X84,Cell specifiers>>.
+
+options::
+The 'options' attribute can contain comma separated values, for
+example: 'header', 'footer'. By default header and footer rows are
+omitted. See <<X74,attribute options>> for a complete list of
+available table options.
+
+cols::
+The 'cols' attribute is a comma separated list of <<X70,column
+specifiers>>. For example `cols="2<p,2*,4p,>"`.
+
+- If 'cols' is present it must specify all columns.
+- If the 'cols' attribute is not specified the number of columns is
+ calculated as the number of data items in the *first line* of the
+ table.
+- The degenerate form for the 'cols' attribute is an integer
+ specifying the number of columns e.g. `cols=4`.
+
+width::
+The 'width' attribute is expressed as a percentage value
+('"1%"'...'"99%"'). The width specifies the table width relative to
+the available width. HTML backends use this value to set the table
+width attribute. It's a bit more complicated with DocBook, see the
+<<X89,DocBook table widths>> sidebar.
+
+filter::
+The 'filter' attribute defines an external shell command that is
+invoked for each cell. The built-in 'asciidoc' table style is
+implemented using a filter.
+
+[[X89]]
+.DocBook table widths
+**********************************************************************
+The AsciiDoc docbook backend generates CALS tables. CALS tables do not
+support a table width attribute -- table width can only be controlled
+by specifying absolute column widths.
+
+Specifying absolute column widths is not media independent because
+different presentation media have different physical dimensions. To
+get round this limitation both
+http://www.sagehill.net/docbookxsl/Tables.html#TableWidth[DocBook XSL
+Stylesheets] and
+http://dblatex.sourceforge.net/doc/manual/ch03s05.html#sec-table-width[dblatex]
+have implemented table width processing instructions for setting the
+table width as a percentage of the available width. AsciiDoc emits
+these processing instructions if the 'width' attribute is set along
+with proportional column widths (the AsciiDoc docbook backend
+'pageunits' attribute defaults to '*').
+
+To generate DocBook tables with absolute column widths set the
+'pageunits' attribute to a CALS absolute unit such as 'pt' and set the
+'pagewidth' attribute to match the width of the presentation media.
+**********************************************************************
+
+[[X70]]
+Column Specifiers
+~~~~~~~~~~~~~~~~~
+Column specifiers define how columns are rendered and appear in the
+table <<X69,cols attribute>>. A column specifier consists of an
+optional column multiplier followed by optional alignment, width and
+style values and is formatted like:
+
+ [<multiplier>*][<align>][<width>][<style>]
+
+- All components are optional. The multiplier must be first and the
+ style last. The order of `<align>` or `<width>` is not important.
+- Column `<width>` can be either an integer proportional value (1...)
+ or a percentage (1%...100%). The default value is 1. To ensure
+ portability across different backends, there is no provision for
+ absolute column widths (not to be confused with output column width
+ <<X72,markup attributes>> which are available in both percentage and
+ absolute units).
+- The '<align>' column alignment specifier is formatted like:
+
+ [<horizontal>][.<vertical>]
++
+Where `<horizontal>` and `<vertical>` are one of the following
+characters: `<`, `^` or `>` which represent 'left', 'center' and
+'right' horizontal alignment or 'top', 'middle' and 'bottom' vertical
+alignment respectively.
+
+- A `<multiplier>` can be used to specify repeated columns e.g.
+ `cols="4*<"` specifies four left-justified columns. The default
+ multiplier value is 1.
+- The `<style>` name specifies a <<X71,table style>> to used to markup
+ column cells (you can use the full style names if you wish but the
+ first letter is normally sufficient).
+- Column specific styles are not applied to header rows.
+
+[[X84]]
+Cell Specifiers
+~~~~~~~~~~~~~~~
+Cell specifiers allow individual cells in 'psv' formatted tables to be
+spanned, multiplied, aligned and styled. Cell specifiers prefix 'psv'
+`|` delimiters and are formatted like:
+
+ [<span>*|+][<align>][<style>]
+
+- '<span>' specifies horizontal and vertical cell spans ('+' operator) or
+ the number of times the cell is replicated ('*' operator). '<span>'
+ is formatted like:
+
+ [<colspan>][.<rowspan>]
++
+Where `<colspan>` and `<rowspan>` are integers specifying the number of
+columns and rows to span.
+
+- `<align>` specifies horizontal and vertical cell alignment an is the
+ same as in <<X70,column specifiers>>.
+- A `<style>` value is the first letter of <<X71,table style>> name.
+
+For example, the following 'psv' formatted cell will span two columns
+and the text will be centered and emphasized:
+
+ `2+^e| Cell text`
+
+[[X71]]
+Table styles
+~~~~~~~~~~~~
+Table styles can be applied to the entire table (by setting the
+'style' attribute in the table's attribute list) or on a per column
+basis (by specifying the style in the table's <<X69,cols attribute>>).
+Table data can be formatted using the following predefined styles:
+
+default::
+The default style: AsciiDoc inline text formatting; blank lines are
+treated as paragraph breaks.
+
+emphasis::
+Like default but all text is emphasised.
+
+monospaced::
+Like default but all text is in a monospaced font.
+
+strong::
+Like default but all text is bold.
+
+header::
+Apply the same style as the table header. Normally used to create a
+vertical header in the first column.
+
+asciidoc::
+With this style table cells can contain any of the AsciiDoc elements
+that are allowed inside document sections. This style runs asciidoc(1)
+as a filter to process cell contents. See also <<X83,Docbook table
+limitations>>.
+
+literal::
+No text formatting; monospaced font; all line breaks are retained
+(the same as the AsciiDoc <<X65,LiteralBlock>> element).
+
+verse::
+All line breaks are retained (just like the AsciiDoc <<X94,verse
+paragraph style>>).
+
+[[X72]]
+Markup attributes
+~~~~~~~~~~~~~~~~~
+AsciiDoc makes a number of attributes available to table markup
+templates and tags. Column specific attributes are available when
+substituting the 'colspec' cell data tags.
+
+pageunits::
+DocBook backend only. Specifies table column absolute width units.
+Defaults to '*'.
+
+pagewidth::
+DocBook backend only. The nominal output page width in 'pageunit'
+units. Used to calculate CALS tables absolute column and table
+widths. Defaults to '425'.
+
+tableabswidth::
+Integer value calculated from 'width' and 'pagewidth' attributes.
+In 'pageunit' units.
+
+tablepcwidth::
+Table width expressed as a percentage of the available width. Integer
+value (0..100).
+
+colabswidth::
+Integer value calculated from 'cols' column width, 'width' and
+'pagewidth' attributes. In 'pageunit' units.
+
+colpcwidth::
+Column width expressed as a percentage of the table width. Integer
+value (0..100).
+
+colcount::
+Total number of table columns.
+
+rowcount::
+Total number of table rows.
+
+halign::
+Horizontal cell content alignment: 'left', 'right' or 'center'.
+
+valign::
+Vertical cell content alignment: 'top', 'bottom' or 'middle'.
+
+colnumber, colstart::
+The number of the leftmost column occupied by the cell (1...).
+
+colend::
+The number of the rightmost column occupied by the cell (1...).
+
+colspan::
+Number of columns the cell should span.
+
+rowspan::
+Number of rows the cell should span (1...).
+
+morerows::
+Number of additional rows the cell should span (0...).
+
+Nested tables
+~~~~~~~~~~~~~
+An alternative 'psv' separator character '!' can be used (instead of
+'|') in nested tables. This allows a single level of table nesting.
+Columns containing nested tables must use the 'asciidoc' style. An
+example can be found in `./examples/website/newtables.txt`.
+
+[[X83]]
+DocBook table limitations
+~~~~~~~~~~~~~~~~~~~~~~~~~
+Fully implementing tables is not trivial, some DocBook toolchains do
+better than others. AsciiDoc HTML table outputs are rendered
+correctly in all the popular browsers -- if your DocBook generated
+tables don't look right compare them with the output generated by the
+AsciiDoc 'xhtml11' backend or try a different DocBook toolchain. Here
+is a list of things to be aware of:
+
+- Although nested tables are not legal in DocBook 4 the FOP and
+ dblatex toolchains will process them correctly. If you use `a2x(1)`
+ you will need to include the `--no-xmllint` option to suppress
+ DocBook validation errors.
++
+NOTE: In theory you can nest DocBook 4 tables one level using the
+'entrytbl' element, but not all toolchains process 'entrytbl'.
+
+- DocBook only allows a subset of block elements inside table cells so
+ not all AsciiDoc elements produce valid DocBook inside table cells.
+ If you get validation errors running `a2x(1)` try the `--no-xmllint`
+ option, toolchains will often process nested block elements such as
+ sidebar blocks and floating titles correctly even though, strictly
+ speaking, they are not legal.
+
+- Text formatting in cells using the 'monospaced' table style will
+ raise validation errors because the DocBook 'literal' element was
+ not designed to support formatted text (using the 'literal' element
+ is a kludge on the part of AsciiDoc as there is no easy way to set
+ the font style in DocBook.
+
+- Cell alignments are ignored for 'verse', 'literal' or 'asciidoc'
+ table styles.
+
+
+[[X1]]
+Manpage Documents
+-----------------
+Sooner or later, if you program in a UNIX environment, you're going
+to have to write a man page.
+
+By observing a couple of additional conventions (detailed below) you
+can write AsciiDoc files that will generate HTML and PDF man pages
+plus the native manpage roff format. The easiest way to generate roff
+manpages from AsciiDoc source is to use the a2x(1) command. The
+following example generates a roff formatted manpage file called
+`asciidoc.1` (a2x(1) uses asciidoc(1) to convert `asciidoc.1.txt` to
+DocBook which it then converts to roff using DocBook XSL Stylesheets):
+
+ a2x --doctype manpage --format manpage asciidoc.1.txt
+
+.Viewing and printing manpage files
+**********************************************************************
+Use the `man(1)` command to view the manpage file:
+
+ $ man -l asciidoc.1
+
+To print a high quality man page to a postscript printer:
+
+ $ man -l -Tps asciidoc.1 | lpr
+
+You could also create a PDF version of the man page by converting
+PostScript to PDF using `ps2pdf(1)`:
+
+ $ man -l -Tps asciidoc.1 | ps2pdf - asciidoc.1.pdf
+
+The `ps2pdf(1)` command is included in the Ghostscript distribution.
+**********************************************************************
+
+To find out more about man pages view the `man(7)` manpage
+(`man 7 man` and `man man-pages` commands).
+
+
+Document Header
+~~~~~~~~~~~~~~~
+A manpage document Header is mandatory. The title line contains the
+man page name followed immediately by the manual section number in
+brackets, for example 'ASCIIDOC(1)'. The title name should not contain
+white space and the manual section number is a single digit optionally
+followed by a single character.
+
+The NAME Section
+~~~~~~~~~~~~~~~~
+The first manpage section is mandatory, must be titled 'NAME' and must
+contain a single paragraph (usually a single line) consisting of a
+list of one or more comma separated command name(s) separated from the
+command purpose by a dash character. The dash must have at least one
+white space character on either side. For example:
+
+ printf, fprintf, sprintf - print formatted output
+
+The SYNOPSIS Section
+~~~~~~~~~~~~~~~~~~~~
+The second manpage section is mandatory and must be titled 'SYNOPSIS'.
+
+refmiscinfo attributes
+~~~~~~~~~~~~~~~~~~~~~~
+In addition to the automatically created man page <<X60,intrinsic
+attributes>> you can assign DocBook
+http://www.docbook.org/tdg5/en/html/refmiscinfo.html[refmiscinfo]
+element 'source', 'version' and 'manual' values using AsciiDoc
+`{mansource}`, `{manversion}` and `{manmanual}` attributes
+respectively. This example is from the AsciiDoc header of a man page
+source file:
+
+ :man source: AsciiDoc
+ :man version: {revnumber}
+ :man manual: AsciiDoc Manual
+
+
+[[X78]]
+Mathematical Formulas
+---------------------
+The 'asciimath' and 'latexmath' <<X77,passthrough macros>> along with
+'asciimath' and 'latexmath' <<X76,passthrough blocks>> provide a
+(backend dependent) mechanism for rendering mathematical formulas. You
+can use the following math markups:
+
+NOTE: The 'latexmath' macro used to include 'LaTeX Math' in DocBook
+outputs is not the same as the 'latexmath' macro used to include
+'LaTeX MathML' in XHTML outputs. 'LaTeX Math' applies to DocBook
+outputs that are processed by <<X31,dblatex>> and is normally used to
+generate PDF files. 'LaTeXMathML' is very much a subset of 'LaTeX
+Math' and applies to XHTML documents.
+
+LaTeX Math
+~~~~~~~~~~
+ftp://ftp.ams.org/pub/tex/doc/amsmath/short-math-guide.pdf[LaTeX
+math] can be included in documents that are processed by
+<<X31,dblatex(1)>>. Example inline formula:
+
+ latexmath:[$C = \alpha + \beta Y^{\gamma} + \epsilon$]
+
+For more examples see the {website}[AsciiDoc website] or the
+distributed `doc/latexmath.txt` file.
+
+ASCIIMathML
+~~~~~~~~~~~
+/////////////////////////////////////////////////////////////////////
+The older ASCIIMathML 1.47 version is used instead of version 2
+because:
+
+1. Version 2 doesn't work when embedded.
+2. Version 2 is much larger.
+/////////////////////////////////////////////////////////////////////
+
+http://www1.chapman.edu/~jipsen/mathml/asciimath.html[ASCIIMathML]
+formulas can be included in XHTML documents generated using the
+'xhtml11' and 'html5' backends. To enable ASCIIMathML support you must
+define the 'asciimath' attribute, for example using the `-a asciimath`
+command-line option. Example inline formula:
+
+ asciimath:[`x/x={(1,if x!=0),(text{undefined},if x=0):}`]
+
+For more examples see the {website}[AsciiDoc website] or the
+distributed `doc/asciimathml.txt` file.
+
+LaTeXMathML
+~~~~~~~~~~~
+/////////////////////////////////////////////////////////////////////
+There is an http://math.etsu.edu/LaTeXMathML/[extended LaTeXMathML
+version] by Jeff Knisley, in addition to a JavaScript file it requires
+the inclusion of a CSS file.
+/////////////////////////////////////////////////////////////////////
+
+'LaTeXMathML' allows LaTeX Math style formulas to be included in XHTML
+documents generated using the AsciiDoc 'xhtml11' and 'html5' backends.
+AsciiDoc uses the
+http://www.maths.nottingham.ac.uk/personal/drw/lm.html[original
+LaTeXMathML] by Douglas Woodall. 'LaTeXMathML' is derived from
+ASCIIMathML and is for users who are more familiar with or prefer
+using LaTeX math formulas (it recognizes a subset of LaTeX Math, the
+differences are documented on the 'LaTeXMathML' web page). To enable
+LaTeXMathML support you must define the 'latexmath' attribute, for
+example using the `-a latexmath` command-line option. Example inline
+formula:
+
+ latexmath:[$\sum_{n=1}^\infty \frac{1}{2^n}$]
+
+For more examples see the {website}[AsciiDoc website] or the
+distributed `doc/latexmathml.txt` file.
+
+MathML
+~~~~~~
+http://www.w3.org/Math/[MathML] is a low level XML markup for
+mathematics. AsciiDoc has no macros for MathML but users familiar with
+this markup could use passthrough macros and passthrough blocks to
+include MathML in output documents.
+
+
+[[X7]]
+Configuration Files
+-------------------
+AsciiDoc source file syntax and output file markup is largely
+controlled by a set of cascading, text based, configuration files. At
+runtime The AsciiDoc default configuration files are combined with
+optional user and document specific configuration files.
+
+Configuration File Format
+~~~~~~~~~~~~~~~~~~~~~~~~~
+Configuration files contain named sections. Each section begins with a
+section name in square brackets []. The section body consists of the
+lines of text between adjacent section headings.
+
+- Section names consist of one or more alphanumeric, underscore or
+ dash characters and cannot begin or end with a dash.
+- Lines starting with a '#' character are treated as comments and
+ ignored.
+- If the section name is prefixed with a '+' character then the
+ section contents is appended to the contents of an already existing
+ same-named section.
+- Otherwise same-named sections and section entries override
+ previously loaded sections and section entries (this is sometimes
+ referred to as 'cascading'). Consequently, downstream configuration
+ files need only contain those sections and section entries that need
+ to be overridden.
+
+TIP: When creating custom configuration files you only need to include
+the sections and entries that differ from the default configuration.
+
+TIP: The best way to learn about configuration files is to read the
+default configuration files in the AsciiDoc distribution in
+conjunction with asciidoc(1) output files. You can view configuration
+file load sequence by turning on the asciidoc(1) `-v` (`--verbose`)
+command-line option.
+
+AsciiDoc reserves the following section names for specific purposes:
+
+miscellaneous::
+ Configuration options that don't belong anywhere else.
+attributes::
+ Attribute name/value entries.
+specialcharacters::
+ Special characters reserved by the backend markup.
+tags::
+ Backend markup tags.
+quotes::
+ Definitions for quoted inline character formatting.
+specialwords::
+ Lists of words and phrases singled out for special markup.
+replacements, replacements2, replacements3::
+ Find and replace substitution definitions.
+specialsections::
+ Used to single out special section names for specific markup.
+macros::
+ Macro syntax definitions.
+titles::
+ Heading, section and block title definitions.
+paradef-*::
+ Paragraph element definitions.
+blockdef-*::
+ DelimitedBlock element definitions.
+listdef-*::
+ List element definitions.
+listtags-*::
+ List element tag definitions.
+tabledef-*::
+ Table element definitions.
+tabletags-*::
+ Table element tag definitions.
+
+Each line of text in these sections is a 'section entry'. Section
+entries share the following syntax:
+
+name=value::
+ The entry value is set to value.
+name=::
+ The entry value is set to a zero length string.
+name!::
+ The entry is undefined (deleted from the configuration). This
+ syntax only applies to 'attributes' and 'miscellaneous'
+ sections.
+
+.Section entry behavior
+- All equals characters inside the `name` must be escaped with a
+ backslash character.
+- `name` and `value` are stripped of leading and trailing white space.
+- Attribute names, tag entry names and markup template section names
+ consist of one or more alphanumeric, underscore or dash characters.
+ Names should not begin or end with a dash.
+- A blank configuration file section (one without any entries) deletes
+ any preceding section with the same name (applies to non-markup
+ template sections).
+
+
+Miscellaneous section
+~~~~~~~~~~~~~~~~~~~~~
+The optional `[miscellaneous]` section specifies the following
+`name=value` options:
+
+newline::
+ Output file line termination characters. Can include any
+ valid Python string escape sequences. The default value is
+ `\r\n` (carriage return, line feed). Should not be quoted or
+ contain explicit spaces (use `\x20` instead). For example:
+
+ $ asciidoc -a 'newline=\n' -b docbook mydoc.txt
+
+outfilesuffix::
+ The default extension for the output file, for example
+ `outfilesuffix=.html`. Defaults to backend name.
+tabsize::
+ The number of spaces to expand tab characters, for example
+ `tabsize=4`. Defaults to 8. A 'tabsize' of zero suppresses tab
+ expansion (useful when piping included files through block
+ filters). Included files can override this option using the
+ 'tabsize' attribute.
+pagewidth, pageunits::
+ These global table related options are documented in the
+ <<X4,Table Configuration File Definitions>> sub-section.
+
+NOTE: `[miscellaneous]` configuration file entries can be set using
+the asciidoc(1) `-a` (`--attribute`) command-line option.
+
+Titles section
+~~~~~~~~~~~~~~
+sectiontitle::
+ Two line section title pattern. The entry value is a Python
+ regular expression containing the named group 'title'.
+
+underlines::
+ A comma separated list of document and section title underline
+ character pairs starting with the section level 0 and ending
+ with section level 4 underline. The default setting is:
+
+ underlines="==","--","~~","^^","++"
+
+sect0...sect4::
+ One line section title patterns. The entry value is a Python
+ regular expression containing the named group 'title'.
+
+blocktitle::
+ <<X42,BlockTitle element>> pattern. The entry value is a
+ Python regular expression containing the named group 'title'.
+
+subs::
+ A comma separated list of substitutions that are performed on
+ the document header and section titles. Defaults to 'normal'
+ substitution.
+
+Tags section
+~~~~~~~~~~~~
+The `[tags]` section contains backend tag definitions (one per
+line). Tags are used to translate AsciiDoc elements to backend
+markup.
+
+An AsciiDoc tag definition is formatted like
+`<tagname>=<starttag>|<endtag>`. For example:
+
+ emphasis=<em>|</em>
+
+In this example asciidoc(1) replaces the | character with the
+emphasized text from the AsciiDoc input file and writes the result to
+the output file.
+
+Use the `{brvbar}` attribute reference if you need to include a | pipe
+character inside tag text.
+
+Attributes section
+~~~~~~~~~~~~~~~~~~
+The optional `[attributes]` section contains predefined attributes.
+
+If the attribute value requires leading or trailing spaces then the
+text text should be enclosed in quotation mark (") characters.
+
+To delete a attribute insert a `name!` entry in a downstream
+configuration file or use the asciidoc(1) `--attribute name!`
+command-line option (an attribute name suffixed with a `!` character
+deletes the attribute)
+
+Special Characters section
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+The `[specialcharacters]` section specifies how to escape characters
+reserved by the backend markup. Each translation is specified on a
+single line formatted like:
+
+ <special_character>=<translated_characters>
+
+Special characters are normally confined to those that resolve
+markup ambiguity (in the case of HTML and XML markups the ampersand,
+less than and greater than characters). The following example causes
+all occurrences of the `<` character to be replaced by `<`.
+
+ <=<
+
+Quoted Text section
+~~~~~~~~~~~~~~~~~~~
+Quoting is used primarily for text formatting. The `[quotes]` section
+defines AsciiDoc quoting characters and their corresponding backend
+markup tags. Each section entry value is the name of a of a `[tags]`
+section entry. The entry name is the character (or characters) that
+quote the text. The following examples are taken from AsciiDoc
+configuration files:
+
+ [quotes]
+ _=emphasis
+
+ [tags]
+ emphasis=<em>|</em>
+
+You can specify the left and right quote strings separately by
+separating them with a | character, for example:
+
+ ``|''=quoted
+
+Omitting the tag will disable quoting, for example, if you don't want
+superscripts or subscripts put the following in a custom configuration
+file or edit the global `asciidoc.conf` configuration file:
+
+ [quotes]
+ ^=
+ ~=
+
+<<X52,Unconstrained quotes>> are differentiated from constrained
+quotes by prefixing the tag name with a hash character, for example:
+
+ __=#emphasis
+
+.Quoted text behavior
+- Quote characters must be non-alphanumeric.
+- To minimize quoting ambiguity try not to use the same quote
+ characters in different quote types.
+
+Special Words section
+~~~~~~~~~~~~~~~~~~~~~
+The `[specialwords]` section is used to single out words and phrases
+that you want to consistently format in some way throughout your
+document without having to repeatedly specify the markup. The name of
+each entry corresponds to a markup template section and the entry
+value consists of a list of words and phrases to be marked up. For
+example:
+
+ [specialwords]
+ strongwords=NOTE IMPORTANT
+
+ [strongwords]
+ <strong>{words}</strong>
+
+The examples specifies that any occurrence of `NOTE` or `IMPORTANT`
+should appear in a bold font.
+
+Words and word phrases are treated as Python regular expressions: for
+example, the word `^NOTE` would only match `NOTE` if appeared at
+the start of a line.
+
+AsciiDoc comes with three built-in Special Word types:
+'emphasizedwords', 'monospacedwords' and 'strongwords', each has a
+corresponding (backend specific) markup template section. Edit the
+configuration files to customize existing Special Words and to add new
+ones.
+
+.Special word behavior
+- Word list entries must be separated by space characters.
+- Word list entries with embedded spaces should be enclosed in quotation (")
+ characters.
+- A `[specialwords]` section entry of the form
+ +name=word1{nbsp}[word2...]+ adds words to existing `name` entries.
+- A `[specialwords]` section entry of the form `name` undefines
+ (deletes) all existing `name` words.
+- Since word list entries are processed as Python regular expressions
+ you need to be careful to escape regular expression special
+ characters.
+- By default Special Words are substituted before Inline Macros, this
+ may lead to undesirable consequences. For example the special word
+ `foobar` would be expanded inside the macro call
+ `http://www.foobar.com[]`. A possible solution is to emphasize
+ whole words only by defining the word using regular expression
+ characters, for example `\bfoobar\b`.
+- If the first matched character of a special word is a backslash then
+ the remaining characters are output without markup i.e. the
+ backslash can be used to escape special word markup. For example
+ the special word `\\?\b[Tt]en\b` will mark up the words `Ten` and
+ `ten` only if they are not preceded by a backslash.
+
+[[X10]]
+Replacements section
+~~~~~~~~~~~~~~~~~~~~
+`[replacements]`, `[replacements2]` and `[replacements3]`
+configuration file entries specify find and replace text and are
+formatted like:
+
+ <find_pattern>=<replacement_text>
+
+The find text can be a Python regular expression; the replace text can
+contain Python regular expression group references.
+
+Use Replacement shortcuts for often used macro references, for
+example (the second replacement allows us to backslash escape the
+macro name):
+
+ NEW!=image:./images/smallnew.png[New!]
+ \\NEW!=NEW!
+
+The only difference between the three replacement types is how they
+are applied. By default 'replacements' and 'replacement2' are applied
+in <<X102,normal>> substitution contexts whereas 'replacements3' needs
+to be configured explicitly and should only be used in backend
+configuration files.
+
+.Replacement behavior
+- The built-in replacements can be escaped with a backslash.
+- If the find or replace text has leading or trailing spaces then the
+ text should be enclosed in quotation (") characters.
+- Since the find text is processed as a regular expression you need to
+ be careful to escape regular expression special characters.
+- Replacements are performed in the same order they appear in the
+ configuration file replacements section.
+
+Markup Template Sections
+~~~~~~~~~~~~~~~~~~~~~~~~
+Markup template sections supply backend markup for translating
+AsciiDoc elements. Since the text is normally backend dependent
+you'll find these sections in the backend specific configuration
+files. Template sections differ from other sections in that they
+contain a single block of text instead of per line 'name=value'
+entries. A markup template section body can contain:
+
+- Attribute references
+- System macro calls.
+- A document content placeholder
+
+The document content placeholder is a single | character and is
+replaced by text from the source element. Use the `{brvbar}`
+attribute reference if you need a literal | character in the template.
+
+[[X27]]
+Configuration file names, precedence and locations
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Configuration files have a `.conf` file name extension; they are
+loaded from the following locations:
+
+1. The directory containing the asciidoc executable.
+2. If there is no `asciidoc.conf` file in the directory containing the
+ asciidoc executable then load from the global configuration
+ directory (normally `/etc/asciidoc` or `/usr/local/etc/asciidoc`)
+ i.e. the global configuration files directory is skipped if
+ AsciiDoc configuration files are installed in the same directory as
+ the asciidoc executable. This allows both a system wide copy and
+ multiple local copies of AsciiDoc to coexist on the same host PC.
+3. The user's `$HOME/.asciidoc` directory (if it exists).
+4. The directory containing the AsciiDoc source file.
+5. Explicit configuration files specified using:
+ - The `conf-files` attribute (one or more file names separated by a
+ `|` character). These files are loaded in the order they are
+ specified and prior to files specified using the `--conf-file`
+ command-line option.
+ - The asciidoc(1) `--conf-file`) command-line option. The
+ `--conf-file` option can be specified multiple times, in which
+ case configuration files will be processed in the same order they
+ appear on the command-line.
+6. <<X100,Backend plugin>> configuration files are loaded from
+ subdirectories named like `backends/<backend>` in locations 1, 2
+ and 3.
+7. <<X59,Filter>> configuration files are loaded from subdirectories
+ named like `filters/<filter>` in locations 1, 2 and 3.
+
+Configuration files from the above locations are loaded in the
+following order:
+
+- The `[attributes]` section only from:
+ * `asciidoc.conf` in location 3
+ * Files from location 5.
++
+This first pass makes locally set attributes available in the global
+`asciidoc.conf` file.
+
+- `asciidoc.conf` from locations 1, 2, 3.
+- 'attributes', 'titles' and 'specialcharacters' sections from the
+ `asciidoc.conf` in location 4.
+- The document header is parsed at this point and we can assume the
+ 'backend' and 'doctype' have now been defined.
+- Backend plugin `<backend>.conf` and `<backend>-<doctype>.conf` files
+ from locations 6. If a backend plugin is not found then try
+ locations 1, 2 and 3 for `<backend>.conf` and
+ `<backend>-<doctype>.conf` backend configuration files.
+- Filter conf files from locations 7.
+- `lang-<lang>.conf` from locations 1, 2, 3.
+- `asciidoc.conf` from location 4.
+- `<backend>.conf` and `<backend>-<doctype>.conf` from location 4.
+- Filter conf files from location 4.
+- `<docfile>.conf` and `<docfile>-<backend>.conf` from location 4.
+- Configuration files from location 5.
+
+Where:
+
+- `<backend>` and `<doctype>` are values specified by the asciidoc(1)
+ `-b` (`--backend`) and `-d` (`--doctype`) command-line options.
+- `<infile>` is the path name of the AsciiDoc input file without the
+ file name extension.
+- `<lang>` is a two letter country code set by the the AsciiDoc 'lang'
+ attribute.
+
+[NOTE]
+=====================================================================
+The backend and language global configuration files are loaded *after*
+the header has been parsed. This means that you can set most
+attributes in the document header. Here's an example header:
+
+ Life's Mysteries
+ ================
+ :author: Hu Nose
+ :doctype: book
+ :toc:
+ :icons:
+ :data-uri:
+ :lang: en
+ :encoding: iso-8859-1
+
+Attributes set in the document header take precedence over
+configuration file attributes.
+
+=====================================================================
+
+TIP: Use the asciidoc(1) `-v` (`--verbose`) command-line option to see
+which configuration files are loaded and the order in which they are
+loaded.
+
+
+Document Attributes
+-------------------
+A document attribute is comprised of a 'name' and a textual 'value'
+and is used for textual substitution in AsciiDoc documents and
+configuration files. An attribute reference (an attribute name
+enclosed in braces) is replaced by the corresponding attribute
+value. Attribute names are case insensitive and can only contain
+alphanumeric, dash and underscore characters.
+
+There are four sources of document attributes (from highest to lowest
+precedence):
+
+- Command-line attributes.
+- AttributeEntry, AttributeList, Macro and BlockId elements.
+- Configuration file `[attributes]` sections.
+- Intrinsic attributes.
+
+Within each of these divisions the last processed entry takes
+precedence.
+
+NOTE: If an attribute is not defined then the line containing the
+attribute reference is dropped. This property is used extensively in
+AsciiDoc configuration files to facilitate conditional markup
+generation.
+
+
+[[X18]]
+Attribute Entries
+-----------------
+The `AttributeEntry` block element allows document attributes to be
+assigned within an AsciiDoc document. Attribute entries are added to
+the global document attributes dictionary. The attribute name/value
+syntax is a single line like:
+
+ :<name>: <value>
+
+For example:
+
+ :Author Initials: JB
+
+This will set an attribute reference `{authorinitials}` to the value
+'JB' in the current document.
+
+To delete (undefine) an attribute use the following syntax:
+
+ :<name>!:
+
+.AttributeEntry behavior
+- The attribute entry line begins with colon -- no white space allowed
+ in left margin.
+- AsciiDoc converts the `<name>` to a legal attribute name (lower
+ case, alphanumeric, dash and underscore characters only -- all other
+ characters deleted). This allows more human friendly text to be
+ used.
+- Leading and trailing white space is stripped from the `<value>`.
+- Lines ending in a space followed by a plus character are continued
+ to the next line, for example:
+
+ :description: AsciiDoc is a text document format for writing notes, +
+ documentation, articles, books, slideshows, web pages +
+ and man pages.
+
+- If the `<value>` is blank then the corresponding attribute value is
+ set to an empty string.
+- Attribute references contained in the entry `<value>` will be
+ expanded.
+- By default AttributeEntry values are substituted for
+ `specialcharacters` and `attributes` (see above), if you want to
+ change or disable AttributeEntry substitution use the <<X77,pass:[]
+ inline macro>> syntax.
+- Attribute entries in the document Header are available for header
+ markup template substitution.
+- Attribute elements override configuration file and intrinsic
+ attributes but do not override command-line attributes.
+
+Here are some more attribute entry examples:
+
+---------------------------------------------------------------------
+AsciiDoc User Manual
+====================
+:author: Stuart Rackham
+:email: srackham@gmail.com
+:revdate: April 23, 2004
+:revnumber: 5.1.1
+---------------------------------------------------------------------
+
+Which creates these attributes:
+
+ {author}, {firstname}, {lastname}, {authorinitials}, {email},
+ {revdate}, {revnumber}
+
+The previous example is equivalent to this <<X95,document header>>:
+
+---------------------------------------------------------------------
+AsciiDoc User Manual
+====================
+Stuart Rackham <srackham@gmail.com>
+5.1.1, April 23, 2004
+---------------------------------------------------------------------
+
+Setting configuration entries
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A variant of the Attribute Entry syntax allows configuration file
+section entries and markup template sections to be set from within an
+AsciiDoc document:
+
+ :<section_name>.[<entry_name>]: <entry_value>
+
+Where `<section_name>` is the configuration section name,
+`<entry_name>` is the name of the entry and `<entry_value>` is the
+optional entry value. This example sets the default labeled list
+style to 'horizontal':
+
+ :listdef-labeled.style: horizontal
+
+It is exactly equivalent to a configuration file containing:
+
+ [listdef-labeled]
+ style=horizontal
+
+- If the `<entry_name>` is omitted then the entire section is
+ substituted with the `<entry_value>`. This feature should only be
+ used to set markup template sections. The following example sets the
+ 'xref2' inline macro markup template:
+
+ :xref2-inlinemacro.: <a href="#{1}">{2?{2}}</a>
+
+- No substitution is performed on configuration file attribute entries
+ and they cannot be undefined.
+- This feature can only be used in attribute entries -- configuration
+ attributes cannot be set using the asciidoc(1) command `--attribute`
+ option.
+
+[[X62]]
+.Attribute entries promote clarity and eliminate repetition
+*********************************************************************
+URLs and file names in AsciiDoc macros are often quite long -- they
+break paragraph flow and readability suffers. The problem is
+compounded by redundancy if the same name is used repeatedly.
+Attribute entries can be used to make your documents easier to read
+and write, here are some examples:
+
+ :1: http://freshmeat.net/projects/asciidoc/
+ :homepage: http://methods.co.nz/asciidoc/[AsciiDoc home page]
+ :new: image:./images/smallnew.png[]
+ :footnote1: footnote:[A meaningless latin term]
+
+ Using previously defined attributes: See the {1}[Freshmeat summary]
+ or the {homepage} for something new {new}. Lorem ispum {footnote1}.
+
+.Note
+- The attribute entry definition must precede it's usage.
+- You are not limited to URLs or file names, entire macro calls or
+ arbitrary lines of text can be abbreviated.
+- Shared attributes entries could be grouped into a separate file and
+ <<X63,included>> in multiple documents.
+*********************************************************************
+
+
+[[X21]]
+Attribute Lists
+---------------
+- An attribute list is a comma separated list of attribute values.
+- The entire list is enclosed in square brackets.
+- Attribute lists are used to pass parameters to macros, blocks (using
+ the <<X79,AttributeList element>>) and inline quotes.
+
+The list consists of zero or more positional attribute values followed
+by zero or more named attribute values. Here are three examples: a
+single unquoted positional attribute; three unquoted positional
+attribute values; one positional attribute followed by two named
+attributes; the unquoted attribute value in the final example contains
+comma (`,`) and double-quote (`"`) character entities:
+
+ [Hello]
+ [quote, Bertrand Russell, The World of Mathematics (1956)]
+ ["22 times", backcolor="#0e0e0e", options="noborders,wide"]
+ [A footnote, "with an image" image:smallnew.png[]]
+
+.Attribute list behavior
+- If one or more attribute values contains a comma the all string
+ values must be quoted (enclosed in double quotation mark
+ characters).
+- If the list contains any named or quoted attributes then all string
+ attribute values must be quoted.
+- To include a double quotation mark (") character in a quoted
+ attribute value the the quotation mark must be escaped with a
+ backslash.
+- List attributes take precedence over existing attributes.
+- List attributes can only be referenced in configuration file markup
+ templates and tags, they are not available elsewhere in the
+ document.
+- Setting a named attribute to `None` undefines the attribute.
+- Positional attributes are referred to as `{1}`,`{2}`,`{3}`,...
+- Attribute `{0}` refers to the entire list (excluding the enclosing
+ square brackets).
+- Named attribute names cannot contain dash characters.
+
+[[X75]]
+Options attribute
+~~~~~~~~~~~~~~~~~
+If the attribute list contains an attribute named `options` it is
+processed as a comma separated list of option names:
+
+- Each name generates an attribute named like `<option>-option` (where
+ `<option>` is the option name) with an empty string value. For
+ example `[options="opt1,opt2,opt3"]` is equivalent to setting the
+ following three attributes
+ `[opt1-option="",opt2-option="",opt2-option=""]`.
+- If you define a an option attribute globally (for example with an
+ <<X18,attribute entry>>) then it will apply to all elements in the
+ document.
+- AsciiDoc implements a number of predefined options which are listed
+ in the <<X74,Attribute Options appendix>>.
+
+Macro Attribute lists
+~~~~~~~~~~~~~~~~~~~~~
+Macros calls are suffixed with an attribute list. The list may be
+empty but it cannot be omitted. List entries are used to pass
+attribute values to macro markup templates.
+
+
+Attribute References
+--------------------
+An attribute reference is an attribute name (possibly followed by an
+additional parameters) enclosed in curly braces. When an attribute
+reference is encountered it is evaluated and replaced by its
+corresponding text value. If the attribute is undefined the line
+containing the attribute is dropped.
+
+There are three types of attribute reference: 'Simple', 'Conditional'
+and 'System'.
+
+.Attribute reference evaluation
+- You can suppress attribute reference expansion by placing a
+ backslash character immediately in front of the opening brace
+ character.
+- By default attribute references are not expanded in
+ 'LiteralParagraphs', 'ListingBlocks' or 'LiteralBlocks'.
+- Attribute substitution proceeds line by line in reverse line order.
+- Attribute reference evaluation is performed in the following order:
+ 'Simple' then 'Conditional' and finally 'System'.
+
+Simple Attributes References
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Simple attribute references take the form `{<name>}`. If the
+attribute name is defined its text value is substituted otherwise the
+line containing the reference is dropped from the output.
+
+Conditional Attribute References
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Additional parameters are used in conjunction with attribute names to
+calculate a substitution value. Conditional attribute references take
+the following forms:
+
+`{<names>=<value>}`::
+ `<value>` is substituted if the attribute `<names>` is
+ undefined otherwise its value is substituted. `<value>` can
+ contain simple attribute references.
+
+`{<names>?<value>}`::
+ `<value>` is substituted if the attribute `<names>` is defined
+ otherwise an empty string is substituted. `<value>` can
+ contain simple attribute references.
+
+`{<names>!<value>}`::
+ `<value>` is substituted if the attribute `<names>` is
+ undefined otherwise an empty string is substituted. `<value>`
+ can contain simple attribute references.
+
+`{<names>#<value>}`::
+ `<value>` is substituted if the attribute `<names>` is defined
+ otherwise the undefined attribute entry causes the containing
+ line to be dropped. `<value>` can contain simple attribute
+ references.
+
+`{<names>%<value>}`::
+ `<value>` is substituted if the attribute `<names>` is not
+ defined otherwise the containing line is dropped. `<value>`
+ can contain simple attribute references.
+
+`{<names>@<regexp>:<value1>[:<value2>]}`::
+ `<value1>` is substituted if the value of attribute `<names>`
+ matches the regular expression `<regexp>` otherwise `<value2>`
+ is substituted. If attribute `<names>` is not defined the
+ containing line is dropped. If `<value2>` is omitted an empty
+ string is assumed. The values and the regular expression can
+ contain simple attribute references. To embed colons in the
+ values or the regular expression escape them with backslashes.
+
+`{<names>$<regexp>:<value1>[:<value2>]}`::
+ Same behavior as the previous ternary attribute except for
+ the following cases:
+
+ `{<names>$<regexp>:<value>}`;;
+ Substitutes `<value>` if `<names>` matches `<regexp>`
+ otherwise the result is undefined and the containing
+ line is dropped.
+
+ `{<names>$<regexp>::<value>}`;;
+ Substitutes `<value>` if `<names>` does not match
+ `<regexp>` otherwise the result is undefined and the
+ containing line is dropped.
+
+The attribute `<names>` parameter normally consists of a single
+attribute name but it can be any one of the following:
+
+- A single attribute name which evaluates to the attributes value.
+- Multiple ',' separated attribute names which evaluates to an empty
+ string if one or more of the attributes is defined, otherwise it's
+ value is undefined.
+- Multiple '+' separated attribute names which evaluates to an empty
+ string if all of the attributes are defined, otherwise it's value is
+ undefined.
+
+Conditional attributes with single attribute names are evaluated first
+so they can be used inside the multi-attribute conditional `<value>`.
+
+Conditional attribute examples
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Conditional attributes are mainly used in AsciiDoc configuration
+files -- see the distribution `.conf` files for examples.
+
+Attribute equality test::
+ If `{backend}` is 'docbook45' or 'xhtml11' the example evaluates to
+ ``DocBook 4.5 or XHTML 1.1 backend'' otherwise it evaluates to
+ ``some other backend'':
+
+ {backend@docbook45|xhtml11:DocBook 4.5 or XHTML 1.1 backend:some other backend}
+
+Attribute value map::
+ This example maps the `frame` attribute values [`topbot`, `all`,
+ `none`, `sides`] to [`hsides`, `border`, `void`, `vsides`]:
+
+ {frame@topbot:hsides}{frame@all:border}{frame@none:void}{frame@sides:vsides}
+
+
+[[X24]]
+System Attribute References
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+System attribute references generate the attribute text value by
+executing a predefined action that is parametrized by one or more
+arguments. The syntax is `{<action>:<arguments>}`.
+
+`{counter:<attrname>[:<seed>]}`::
+ Increments the document attribute (if the attribute is
+ undefined it is set to `1`). Returns the new attribute value.
+
+ - Counters generate global (document wide) attributes.
+ - The optional `<seed>` specifies the counter's initial value;
+ it can be a number or a single letter; defaults to '1'.
+ - `<seed>` can contain simple and conditional attribute
+ references.
+ - The 'counter' system attribute will not be executed if the
+ containing line is dropped by the prior evaluation of an
+ undefined attribute.
+
+`{counter2:<attrname>[:<seed>]}`::
+ Same as `counter` except the it always returns a blank string.
+
+`{eval:<expression>}`::
+ Substitutes the result of the Python `<expression>`.
+
+ - If `<expression>` evaluates to `None` or `False` the
+ reference is deemed undefined and the line containing the
+ reference is dropped from the output.
+ - If the expression evaluates to `True` the attribute
+ evaluates to an empty string.
+ - `<expression>` can contain simple and conditional attribute
+ references.
+ - The 'eval' system attribute can be nested inside other
+ system attributes.
+
+`{eval3:<command>}`::
+ Passthrough version of `{eval:<expression>}` -- the generated
+ output is written directly to the output without any further
+ substitutions.
+
+`{include:<filename>}`::
+ Substitutes contents of the file named `<filename>`.
+
+ - The included file is read at the time of attribute
+ substitution.
+ - If the file does not exist a warning is emitted and the line
+ containing the reference is dropped from the output file.
+ - Tabs are expanded based on the current 'tabsize' attribute
+ value.
+
+`{set:<attrname>[!][:<value>]}`::
+ Sets or unsets document attribute. Normally only used in
+ configuration file markup templates (use
+ <<X18,AttributeEntries>> in AsciiDoc documents).
+
+ - If the attribute name is followed by an exclamation mark
+ the attribute becomes undefined.
+ - If `<value>` is omitted the attribute is set to a blank
+ string.
+ - `<value>` can contain simple and conditional attribute
+ references.
+ - Returns a blank string unless the attribute is undefined in
+ which case the return value is undefined and the enclosing
+ line will be dropped.
+
+`{set2:<attrname>[!][:<value>]}`::
+ Same as `set` except that the attribute scope is local to the
+ template.
+
+`{sys:<command>}`::
+ Substitutes the stdout generated by the execution of the shell
+ `<command>`.
+
+`{sys2:<command>}`::
+ Substitutes the stdout and stderr generated by the execution
+ of the shell `<command>`.
+
+`{sys3:<command>}`::
+ Passthrough version of `{sys:<command>}` -- the generated
+ output is written directly to the output without any further
+ substitutions.
+
+`{template:<template>}`::
+ Substitutes the contents of the configuration file section
+ named `<template>`. Attribute references contained in the
+ template are substituted.
+
+.System reference behavior
+- System attribute arguments can contain non-system attribute
+ references.
+- Closing brace characters inside system attribute arguments must be
+ escaped with a backslash.
+
+[[X60]]
+Intrinsic Attributes
+--------------------
+Intrinsic attributes are simple attributes that are created
+automatically from: AsciiDoc document header parameters; asciidoc(1)
+command-line arguments; attributes defined in the default
+configuration files; the execution context. Here's the list of
+predefined intrinsic attributes:
+
+ {amp} ampersand (&) character entity
+ {asciidoc-args} used to pass inherited arguments to asciidoc filters
+ {asciidoc-confdir} the asciidoc(1) global configuration directory
+ {asciidoc-dir} the asciidoc(1) application directory
+ {asciidoc-file} the full path name of the asciidoc(1) script
+ {asciidoc-version} the version of asciidoc(1)
+ {author} author's full name
+ {authored} empty string '' if {author} or {email} defined,
+ {authorinitials} author initials (from document header)
+ {backend-<backend>} empty string ''
+ {<backend>-<doctype>} empty string ''
+ {backend} document backend specified by `-b` option
+ {backend-confdir} the directory containing the <backend>.conf file
+ {backslash} backslash character
+ {basebackend-<base>} empty string ''
+ {basebackend} html or docbook
+ {blockname} current block name (note 8).
+ {brvbar} broken vertical bar (|) character
+ {docdate} document last modified date
+ {docdir} document input directory name (note 5)
+ {docfile} document file name (note 5)
+ {docname} document file name without extension (note 6)
+ {doctime} document last modified time
+ {doctitle} document title (from document header)
+ {doctype-<doctype>} empty string ''
+ {doctype} document type specified by `-d` option
+ {email} author's email address (from document header)
+ {empty} empty string ''
+ {encoding} specifies input and output encoding
+ {filetype-<fileext>} empty string ''
+ {filetype} output file name file extension
+ {firstname} author first name (from document header)
+ {gt} greater than (>) character entity
+ {id} running block id generated by BlockId elements
+ {indir} input file directory name (note 2,5)
+ {infile} input file name (note 2,5)
+ {lastname} author last name (from document header)
+ {ldquo} Left double quote character (note 7)
+ {level} title level 1..4 (in section titles)
+ {listindex} the list index (1..) of the most recent list item
+ {localdate} the current date
+ {localtime} the current time
+ {lsquo} Left single quote character (note 7)
+ {lt} less than (<) character entity
+ {manname} manpage name (defined in NAME section)
+ {manpurpose} manpage (defined in NAME section)
+ {mantitle} document title minus the manpage volume number
+ {manvolnum} manpage volume number (1..8) (from document header)
+ {middlename} author middle name (from document header)
+ {nbsp} non-breaking space character entity
+ {notitle} do not display the document title
+ {outdir} document output directory name (note 2)
+ {outfile} output file name (note 2)
+ {python} the full path name of the Python interpreter executable
+ {rdquo} Right double quote character (note 7)
+ {reftext} running block xreflabel generated by BlockId elements
+ {revdate} document revision date (from document header)
+ {revnumber} document revision number (from document header)
+ {rsquo} Right single quote character (note 7)
+ {sectnum} formatted section number (in section titles)
+ {sp} space character
+ {showcomments} send comment lines to the output
+ {title} section title (in titled elements)
+ {two-colons} Two colon characters
+ {two-semicolons} Two semicolon characters
+ {user-dir} the ~/.asciidoc directory (if it exists)
+ {verbose} defined as '' if --verbose command option specified
+ {wj} Word-joiner
+ {zwsp} Zero-width space character entity
+
+[NOTE]
+======
+1. Intrinsic attributes are global so avoid defining custom attributes
+ with the same names.
+2. `{outfile}`, `{outdir}`, `{infile}`, `{indir}` attributes are
+ effectively read-only (you can set them but it won't affect the
+ input or output file paths).
+3. See also the <<X88,Backend Attributes>> section for attributes
+ that relate to AsciiDoc XHTML file generation.
+4. The entries that translate to blank strings are designed to be used
+ for conditional text inclusion. You can also use the `ifdef`,
+ `ifndef` and `endif` System macros for conditional inclusion.
+ footnote:[Conditional inclusion using `ifdef` and `ifndef` macros
+ differs from attribute conditional inclusion in that the former
+ occurs when the file is read while the latter occurs when the
+ contents are written.]
+5. `{docfile}` and `{docdir}` refer to root document specified on the
+ asciidoc(1) command-line; `{infile}` and `{indir}` refer to the
+ current input file which may be the root document or an included
+ file. When the input is being read from the standard input
+ (`stdin`) these attributes are undefined.
+6. If the input file is the standard input and the output file is not
+ the standard output then `{docname}` is the output file name sans
+ file extension.
+7. See
+ http://en.wikipedia.org/wiki/Non-English_usage_of_quotation_marks[non-English
+ usage of quotation marks].
+8. The `{blockname}` attribute identifies the style of the current
+ block. It applies to delimited blocks, lists and tables. Here is a
+ list of `{blockname}` values (does not include filters or custom
+ block and style names):
+
+ delimited blocks:: comment, sidebar, open, pass, literal, verse,
+ listing, quote, example, note, tip, important, caution, warning,
+ abstract, partintro
+
+ lists:: arabic, loweralpha, upperalpha, lowerroman, upperroman,
+ labeled, labeled3, labeled4, qanda, horizontal, bibliography,
+ glossary
+
+ tables:: table
+
+======
+
+
+[[X73]]
+Block Element Definitions
+-------------------------
+The syntax and behavior of Paragraph, DelimitedBlock, List and Table
+block elements is determined by block definitions contained in
+<<X7,AsciiDoc configuration file>> sections.
+
+Each definition consists of a section title followed by one or more
+section entries. Each entry defines a block parameter controlling some
+aspect of the block's behavior. Here's an example:
+
+---------------------------------------------------------------------
+[blockdef-listing]
+delimiter=^-{4,}$
+template=listingblock
+presubs=specialcharacters,callouts
+---------------------------------------------------------------------
+
+Configuration file block definition sections are processed
+incrementally after each configuration file is loaded. Block
+definition section entries are merged into the block definition, this
+allows block parameters to be overridden and extended by later
+<<X27,loading configuration files>>.
+
+AsciiDoc Paragraph, DelimitedBlock, List and Table block elements
+share a common subset of configuration file parameters:
+
+delimiter::
+ A Python regular expression that matches the first line of a block
+ element -- in the case of DelimitedBlocks and Tables it also matches
+ the last line.
+
+template::
+ The name of the configuration file markup template section that will
+ envelope the block contents. The pipe ('|') character is substituted
+ for the block contents. List elements use a set of (list specific)
+ tag parameters instead of a single template. The template name can
+ contain attribute references allowing dynamic template selection a
+ the time of template substitution.
+
+options::
+ A comma delimited list of element specific option names. In addition
+ to being used internally, options are available during markup tag
+ and template substitution as attributes with an empty string value
+ named like `<option>-option` (where `<option>` is the option name).
+ See <<X74,attribute options>> for a complete list of available
+ options.
+
+subs, presubs, postsubs::
+ * 'presubs' and 'postsubs' are lists of comma separated substitutions that are
+ performed on the block contents. 'presubs' is applied first,
+ 'postsubs' (if specified) second.
+
+ * 'subs' is an alias for 'presubs'.
+
+ * If a 'filter' is allowed (Paragraphs, DelimitedBlocks and Tables)
+ and has been specified then 'presubs' and 'postsubs' substitutions
+ are performed before and after the filter is run respectively.
+
+ * Allowed values: 'specialcharacters', 'quotes', 'specialwords',
+ 'replacements', 'macros', 'attributes', 'callouts'.
+
+ * [[X102]]The following composite values are also allowed:
+
+ 'none';;
+ No substitutions.
+ 'normal';;
+ The following substitutions in the following order:
+ 'specialcharacters', 'quotes', 'attributes', 'specialwords',
+ 'replacements', 'macros', 'replacements2'.
+ 'verbatim';;
+ The following substitutions in the following order:
+ 'specialcharacters' and 'callouts'.
+
+ * 'normal' and 'verbatim' substitutions can be redefined by with
+ `subsnormal` and `subsverbatim` entries in a configuration file
+ `[miscellaneous]` section.
+
+ * The substitutions are processed in the order in which they are
+ listed and can appear more than once.
+
+filter::
+ This optional entry specifies an executable shell command for
+ processing block content (Paragraphs, DelimitedBlocks and Tables).
+ The filter command can contain attribute references.
+
+posattrs::
+ Optional comma separated list of positional attribute names. This
+ list maps positional attributes (in the block's <<X21,attribute
+ list>>) to named block attributes. The following example, from the
+ QuoteBlock definition, maps the first and section positional
+ attributes:
+
+ posattrs=attribution,citetitle
+
+style::
+ This optional parameter specifies the default style name.
+
+
+<stylename>-style::
+ Optional style definition (see <<X23,Styles>> below).
+
+The following block parameters behave like document attributes and can
+be set in block attribute lists and style definitions: 'template',
+'options', 'subs', 'presubs', 'postsubs', 'filter'.
+
+[[X23]]
+Styles
+~~~~~~
+A style is a set of block parameter bundled as a single named
+parameter. The following example defines a style named 'verbatim':
+
+ verbatim-style=template="literalblock",subs="verbatim"
+
+If a block's <<X21,attribute list>> contains a 'style' attribute then
+the corresponding style parameters are be merged into the default
+block definition parameters.
+
+- All style parameter names must be suffixed with `-style` and the
+ style parameter value is in the form of a list of <<X21,named
+ attributes>>.
+- The 'template' style parameter is mandatory, other parameters can be
+ omitted in which case they inherit their values from the default
+ block definition parameters.
+- Multi-item style parameters ('subs','presubs','postsubs','posattrs')
+ must be specified using Python tuple syntax (rather than a simple
+ list of values as they in separate entries) e.g.
+ `postsubs=("callouts",)` not `postsubs="callouts"`.
+
+Paragraphs
+~~~~~~~~~~
+Paragraph translation is controlled by `[paradef-*]` configuration
+file section entries. Users can define new types of paragraphs and
+modify the behavior of existing types by editing AsciiDoc
+configuration files.
+
+Here is the shipped Default paragraph definition:
+
+--------------------------------------------------------------------
+[paradef-default]
+delimiter=(?P<text>\S.*)
+template=paragraph
+--------------------------------------------------------------------
+
+The normal paragraph definition has a couple of special properties:
+
+1. It must exist and be defined in a configuration file section named
+ `[paradef-default]`.
+2. Irrespective of its position in the configuration files default
+ paragraph document matches are attempted only after trying all
+ other paragraph types.
+
+Paragraph specific block parameter notes:
+
+delimiter::
+ This regular expression must contain the named group 'text' which
+ matches the text on the first line. Paragraphs are terminated by a
+ blank line, the end of file, or the start of a DelimitedBlock.
+
+options::
+ The 'listelement' option specifies that paragraphs of this type will
+ automatically be considered part of immediately preceding list
+ items. The 'skip' option causes the paragraph to be treated as a
+ comment (see <<X26,CommentBlocks>>).
+
+.Paragraph processing proceeds as follows:
+1. The paragraph text is aligned to the left margin.
+2. Optional 'presubs' inline substitutions are performed on the
+ paragraph text.
+3. If a filter command is specified it is executed and the paragraph
+ text piped to its standard input; the filter output replaces the
+ paragraph text.
+4. Optional 'postsubs' inline substitutions are performed on the
+ paragraph text.
+5. The paragraph text is enveloped by the paragraph's markup template
+ and written to the output file.
+
+Delimited Blocks
+~~~~~~~~~~~~~~~~
+DelimitedBlock 'options' values are:
+
+sectionbody::
+ The block contents are processed as a SectionBody.
+
+skip::
+ The block is treated as a comment (see <<X26,CommentBlocks>>).
+ Preceding <<X21,attribute lists>> and <<X42,block titles>> are not
+ consumed.
+
+'presubs', 'postsubs' and 'filter' entries are ignored when
+'sectionbody' or 'skip' options are set.
+
+DelimitedBlock processing proceeds as follows:
+
+1. Optional 'presubs' substitutions are performed on the block
+ contents.
+2. If a filter is specified it is executed and the block's contents
+ piped to its standard input. The filter output replaces the block
+ contents.
+3. Optional 'postsubs' substitutions are performed on the block
+ contents.
+4. The block contents is enveloped by the block's markup template and
+ written to the output file.
+
+TIP: Attribute expansion is performed on the block filter command
+before it is executed, this is useful for passing arguments to the
+filter.
+
+Lists
+~~~~~
+List behavior and syntax is determined by `[listdef-*]` configuration
+file sections. The user can change existing list behavior and add new
+list types by editing configuration files.
+
+List specific block definition notes:
+
+type::
+ This is either 'bulleted','numbered','labeled' or 'callout'.
+
+delimiter::
+ A Python regular expression that matches the first line of a
+ list element entry. This expression can contain the named groups
+ 'text' (bulleted groups), 'index' and 'text' (numbered lists),
+ 'label' and 'text' (labeled lists).
+
+tags::
+ The `<name>` of the `[listtags-<name>]` configuration file section
+ containing list markup tag definitions. The tag entries ('list',
+ 'entry', 'label', 'term', 'text') map the AsciiDoc list structure to
+ backend markup; see the 'listtags' sections in the AsciiDoc
+ distributed backend `.conf` configuration files for examples.
+
+Tables
+~~~~~~
+Table behavior and syntax is determined by `[tabledef-*]` and
+`[tabletags-*]` configuration file sections. The user can change
+existing table behavior and add new table types by editing
+configuration files. The following `[tabledef-*]` section entries
+generate table output markup elements:
+
+colspec::
+ The table 'colspec' tag definition.
+
+headrow, footrow, bodyrow::
+ Table header, footer and body row tag definitions. 'headrow' and
+ 'footrow' table definition entries default to 'bodyrow' if
+ they are undefined.
+
+headdata, footdata, bodydata::
+ Table header, footer and body data tag definitions. 'headdata' and
+ 'footdata' table definition entries default to 'bodydata' if they
+ are undefined.
+
+paragraph::
+ If the 'paragraph' tag is specified then blank lines in the cell
+ data are treated as paragraph delimiters and marked up using this
+ tag.
+
+[[X4]]
+Table behavior is also influenced by the following `[miscellaneous]`
+configuration file entries:
+
+pagewidth::
+ This integer value is the printable width of the output media. See
+ <<X69,table attributes>>.
+
+pageunits::
+ The units of width in output markup width attribute values.
+
+.Table definition behavior
+- The output markup generation is specifically designed to work with
+ the HTML and CALS (DocBook) table models, but should be adaptable to
+ most XML table schema.
+- Table definitions can be ``mixed in'' from multiple cascading
+ configuration files.
+- New table definitions inherit the default table and table tags
+ definitions (`[tabledef-default]` and `[tabletags-default]`) so you
+ only need to override those conf file entries that require
+ modification.
+
+
+[[X59]]
+Filters
+-------
+AsciiDoc filters allow external commands to process AsciiDoc
+'Paragraphs', 'DelimitedBlocks' and 'Table' content. Filters are
+primarily an extension mechanism for generating specialized outputs.
+Filters are implemented using external commands which are specified in
+configuration file definitions.
+
+There's nothing special about the filters, they're just standard UNIX
+filters: they read text from the standard input, process it, and write
+to the standard output.
+
+The asciidoc(1) command `--filter` option can be used to install and
+remove filters. The same option is used to unconditionally load a
+filter.
+
+Attribute substitution is performed on the filter command prior to
+execution -- attributes can be used to pass parameters from the
+AsciiDoc source document to the filter.
+
+WARNING: Filters sometimes included executable code. Before installing
+a filter you should verify that it is from a trusted source.
+
+Filter Search Paths
+~~~~~~~~~~~~~~~~~~~
+If the filter command does not specify a directory path then
+asciidoc(1) recursively searches for the executable filter command:
+
+- First it looks in the user's `$HOME/.asciidoc/filters` directory.
+- Next the global filters directory (usually `/etc/asciidoc/filters`
+ or `/usr/local/etc/asciidoc`) directory is searched.
+- Then it looks in the asciidoc(1) `./filters` directory.
+- Finally it relies on the executing shell to search the environment
+ search path (`$PATH`).
+
+Standard practice is to install each filter in it's own sub-directory
+with the same name as the filter's style definition. For example the
+music filter's style name is 'music' so it's configuration and filter
+files are stored in the `filters/music` directory.
+
+Filter Configuration Files
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+Filters are normally accompanied by a configuration file containing a
+Paragraph or DelimitedBlock definition along with corresponding markup
+templates.
+
+While it is possible to create new 'Paragraph' or 'DelimitedBlock'
+definitions the preferred way to implement a filter is to add a
+<<X23,style>> to the existing Paragraph and ListingBlock definitions
+(all filters shipped with AsciiDoc use this technique). The filter is
+applied to the paragraph or delimited block by preceding it with an
+attribute list: the first positional attribute is the style name,
+remaining attributes are normally filter specific parameters.
+
+asciidoc(1) auto-loads all `.conf` files found in the filter search
+paths unless the container directory also contains a file named
+`__noautoload__` (see previous section). The `__noautoload__` feature
+is used for filters that will be loaded manually using the `--filter`
+option.
+
+[[X56]]
+Example Filter
+~~~~~~~~~~~~~~
+AsciiDoc comes with a toy filter for highlighting source code keywords
+and comments. See also the `./filters/code/code-filter-readme.txt`
+file.
+
+NOTE: The purpose of this toy filter is to demonstrate how to write a
+filter -- it's much to simplistic to be passed off as a code syntax
+highlighter. If you want a full featured multi-language highlighter
+use the {website}source-highlight-filter.html[source code highlighter
+filter].
+
+Built-in filters
+~~~~~~~~~~~~~~~~
+The AsciiDoc distribution includes 'source', 'music', 'latex' and
+'graphviz' filters, details are on the
+{website}index.html#_filters[AsciiDoc website].
+
+[cols="1e,5",frame="topbot",options="header"]
+.Built-in filters list
+|====================================================================
+|Filter name |Description
+
+|music
+|A {website}music-filter.html[music filter] is included in the
+distribution `./filters/` directory. It translates music in
+http://lilypond.org/[LilyPond] or http://abcnotation.org.uk/[ABC]
+notation to standard classical notation.
+
+|source
+|A {website}source-highlight-filter.html[source code highlight filter]
+is included in the distribution `./filters/` directory.
+
+|latex
+|The {website}latex-filter.html[AsciiDoc LaTeX filter] translates
+LaTeX source to a PNG image that is automatically inserted into the
+AsciiDoc output documents.
+
+|graphviz
+|Gouichi Iisaka has written a http://www.graphviz.org/[Graphviz]
+filter for AsciiDoc. Graphviz generates diagrams from a textual
+specification. Gouichi Iisaka's Graphviz filter is included in the
+AsciiDoc distribution. Here are some
+{website}asciidoc-graphviz-sample.html[AsciiDoc Graphviz examples].
+
+|====================================================================
+
+[[X58]]
+Filter plugins
+~~~~~~~~~~~~~~
+Filter <<X101,plugins>> are a mechanism for distributing AsciiDoc
+filters. A filter plugin is a Zip file containing the files that
+constitute a filter. The asciidoc(1) `--filter` option is used to
+load and manage filer <<X101,plugins>>.
+
+- Filter plugins <<X27,take precedence>> over built-in filters with
+ the same name.
+- By default filter plugins are installed in
+ `$HOME/.asciidoc/filters/<filter>` where `<filter>` is the filter
+ name.
+
+
+[[X101]]
+Plugins
+-------
+The AsciiDoc plugin architecture is an extension mechanism that allows
+additional <<X100,backends>>, <<X58,filters>> and <<X99,themes>> to be
+added to AsciiDoc.
+
+- A plugin is a Zip file containing an AsciiDoc backend, filter or
+ theme (configuration files, stylesheets, scripts, images).
+- The asciidoc(1) `--backend`, `--filter` and `--theme` command-line
+ options are used to load and manage plugins. Each of these options
+ responds to the plugin management 'install', 'list', 'remove' and
+ 'build' commands.
+- The plugin management command names are reserved and cannot be used
+ for filter, backend or theme names.
+- The plugin Zip file name always begins with the backend, filter or
+ theme name.
+
+Plugin commands and conventions are documented in the asciidoc(1) man
+page. You can find lists of plugins on the
+{website}plugins.html[AsciiDoc website].
+
+
+[[X36]]
+Help Commands
+-------------
+The asciidoc(1) command has a `--help` option which prints help topics
+to stdout. The default topic summarizes asciidoc(1) usage:
+
+ $ asciidoc --help
+
+To print a help topic specify the topic name as a command argument.
+Help topic names can be shortened so long as they are not ambiguous.
+Examples:
+
+ $ asciidoc --help manpage
+ $ asciidoc -h m # Short version of previous example.
+ $ asciidoc --help syntax
+ $ asciidoc -h s # Short version of previous example.
+
+Customizing Help
+~~~~~~~~~~~~~~~~
+To change, delete or add your own help topics edit a help
+configuration file. The help file name `help-<lang>.conf` is based on
+the setting of the `lang` attribute, it defaults to `help.conf`
+(English). The <<X27,help file location>> will depend on whether you
+want the topics to apply to all users or just the current user.
+
+The help topic files have the same named section format as other
+<<X7,configuration files>>. The `help.conf` files are stored in the
+same locations and loaded in the same order as other configuration
+files.
+
+When the `--help` command-line option is specified AsciiDoc loads the
+appropriate help files and then prints the contents of the section
+whose name matches the help topic name. If a topic name is not
+specified `default` is used. You don't need to specify the whole help
+topic name on the command-line, just enough letters to ensure it's not
+ambiguous. If a matching help file section is not found a list of
+available topics is printed.
+
+
+Tips and Tricks
+---------------
+
+Know Your Editor
+~~~~~~~~~~~~~~~~
+Writing AsciiDoc documents will be a whole lot more pleasant if you
+know your favorite text editor. Learn how to indent and reformat text
+blocks, paragraphs, lists and sentences. <<X20,Tips for 'vim' users>>
+follow.
+
+[[X20]]
+Vim Commands for Formatting AsciiDoc
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Text Wrap Paragraphs
+^^^^^^^^^^^^^^^^^^^^
+Use the vim `:gq` command to reformat paragraphs. Setting the
+'textwidth' sets the right text wrap margin; for example:
+
+ :set textwidth=70
+
+To reformat a paragraph:
+
+1. Position the cursor at the start of the paragraph.
+2. Type `gq}`.
+
+Execute `:help gq` command to read about the vim gq command.
+
+[TIP]
+=====================================================================
+- Assign the `gq}` command to the Q key with the `nnoremap Q gq}`
+ command or put it in your `~/.vimrc` file to so it's always
+ available (see the <<X61, Example `~/.vimrc` file>>).
+- Put `set` commands in your `~/.vimrc` file so you don't have to
+ enter them manually.
+- The Vim website (http://www.vim.org) has a wealth of resources,
+ including scripts for automated spell checking and ASCII Art
+ drawing.
+=====================================================================
+
+Format Lists
+^^^^^^^^^^^^
+The `gq` command can also be used to format bulleted, numbered and
+callout lists. First you need to set the `comments`, `formatoptions`
+and `formatlistpat` (see the <<X61, Example `~/.vimrc` file>>).
+
+Now you can format simple lists that use dash, asterisk, period and
+plus bullets along with numbered ordered lists:
+
+1. Position the cursor at the start of the list.
+2. Type `gq}`.
+
+Indent Paragraphs
+^^^^^^^^^^^^^^^^^
+Indent whole paragraphs by indenting the fist line with the desired
+indent and then executing the `gq}` command.
+
+[[X61]]
+Example `~/.vimrc` File
+^^^^^^^^^^^^^^^^^^^^^^^
+---------------------------------------------------------------------
+" Use bold bright fonts.
+set background=dark
+
+" Show tabs and trailing characters.
+set listchars=tab:,trail:
+set list
+
+" Don't highlight searched text.
+highlight clear Search
+
+" Don't move to matched text while search pattern is being entered.
+set noincsearch
+
+" Reformat paragraphs and list.
+nnoremap R gq}
+
+" Delete trailing white space and Dos-returns and to expand tabs to spaces.
+nnoremap S :set et<CR>:retab!<CR>:%s/[\r \t]\+$//<CR>
+
+autocmd BufRead,BufNewFile *.txt,README,TODO,CHANGELOG,NOTES
+ \ setlocal autoindent expandtab tabstop=8 softtabstop=2 shiftwidth=2 filetype=asciidoc
+ \ textwidth=70 wrap formatoptions=tcqn
+ \ formatlistpat=^\\s*\\d\\+\\.\\s\\+\\\\|^\\s*<\\d\\+>\\s\\+\\\\|^\\s*[a-zA-Z.]\\.\\s\\+\\\\|^\\s*[ivxIVX]\\+\\.\\s\\+
+ \ comments=s1:/*,ex:*/,://,b:#,:%,:XCOMM,fb:-,fb:*,fb:+,fb:.,fb:>
+---------------------------------------------------------------------
+
+Troubleshooting
+~~~~~~~~~~~~~~~
+AsciiDoc diagnostic features are detailed in the <<X82,Diagnostics
+appendix>>.
+
+Gotchas
+~~~~~~~
+Incorrect character encoding::
+ If you get an error message like `'UTF-8' codec can't decode ...`
+ then you source file contains invalid UTF-8 characters -- set the
+ AsciiDoc <<X54,encoding attribute>> for the correct character set
+ (typically ISO-8859-1 (Latin-1) for European languages).
+
+Invalid output::
+ AsciiDoc attempts to validate the input AsciiDoc source but makes
+ no attempt to validate the output markup, it leaves that to
+ external tools such as `xmllint(1)` (integrated into `a2x(1)`).
+ Backend validation cannot be hardcoded into AsciiDoc because
+ backends are dynamically configured. The following example
+ generates valid HTML but invalid DocBook (the DocBook `literal`
+ element cannot contain an `emphasis` element):
+
+ +monospaced text with an _emphasized_ word+
+
+Misinterpreted text formatting::
+ You can suppress markup expansion by placing a backslash character
+ immediately in front of the element. The following example
+ suppresses inline monospaced formatting:
+
+ \+1 for C++.
+
+Overlapping text formatting::
+ Overlapping text formatting will generate illegal overlapping
+ markup tags which will result in downstream XML parsing errors.
+ Here's an example:
+
+ Some *strong markup _that overlaps* emphasized markup_.
+
+Ambiguous underlines::
+ A DelimitedBlock can immediately follow a paragraph without an
+ intervening blank line, but be careful, a single line paragraph
+ underline may be misinterpreted as a section title underline
+ resulting in a ``closing block delimiter expected'' error.
+
+Ambiguous ordered list items::
+ Lines beginning with numbers at the end of sentences will be
+ interpreted as ordered list items. The following example
+ (incorrectly) begins a new list with item number 1999:
+
+ He was last sighted in
+ 1999. Since then things have moved on.
++
+The 'list item out of sequence' warning makes it unlikely that this
+problem will go unnoticed.
+
+Special characters in attribute values::
+ Special character substitution precedes attribute substitution so
+ if attribute values contain special characters you may, depending
+ on the substitution context, need to escape the special characters
+ yourself. For example:
+
+ $ asciidoc -a 'orgname=Bill & Ben Inc.' mydoc.txt
+
+Attribute lists::
+ If any named attribute entries are present then all string
+ attribute values must be quoted. For example:
+
+ ["Desktop screenshot",width=32]
+
+[[X90]]
+Combining separate documents
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+You have a number of stand-alone AsciiDoc documents that you want to
+process as a single document. Simply processing them with a series of
+`include` macros won't work because the documents contain (level 0)
+document titles. The solution is to create a top level wrapper
+document and use the `leveloffset` attribute to push them all down one
+level. For example:
+
+[listing]
+.....................................................................
+Combined Document Title
+=======================
+
+// Push titles down one level.
+:leveloffset: 1
+
+\include::document1.txt[]
+
+// Return to normal title levels.
+:leveloffset: 0
+
+A Top Level Section
+-------------------
+Lorum ipsum.
+
+// Push titles down one level.
+:leveloffset: 1
+
+\include::document2.txt[]
+
+\include::document3.txt[]
+.....................................................................
+
+The document titles in the included documents will now be processed as
+level 1 section titles, level 1 sections as level 2 sections and so
+on.
+
+- Put a blank line between the `include` macro lines to ensure the
+ title of the included document is not seen as part of the last
+ paragraph of the previous document.
+- You won't want non-title document header lines (for example, Author
+ and Revision lines) in the included files -- conditionally exclude
+ them if they are necessary for stand-alone processing.
+
+Processing document sections separately
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+You have divided your AsciiDoc document into separate files (one per
+top level section) which are combined and processed with the following
+top level document:
+
+---------------------------------------------------------------------
+Combined Document Title
+=======================
+Joe Bloggs
+v1.0, 12-Aug-03
+
+\include::section1.txt[]
+
+\include::section2.txt[]
+
+\include::section3.txt[]
+---------------------------------------------------------------------
+
+You also want to process the section files as separate documents.
+This is easy because asciidoc(1) will quite happily process
+`section1.txt`, `section2.txt` and `section3.txt` separately -- the
+resulting output documents contain the section but have no document
+title.
+
+Processing document snippets
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Use the `-s` (`--no-header-footer`) command-line option to suppress
+header and footer output, this is useful if the processed output is to
+be included in another file. For example:
+
+ $ asciidoc -sb docbook section1.txt
+
+asciidoc(1) can be used as a filter, so you can pipe chunks of text
+through it. For example:
+
+ $ echo 'Hello *World!*' | asciidoc -s -
+ <div class="paragraph"><p>Hello <strong>World!</strong></p></div>
+
+Badges in HTML page footers
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+See the `[footer]` section in the AsciiDoc distribution `xhtml11.conf`
+configuration file.
+
+Pretty printing AsciiDoc output
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+If the indentation and layout of the asciidoc(1) output is not to your
+liking you can:
+
+1. Change the indentation and layout of configuration file markup
+ template sections. The `{empty}` attribute is useful for outputting
+ trailing blank lines in markup templates.
+
+2. Use Dave Raggett's http://tidy.sourceforge.net/[HTML Tidy] program
+ to tidy asciidoc(1) output. Example:
+
+ $ asciidoc -b docbook -o - mydoc.txt | tidy -indent -xml >mydoc.xml
+
+3. Use the `xmllint(1)` format option. Example:
+
+ $ xmllint --format mydoc.xml
+
+Supporting minor DocBook DTD variations
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The conditional inclusion of DocBook SGML markup at the end of the
+distribution `docbook45.conf` file illustrates how to support minor
+DTD variations. The included sections override corresponding entries
+from preceding sections.
+
+Creating stand-alone HTML documents
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+If you've ever tried to send someone an HTML document that includes
+stylesheets and images you'll know that it's not as straight-forward
+as exchanging a single file. AsciiDoc has options to create
+stand-alone documents containing embedded images, stylesheets and
+scripts. The following AsciiDoc command creates a single file
+containing <<X66,embedded images>>, CSS stylesheets, and JavaScript
+(for table of contents and footnotes):
+
+ $ asciidoc -a data-uri -a icons -a toc -a max-width=55em article.txt
+
+You can view the HTML file here: {website}article-standalone.html[]
+
+Shipping stand-alone AsciiDoc source
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Reproducing presentation documents from someone else's source has one
+major problem: unless your configuration files are the same as the
+creator's you won't get the same output.
+
+The solution is to create a single backend specific configuration file
+using the asciidoc(1) `-c` (`--dump-conf`) command-line option. You
+then ship this file along with the AsciiDoc source document plus the
+`asciidoc.py` script. The only end user requirement is that they have
+Python installed (and that they consider you a trusted source). This
+example creates a composite HTML configuration file for `mydoc.txt`:
+
+ $ asciidoc -cb xhtml11 mydoc.txt > mydoc-xhtml11.conf
+
+Ship `mydoc.txt`, `mydoc-html.conf`, and `asciidoc.py`. With
+these three files (and a Python interpreter) the recipient can
+regenerate the HMTL output:
+
+ $ ./asciidoc.py -eb xhtml11 mydoc.txt
+
+The `-e` (`--no-conf`) option excludes the use of implicit
+configuration files, ensuring that only entries from the
+`mydoc-html.conf` configuration are used.
+
+Inserting blank space
+~~~~~~~~~~~~~~~~~~~~~
+Adjust your style sheets to add the correct separation between block
+elements. Inserting blank paragraphs containing a single non-breaking
+space character `{nbsp}` works but is an ad hoc solution compared
+to using style sheets.
+
+Closing open sections
+~~~~~~~~~~~~~~~~~~~~~
+You can close off section tags up to level `N` by calling the
+`eval::[Section.setlevel(N)]` system macro. This is useful if you
+want to include a section composed of raw markup. The following
+example includes a DocBook glossary division at the top section level
+(level 0):
+
+---------------------------------------------------------------------
+\ifdef::basebackend-docbook[]
+
+\eval::[Section.setlevel(0)]
+
++++++++++++++++++++++++++++++++
+<glossary>
+ <title>Glossary
+
+ ...
+
+
++++++++++++++++++++++++++++++++
+\endif::basebackend-docbook[]
+---------------------------------------------------------------------
+
+Validating output files
+~~~~~~~~~~~~~~~~~~~~~~~
+Use `xmllint(1)` to check the AsciiDoc generated markup is both well
+formed and valid. Here are some examples:
+
+ $ xmllint --nonet --noout --valid docbook-file.xml
+ $ xmllint --nonet --noout --valid xhtml11-file.html
+ $ xmllint --nonet --noout --valid --html html4-file.html
+
+The `--valid` option checks the file is valid against the document
+type's DTD, if the DTD is not installed in your system's catalog then
+it will be fetched from its Internet location. If you omit the
+`--valid` option the document will only be checked that it is well
+formed.
+
+The online http://validator.w3.org/#validate_by_uri+with_options[W3C
+Markup Validation Service] is the defacto standard when it comes to
+validating HTML (it validates all HTML standards including HTML5).
+
+
+:numbered!:
+
+[glossary]
+Glossary
+--------
+[glossary]
+[[X8]] Block element::
+ An AsciiDoc block element is a document entity composed of one or
+ more whole lines of text.
+
+[[X34]] Inline element::
+ AsciiDoc inline elements occur within block element textual
+ content, they perform formatting and substitution tasks.
+
+Formal element::
+ An AsciiDoc block element that has a BlockTitle. Formal elements
+ are normally listed in front or back matter, for example lists of
+ tables, examples and figures.
+
+Verbatim element::
+ The word verbatim indicates that white space and line breaks in
+ the source document are to be preserved in the output document.
+
+
+[appendix]
+Migration Notes
+---------------
+[[X53]]
+Version 7 to version 8
+~~~~~~~~~~~~~~~~~~~~~~
+- A new set of quotes has been introduced which may match inline text
+ in existing documents -- if they do you'll need to escape the
+ matched text with backslashes.
+- The index entry inline macro syntax has changed -- if your documents
+ include indexes you may need to edit them.
+- Replaced a2x(1) `--no-icons` and `--no-copy` options with their
+ negated equivalents: `--icons` and `--copy` respectively. The
+ default behavior has also changed -- the use of icons and copying of
+ icon and CSS files must be specified explicitly with the `--icons`
+ and `--copy` options.
+
+The rationale for the changes can be found in the AsciiDoc
+`CHANGELOG`.
+
+NOTE: If you want to disable unconstrained quotes, the new alternative
+constrained quotes syntax and the new index entry syntax then you can
+define the attribute `asciidoc7compatible` (for example by using the
+`-a asciidoc7compatible` command-line option).
+
+[[X38]]
+[appendix]
+Packager Notes
+--------------
+Read the `README` and `INSTALL` files (in the distribution root
+directory) for install prerequisites and procedures. The distribution
+`Makefile.in` (used by `configure` to generate the `Makefile`) is the
+canonical installation procedure.
+
+
+[[X39]]
+[appendix]
+AsciiDoc Safe Mode
+-------------------
+AsciiDoc 'safe mode' skips potentially dangerous scripted sections in
+AsciiDoc source files by inhibiting the execution of arbitrary code or
+the inclusion of arbitrary files.
+
+The safe mode is disabled by default, it can be enabled with the
+asciidoc(1) `--safe` command-line option.
+
+.Safe mode constraints
+- `eval`, `sys` and `sys2` executable attributes and block macros are
+ not executed.
+- `include::[]` and `include1::[]` block macro
+ files must reside inside the parent file's directory.
+- `{include:}` executable attribute files must reside
+ inside the source document directory.
+- Passthrough Blocks are dropped.
+
+[WARNING]
+=====================================================================
+The safe mode is not designed to protect against unsafe AsciiDoc
+configuration files. Be especially careful when:
+
+1. Implementing filters.
+2. Implementing elements that don't escape special characters.
+3. Accepting configuration files from untrusted sources.
+=====================================================================
+
+
+[appendix]
+Using AsciiDoc with non-English Languages
+-----------------------------------------
+AsciiDoc can process UTF-8 character sets but there are some things
+you need to be aware of:
+
+- If you are generating output documents using a DocBook toolchain
+ then you should set the AsciiDoc `lang` attribute to the appropriate
+ language (it defaults to `en` (English)). This will ensure things
+ like table of contents, figure and table captions and admonition
+ captions are output in the specified language. For example:
+
+ $ a2x -a lang=es doc/article.txt
+
+- If you are outputting HTML directly from asciidoc(1) you'll
+ need to set the various `*_caption` attributes to match your target
+ language (see the list of captions and titles in the `[attributes]`
+ section of the distribution `lang-*.conf` files). The easiest way is
+ to create a language `.conf` file (see the AsciiDoc's `lang-en.conf`
+ file).
++
+NOTE: You still use the 'NOTE', 'CAUTION', 'TIP', 'WARNING',
+'IMPORTANT' captions in the AsciiDoc source, they get translated in
+the HTML output file.
+
+- asciidoc(1) automatically loads configuration files named like
+ `lang-.conf` where `` is a two letter language code that
+ matches the current AsciiDoc `lang` attribute. See also
+ <>.
+
+
+[appendix]
+Vim Syntax Highlighter
+----------------------
+Syntax highlighting is incredibly useful, in addition to making
+reading AsciiDoc documents much easier syntax highlighting also helps
+you catch AsciiDoc syntax errors as you write your documents.
+
+The AsciiDoc `./vim/` distribution directory contains Vim syntax
+highlighter and filetype detection scripts for AsciiDoc. Syntax
+highlighting makes it much easier to spot AsciiDoc syntax errors.
+
+If Vim is installed on your system the AsciiDoc installer
+(`install.sh`) will automatically install the vim scripts in the Vim
+global configuration directory (`/etc/vim`).
+
+You can also turn on syntax highlighting by adding the following line
+to the end of you AsciiDoc source files:
+
+ // vim: set syntax=asciidoc:
+
+TIP: Bold fonts are often easier to read, use the Vim `:set
+background=dark` command to set bold bright fonts.
+
+NOTE: There are a number of alternative syntax highlighters for
+various editors listed on the {website}[AsciiDoc website].
+
+Limitations
+~~~~~~~~~~~
+The current implementation does a reasonable job but on occasions gets
+things wrong:
+
+- Nested quoted text formatting is highlighted according to the outer
+ format.
+- If a closing Example Block delimiter is sometimes mistaken for a
+ title underline. A workaround is to insert a blank line before the
+ closing delimiter.
+- Lines within a paragraph starting with equals characters may be
+ highlighted as single-line titles.
+- Lines within a paragraph beginning with a period may be highlighted
+ as block titles.
+
+
+[[X74]]
+[appendix]
+Attribute Options
+-----------------
+Here is the list of predefined <>:
+
+
+[cols="2e,2,2,5",frame="topbot",options="header"]
+|====================================================================
+|Option|Backends|AsciiDoc Elements|Description
+
+|autowidth |xhtml11, html5, html4 |table|
+The column widths are determined by the browser, not the AsciiDoc
+'cols' attribute. If there is no 'width' attribute the table width is
+also left up to the browser.
+
+|unbreakable |xhtml11, html5 |block elements|
+'unbreakable' attempts to keep the block element together on a single
+printed page c.f. the 'breakable' and 'unbreakable' docbook (XSL/FO)
+options below.
+
+|breakable, unbreakable |docbook (XSL/FO) |table, example, block image|
+The 'breakable' options allows block elements to break across page
+boundaries; 'unbreakable' attempts to keep the block element together
+on a single page. If neither option is specified the default XSL
+stylesheet behavior prevails.
+
+|compact |docbook, xhtml11, html5 |bulleted list, numbered list|
+Minimizes vertical space in the list
+
+|footer |docbook, xhtml11, html5, html4 |table|
+The last row of the table is rendered as a footer.
+
+|header |docbook, xhtml11, html5, html4 |table|
+The first row of the table is rendered as a header.
+
+|pgwide |docbook (XSL/FO) |table, block image, horizontal labeled list|
+Specifies that the element should be rendered across the full text
+width of the page irrespective of the current indentation.
+
+|strong |xhtml11, html5, html4 |labeled lists|
+Emboldens label text.
+|====================================================================
+
+
+[[X82]]
+[appendix]
+Diagnostics
+-----------
+The `asciidoc(1)` `--verbose` command-line option prints additional
+information to stderr: files processed, filters processed, warnings,
+system attribute evaluation.
+
+A special attribute named 'trace' enables the output of
+element-by-element diagnostic messages detailing output markup
+generation to stderr. The 'trace' attribute can be set on the
+command-line or from within the document using <> (the latter allows tracing to be confined to specific
+portions of the document).
+
+- Trace messages print the source file name and line number and the
+ trace name followed by related markup.
+- 'trace names' are normally the names of AsciiDoc elements (see the
+ list below).
+- The trace message is only printed if the 'trace' attribute value
+ matches the start of a 'trace name'. The 'trace' attribute value can
+ be any Python regular expression. If a trace value is not specified
+ all trace messages will be printed (this can result in large amounts
+ of output if applied to the whole document).
+
+- In the case of inline substitutions:
+ * The text before and after the substitution is printed; the before
+ text is preceded by a line containing `<<<` and the after text by
+ a line containing `>>>`.
+ * The 'subs' trace value is an alias for all inline substitutions.
+
+.Trace names
+.....................................................................
+ block close
+ block open
+
+dropped line (a line containing an undefined attribute reference).
+floating title
+footer
+header
+list close
+list entry close
+list entry open
+list item close
+list item open
+list label close
+list label open
+list open
+macro block (a block macro)
+name (man page NAME section)
+paragraph
+preamble close
+preamble open
+push blockname
+pop blockname
+section close
+section open: level
+subs (all inline substitutions)
+table
+.....................................................................
+
+Where:
+
+- `` is section level number '0...4'.
+- `` is a delimited block name: 'comment', 'sidebar',
+ 'open', 'pass', 'listing', 'literal', 'quote', 'example'.
+- `` is an inline substitution type:
+ 'specialcharacters','quotes','specialwords', 'replacements',
+ 'attributes','macros','callouts', 'replacements2', 'replacements3'.
+
+Command-line examples:
+
+. Trace the entire document.
+
+ $ asciidoc -a trace mydoc.txt
+
+. Trace messages whose names start with `quotes` or `macros`:
+
+ $ asciidoc -a 'trace=quotes|macros' mydoc.txt
+
+. Print the first line of each trace message:
+
+ $ asciidoc -a trace mydoc.txt 2>&1 | grep ^TRACE:
+
+Attribute Entry examples:
+
+. Begin printing all trace messages:
+
+ :trace:
+
+. Print only matched trace messages:
+
+ :trace: quotes|macros
+
+. Turn trace messages off:
+
+ :trace!:
+
+
+[[X88]]
+[appendix]
+Backend Attributes
+------------------
+This table contains a list of optional attributes that influence the
+generated outputs.
+
+[cols="1e,1,5a",frame="topbot",options="header"]
+|====================================================================
+|Name |Backends |Description
+
+|badges |xhtml11, html5 |
+Link badges ('XHTML 1.1' and 'CSS') in document footers. By default
+badges are omitted ('badges' is undefined).
+
+NOTE: The path names of images, icons and scripts are relative path
+names to the output document not the source document.
+
+|data-uri |xhtml11, html5 |
+Embed images using the <>.
+
+|css-signature |html5, xhtml11 |
+Set a 'CSS signature' for the document (sets the 'id' attribute of the
+HTML 'body' element). CSS signatures provide a mechanism that allows
+users to personalize the document appearance. The term 'CSS signature'
+was http://archivist.incutio.com/viewlist/css-discuss/13291[coined by
+Eric Meyer].
+
+
+|disable-javascript |xhtml11, html5 |
+If the `disable-javascript` attribute is defined the `asciidoc.js`
+JavaScript is not embedded or linked to the output document. By
+default AsciiDoc automatically embeds or links the `asciidoc.js`
+JavaScript to the output document. The script dynamically generates
+<> and <>.
+
+|[[X97]] docinfo, docinfo1, docinfo2 |All backends |
+These three attributes control which <> will be included in the the header of the output file:
+
+docinfo:: Include `-docinfo.`
+docinfo1:: Include `docinfo.`
+docinfo2:: Include `docinfo.` and `-docinfo.`
+
+Where `` is the file name (sans extension) of the AsciiDoc
+input file and `` is `.html` for HTML outputs or `.xml` for
+DocBook outputs. If the input file is the standard input then the
+output file name is used. The following example will include the
+`mydoc-docinfo.xml` docinfo file in the DocBook `mydoc.xml` output
+file:
+
+ $ asciidoc -a docinfo -b docbook mydoc.txt
+
+This next example will include `docinfo.html` and `mydoc-docinfo.html`
+docinfo files in the HTML output file:
+
+ $ asciidoc -a docinfo2 -b html4 mydoc.txt
+
+
+|[[X54]]encoding |html4, html5, xhtml11, docbook |
+Set the input and output document character set encoding. For example
+the `--attribute encoding=ISO-8859-1` command-line option will set the
+character set encoding to `ISO-8859-1`.
+
+- The default encoding is UTF-8.
+- This attribute specifies the character set in the output document.
+- The encoding name must correspond to a Python codec name or alias.
+- The 'encoding' attribute can be set using an AttributeEntry inside
+ the document header. For example:
+
+ :encoding: ISO-8859-1
+
+|[[X45]]icons |xhtml11, html5 |
+Link admonition paragraph and admonition block icon images and badge
+images. By default 'icons' is undefined and text is used in place of
+icon images.
+
+|[[X44]]iconsdir |html4, html5, xhtml11, docbook |
+The name of the directory containing linked admonition icons,
+navigation icons and the `callouts` sub-directory (the `callouts`
+sub-directory contains <> number images). 'iconsdir'
+defaults to `./images/icons`.
+
+|imagesdir |html4, html5, xhtml11, docbook |
+If this attribute is defined it is prepended to the target image file
+name paths in inline and block image macros.
+
+|keywords, description, title |html4, html5, xhtml11 |
+The 'keywords' and 'description' attributes set the correspondingly
+named HTML meta tag contents; the 'title' attribute sets the HTML
+title tag contents. Their principle use is for SEO (Search Engine
+Optimisation). All three are optional, but if they are used they must
+appear in the document header (or on the command-line). If 'title' is
+not specified the AsciiDoc document title is used.
+
+|linkcss |html5, xhtml11 |
+Link CSS stylesheets and JavaScripts. By default 'linkcss' is
+undefined in which case stylesheets and scripts are automatically
+embedded in the output document.
+
+|[[X103]]max-width |html5, xhtml11 |
+Set the document maximum display width (sets the 'body' element CSS
+'max-width' property).
+
+|numbered |html4, html5, xhtml11, docbook (XSL Stylesheets) |
+Adds section numbers to section titles. The 'docbook' backend ignores
+'numbered' attribute entries after the document header.
+
+|plaintext | All backends |
+If this global attribute is defined all inline substitutions are
+suppressed and block indents are retained. This option is useful when
+dealing with large amounts of imported plain text.
+
+|quirks |xhtml11 |
+Include the `xhtml11-quirks.conf` configuration file and
+`xhtml11-quirks.css` <> to work around IE6 browser
+incompatibilities. This feature is deprecated and its use is
+discouraged -- documents are still viewable in IE6 without it.
+
+|revremark |docbook |
+A short summary of changes in this document revision. Must be defined
+prior to the first document section. The document also needs to be
+dated to output this attribute.
+
+|scriptsdir |html5, xhtml11 |
+The name of the directory containing linked JavaScripts.
+See <>.
+
+|sgml |docbook45 |
+The `--backend=docbook45` command-line option produces DocBook 4.5
+XML. You can produce the older DocBook SGML format using the
+`--attribute sgml` command-line option.
+
+|stylesdir |html5, xhtml11 |
+The name of the directory containing linked or embedded
+<>.
+See <>.
+
+|stylesheet |html5, xhtml11 |
+The file name of an optional additional CSS <>.
+
+|theme |html5, xhtml11 |
+Use alternative stylesheet (see <>).
+
+|[[X91]]toc |html5, xhtml11, docbook (XSL Stylesheets) |
+Adds a table of contents to the start of an article or book document.
+The `toc` attribute can be specified using the `--attribute toc`
+command-line option or a `:toc:` attribute entry in the document
+header. The 'toc' attribute is defined by default when the 'docbook'
+backend is used. To disable table of contents generation undefine the
+'toc' attribute by putting a `:toc!:` attribute entry in the document
+header or from the command-line with an `--attribute toc!` option.
+
+*xhtml11 and html5 backends*
+
+- JavaScript needs to be enabled in your browser.
+- The following example generates a numbered table of contents using a
+ JavaScript embedded in the `mydoc.html` output document:
+
+ $ asciidoc -a toc -a numbered mydoc.txt
+
+|toc2 |html5, xhtml11 |
+Adds a scrollable table of contents in the left hand margin of an
+article or book document. Use the 'max-width' attribute to change the
+content width. In all other respects behaves the same as the 'toc'
+attribute.
+
+|toc-placement |html5, xhtml11 |
+When set to 'auto' (the default value) asciidoc(1) will place the
+table of contents in the document header. When 'toc-placement' is set
+to 'manual' the TOC can be positioned anywhere in the document by
+placing the `toc::[]` block macro at the point you want the TOC to
+appear.
+
+NOTE: If you use 'toc-placement' then you also have to define the
+<> attribute.
+
+|toc-title |html5, xhtml11 |
+Sets the table of contents title (defaults to 'Table of Contents').
+
+|toclevels |html5, xhtml11 |
+Sets the number of title levels (1..4) reported in the table of
+contents (see the 'toc' attribute above). Defaults to 2 and must be
+used with the 'toc' attribute. Example usage:
+
+ $ asciidoc -a toc -a toclevels=3 doc/asciidoc.txt
+
+|====================================================================
+
+
+[appendix]
+License
+-------
+AsciiDoc is free software; you can redistribute it and/or modify it
+under the terms of the 'GNU General Public License version 2' (GPLv2)
+as published by the Free Software Foundation.
+
+AsciiDoc is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+General Public License version 2 for more details.
+
+AsciiDoc Highlighter sponsored by O'Reilly Media
+
+Copyright (C) 2002-2011 Stuart Rackham.
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/assembly_x86.asm b/_embed/public/ace/demo/kitchen-sink/docs/assembly_x86.asm
new file mode 100644
index 00000000..01e8305c
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/assembly_x86.asm
@@ -0,0 +1,18 @@
+section .text
+ global main ;must be declared for using gcc
+
+main: ;tell linker entry point
+
+ mov edx, len ;message length
+ mov ecx, msg ;message to write
+ mov ebx, 1 ;file descriptor (stdout)
+ mov eax, 4 ;system call number (sys_write)
+ int 0x80 ;call kernel
+
+ mov eax, 1 ;system call number (sys_exit)
+ int 0x80 ;call kernel
+
+section .data
+
+msg db 'Hello, world!',0xa ;our dear string
+len equ $ - msg ;length of our dear string
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/autohotkey.ahk b/_embed/public/ace/demo/kitchen-sink/docs/autohotkey.ahk
new file mode 100644
index 00000000..73687e67
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/autohotkey.ahk
@@ -0,0 +1,35 @@
+#NoEnv
+SetBatchLines -1
+
+CoordMode Mouse, Screen
+OnExit GuiClose
+
+zoom := 9
+
+computeSize(){
+ global as_x
+ as_x := Round(ws_x/zoom/2 - 0.5)
+ if (zoom>1) {
+ pix := Round(zoom)
+ } ele {
+ pix := 1
+ }
+ ToolTip Message %as_x% %zoom% %ws_x% %hws_x%
+}
+
+hdc_frame := DllCall("GetDC", UInt, MagnifierID)
+
+; comment
+DrawCross(byRef x="", rX,rY,z, dc){
+ ;specify the style, thickness and color of the cross lines
+ h_pen := DllCall( "gdi32.dll\CreatePen", Int, 0, Int, 1, UInt, 0x0000FF)
+}
+
+;Ctrl ^; Shift +; Win #; Alt !
+^NumPadAdd::
+^WheelUp::
+^;:: ;comment
+ If(zoom < ws_x and ( A_ThisHotKey = "^WheelUp" or A_ThisHotKey ="^NumPadAdd") )
+ zoom *= 1.189207115 ; sqrt(sqrt(2))
+ Gosub,setZoom
+return
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/batchfile.bat b/_embed/public/ace/demo/kitchen-sink/docs/batchfile.bat
new file mode 100644
index 00000000..c066a9e9
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/batchfile.bat
@@ -0,0 +1,15 @@
+:: batch file highlighting in Ace!
+@echo off
+
+CALL set var1=%cd%
+echo unhide everything in %var1%!
+
+:: FOR loop in bat is super strange!
+FOR /f "tokens=*" %%G IN ('dir /A:D /b') DO (
+echo %var1%%%G
+attrib -r -a -h -s "%var1%%%G" /D /S
+)
+
+pause
+
+REM that's all
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/bro.bro b/_embed/public/ace/demo/kitchen-sink/docs/bro.bro
new file mode 100644
index 00000000..937d37dc
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/bro.bro
@@ -0,0 +1,26 @@
+##! Add countries for the originator and responder of a connection
+##! to the connection logs.
+
+module Conn;
+
+export {
+ redef record Conn::Info += {
+ ## Country code for the originator of the connection based
+ ## on a GeoIP lookup.
+ orig_cc: string &optional &log;
+ ## Country code for the responser of the connection based
+ ## on a GeoIP lookup.
+ resp_cc: string &optional &log;
+ };
+}
+
+event connection_state_remove(c: connection)
+ {
+ local orig_loc = lookup_location(c$id$orig_h);
+ if ( orig_loc?$country_code )
+ c$conn$orig_cc = orig_loc$country_code;
+
+ local resp_loc = lookup_location(c$id$resp_h);
+ if ( resp_loc?$country_code )
+ c$conn$resp_cc = resp_loc$country_code;
+ }
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/c9search.c9search_results b/_embed/public/ace/demo/kitchen-sink/docs/c9search.c9search_results
new file mode 100644
index 00000000..0ad9ccd4
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/c9search.c9search_results
@@ -0,0 +1,25 @@
+Searching for var in/.c9/metadata/workspace/pluginsregexp, case sensitive, whole word
+
+configs/default.js:
+ 1: var fs = require("fs");
+ 2: var argv = require('optimist').argv;
+ 3: var path = require("path");
+ 5: var clientExtensions = {};
+ 6: var clientDirs = fs.readdirSync(__dirname + "/../plugins-client");
+ 7: for (var i = 0; i < clientDirs.length; i++) {
+ 8: var dir = clientDirs[i];
+ 12: var name = dir.split(".")[1];
+ 16: var projectDir = (argv.w && path.resolve(process.cwd(), argv.w)) || process.cwd();
+ 17: var fsUrl = "/workspace";
+ 19: var port = argv.p || process.env.PORT || 3131;
+ 20: var host = argv.l || "localhost";
+ 22: var config = {
+
+configs/local.js:
+ 2: var config = require("./default");
+
+configs/packed.js:
+ 1: var config = require("./default");
+
+
+Found 15 matches in 3 files
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/c_cpp.cpp b/_embed/public/ace/demo/kitchen-sink/docs/c_cpp.cpp
new file mode 100644
index 00000000..eb285703
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/c_cpp.cpp
@@ -0,0 +1,46 @@
+// compound assignment operators
+
+#include
+
+#include \
+
+
+#include \
+ \
+
+
+#include \
+ \
+ "iostream"
+
+#include
+#include "boost/asio/io_service.hpp"
+
+#include \
+ \
+ "iostream" \
+ "string" \
+
+
+using namespace std;
+
+//
+int main ()
+{
+ int a, b=3; /* foobar */
+ a = b; // single line comment\
+ continued
+ a+=2; // equivalent to a=a+2
+ cout << a;
+ #if VERBOSE >= 2
+ prints("trace message\n");
+ #endif
+ return 0;
+}
+
+/* Print an error message and get out */
+#define ABORT \
+ do { \
+ print( "Abort\n" ); \
+ exit(8); \
+} while (0) /* Note: No semicolon */
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/cirru.cirru b/_embed/public/ace/demo/kitchen-sink/docs/cirru.cirru
new file mode 100644
index 00000000..244833df
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/cirru.cirru
@@ -0,0 +1,42 @@
+-- https://github.com/Cirru/cirru-gopher/blob/master/code/scope.cr,
+
+set a (int 2)
+
+print (self)
+
+set c (child)
+
+under c
+ under parent
+ print a
+
+print $ get c a
+
+set c x (int 3)
+print $ get c x
+
+set just-print $ code
+ print a
+
+print just-print
+
+eval (self) just-print
+eval just-print
+
+print (string "string with space")
+print (string "escapes \n \"\\")
+
+brackets ((((()))))
+
+"eval" $ string "eval"
+
+print (add $ (int 1) (int 2))
+
+print $ unwrap $
+ map (a $ int 1) (b $ int 2)
+
+print a
+ int 1
+ , b c
+ int 2
+ , d
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/clojure.clj b/_embed/public/ace/demo/kitchen-sink/docs/clojure.clj
new file mode 100644
index 00000000..42acfcc7
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/clojure.clj
@@ -0,0 +1,19 @@
+(defn parting
+ "returns a String parting in a given language"
+ ([] (parting "World"))
+ ([name] (parting name "en"))
+ ([name language]
+ ; condp is similar to a case statement in other languages.
+ ; It is described in more detail later.
+ ; It is used here to take different actions based on whether the
+ ; parameter "language" is set to "en", "es" or something else.
+ (condp = language
+ "en" (str "Goodbye, " name)
+ "es" (str "Adios, " name)
+ (throw (IllegalArgumentException.
+ (str "unsupported language " language))))))
+
+(println (parting)) ; -> Goodbye, World
+(println (parting "Mark")) ; -> Goodbye, Mark
+(println (parting "Mark" "es")) ; -> Adios, Mark
+(println (parting "Mark", "xy")) ; -> java.lang.IllegalArgumentException: unsupported language xy
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/cobol.CBL b/_embed/public/ace/demo/kitchen-sink/docs/cobol.CBL
new file mode 100644
index 00000000..30404ce4
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/cobol.CBL
@@ -0,0 +1 @@
+TODO
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/coffee.coffee b/_embed/public/ace/demo/kitchen-sink/docs/coffee.coffee
new file mode 100644
index 00000000..a7e50d08
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/coffee.coffee
@@ -0,0 +1,22 @@
+#!/usr/bin/env coffee
+
+try
+ throw URIError decodeURI(0xC0ffee * 123456.7e-8 / .9)
+catch e
+ console.log 'qstring' + "qqstring" + '''
+ qdoc
+ ''' + """
+ qqdoc
+ """
+
+do ->
+ ###
+ herecomment
+ ###
+ re = /regex/imgy.test ///
+ heregex # comment
+ ///imgy
+ this isnt: `just JavaScript`
+ undefined
+
+sentence = "#{ 22 / 7 } is a decent approximation of π"
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/coldfusion.cfm b/_embed/public/ace/demo/kitchen-sink/docs/coldfusion.cfm
new file mode 100644
index 00000000..750a389f
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/coldfusion.cfm
@@ -0,0 +1,5 @@
+
+
+
+
+#welcome#
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/csharp.cs b/_embed/public/ace/demo/kitchen-sink/docs/csharp.cs
new file mode 100644
index 00000000..9478be87
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/csharp.cs
@@ -0,0 +1,4 @@
+public void HelloWorld() {
+ //Say Hello!
+ Console.WriteLine("Hello World");
+}
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/css.css b/_embed/public/ace/demo/kitchen-sink/docs/css.css
new file mode 100644
index 00000000..6d2d71f5
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/css.css
@@ -0,0 +1,18 @@
+.text-layer {
+ font: 12px Monaco, "Courier New", monospace;
+ cursor: text;
+}
+
+.blinker {
+ animation: blink 1s linear infinite alternate;
+}
+
+@keyframes blink {
+ 0%, 40% {
+ opacity: 0;
+ }
+
+ 40.5%, 100% {
+ opacity: 1
+ }
+}
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/curly.curly b/_embed/public/ace/demo/kitchen-sink/docs/curly.curly
new file mode 100644
index 00000000..c42d6790
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/curly.curly
@@ -0,0 +1,16 @@
+
+
+
+
+
+
+
+
{{author_name}}
+
+
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/d.d b/_embed/public/ace/demo/kitchen-sink/docs/d.d
new file mode 100644
index 00000000..57069067
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/d.d
@@ -0,0 +1,14 @@
+#!/usr/bin/env rdmd
+// Computes average line length for standard input.
+import std.stdio;
+
+void main() {
+ ulong lines = 0;
+ double sumLength = 0;
+ foreach (line; stdin.byLine()) {
+ ++lines;
+ sumLength += line.length;
+ }
+ writeln("Average line length: ",
+ lines ? sumLength / lines : 0);
+}
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/dart.dart b/_embed/public/ace/demo/kitchen-sink/docs/dart.dart
new file mode 100644
index 00000000..735a20b3
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/dart.dart
@@ -0,0 +1,19 @@
+// Go ahead and modify this example.
+
+import "dart:html";
+
+// Computes the nth Fibonacci number.
+int fibonacci(int n) {
+ if (n < 2) return n;
+ return fibonacci(n - 1) + fibonacci(n - 2);
+}
+
+// Displays a Fibonacci number.
+void main() {
+ int i = 20;
+ String message = "fibonacci($i) = ${fibonacci(i)}";
+
+ // This example uses HTML to display the result and it will appear
+ // in a nested HTML frame (an iframe).
+ document.body.append(new HeadingElement.h1()..appendText(message));
+}
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/diff.diff b/_embed/public/ace/demo/kitchen-sink/docs/diff.diff
new file mode 100644
index 00000000..d469437c
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/diff.diff
@@ -0,0 +1,69 @@
+diff --git a/lib/ace/edit_session.js b/lib/ace/edit_session.js
+index 23fc3fc..ed3b273 100644
+--- a/lib/ace/edit_session.js
++++ b/lib/ace/edit_session.js
+@@ -51,6 +51,7 @@ var TextMode = require("./mode/text").Mode;
+ var Range = require("./range").Range;
+ var Document = require("./document").Document;
+ var BackgroundTokenizer = require("./background_tokenizer").BackgroundTokenizer;
++var SearchHighlight = require("./search_highlight").SearchHighlight;
+
+ /**
+ * class EditSession
+@@ -307,6 +308,13 @@ var EditSession = function(text, mode) {
+ return token;
+ };
+
++ this.highlight = function(re) {
++ if (!this.$searchHighlight) {
++ var highlight = new SearchHighlight(null, "ace_selected-word", "text");
++ this.$searchHighlight = this.addDynamicMarker(highlight);
++ }
++ this.$searchHighlight.setRegexp(re);
++ }
+ /**
+ * EditSession.setUndoManager(undoManager)
+ * - undoManager (UndoManager): The new undo manager
+@@ -556,7 +564,8 @@ var EditSession = function(text, mode) {
+ type : type || "line",
+ renderer: typeof type == "function" ? type : null,
+ clazz : clazz,
+- inFront: !!inFront
++ inFront: !!inFront,
++ id: id
+ }
+
+ if (inFront) {
+diff --git a/lib/ace/editor.js b/lib/ace/editor.js
+index 834e603..b27ec73 100644
+--- a/lib/ace/editor.js
++++ b/lib/ace/editor.js
+@@ -494,7 +494,7 @@ var Editor = function(renderer, session) {
+ * Emitted when a selection has changed.
+ **/
+ this.onSelectionChange = function(e) {
+- var session = this.getSession();
++ var session = this.session;
+
+ if (session.$selectionMarker) {
+ session.removeMarker(session.$selectionMarker);
+@@ -509,12 +509,40 @@ var Editor = function(renderer, session) {
+ this.$updateHighlightActiveLine();
+ }
+
+- var self = this;
+- if (this.$highlightSelectedWord && !this.$wordHighlightTimer)
+- this.$wordHighlightTimer = setTimeout(function() {
+- self.session.$mode.highlightSelection(self);
+- self.$wordHighlightTimer = null;
+- }, 30, this);
++ var re = this.$highlightSelectedWord && this.$getSelectionHighLightRegexp()
+ };
+diff --git a/lib/ace/search_highlight.js b/lib/ace/search_highlight.js
+new file mode 100644
+index 0000000..b2df779
+--- /dev/null
++++ b/lib/ace/search_highlight.js
+@@ -0,0 +1,3 @@
++new
++empty file
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/dot.dot b/_embed/public/ace/demo/kitchen-sink/docs/dot.dot
new file mode 100644
index 00000000..1e13be7e
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/dot.dot
@@ -0,0 +1,110 @@
+// Original source: http://www.graphviz.org/content/lion_share
+##"A few people in the field of genetics are using dot to draw "marriage node diagram" pedigree drawings. Here is one I have done of a test pedigree from the FTREE pedigree drawing package (Lion Share was a racehorse)." Contributed by David Duffy.
+
+##Command to get the layout: "dot -Tpng thisfile > thisfile.png"
+
+digraph Ped_Lion_Share {
+# page = "8.2677165,11.692913" ;
+ratio = "auto" ;
+mincross = 2.0 ;
+label = "Pedigree Lion_Share" ;
+
+"001" [shape=box , regular=1,style=filled,fillcolor=white ] ;
+"002" [shape=box , regular=1,style=filled,fillcolor=white ] ;
+"003" [shape=circle , regular=1,style=filled,fillcolor=white ] ;
+"004" [shape=box , regular=1,style=filled,fillcolor=white ] ;
+"005" [shape=box , regular=1,style=filled,fillcolor=white ] ;
+"006" [shape=circle , regular=1,style=filled,fillcolor=white ] ;
+"007" [shape=circle , regular=1,style=filled,fillcolor=white ] ;
+"009" [shape=circle , regular=1,style=filled,fillcolor=white ] ;
+"014" [shape=circle , regular=1,style=filled,fillcolor=white ] ;
+"015" [shape=circle , regular=1,style=filled,fillcolor=white ] ;
+"016" [shape=circle , regular=1,style=filled,fillcolor=white ] ;
+"ZZ01" [shape=circle , regular=1,style=filled,fillcolor=white ] ;
+"ZZ02" [shape=circle , regular=1,style=filled,fillcolor=white ] ;
+"017" [shape=circle , regular=1,style=filled,fillcolor=white ] ;
+"012" [shape=circle , regular=1,style=filled,fillcolor=white ] ;
+"008" [shape=box , regular=1,style=filled,fillcolor=white ] ;
+"011" [shape=box , regular=1,style=filled,fillcolor=white ] ;
+"013" [shape=box , regular=1,style=filled,fillcolor=white ] ;
+"010" [shape=box , regular=1,style=filled,fillcolor=white ] ;
+"023" [shape=circle , regular=1,style=filled,fillcolor=white ] ;
+"020" [shape=circle , regular=1,style=filled,fillcolor=white ] ;
+"021" [shape=circle , regular=1,style=filled,fillcolor=white ] ;
+"018" [shape=circle , regular=1,style=filled,fillcolor=white ] ;
+"025" [shape=circle , regular=1,style=filled,fillcolor=white ] ;
+"019" [shape=box , regular=1,style=filled,fillcolor=white ] ;
+"022" [shape=box , regular=1,style=filled,fillcolor=white ] ;
+"024" [shape=box , regular=1,style=filled,fillcolor=white ] ;
+"027" [shape=circle , regular=1,style=filled,fillcolor=white ] ;
+"026" [shape=box , regular=1,style=filled,fillcolor=white ] ;
+"028" [shape=box , regular=1,style=filled,fillcolor=grey ] ;
+"marr0001" [shape=diamond,style=filled,label="",height=.1,width=.1] ;
+"001" -> "marr0001" [dir=none,weight=1] ;
+"007" -> "marr0001" [dir=none,weight=1] ;
+"marr0001" -> "017" [dir=none, weight=2] ;
+"marr0002" [shape=diamond,style=filled,label="",height=.1,width=.1] ;
+"001" -> "marr0002" [dir=none,weight=1] ;
+"ZZ02" -> "marr0002" [dir=none,weight=1] ;
+"marr0002" -> "012" [dir=none, weight=2] ;
+"marr0003" [shape=diamond,style=filled,label="",height=.1,width=.1] ;
+"002" -> "marr0003" [dir=none,weight=1] ;
+"003" -> "marr0003" [dir=none,weight=1] ;
+"marr0003" -> "008" [dir=none, weight=2] ;
+"marr0004" [shape=diamond,style=filled,label="",height=.1,width=.1] ;
+"002" -> "marr0004" [dir=none,weight=1] ;
+"006" -> "marr0004" [dir=none,weight=1] ;
+"marr0004" -> "011" [dir=none, weight=2] ;
+"marr0005" [shape=diamond,style=filled,label="",height=.1,width=.1] ;
+"002" -> "marr0005" [dir=none,weight=1] ;
+"ZZ01" -> "marr0005" [dir=none,weight=1] ;
+"marr0005" -> "013" [dir=none, weight=2] ;
+"marr0006" [shape=diamond,style=filled,label="",height=.1,width=.1] ;
+"004" -> "marr0006" [dir=none,weight=1] ;
+"009" -> "marr0006" [dir=none,weight=1] ;
+"marr0006" -> "010" [dir=none, weight=2] ;
+"marr0007" [shape=diamond,style=filled,label="",height=.1,width=.1] ;
+"005" -> "marr0007" [dir=none,weight=1] ;
+"015" -> "marr0007" [dir=none,weight=1] ;
+"marr0007" -> "023" [dir=none, weight=2] ;
+"marr0008" [shape=diamond,style=filled,label="",height=.1,width=.1] ;
+"005" -> "marr0008" [dir=none,weight=1] ;
+"016" -> "marr0008" [dir=none,weight=1] ;
+"marr0008" -> "020" [dir=none, weight=2] ;
+"marr0009" [shape=diamond,style=filled,label="",height=.1,width=.1] ;
+"005" -> "marr0009" [dir=none,weight=1] ;
+"012" -> "marr0009" [dir=none,weight=1] ;
+"marr0009" -> "021" [dir=none, weight=2] ;
+"marr0010" [shape=diamond,style=filled,label="",height=.1,width=.1] ;
+"008" -> "marr0010" [dir=none,weight=1] ;
+"017" -> "marr0010" [dir=none,weight=1] ;
+"marr0010" -> "018" [dir=none, weight=2] ;
+"marr0011" [shape=diamond,style=filled,label="",height=.1,width=.1] ;
+"011" -> "marr0011" [dir=none,weight=1] ;
+"023" -> "marr0011" [dir=none,weight=1] ;
+"marr0011" -> "025" [dir=none, weight=2] ;
+"marr0012" [shape=diamond,style=filled,label="",height=.1,width=.1] ;
+"013" -> "marr0012" [dir=none,weight=1] ;
+"014" -> "marr0012" [dir=none,weight=1] ;
+"marr0012" -> "019" [dir=none, weight=2] ;
+"marr0013" [shape=diamond,style=filled,label="",height=.1,width=.1] ;
+"010" -> "marr0013" [dir=none,weight=1] ;
+"021" -> "marr0013" [dir=none,weight=1] ;
+"marr0013" -> "022" [dir=none, weight=2] ;
+"marr0014" [shape=diamond,style=filled,label="",height=.1,width=.1] ;
+"019" -> "marr0014" [dir=none,weight=1] ;
+"020" -> "marr0014" [dir=none,weight=1] ;
+"marr0014" -> "024" [dir=none, weight=2] ;
+"marr0015" [shape=diamond,style=filled,label="",height=.1,width=.1] ;
+"022" -> "marr0015" [dir=none,weight=1] ;
+"025" -> "marr0015" [dir=none,weight=1] ;
+"marr0015" -> "027" [dir=none, weight=2] ;
+"marr0016" [shape=diamond,style=filled,label="",height=.1,width=.1] ;
+"024" -> "marr0016" [dir=none,weight=1] ;
+"018" -> "marr0016" [dir=none,weight=1] ;
+"marr0016" -> "026" [dir=none, weight=2] ;
+"marr0017" [shape=diamond,style=filled,label="",height=.1,width=.1] ;
+"026" -> "marr0017" [dir=none,weight=1] ;
+"027" -> "marr0017" [dir=none,weight=1] ;
+"marr0017" -> "028" [dir=none, weight=2] ;
+}
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/drools.drl b/_embed/public/ace/demo/kitchen-sink/docs/drools.drl
new file mode 100644
index 00000000..80e7b784
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/drools.drl
@@ -0,0 +1,127 @@
+/*
+ * Copyright 2010 JBoss Inc
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/*
+ Original source
+ https://github.com/droolsjbpm/drools/blob/master/drools-examples/
+ http://docs.jboss.org/drools/
+*/
+package com.example.ace
+
+import java.math.BigDecimal
+import function my.package.Foo.hello
+
+declare FactType
+ @author( Bob )
+ id : String
+ name : String @maxLength(100) @notnull
+
+ value : BigDecimal
+end
+
+declare FactType2 extends AnotherType
+end
+
+declare trait TraitType extends com.package.AnotherType
+end
+
+
+declare trait GoldenCustomer
+ balance : long @Alias( "org.acme.foo.accountBalance" )
+end
+
+global org.slf4j.Logger logger
+
+/**
+ * @param name who we'll salute?
+ */
+function String hello(String name) {
+ return "Hello "+name+"!";
+}
+
+rule "Trim all strings"
+ dialect "java"
+ no-loop
+when // fdsfds
+ $s : String(a == null || == "empty", $g : size)
+ Cheese( name matches "(Buffalo)?\\S*Mozarella" )
+ CheeseCounter( cheeses contains $var ) // contains with a variable
+ CheeseCounter( cheese memberof $matureCheeses )
+ Cheese( name soundslike 'foobar' )
+ Message( routingValue str[startsWith] "R1" )
+ Cheese( name in ( "stilton", "cheddar", $cheese ) )
+ Person( eval( age == girlAge + 2 ), sex = 'M' )
+then
+ /**
+ * TODO There mus be better way
+ */
+ retract($s);
+ String a = "fd";
+ a.toString();
+
+ insert($s.trim());
+end
+
+query isContainedIn( String x, String y )
+ Location( x, y; )
+ or
+ ( Location( z, y; ) and isContainedIn( x, z; ) )
+end
+
+rule "go" salience 10
+when
+ $s : String( )
+then
+ System.out.println( $s );
+end
+
+rule "When all English buses are not red"
+when
+ not(forall( $bus : Bus( nationality == 'english')
+ Bus( this == $bus, color = 'red' ) ))
+then
+ // What if all english buses are not red?
+end
+
+rule "go1"
+when
+ String( this == "go1" )
+ isContainedIn("Office", "House"; )
+then
+ System.out.println( "office is in the house" );
+end
+
+rule "go2"
+when
+ String( this == "go2" )
+ isContainedIn("Draw", "House"; )
+then
+ System.out.println( "Draw in the House" );
+end
+
+/**
+ * Go Right
+ */
+rule GoRight dialect "mvel" salience (Math.abs( $df.colDiff )) when
+ $df : DirectionDiff(colDiff > 0 )
+ $target : Cell( row == $df.row, col == ($df.col + 1) )
+ CellContents( cell == $target, cellType != CellType.WALL )
+ not Direction(character == $df.fromChar, horizontal == Direction.RIGHT )
+then
+ System.out.println( "monster right" );
+ retract( $df );
+ insert( new Direction($df.fromChar, Direction.RIGHT, Direction.NONE ) );
+end
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/eiffel.e b/_embed/public/ace/demo/kitchen-sink/docs/eiffel.e
new file mode 100644
index 00000000..943cdb35
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/eiffel.e
@@ -0,0 +1,30 @@
+note
+ description: "Represents a person."
+
+class
+ PERSON
+
+create
+ make, make_unknown
+
+feature {NONE} -- Creation
+
+ make (a_name: like name)
+ -- Create a person with `a_name' as `name'.
+ do
+ name := a_name
+ ensure
+ name = a_name
+ end
+
+ make_unknown
+ do ensure
+ name = Void
+ end
+
+feature -- Access
+
+ name: detachable STRING
+ -- Full name or Void if unknown.
+
+end
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/ejs.ejs b/_embed/public/ace/demo/kitchen-sink/docs/ejs.ejs
new file mode 100644
index 00000000..aaf497a9
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/ejs.ejs
@@ -0,0 +1,31 @@
+
+
+
+ Cloud9 Rocks!
+
+
+
+
+
+
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/lucene.lucene b/_embed/public/ace/demo/kitchen-sink/docs/lucene.lucene
new file mode 100644
index 00000000..7ac4b90b
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/lucene.lucene
@@ -0,0 +1 @@
+(title:"foo bar" AND body:"quick fox") OR title:fox
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/markdown.md b/_embed/public/ace/demo/kitchen-sink/docs/markdown.md
new file mode 100644
index 00000000..63e96eab
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/markdown.md
@@ -0,0 +1,186 @@
+Ace (Ajax.org Cloud9 Editor)
+============================
+
+Ace is a standalone code editor written in JavaScript. Our goal is to create a browser based editor that matches and extends the features, usability and performance of existing native editors such as TextMate, Vim or Eclipse. It can be easily embedded in any web page or JavaScript application. Ace is developed as the primary editor for [Cloud9 IDE](http://www.cloud9ide.com/) and the successor of the Mozilla Skywriter (Bespin) Project.
+
+Features
+--------
+
+* Syntax highlighting
+* Automatic indent and outdent
+* An optional command line
+* Handles huge documents (100,000 lines and more are no problem)
+* Fully customizable key bindings including VI and Emacs modes
+* Themes (TextMate themes can be imported)
+* Search and replace with regular expressions
+* Highlight matching parentheses
+* Toggle between soft tabs and real tabs
+* Displays hidden characters
+* Drag and drop text using the mouse
+* Line wrapping
+* Unstructured / user code folding
+* Live syntax checker (currently JavaScript/CoffeeScript)
+
+Take Ace for a spin!
+--------------------
+
+Check out the Ace live [demo](http://ajaxorg.github.com/ace/) or get a [Cloud9 IDE account](http://run.cloud9ide.com) to experience Ace while editing one of your own GitHub projects.
+
+If you want, you can use Ace as a textarea replacement thanks to the [Ace Bookmarklet](http://ajaxorg.github.com/ace/build/textarea/editor.html).
+
+History
+-------
+
+Previously known as “Bespin” and “Skywriter” it’s now known as Ace (Ajax.org Cloud9 Editor)! Bespin and Ace started as two independent projects, both aiming to build a no-compromise code editor component for the web. Bespin started as part of Mozilla Labs and was based on the canvas tag, while Ace is the Editor component of the Cloud9 IDE and is using the DOM for rendering. After the release of Ace at JSConf.eu 2010 in Berlin the Skywriter team decided to merge Ace with a simplified version of Skywriter's plugin system and some of Skywriter's extensibility points. All these changes have been merged back to Ace. Both Ajax.org and Mozilla are actively developing and maintaining Ace.
+
+Getting the code
+----------------
+
+Ace is a community project. We actively encourage and support contributions. The Ace source code is hosted on GitHub. It is released under the BSD License. This license is very simple, and is friendly to all kinds of projects, whether open source or not. Take charge of your editor and add your favorite language highlighting and keybindings!
+
+```bash
+ git clone git://github.com/ajaxorg/ace.git
+ cd ace
+ git submodule update --init --recursive
+```
+
+Embedding Ace
+-------------
+
+Ace can be easily embedded into any existing web page. The Ace git repository ships with a pre-packaged version of Ace inside of the `build` directory. The same packaged files are also available as a separate [download](https://github.com/ajaxorg/ace/downloads). Simply copy the contents of the `src` subdirectory somewhere into your project and take a look at the included demos of how to use Ace.
+
+The easiest version is simply:
+
+```html
+
some text
+
+
+```
+
+With "editor" being the id of the DOM element, which should be converted to an editor. Note that this element must be explicitly sized and positioned `absolute` or `relative` for Ace to work. e.g.
+
+```css
+ #editor {
+ position: absolute;
+ width: 500px;
+ height: 400px;
+ }
+```
+
+To change the theme simply include the Theme's JavaScript file
+
+```html
+
+```
+
+and configure the editor to use the theme:
+
+```javascript
+ editor.setTheme("ace/theme/twilight");
+```
+
+By default the editor only supports plain text mode; many other languages are available as separate modules. After including the mode's JavaScript file:
+
+```html
+
+```
+
+Then the mode can be used like this:
+
+```javascript
+ var JavaScriptMode = require("ace/mode/javascript").Mode;
+ editor.getSession().setMode(new JavaScriptMode());
+```
+
+Documentation
+-------------
+
+You find a lot more sample code in the [demo app](https://github.com/ajaxorg/ace/blob/master/demo/demo.js).
+
+There is also some documentation on the [wiki page](https://github.com/ajaxorg/ace/wiki).
+
+If you still need help, feel free to drop a mail on the [ace mailing list](http://groups.google.com/group/ace-discuss).
+
+Running Ace
+-----------
+
+After the checkout Ace works out of the box. No build step is required. Open 'editor.html' in any browser except Google Chrome. Google Chrome doesn't allow XMLHTTPRequests from files loaded from disc (i.e. with a file:/// URL). To open Ace in Chrome simply start the bundled mini HTTP server:
+
+```bash
+ ./static.py
+```
+
+Or using Node.JS
+
+```bash
+ ./static.js
+```
+
+The editor can then be opened at http://localhost:8888/index.html.
+
+Package Ace
+-----------
+
+To package Ace we use the dryice build tool developed by the Mozilla Skywriter team. Before you can build you need to make sure that the submodules are up to date.
+
+```bash
+ git submodule update --init --recursive
+```
+
+Afterwards Ace can be built by calling
+
+```bash
+ ./Makefile.dryice.js normal
+```
+
+The packaged Ace will be put in the 'build' folder.
+
+To build the bookmarklet version execute
+
+```bash
+ ./Makefile.dryice.js bm
+```
+
+Running the Unit Tests
+----------------------
+
+The Ace unit tests run on node.js. Before the first run a couple of node modules have to be installed. The easiest way to do this is by using the node package manager (npm). In the Ace base directory simply call
+
+```bash
+ npm link .
+```
+
+To run the tests call:
+
+```bash
+ node lib/ace/test/all.js
+```
+
+You can also run the tests in your browser by serving:
+
+ http://localhost:8888/lib/ace/test/tests.html
+
+This makes debugging failing tests way more easier.
+
+Contributing
+------------
+
+Ace wouldn't be what it is without contributions! Feel free to fork and improve/enhance Ace any way you want. If you feel that the editor or the Ace community will benefit from your changes, please open a pull request. To protect the interests of the Ace contributors and users we require contributors to sign a Contributors License Agreement (CLA) before we pull the changes into the main repository. Our CLA is the simplest of agreements, requiring that the contributions you make to an ajax.org project are only those you're allowed to make. This helps us significantly reduce future legal risk for everyone involved. It is easy, helps everyone, takes ten minutes, and only needs to be completed once. There are two versions of the agreement:
+
+1. [The Individual CLA](https://github.com/ajaxorg/ace/raw/master/doc/Contributor_License_Agreement-v2.pdf): use this version if you're working on an ajax.org in your spare time, or can clearly claim ownership of copyright in what you'll be submitting.
+2. [The Corporate CLA](https://github.com/ajaxorg/ace/raw/master/doc/Corporate_Contributor_License_Agreement-v2.pdf): have your corporate lawyer review and submit this if your company is going to be contributing to ajax.org projects
+
+If you want to contribute to an ajax.org project please print the CLA and fill it out and sign it. Then either send it by snail mail or fax to us or send it back scanned (or as a photo) by email.
+
+Email: fabian.jakobs@web.de
+
+Fax: +31 (0) 206388953
+
+Address: Ajax.org B.V.
+ Keizersgracht 241
+ 1016 EA, Amsterdam
+ the Netherlands
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/mask.mask b/_embed/public/ace/demo/kitchen-sink/docs/mask.mask
new file mode 100644
index 00000000..85a9e6c2
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/mask.mask
@@ -0,0 +1,52 @@
+/* Mask Syntax Demo */
+
+div > ' Test ~[name]';
+
+define :userProfile {
+ header {
+ h4 > @title;
+ button.close;
+ }
+}
+
+:userProfile {
+ @title > ' Hello ~[: username.toUpperCase()]'
+}
+
+style {
+ html, body {
+ background: url('name.png') 0 0 no-repeat;
+ }
+}
+
+button {
+ event click (e) {
+ this.textContent = `name ${e.clientX} !`;
+ }
+}
+
+md > """
+
+- div
+- span
+
+Hello
+
+[one](http://google.com)
+
+""";
+
+
+header .foo > 'Heading'
+
+button .baz x-signal='click: test' disabled > "
+ Hello,
+ world
+ \"Buddy\"
+"
+
+var a = {
+ name: `name ${window.innerWidth}`
+};
+
+span .foo > "~[bind: a.name]"
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/matlab.matlab b/_embed/public/ace/demo/kitchen-sink/docs/matlab.matlab
new file mode 100644
index 00000000..b2ca44d5
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/matlab.matlab
@@ -0,0 +1,17 @@
+%{
+ %{
+ Ace Matlab demo
+ %}
+%}
+
+classdef hello
+ methods
+ function greet(this)
+ disp('Hello!') % say hi
+ end
+ end
+end
+
+% transpose
+a = [ 'x''y', "x\n\
+ y", 1' ]' + 2'
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/maze.mz b/_embed/public/ace/demo/kitchen-sink/docs/maze.mz
new file mode 100644
index 00000000..72c140e2
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/maze.mz
@@ -0,0 +1,23 @@
+## ## () ## ^^ ## ## ## ##
+## H1 C2 S1 <> S2 H2 DN ##
+## %U <> %D *2 %L IZ .. ##
+## ## ## .. ## DN *3 ## ##
+## ## ## %R C1 IZ () ## ##
+## ## ## ## >/ *1
+## () *3 *1 %L ()
+
+
+// Set divisor and dividend
+S1-> = 9
+S2-> = 24
+
+// Holding cells
+H1-> IF *1 THEN %R ELSE %N
+H2-> IF *2 THEN %R ELSE %N
+
+// Arithmetic
+DN-> -= 1
+IZ-> IF <= 0 THEN %D ELSE %U
+
+C1-> IF *3 THEN %D ELSE %R
+C2-> IF *3 THEN %U ELSE %D
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/mel.mel b/_embed/public/ace/demo/kitchen-sink/docs/mel.mel
new file mode 100644
index 00000000..63dc14d6
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/mel.mel
@@ -0,0 +1,33 @@
+// animated duplicates, instances script
+proc animatedDuplication (int $rangeStart, int $rangeEnd, int $numOfDuplicates, int $duplicateOrInstance)
+{
+ int $range_start = $rangeStart;
+ int $range_end = $rangeEnd;
+ int $num_of_duplicates = $numOfDuplicates;
+ int $step_size = ($range_end - $range_start) / $num_of_duplicates;
+ int $i = 0;
+ int $temp;
+
+ currentTime $range_start; // set to range start
+
+ string $selectedObjects[]; // to store selected objects
+ $selectedObjects = `ls -sl`; // store selected objects
+ select $selectedObjects;
+
+ while ($i <= $num_of_duplicates)
+ {
+ $temp = $range_start + ($step_size * $i);
+ currentTime ($temp);
+ // seleced the objects to duplicate or instance
+ select $selectedObjects;
+ if($duplicateOrInstance == 0)
+ {
+ duplicate;
+ }
+ else
+ {
+ instance;
+ }
+ $i++;
+ }
+}
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/mipsassembler.s b/_embed/public/ace/demo/kitchen-sink/docs/mipsassembler.s
new file mode 100644
index 00000000..4b89d4a8
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/mipsassembler.s
@@ -0,0 +1,2 @@
+TODO add a nice demo!
+Try to keep it short!
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/mushcode.mc b/_embed/public/ace/demo/kitchen-sink/docs/mushcode.mc
new file mode 100644
index 00000000..6861f955
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/mushcode.mc
@@ -0,0 +1,8 @@
+@create phone
+&pickup phone=$pick up:@ifelse [u(is,u(mode),ICC)]={@pemit %#=You pick up the [fullname(me)].[set(me,PHONER:%#)][set(me,MODE:CIP)][set([u(INCOMING)],CONNECTED:[num(me)])][set(me,CONNECTED:[u(INCOMING)])]%r[showpicture(PICPICKUP)]%rUse '[color(green,black,psay )]' (or '[color(green,black,p )]') to talk into the phone.;@oemit %#=%N picks up the [fullname(me)].},{@pemit %#=You pick up the phone but no one is there. You hear a dialtone and then hang up. [play(u(DIALTONE))];@oemit %#=%N picks up the phone, but no one is on the other end.}
+&ringfun phone=[ifelse(eq(comp([u(%0/ringtone)],off),0),[color(black,cyan,INCOMING CALL FROM %1)],[play([switch([u(%0/ringtone)],1,[u(%0/ringtone1)],2,[u(%0/ringtone2)],3,[u(%0/ringtone3)],4,[u(%0/ringtone4)],5,[u(%0/ringtone5)],6,[u(%0/ringtone6)],7,[u(%0/ringtone7)],8,[u(%0/ringtone8)],9,[u(%0/ringtone9)],custom,[u(%0/customtone)],vibrate,[u(%0/vibrate)])])]
+&ringloop phone=@switch [u(ringstate)]=1,{@emit [setq(q,[u(connecting)])][set(%qq,rangs:0)][set(%qq,mode:WFC)][set(%qq,INCOMING:)];@ifelse [u(%qq/HASVMB)]={@tr me/ROUTEVMB=[u(connecting)];},{@pemit %#=[u(MSGCNC)];}},2,{@pemit %#=The call is connected.[setq(q,[u(CONNECTING)])][set(me,CONNECTED:%qq)][set(%qq,CONNECTED:[num(me)])][set(%qq,MODE:CIP)];@tr me/ciploop;@tr %qq/ciploop;},3,{@emit On [fullname(me)]'s earpiece you hear a ringing sound.[play(u(LINETONE))];@tr me/ringhere;@increment [u(connecting)]/RANGS;@wait 5={@tr me/ringloop};},4,{}
+&ringstate phone=[setq(q,u(connecting))][setq(1,[gt(u(%qq/rangs),sub(u(%qq/rings),1))])][setq(2,[and(u(is,u(%qq/MODE),CIP),u(is,u(%qq/INCOMING),[num(me)]))][setq(3,[u(is,u(%qq/MODE),ICC)])][ifelse(%q1,1,ifelse(%q2,2,ifelse(%q3,3,4)))]
+;comment
+@@(comment)
+say [time()]
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/my_lang.my_lang b/_embed/public/ace/demo/kitchen-sink/docs/my_lang.my_lang
new file mode 100644
index 00000000..4b89d4a8
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/my_lang.my_lang
@@ -0,0 +1,2 @@
+TODO add a nice demo!
+Try to keep it short!
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/mysql.mysql b/_embed/public/ace/demo/kitchen-sink/docs/mysql.mysql
new file mode 100644
index 00000000..30404ce4
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/mysql.mysql
@@ -0,0 +1 @@
+TODO
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/nsis.nsi b/_embed/public/ace/demo/kitchen-sink/docs/nsis.nsi
new file mode 100644
index 00000000..1b566b75
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/nsis.nsi
@@ -0,0 +1,31 @@
+/*
+ NSIS Mode
+ for Ace
+*/
+
+; Includes
+!include MUI2.nsh
+
+; Settings
+Name "installer_name"
+OutFile "installer_name.exe"
+RequestExecutionLevel user
+CRCCheck on
+!ifdef x64
+ InstallDir "$PROGRAMFILES64\installer_name"
+!else
+ InstallDir "$PROGRAMFILES\installer_name"
+!endif
+
+; Pages
+!insertmacro MUI_PAGE_INSTFILES
+
+; Sections
+Section "section_name" section_index
+ # your code here
+SectionEnd
+
+; Functions
+Function .onInit
+ MessageBox MB_OK "Here comes a$\n$\rline-break!"
+FunctionEnd
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/objectivec.m b/_embed/public/ace/demo/kitchen-sink/docs/objectivec.m
new file mode 100644
index 00000000..1728dfe5
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/objectivec.m
@@ -0,0 +1,104 @@
+@protocol Printing: someParent
+-(void) print;
+@end
+
+@interface Fraction: NSObject {
+ int numerator;
+ int denominator;
+}
+@end
+
+@"blah\8" @"a\222sd\d" @"\faw\"\? \' \4 n\\" @"\56"
+@"\xSF42"
+
+-(NSDecimalNumber*)addCount:(id)addObject{
+
+return [count decimalNumberByAdding:addObject.count];
+
+}
+
+ NS_DURING NS_HANDLER NS_ENDHANDLER
+
+@try {
+ if (argc > 1) {
+ @throw [NSException exceptionWithName:@"Throwing a test exception" reason:@"Testing the @throw directive." userInfo:nil];
+ }
+}
+@catch (id theException) {
+ NSLog(@"%@", theException);
+ result = 1 ;
+}
+@finally {
+ NSLog(@"This always happens.");
+ result += 2 ;
+}
+
+ @synchronized(lock) {
+ NSLog(@"Hello World");
+ }
+
+struct { @defs( NSObject) }
+
+char *enc1 = @encode(int);
+
+ IBOutlet|IBAction|BOOL|SEL|id|unichar|IMP|Class
+
+
+ @class @protocol
+
+@public
+ // instance variables
+@package
+ // instance variables
+@protected
+ // instance variables
+@private
+ // instance variables
+
+ YES NO Nil nil
+NSApp()
+NSRectToCGRect (Protocol ProtocolFromString:"NSTableViewDelegate"))
+
+[SPPoint pointFromCGPoint:self.position]
+
+NSRoundDownToMultipleOfPageSize
+
+#import
+
+int main( int argc, const char *argv[] ) {
+ printf( "hello world\n" );
+ return 0;
+}
+
+NSChangeSpelling
+
+@"0 != SUBQUERY(image, $x, 0 != SUBQUERY($x.bookmarkItems, $y, $y.@count == 0).@count).@count"
+
+@selector(lowercaseString) @selector(uppercaseString:)
+
+NSFetchRequest *localRequest = [[NSFetchRequest alloc] init];
+localRequest.entity = [NSEntityDescription entityForName:@"VNSource" inManagedObjectContext:context];
+localRequest.sortDescriptors = [NSArray arrayWithObject:[NSSortDescriptor sortDescriptorWithKey:@"resolution" ascending:YES]];
+NSPredicate *predicate = [NSPredicate predicateWithFormat:@"0 != SUBQUERY(image, $x, 0 != SUBQUERY($x.bookmarkItems, $y, $y.@count == 0).@count).@count"];
+[NSPredicate predicateWithFormat:]
+NSString *predicateString = [NSString stringWithFormat:@"SELF beginsWith[cd] %@", searchString];
+NSPredicate *pred = [NSPredicate predicateWithFormat:predicateString];
+NSArray *filteredKeys = [[myMutableDictionary allKeys] filteredArrayUsingPredicate:pred];
+
+localRequest.predicate = [NSPredicate predicateWithFormat:@"whichChart = %@" argumentArray: listChartToDownload];
+localRequest.fetchBatchSize = 100;
+arrayRequest = [context executeFetchRequest:localRequest error:&error1];
+
+[localRequest release];
+
+#ifndef Nil
+#define Nil __DARWIN_NULL /* id of Nil class */
+#endif
+
+@implementation MyObject
+- (unsigned int)areaOfWidth:(unsigned int)width
+ height:(unsigned int)height
+{
+ return width*height;
+}
+@end
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/ocaml.ml b/_embed/public/ace/demo/kitchen-sink/docs/ocaml.ml
new file mode 100644
index 00000000..85e6eba7
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/ocaml.ml
@@ -0,0 +1,18 @@
+(*
+ * Example of early return implementation taken from
+ * http://ocaml.janestreet.com/?q=node/91
+ *)
+
+let with_return (type t) (f : _ -> t) =
+ let module M =
+ struct exception Return of t end
+ in
+ let return = { return = (fun x -> raise (M.Return x)); } in
+ try f return with M.Return x -> x
+
+
+(* Function that uses the 'early return' functionality provided by `with_return` *)
+let sum_until_first_negative list =
+ with_return (fun r ->
+ List.fold list ~init:0 ~f:(fun acc x ->
+ if x >= 0 then acc + x else r.return acc))
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/pascal.pas b/_embed/public/ace/demo/kitchen-sink/docs/pascal.pas
new file mode 100644
index 00000000..7a4a7fc6
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/pascal.pas
@@ -0,0 +1,48 @@
+(*****************************************************************************
+ * A simple bubble sort program. Reads integers, one per line, and prints *
+ * them out in sorted order. Blows up if there are more than 49. *
+ *****************************************************************************)
+PROGRAM Sort(input, output);
+ CONST
+ (* Max array size. *)
+ MaxElts = 50;
+ TYPE
+ (* Type of the element array. *)
+ IntArrType = ARRAY [1..MaxElts] OF Integer;
+
+ VAR
+ (* Indexes, exchange temp, array size. *)
+ i, j, tmp, size: integer;
+
+ (* Array of ints *)
+ arr: IntArrType;
+
+ (* Read in the integers. *)
+ PROCEDURE ReadArr(VAR size: Integer; VAR a: IntArrType);
+ BEGIN
+ size := 1;
+ WHILE NOT eof DO BEGIN
+ readln(a[size]);
+ IF NOT eof THEN
+ size := size + 1
+ END
+ END;
+
+ BEGIN
+ (* Read *)
+ ReadArr(size, arr);
+
+ (* Sort using bubble sort. *)
+ FOR i := size - 1 DOWNTO 1 DO
+ FOR j := 1 TO i DO
+ IF arr[j] > arr[j + 1] THEN BEGIN
+ tmp := arr[j];
+ arr[j] := arr[j + 1];
+ arr[j + 1] := tmp;
+ END;
+
+ (* Print. *)
+ FOR i := 1 TO size DO
+ writeln(arr[i])
+ END.
+
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/perl.pl b/_embed/public/ace/demo/kitchen-sink/docs/perl.pl
new file mode 100644
index 00000000..d6a332e2
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/perl.pl
@@ -0,0 +1,37 @@
+#!/usr/bin/perl
+=begin
+ perl example code for Ace
+=cut
+
+use strict;
+use warnings;
+my $num_primes = 0;
+my @primes;
+
+# Put 2 as the first prime so we won't have an empty array
+$primes[$num_primes] = 2;
+$num_primes++;
+
+MAIN_LOOP:
+for my $number_to_check (3 .. 200)
+{
+ for my $p (0 .. ($num_primes-1))
+ {
+ if ($number_to_check % $primes[$p] == 0)
+ {
+ next MAIN_LOOP;
+ }
+ }
+
+ # If we reached this point it means $number_to_check is not
+ # divisable by any prime number that came before it.
+ $primes[$num_primes] = $number_to_check;
+ $num_primes++;
+}
+
+for my $p (0 .. ($num_primes-1))
+{
+ print $primes[$p], ", ";
+}
+print "\n";
+
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/pgsql.pgsql b/_embed/public/ace/demo/kitchen-sink/docs/pgsql.pgsql
new file mode 100644
index 00000000..ef265cdc
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/pgsql.pgsql
@@ -0,0 +1,118 @@
+
+BEGIN;
+
+/**
+* Samples from PostgreSQL src/tutorial/basics.source
+*/
+CREATE TABLE weather (
+ city varchar(80),
+ temp_lo int, -- low temperature
+ temp_hi int, -- high temperature
+ prcp real, -- precipitation
+ "date" date
+);
+
+CREATE TABLE cities (
+ name varchar(80),
+ location point
+);
+
+
+INSERT INTO weather
+ VALUES ('San Francisco', 46, 50, 0.25, '1994-11-27');
+
+INSERT INTO cities
+ VALUES ('San Francisco', '(-194.0, 53.0)');
+
+INSERT INTO weather (city, temp_lo, temp_hi, prcp, "date")
+ VALUES ('San Francisco', 43, 57, 0.0, '1994-11-29');
+
+INSERT INTO weather (date, city, temp_hi, temp_lo)
+ VALUES ('1994-11-29', 'Hayward', 54, 37);
+
+
+SELECT city, (temp_hi+temp_lo)/2 AS temp_avg, "date" FROM weather;
+
+SELECT city, temp_lo, temp_hi, prcp, "date", location
+ FROM weather, cities
+ WHERE city = name;
+
+
+
+/**
+* Dollar quotes starting at the end of the line are colored as SQL unless
+* a special language tag is used. Dollar quote syntax coloring is implemented
+* for Perl, Python, JavaScript, and Json.
+*/
+create or replace function blob_content_chunked(
+ in p_data bytea,
+ in p_chunk integer)
+returns setof bytea as $$
+-- Still SQL comments
+declare
+ v_size integer = octet_length(p_data);
+begin
+ for i in 1..v_size by p_chunk loop
+ return next substring(p_data from i for p_chunk);
+ end loop;
+end;
+$$ language plpgsql stable;
+
+
+-- pl/perl
+CREATE FUNCTION perl_max (integer, integer) RETURNS integer AS $perl$
+ # perl comment...
+ my ($x,$y) = @_;
+ if (! defined $x) {
+ if (! defined $y) { return undef; }
+ return $y;
+ }
+ if (! defined $y) { return $x; }
+ if ($x > $y) { return $x; }
+ return $y;
+$perl$ LANGUAGE plperl;
+
+-- pl/python
+CREATE FUNCTION usesavedplan() RETURNS trigger AS $python$
+ # python comment...
+ if SD.has_key("plan"):
+ plan = SD["plan"]
+ else:
+ plan = plpy.prepare("SELECT 1")
+ SD["plan"] = plan
+$python$ LANGUAGE plpythonu;
+
+-- pl/v8 (javascript)
+CREATE FUNCTION plv8_test(keys text[], vals text[]) RETURNS text AS $javascript$
+var o = {};
+for(var i=0; i
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/plaintext.txt b/_embed/public/ace/demo/kitchen-sink/docs/plaintext.txt
new file mode 100644
index 00000000..37bb4cca
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/plaintext.txt
@@ -0,0 +1,11 @@
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
+
+Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui blandit praesent luptatum zzril delenit augue duis dolore te feugait nulla facilisi. Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat.
+
+Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat. Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui blandit praesent luptatum zzril delenit augue duis dolore te feugait nulla facilisi.
+
+Nam liber tempor cum soluta nobis eleifend option congue nihil imperdiet doming id quod mazim placerat facer possim assum. Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat. Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat.
+
+Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis.
+
+At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, At accusam aliquyam diam diam dolore dolores duo eirmod eos erat, et nonumy sed tempor et et invidunt justo labore Stet clita ea et gubergren, kasd magna no rebum. sanctus sea sed takimata ut vero voluptua. est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/powershell.ps1 b/_embed/public/ace/demo/kitchen-sink/docs/powershell.ps1
new file mode 100644
index 00000000..f3a70bc1
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/powershell.ps1
@@ -0,0 +1,24 @@
+# This is a simple comment
+function Hello($name) {
+ Write-host "Hello $name"
+}
+
+function add($left, $right=4) {
+ if ($right -ne 4) {
+ return $left
+ } elseif ($left -eq $null -and $right -eq 2) {
+ return 3
+ } else {
+ return 2
+ }
+}
+
+$number = 1 + 2;
+$number += 3
+
+Write-Host Hello -name "World"
+
+$an_array = @(1, 2, 3)
+$a_hash = @{"something" = "something else"}
+
+& notepad .\readme.md
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/praat.praat b/_embed/public/ace/demo/kitchen-sink/docs/praat.praat
new file mode 100644
index 00000000..3700ae6f
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/praat.praat
@@ -0,0 +1,148 @@
+form Highlighter test
+ sentence My_sentence This should all be a string
+ text My_text This should also all be a string
+ word My_word Only the first word is a string, the rest is invalid
+ boolean Binary 1
+ boolean Text no
+ boolean Quoted "yes"
+ comment This should be a string
+ real left_Range -123.6
+ positive right_Range_max 3.3
+ integer Int 4
+ natural Nat 4
+endform
+
+# External scripts
+include /path/to/file
+runScript: "/path/to/file"
+execute /path/to/file
+
+stopwatch
+
+# old-style procedure call
+call oldStyle "quoted" 2 unquoted string
+assert oldStyle.local = 1
+
+# New-style procedure call with parens
+@newStyle("quoted", 2, "quoted string")
+if praatVersion >= 5364
+ # New-style procedure call with colon
+ @newStyle: "quoted", 2, "quoted string"
+endif
+
+# if-block with built-in variables
+if windows
+ # We are on Windows
+elsif unix = 1 or !macintosh
+ exitScript: "We are on Linux"
+else macintosh == 1
+ exit We are on Mac
+endif
+
+# inline if with inline comment
+var = if macintosh = 1 then 0 else 1 fi ; This is an inline comment
+
+# for-loop with explicit from using local variable
+# and paren-style function calls and variable interpolation
+n = numberOfSelected("Sound")
+for i from newStyle.local to n
+ sound'i' = selected("Sound", i)
+ sound[i] = sound'i'
+endfor
+
+for i from 1 to n
+ # Different styles of object selection
+ select sound'i'
+ sound = selected()
+ sound$ = selected$("Sound")
+ select Sound 'sound$'
+ selectObject(sound[i])
+ selectObject: sound
+
+ # Pause commands
+ beginPause("Viewing " + sound$)
+ if i > 1
+ button = endPause("Stop", "Previous",
+ ...if i = total_sounds then "Finish" else "Next" fi,
+ ...3, 1)
+ else
+ button = endPause("Stop",
+ ...if i = total_sounds then "Finish" else "Next" fi,
+ ...2, 1)
+ endif
+ editor_name$ = if total_textgrids then "TextGrid " else "Sound " fi + name$
+ nocheck editor 'editor_name$'
+ nocheck Close
+ nocheck endeditor
+
+ # New-style standalone command call
+ Rename: "SomeName"
+
+ # Command call with assignment
+ duration = Get total duration
+
+ # Multi-line command with modifier
+ pitch = noprogress To Pitch (ac): 0, 75, 15, "no",
+ ...0.03, 0.45, 0.01, 0.35, 0.14, 600
+
+ # do-style command with assignment
+ minimum = do("Get minimum...", 0, 0, "Hertz", "Parabolic")
+
+ # New-style multi-line command call with broken strings
+ table = Create Table with column names: "table", 0,
+ ..."file subject speaker
+ ...f0 f1 f2 f3 " +
+ ..."duration response"
+
+ removeObject: pitch, table
+
+ # Picture window commands
+ selectObject: sound
+ # do-style command
+ do("Select inner viewport...", 1, 6, 0.5, 1.5)
+ Black
+ Draw... 0 0 0 0 "no" Curve
+ Draw inner box
+ Text bottom: "yes", sound$
+ Erase all
+
+ # Demo window commands
+ demo Erase all
+ demo Select inner viewport... 0 100 0 100
+ demo Axes... 0 100 0 100
+ demo Paint rectangle... white 0 100 0 100
+ demo Text... 50 centre 50 half Click to finish
+ demoWaitForInput ( )
+ demo Erase all
+ demo Text: 50, "centre", 50, "half", "Finished"
+endfor
+
+# An old-style sendpraat block
+sendpraat Praat
+ ...'newline$' Create Sound as pure tone... "tone" 1 0 0.4 44100 440 0.2 0.01 0.01
+ ...'newline$' Play
+ ...'newline$' Remove
+
+# A new-style sendpraat block
+beginSendPraat: "Praat"
+ Create Sound as pure tone: "tone", 1, 0, 0.4, 44100, 440, 0.2, 0.01, 0.01
+ duration = Get total duration
+ Remove
+endSendPraat: "duration"
+appendInfoLine: "The generated sound lasted for ", duration, "seconds"
+
+time = stopwatch
+clearinfo
+echo This script took
+print 'time' seconds to
+printline execute.
+
+# Old-style procedure declaration
+procedure oldStyle .str1$ .num .str2$
+ .local = 1
+endproc
+
+# New-style procedure declaration
+procedure newStyle (.str1$, .num, .str2$)
+ .local = 1
+endproc
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/prolog.plg b/_embed/public/ace/demo/kitchen-sink/docs/prolog.plg
new file mode 100644
index 00000000..2c867157
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/prolog.plg
@@ -0,0 +1,18 @@
+partition([], _, [], []).
+partition([X|Xs], Pivot, Smalls, Bigs) :-
+ ( X @< Pivot ->
+ Smalls = [X|Rest],
+ partition(Xs, Pivot, Rest, Bigs)
+ ; Bigs = [X|Rest],
+ partition(Xs, Pivot, Smalls, Rest)
+ ).
+
+quicksort([]) --> [].
+quicksort([X|Xs]) -->
+ { partition(Xs, X, Smaller, Bigger) },
+ quicksort(Smaller), [X], quicksort(Bigger).
+
+perfect(N) :-
+ between(1, inf, N), U is N // 2,
+ findall(D, (between(1,U,D), N mod D =:= 0), Ds),
+ sumlist(Ds, N).
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/properties.properties b/_embed/public/ace/demo/kitchen-sink/docs/properties.properties
new file mode 100644
index 00000000..446b340d
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/properties.properties
@@ -0,0 +1,15 @@
+# You are reading the ".properties" entry.
+! The exclamation mark can also mark text as comments.
+# The key and element characters #, !, =, and : are written with a preceding backslash to ensure that they are properly loaded.
+website = http\://en.wikipedia.org/
+language = English
+# The backslash below tells the application to continue reading
+# the value onto the next line.
+message = Welcome to \
+ Wikipedia!
+# Add spaces to the key
+key\ with\ spaces = This is the value that could be looked up with the key "key with spaces".
+# Unicode
+tab : \u0009
+empty-key=
+last.line=value
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/protobuf.proto b/_embed/public/ace/demo/kitchen-sink/docs/protobuf.proto
new file mode 100644
index 00000000..4da95a75
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/protobuf.proto
@@ -0,0 +1,16 @@
+message Point {
+ required int32 x = 1;
+ required int32 y = 2;
+ optional string label = 3;
+}
+
+message Line {
+ required Point start = 1;
+ required Point end = 2;
+ optional string label = 3;
+}
+
+message Polyline {
+ repeated Point point = 1;
+ optional string label = 2;
+}
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/python.py b/_embed/public/ace/demo/kitchen-sink/docs/python.py
new file mode 100644
index 00000000..90afdc30
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/python.py
@@ -0,0 +1,19 @@
+#!/usr/local/bin/python
+
+import string, sys
+
+# If no arguments were given, print a helpful message
+if len(sys.argv)==1:
+ print '''Usage:
+celsius temp1 temp2 ...'''
+ sys.exit(0)
+
+# Loop over the arguments
+for i in sys.argv[1:]:
+ try:
+ fahrenheit=float(string.atoi(i))
+ except string.atoi_error:
+ print repr(i), "not a numeric value"
+ else:
+ celsius=(fahrenheit-32)*5.0/9.0
+ print '%i\260F = %i\260C' % (int(fahrenheit), int(celsius+.5))
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/r.r b/_embed/public/ace/demo/kitchen-sink/docs/r.r
new file mode 100644
index 00000000..e4d4c579
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/r.r
@@ -0,0 +1,20 @@
+Call:
+lm(formula = y ~ x)
+
+Residuals:
+1 2 3 4 5 6
+3.3333 -0.6667 -2.6667 -2.6667 -0.6667 3.3333
+
+Coefficients:
+ Estimate Std. Error t value Pr(>|t|)
+(Intercept) -9.3333 2.8441 -3.282 0.030453 *
+x 7.0000 0.7303 9.585 0.000662 ***
+---
+Signif. codes: 0 ‘***’ 0.001 ‘**’ 0.01 ‘*’ 0.05 ‘.’ 0.1 ‘ ’ 1
+
+Residual standard error: 3.055 on 4 degrees of freedom
+Multiple R-squared: 0.9583, Adjusted R-squared: 0.9478
+F-statistic: 91.88 on 1 and 4 DF, p-value: 0.000662
+
+> par(mfrow=c(2, 2)) # Request 2x2 plot layout
+> plot(lm_1) # Diagnostic plot of regression model
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/razor.cshtml b/_embed/public/ace/demo/kitchen-sink/docs/razor.cshtml
new file mode 100644
index 00000000..d19d6055
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/razor.cshtml
@@ -0,0 +1,7 @@
+@* razor mode *@
+@{
+ Layout = "~/layout"
+ @:
+ @Layout
+ @:
+}
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/rdoc.Rd b/_embed/public/ace/demo/kitchen-sink/docs/rdoc.Rd
new file mode 100644
index 00000000..16664795
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/rdoc.Rd
@@ -0,0 +1,64 @@
+\name{picker}
+\alias{picker}
+\title{Create a picker control}
+\description{
+ Create a picker control to enable manipulation of plot variables based on a set of fixed choices.
+}
+
+\usage{
+picker(..., initial = NULL, label = NULL)
+}
+
+
+\arguments{
+ \item{\dots}{
+ Arguments containing objects to be presented as choices for the picker (or a list containing the choices). If an element is named then the name is used to display it within the picker. If an element is not named then it is displayed within the picker using \code{\link{as.character}}.
+}
+ \item{initial}{
+ Initial value for picker. Value must be present in the list of choices specified. If not specified defaults to the first choice.
+}
+ \item{label}{
+ Display label for picker. Defaults to the variable name if not specified.
+}
+}
+
+\value{
+ An object of class "manipulator.picker" which can be passed to the \code{\link{manipulate}} function.
+}
+
+\seealso{
+\code{\link{manipulate}}, \code{\link{slider}}, \code{\link{checkbox}}, \code{\link{button}}
+}
+
+
+\examples{
+\dontrun{
+
+## Filtering data with a picker
+manipulate(
+ barplot(as.matrix(longley[,factor]),
+ beside = TRUE, main = factor),
+ factor = picker("GNP", "Unemployed", "Employed"))
+
+## Create a picker with labels
+manipulate(
+ plot(pressure, type = type),
+ type = picker("points" = "p", "line" = "l", "step" = "s"))
+
+## Picker with groups
+manipulate(
+ barplot(as.matrix(mtcars[group,"mpg"]), beside=TRUE),
+ group = picker("Group 1" = 1:11,
+ "Group 2" = 12:22,
+ "Group 3" = 23:32))
+
+## Histogram w/ picker to select type
+require(lattice)
+require(stats)
+manipulate(
+ histogram(~ height | voice.part,
+ data = singer, type = type),
+ type = picker("percent", "count", "density"))
+
+}
+}
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/rhtml.Rhtml b/_embed/public/ace/demo/kitchen-sink/docs/rhtml.Rhtml
new file mode 100644
index 00000000..5eb6189d
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/rhtml.Rhtml
@@ -0,0 +1,22 @@
+
+
+
+Title
+
+
+
+
+
This is an R HTML document. When you click the Knit HTML button a web page will be generated that includes both content as well as the output of any embedded R code chunks within the document. You can embed an R code chunk like this:
;
\ No newline at end of file
diff --git a/_embed/public/ace/demo/kitchen-sink/docs/twig.twig b/_embed/public/ace/demo/kitchen-sink/docs/twig.twig
new file mode 100644
index 00000000..02214f09
--- /dev/null
+++ b/_embed/public/ace/demo/kitchen-sink/docs/twig.twig
@@ -0,0 +1,30 @@
+
+
+
+ My Webpage
+
+
+
+ demo showing Ace usage with r.js:
+
+ install r.js and almond
+ and run `r.js -o demo/r.js/build.js`
+
+ note that you also need ace/build/src to lazy load modes and themes
+ require("ace/config").set("basePath", "../../build/src");
+ require("ace/config").set("packaged", true);
+
+--[[--
+num_args takes in 5.1 byte code and extracts the number of arguments from its function header.
+--]]--
+
+function int(t)
+ return t:byte(1) + t:byte(2) * 0x100 + t:byte(3) * 0x10000 + t:byte(4) * 0x1000000
+end
+
+function num_args(func)
+ local dump = string.dump(func)
+ local offset, cursor = int(dump:sub(13)), offset + 26
+ --Get the params and var flag (whether there's a ... in the param)
+ return dump:sub(cursor):byte(), dump:sub(cursor+1):byte()
+end
+
+
+ 
+ 
+