asciidoc-8.6.9/a2x.py0000775000175100017510000011020312236306716014536 0ustar srackhamsrackham#!/usr/bin/env python ''' a2x - A toolchain manager for AsciiDoc (converts Asciidoc text files to other file formats) Copyright: Stuart Rackham (c) 2009 License: MIT Email: srackham@gmail.com ''' import os import fnmatch import HTMLParser import re import shutil import subprocess import sys import traceback import urlparse import zipfile import xml.dom.minidom import mimetypes PROG = os.path.basename(os.path.splitext(__file__)[0]) VERSION = '8.6.9' # AsciiDoc global configuration file directory. # NOTE: CONF_DIR is "fixed up" by Makefile -- don't rename or change syntax. CONF_DIR = '/etc/asciidoc' ###################################################################### # Default configuration file parameters. ###################################################################### # Optional environment variable dictionary passed to # executing programs. If set to None the existing # environment is used. ENV = None # External executables. ASCIIDOC = 'asciidoc' XSLTPROC = 'xsltproc' DBLATEX = 'dblatex' # pdf generation. FOP = 'fop' # pdf generation (--fop option). W3M = 'w3m' # text generation. LYNX = 'lynx' # text generation (if no w3m). XMLLINT = 'xmllint' # Set to '' to disable. EPUBCHECK = 'epubcheck' # Set to '' to disable. # External executable default options. ASCIIDOC_OPTS = '' DBLATEX_OPTS = '' FOP_OPTS = '' XSLTPROC_OPTS = '' BACKEND_OPTS = '' ###################################################################### # End of configuration file parameters. ###################################################################### ##################################################################### # Utility functions ##################################################################### OPTIONS = None # These functions read verbose and dry_run command options. def errmsg(msg): sys.stderr.write('%s: %s\n' % (PROG,msg)) def warning(msg): errmsg('WARNING: %s' % msg) def infomsg(msg): print '%s: %s' % (PROG,msg) def die(msg, exit_code=1): errmsg('ERROR: %s' % msg) sys.exit(exit_code) def trace(): """Print traceback to stderr.""" errmsg('-'*60) traceback.print_exc(file=sys.stderr) errmsg('-'*60) def verbose(msg): if OPTIONS.verbose or OPTIONS.dry_run: infomsg(msg) class AttrDict(dict): """ Like a dictionary except values can be accessed as attributes i.e. obj.foo can be used in addition to obj['foo']. If self._default has been set then it will be returned if a non-existant attribute is accessed (instead of raising an AttributeError). """ def __getattr__(self, key): try: return self[key] except KeyError, k: if self.has_key('_default'): return self['_default'] else: raise AttributeError, k def __setattr__(self, key, value): self[key] = value def __delattr__(self, key): try: del self[key] except KeyError, k: raise AttributeError, k def __repr__(self): return '' def __getstate__(self): return dict(self) def __setstate__(self,value): for k,v in value.items(): self[k]=v def isexecutable(file_name): return os.path.isfile(file_name) and os.access(file_name, os.X_OK) def find_executable(file_name): ''' Search for executable file_name in the system PATH. Return full path name or None if not found. ''' def _find_executable(file_name): if os.path.split(file_name)[0] != '': # file_name includes directory so don't search path. if not isexecutable(file_name): return None else: return file_name for p in os.environ.get('PATH', os.defpath).split(os.pathsep): f = os.path.join(p, file_name) if isexecutable(f): return os.path.realpath(f) return None if os.name == 'nt' and os.path.splitext(file_name)[1] == '': for ext in ('.cmd','.bat','.exe'): result = _find_executable(file_name + ext) if result: break else: result = _find_executable(file_name) return result def write_file(filename, data, mode='w'): f = open(filename, mode) try: f.write(data) finally: f.close() def read_file(filename, mode='r'): f = open(filename, mode) try: return f.read() finally: f.close() def shell_cd(path): verbose('chdir %s' % path) if not OPTIONS.dry_run: os.chdir(path) def shell_makedirs(path): if os.path.isdir(path): return verbose('creating %s' % path) if not OPTIONS.dry_run: os.makedirs(path) def shell_copy(src, dst): verbose('copying "%s" to "%s"' % (src,dst)) if not OPTIONS.dry_run: shutil.copy(src, dst) def shell_rm(path): if not os.path.exists(path): return verbose('deleting %s' % path) if not OPTIONS.dry_run: os.unlink(path) def shell_rmtree(path): if not os.path.isdir(path): return verbose('deleting %s' % path) if not OPTIONS.dry_run: shutil.rmtree(path) def shell(cmd, raise_error=True): ''' Execute command cmd in shell and return tuple (stdoutdata, stderrdata, returncode). If raise_error is True then a non-zero return terminates the application. ''' if os.name == 'nt': # TODO: this is probably unnecessary, see: # http://groups.google.com/group/asciidoc/browse_frm/thread/9442ee0c419f1242 # Windows doesn't like running scripts directly so explicitly # specify python interpreter. # Extract first (quoted or unquoted) argument. mo = re.match(r'^\s*"\s*(?P[^"]+)\s*"', cmd) if not mo: mo = re.match(r'^\s*(?P[^ ]+)', cmd) if mo.group('arg0').endswith('.py'): cmd = 'python ' + cmd # Remove redundant quoting -- this is not just cosmetic, # quoting seems to dramatically decrease the allowed command # length in Windows XP. cmd = re.sub(r'"([^ ]+?)"', r'\1', cmd) verbose('executing: %s' % cmd) if OPTIONS.dry_run: return stdout = stderr = subprocess.PIPE try: popen = subprocess.Popen(cmd, stdout=stdout, stderr=stderr, shell=True, env=ENV) except OSError, e: die('failed: %s: %s' % (cmd, e)) stdoutdata, stderrdata = popen.communicate() if OPTIONS.verbose: print stdoutdata print stderrdata if popen.returncode != 0 and raise_error: die('%s returned non-zero exit status %d' % (cmd, popen.returncode)) return (stdoutdata, stderrdata, popen.returncode) def find_resources(files, tagname, attrname, filter=None): ''' Search all files and return a list of local URIs from attrname attribute values in tagname tags. Handles HTML open and XHTML closed tags. Non-local URIs are skipped. files can be a file name or a list of file names. The filter function takes a dictionary of tag attributes and returns True if the URI is to be included. ''' class FindResources(HTMLParser.HTMLParser): # Nested parser class shares locals with enclosing function. def handle_startendtag(self, tag, attrs): self.handle_starttag(tag, attrs) def handle_starttag(self, tag, attrs): attrs = dict(attrs) if tag == tagname and (filter is None or filter(attrs)): # Accept only local URIs. uri = urlparse.urlparse(attrs[attrname]) if uri[0] in ('','file') and not uri[1] and uri[2]: result.append(uri[2]) if isinstance(files, str): files = [files] result = [] for filename in files: verbose('finding resources in: %s' % filename) if OPTIONS.dry_run: continue parser = FindResources() # HTMLParser has problems with non-ASCII strings. # See http://bugs.python.org/issue3932 contents = read_file(filename) mo = re.search(r'\A<\?xml.* encoding="(.*?)"', contents) if mo: encoding = mo.group(1) parser.feed(contents.decode(encoding)) else: parser.feed(contents) parser.close() result = list(set(result)) # Drop duplicate values. result.sort() return result # NOT USED. def copy_files(files, src_dir, dst_dir): ''' Copy list of relative file names from src_dir to dst_dir. ''' for filename in files: filename = os.path.normpath(filename) if os.path.isabs(filename): continue src = os.path.join(src_dir, filename) dst = os.path.join(dst_dir, filename) if not os.path.exists(dst): if not os.path.isfile(src): warning('missing file: %s' % src) continue dstdir = os.path.dirname(dst) shell_makedirs(dstdir) shell_copy(src, dst) def find_files(path, pattern): ''' Return list of file names matching pattern in directory path. ''' result = [] for (p,dirs,files) in os.walk(path): for f in files: if fnmatch.fnmatch(f, pattern): result.append(os.path.normpath(os.path.join(p,f))) return result def exec_xsltproc(xsl_file, xml_file, dst_dir, opts = ''): cwd = os.getcwd() shell_cd(dst_dir) try: shell('"%s" %s "%s" "%s"' % (XSLTPROC, opts, xsl_file, xml_file)) finally: shell_cd(cwd) def get_source_options(asciidoc_file): ''' Look for a2x command options in AsciiDoc source file. Limitation: options cannot contain double-quote characters. ''' def parse_options(): # Parse options to result sequence. inquotes = False opt = '' for c in options: if c == '"': if inquotes: result.append(opt) opt = '' inquotes = False else: inquotes = True elif c == ' ': if inquotes: opt += c elif opt: result.append(opt) opt = '' else: opt += c if opt: result.append(opt) result = [] if os.path.isfile(asciidoc_file): options = '' f = open(asciidoc_file) try: for line in f: mo = re.search(r'^//\s*a2x:', line) if mo: options += ' ' + line[mo.end():].strip() finally: f.close() parse_options() return result ##################################################################### # Application class ##################################################################### class A2X(AttrDict): ''' a2x options and conversion functions. ''' def execute(self): ''' Process a2x command. ''' self.process_options() # Append configuration file options. self.asciidoc_opts += ' ' + ASCIIDOC_OPTS self.dblatex_opts += ' ' + DBLATEX_OPTS self.fop_opts += ' ' + FOP_OPTS self.xsltproc_opts += ' ' + XSLTPROC_OPTS self.backend_opts += ' ' + BACKEND_OPTS # Execute to_* functions. if self.backend: self.to_backend() else: self.__getattribute__('to_'+self.format)() if not (self.keep_artifacts or self.format == 'docbook' or self.skip_asciidoc): shell_rm(self.dst_path('.xml')) def load_conf(self): ''' Load a2x configuration file from default locations and --conf-file option. ''' global ASCIIDOC CONF_FILE = 'a2x.conf' a2xdir = os.path.dirname(os.path.realpath(__file__)) conf_files = [] # From a2x.py directory. conf_files.append(os.path.join(a2xdir, CONF_FILE)) # If the asciidoc executable and conf files are in the a2x directory # then use the local copy of asciidoc and skip the global a2x conf. asciidoc = os.path.join(a2xdir, 'asciidoc.py') asciidoc_conf = os.path.join(a2xdir, 'asciidoc.conf') if os.path.isfile(asciidoc) and os.path.isfile(asciidoc_conf): self.asciidoc = asciidoc else: self.asciidoc = None # From global conf directory. conf_files.append(os.path.join(CONF_DIR, CONF_FILE)) # From $HOME directory. home_dir = os.environ.get('HOME') if home_dir is not None: conf_files.append(os.path.join(home_dir, '.asciidoc', CONF_FILE)) # If asciidoc is not local to a2x then search the PATH. if not self.asciidoc: self.asciidoc = find_executable(ASCIIDOC) if not self.asciidoc: die('unable to find asciidoc: %s' % ASCIIDOC) # From backend plugin directory. if self.backend is not None: stdout = shell(self.asciidoc + ' --backend list')[0] backends = [(i, os.path.split(i)[1]) for i in stdout.splitlines()] backend_dir = [i[0] for i in backends if i[1] == self.backend] if len(backend_dir) == 0: die('missing %s backend' % self.backend) if len(backend_dir) > 1: die('more than one %s backend' % self.backend) verbose('found %s backend directory: %s' % (self.backend, backend_dir[0])) conf_files.append(os.path.join(backend_dir[0], 'a2x-backend.py')) # From --conf-file option. if self.conf_file is not None: if not os.path.isfile(self.conf_file): die('missing configuration file: %s' % self.conf_file) conf_files.append(self.conf_file) # From --xsl-file option. if self.xsl_file is not None: if not os.path.isfile(self.xsl_file): die('missing XSL file: %s' % self.xsl_file) self.xsl_file = os.path.abspath(self.xsl_file) # Load ordered files. for f in conf_files: if os.path.isfile(f): verbose('loading configuration file: %s' % f) execfile(f, globals()) def process_options(self): ''' Validate and command options and set defaults. ''' if not os.path.isfile(self.asciidoc_file): die('missing SOURCE_FILE: %s' % self.asciidoc_file) self.asciidoc_file = os.path.abspath(self.asciidoc_file) if os.path.splitext(self.asciidoc_file)[1].lower() == '.xml': self.skip_asciidoc = True else: self.skip_asciidoc = False if not self.destination_dir: self.destination_dir = os.path.dirname(self.asciidoc_file) else: if not os.path.isdir(self.destination_dir): die('missing --destination-dir: %s' % self.destination_dir) self.destination_dir = os.path.abspath(self.destination_dir) if not self.format in ('chunked','epub','htmlhelp','xhtml'): warning('--destination-dir option is only applicable to HTML based outputs') self.resource_dirs = [] self.resource_files = [] if self.resource_manifest: if not os.path.isfile(self.resource_manifest): die('missing --resource-manifest: %s' % self.resource_manifest) f = open(self.resource_manifest) try: for r in f: self.resources.append(r.strip()) finally: f.close() for r in self.resources: r = os.path.expanduser(r) r = os.path.expandvars(r) if r.endswith('/') or r.endswith('\\'): if os.path.isdir(r): self.resource_dirs.append(r) else: die('missing resource directory: %s' % r) elif os.path.isdir(r): self.resource_dirs.append(r) elif r.startswith('.') and '=' in r: ext, mimetype = r.split('=') mimetypes.add_type(mimetype, ext) else: self.resource_files.append(r) for p in (os.path.dirname(self.asciidoc), CONF_DIR): for d in ('images','stylesheets'): d = os.path.join(p,d) if os.path.isdir(d): self.resource_dirs.append(d) verbose('resource files: %s' % self.resource_files) verbose('resource directories: %s' % self.resource_dirs) if not self.doctype and self.format == 'manpage': self.doctype = 'manpage' if self.doctype: self.asciidoc_opts += ' --doctype %s' % self.doctype for attr in self.attributes: self.asciidoc_opts += ' --attribute "%s"' % attr # self.xsltproc_opts += ' --nonet' if self.verbose: self.asciidoc_opts += ' --verbose' self.dblatex_opts += ' -V' if self.icons or self.icons_dir: params = [ 'callout.graphics 1', 'navig.graphics 1', 'admon.textlabel 0', 'admon.graphics 1', ] if self.icons_dir: params += [ 'admon.graphics.path "%s/"' % self.icons_dir, 'callout.graphics.path "%s/callouts/"' % self.icons_dir, 'navig.graphics.path "%s/"' % self.icons_dir, ] else: params = [ 'callout.graphics 0', 'navig.graphics 0', 'admon.textlabel 1', 'admon.graphics 0', ] if self.stylesheet: params += ['html.stylesheet "%s"' % self.stylesheet] if self.format == 'htmlhelp': params += ['htmlhelp.chm "%s"' % self.basename('.chm'), 'htmlhelp.hhp "%s"' % self.basename('.hhp'), 'htmlhelp.hhk "%s"' % self.basename('.hhk'), 'htmlhelp.hhc "%s"' % self.basename('.hhc')] if self.doctype == 'book': params += ['toc.section.depth 1'] # Books are chunked at chapter level. params += ['chunk.section.depth 0'] for o in params: if o.split()[0]+' ' not in self.xsltproc_opts: self.xsltproc_opts += ' --stringparam ' + o if self.fop_opts: self.fop = True def dst_path(self, ext): ''' Return name of file or directory in the destination directory with the same name as the asciidoc source file but with extension ext. ''' return os.path.join(self.destination_dir, self.basename(ext)) def basename(self, ext): ''' Return the base name of the asciidoc source file but with extension ext. ''' return os.path.basename(os.path.splitext(self.asciidoc_file)[0]) + ext def asciidoc_conf_file(self, path): ''' Return full path name of file in asciidoc configuration files directory. Search first the directory containing the asciidoc executable then the global configuration file directory. ''' f = os.path.join(os.path.dirname(self.asciidoc), path) if not os.path.isfile(f): f = os.path.join(CONF_DIR, path) if not os.path.isfile(f): die('missing configuration file: %s' % f) return os.path.normpath(f) def xsl_stylesheet(self, file_name=None): ''' Return full path name of file in asciidoc docbook-xsl configuration directory. If an XSL file was specified with the --xsl-file option then it is returned. ''' if self.xsl_file is not None: return self.xsl_file if not file_name: file_name = self.format + '.xsl' return self.asciidoc_conf_file(os.path.join('docbook-xsl', file_name)) def copy_resources(self, html_files, src_dir, dst_dir, resources=[]): ''' Search html_files for images and CSS resource URIs (html_files can be a list of file names or a single file name). Copy them from the src_dir to the dst_dir. If not found in src_dir then recursively search all specified resource directories. Optional additional resources files can be passed in the resources list. ''' resources = resources[:] resources += find_resources(html_files, 'link', 'href', lambda attrs: attrs.get('type') == 'text/css') resources += find_resources(html_files, 'img', 'src') resources += self.resource_files resources = list(set(resources)) # Drop duplicates. resources.sort() for f in resources: if '=' in f: src, dst = f.split('=') if not dst: dst = src else: src = dst = f src = os.path.normpath(src) dst = os.path.normpath(dst) if os.path.isabs(dst): die('absolute resource file name: %s' % dst) if dst.startswith(os.pardir): die('resource file outside destination directory: %s' % dst) src = os.path.join(src_dir, src) dst = os.path.join(dst_dir, dst) if not os.path.isfile(src): for d in self.resource_dirs: d = os.path.join(src_dir, d) found = find_files(d, os.path.basename(src)) if found: src = found[0] break else: if not os.path.isfile(dst): die('missing resource: %s' % src) continue # Arrive here if resource file has been found. if os.path.normpath(src) != os.path.normpath(dst): dstdir = os.path.dirname(dst) shell_makedirs(dstdir) shell_copy(src, dst) def to_backend(self): ''' Convert AsciiDoc source file to a backend output file using the global 'to_' function (loaded from backend plugin a2x-backend.py file). Executes the global function in an A2X class instance context. ''' eval('to_%s(self)' % self.backend) def to_docbook(self): ''' Use asciidoc to convert asciidoc_file to DocBook. args is a string containing additional asciidoc arguments. ''' docbook_file = self.dst_path('.xml') if self.skip_asciidoc: if not os.path.isfile(docbook_file): die('missing docbook file: %s' % docbook_file) return shell('"%s" --backend docbook -a "a2x-format=%s" %s --out-file "%s" "%s"' % (self.asciidoc, self.format, self.asciidoc_opts, docbook_file, self.asciidoc_file)) if not self.no_xmllint and XMLLINT: shell('"%s" --nonet --noout --valid "%s"' % (XMLLINT, docbook_file)) def to_xhtml(self): self.to_docbook() docbook_file = self.dst_path('.xml') xhtml_file = self.dst_path('.html') opts = '%s --output "%s"' % (self.xsltproc_opts, xhtml_file) exec_xsltproc(self.xsl_stylesheet(), docbook_file, self.destination_dir, opts) src_dir = os.path.dirname(self.asciidoc_file) self.copy_resources(xhtml_file, src_dir, self.destination_dir) def to_manpage(self): self.to_docbook() docbook_file = self.dst_path('.xml') opts = self.xsltproc_opts exec_xsltproc(self.xsl_stylesheet(), docbook_file, self.destination_dir, opts) def to_pdf(self): if self.fop: self.exec_fop() else: self.exec_dblatex() def exec_fop(self): self.to_docbook() docbook_file = self.dst_path('.xml') xsl = self.xsl_stylesheet('fo.xsl') fo = self.dst_path('.fo') pdf = self.dst_path('.pdf') opts = '%s --output "%s"' % (self.xsltproc_opts, fo) exec_xsltproc(xsl, docbook_file, self.destination_dir, opts) shell('"%s" %s -fo "%s" -pdf "%s"' % (FOP, self.fop_opts, fo, pdf)) if not self.keep_artifacts: shell_rm(fo) def exec_dblatex(self): self.to_docbook() docbook_file = self.dst_path('.xml') xsl = self.asciidoc_conf_file(os.path.join('dblatex','asciidoc-dblatex.xsl')) sty = self.asciidoc_conf_file(os.path.join('dblatex','asciidoc-dblatex.sty')) shell('"%s" -t %s -p "%s" -s "%s" %s "%s"' % (DBLATEX, self.format, xsl, sty, self.dblatex_opts, docbook_file)) def to_dvi(self): self.exec_dblatex() def to_ps(self): self.exec_dblatex() def to_tex(self): self.exec_dblatex() def to_htmlhelp(self): self.to_chunked() def to_chunked(self): self.to_docbook() docbook_file = self.dst_path('.xml') opts = self.xsltproc_opts xsl_file = self.xsl_stylesheet() if self.format == 'chunked': dst_dir = self.dst_path('.chunked') elif self.format == 'htmlhelp': dst_dir = self.dst_path('.htmlhelp') if not 'base.dir ' in opts: opts += ' --stringparam base.dir "%s/"' % os.path.basename(dst_dir) # Create content. shell_rmtree(dst_dir) shell_makedirs(dst_dir) exec_xsltproc(xsl_file, docbook_file, self.destination_dir, opts) html_files = find_files(dst_dir, '*.html') src_dir = os.path.dirname(self.asciidoc_file) self.copy_resources(html_files, src_dir, dst_dir) def update_epub_manifest(self, opf_file): ''' Scan the OEBPS directory for any files that have not been registered in the OPF manifest then add them to the manifest. ''' opf_dir = os.path.dirname(opf_file) resource_files = [] for (p,dirs,files) in os.walk(os.path.dirname(opf_file)): for f in files: f = os.path.join(p,f) if os.path.isfile(f): assert f.startswith(opf_dir) f = '.' + f[len(opf_dir):] f = os.path.normpath(f) if f not in ['content.opf']: resource_files.append(f) opf = xml.dom.minidom.parseString(read_file(opf_file)) manifest_files = [] manifest = opf.getElementsByTagName('manifest')[0] for el in manifest.getElementsByTagName('item'): f = el.getAttribute('href') f = os.path.normpath(f) manifest_files.append(f) count = 0 for f in resource_files: if f not in manifest_files: count += 1 verbose('adding to manifest: %s' % f) item = opf.createElement('item') item.setAttribute('href', f.replace(os.path.sep, '/')) item.setAttribute('id', 'a2x-%d' % count) mimetype = mimetypes.guess_type(f)[0] if mimetype is None: die('unknown mimetype: %s' % f) item.setAttribute('media-type', mimetype) manifest.appendChild(item) if count > 0: write_file(opf_file, opf.toxml()) def to_epub(self): self.to_docbook() xsl_file = self.xsl_stylesheet() docbook_file = self.dst_path('.xml') epub_file = self.dst_path('.epub') build_dir = epub_file + '.d' shell_rmtree(build_dir) shell_makedirs(build_dir) # Create content. exec_xsltproc(xsl_file, docbook_file, build_dir, self.xsltproc_opts) # Copy resources referenced in the OPF and resources referenced by the # generated HTML (in theory DocBook XSL should ensure they are # identical but this is not always the case). src_dir = os.path.dirname(self.asciidoc_file) dst_dir = os.path.join(build_dir, 'OEBPS') opf_file = os.path.join(dst_dir, 'content.opf') opf_resources = find_resources(opf_file, 'item', 'href') html_files = find_files(dst_dir, '*.html') self.copy_resources(html_files, src_dir, dst_dir, opf_resources) # Register any unregistered resources. self.update_epub_manifest(opf_file) # Build epub archive. cwd = os.getcwd() shell_cd(build_dir) try: if not self.dry_run: zip = zipfile.ZipFile(epub_file, 'w') try: # Create and add uncompressed mimetype file. verbose('archiving: mimetype') write_file('mimetype', 'application/epub+zip') zip.write('mimetype', compress_type=zipfile.ZIP_STORED) # Compress all remaining files. for (p,dirs,files) in os.walk('.'): for f in files: f = os.path.normpath(os.path.join(p,f)) if f != 'mimetype': verbose('archiving: %s' % f) zip.write(f, compress_type=zipfile.ZIP_DEFLATED) finally: zip.close() verbose('created archive: %s' % epub_file) finally: shell_cd(cwd) if not self.keep_artifacts: shell_rmtree(build_dir) if self.epubcheck and EPUBCHECK: if not find_executable(EPUBCHECK): warning('epubcheck skipped: unable to find executable: %s' % EPUBCHECK) else: shell('"%s" "%s"' % (EPUBCHECK, epub_file)) def to_text(self): text_file = self.dst_path('.text') html_file = self.dst_path('.text.html') if self.lynx: shell('"%s" %s --conf-file "%s" -b html4 -a "a2x-format=%s" -o "%s" "%s"' % (self.asciidoc, self.asciidoc_opts, self.asciidoc_conf_file('text.conf'), self.format, html_file, self.asciidoc_file)) shell('"%s" -dump "%s" > "%s"' % (LYNX, html_file, text_file)) else: # Use w3m(1). self.to_docbook() docbook_file = self.dst_path('.xml') opts = '%s --output "%s"' % (self.xsltproc_opts, html_file) exec_xsltproc(self.xsl_stylesheet(), docbook_file, self.destination_dir, opts) shell('"%s" -cols 70 -dump -T text/html -no-graph "%s" > "%s"' % (W3M, html_file, text_file)) if not self.keep_artifacts: shell_rm(html_file) ##################################################################### # Script main line. ##################################################################### if __name__ == '__main__': description = '''A toolchain manager for AsciiDoc (converts Asciidoc text files to other file formats)''' from optparse import OptionParser parser = OptionParser(usage='usage: %prog [OPTIONS] SOURCE_FILE', version='%s %s' % (PROG,VERSION), description=description) parser.add_option('-a', '--attribute', action='append', dest='attributes', default=[], metavar='ATTRIBUTE', help='set asciidoc attribute value') parser.add_option('--asciidoc-opts', action='append', dest='asciidoc_opts', default=[], metavar='ASCIIDOC_OPTS', help='asciidoc options') #DEPRECATED parser.add_option('--copy', action='store_true', dest='copy', default=False, help='DEPRECATED: does nothing') parser.add_option('--conf-file', dest='conf_file', default=None, metavar='CONF_FILE', help='configuration file') parser.add_option('-D', '--destination-dir', action='store', dest='destination_dir', default=None, metavar='PATH', help='output directory (defaults to SOURCE_FILE directory)') parser.add_option('-d','--doctype', action='store', dest='doctype', metavar='DOCTYPE', choices=('article','manpage','book'), help='article, manpage, book') parser.add_option('-b','--backend', action='store', dest='backend', metavar='BACKEND', help='name of backend plugin') parser.add_option('--epubcheck', action='store_true', dest='epubcheck', default=False, help='check EPUB output with epubcheck') parser.add_option('-f','--format', action='store', dest='format', metavar='FORMAT', default = 'pdf', choices=('chunked','epub','htmlhelp','manpage','pdf', 'text', 'xhtml','dvi','ps','tex','docbook'), help='chunked, epub, htmlhelp, manpage, pdf, text, xhtml, dvi, ps, tex, docbook') parser.add_option('--icons', action='store_true', dest='icons', default=False, help='use admonition, callout and navigation icons') parser.add_option('--icons-dir', action='store', dest='icons_dir', default=None, metavar='PATH', help='admonition and navigation icon directory') parser.add_option('-k', '--keep-artifacts', action='store_true', dest='keep_artifacts', default=False, help='do not delete temporary build files') parser.add_option('--lynx', action='store_true', dest='lynx', default=False, help='use lynx to generate text files') parser.add_option('-L', '--no-xmllint', action='store_true', dest='no_xmllint', default=False, help='do not check asciidoc output with xmllint') parser.add_option('-n','--dry-run', action='store_true', dest='dry_run', default=False, help='just print the commands that would have been executed') parser.add_option('-r','--resource', action='append', dest='resources', default=[], metavar='PATH', help='resource file or directory containing resource files') parser.add_option('-m', '--resource-manifest', action='store', dest='resource_manifest', default=None, metavar='FILE', help='read resources from FILE') #DEPRECATED parser.add_option('--resource-dir', action='append', dest='resources', default=[], metavar='PATH', help='DEPRECATED: use --resource') #DEPRECATED parser.add_option('-s','--skip-asciidoc', action='store_true', dest='skip_asciidoc', default=False, help='DEPRECATED: redundant') parser.add_option('--stylesheet', action='store', dest='stylesheet', default=None, metavar='STYLESHEET', help='HTML CSS stylesheet file name') #DEPRECATED parser.add_option('--safe', action='store_true', dest='safe', default=False, help='DEPRECATED: does nothing') parser.add_option('--dblatex-opts', action='append', dest='dblatex_opts', default=[], metavar='DBLATEX_OPTS', help='dblatex options') parser.add_option('--backend-opts', action='append', dest='backend_opts', default=[], metavar='BACKEND_OPTS', help='backend plugin options') parser.add_option('--fop', action='store_true', dest='fop', default=False, help='use FOP to generate PDF files') parser.add_option('--fop-opts', action='append', dest='fop_opts', default=[], metavar='FOP_OPTS', help='options for FOP pdf generation') parser.add_option('--xsltproc-opts', action='append', dest='xsltproc_opts', default=[], metavar='XSLTPROC_OPTS', help='xsltproc options for XSL stylesheets') parser.add_option('--xsl-file', action='store', dest='xsl_file', metavar='XSL_FILE', help='custom XSL stylesheet') parser.add_option('-v', '--verbose', action='count', dest='verbose', default=0, help='increase verbosity') if len(sys.argv) == 1: parser.parse_args(['--help']) source_options = get_source_options(sys.argv[-1]) argv = source_options + sys.argv[1:] opts, args = parser.parse_args(argv) if len(args) != 1: parser.error('incorrect number of arguments') opts.asciidoc_opts = ' '.join(opts.asciidoc_opts) opts.dblatex_opts = ' '.join(opts.dblatex_opts) opts.fop_opts = ' '.join(opts.fop_opts) opts.xsltproc_opts = ' '.join(opts.xsltproc_opts) opts.backend_opts = ' '.join(opts.backend_opts) opts = eval(str(opts)) # Convert optparse.Values to dict. a2x = A2X(opts) OPTIONS = a2x # verbose and dry_run used by utility functions. verbose('args: %r' % argv) a2x.asciidoc_file = args[0] try: a2x.load_conf() a2x.execute() except KeyboardInterrupt: exit(1) asciidoc-8.6.9/asciidoc.py0000775000175100017510000076037212236532614015642 0ustar srackhamsrackham#!/usr/bin/env python """ asciidoc - converts an AsciiDoc text file to HTML or DocBook Copyright (C) 2002-2010 Stuart Rackham. Free use of this software is granted under the terms of the GNU General Public License (GPL). """ import sys, os, re, time, traceback, tempfile, subprocess, codecs, locale, unicodedata, copy ### Used by asciidocapi.py ### VERSION = '8.6.9' # See CHANGLOG file for version history. MIN_PYTHON_VERSION = '2.4' # Require this version of Python or better. #--------------------------------------------------------------------------- # Program constants. #--------------------------------------------------------------------------- DEFAULT_BACKEND = 'html' DEFAULT_DOCTYPE = 'article' # Allowed substitution options for List, Paragraph and DelimitedBlock # definition subs entry. SUBS_OPTIONS = ('specialcharacters','quotes','specialwords', 'replacements', 'attributes','macros','callouts','normal','verbatim', 'none','replacements2','replacements3') # Default value for unspecified subs and presubs configuration file entries. SUBS_NORMAL = ('specialcharacters','quotes','attributes', 'specialwords','replacements','macros','replacements2') SUBS_VERBATIM = ('specialcharacters','callouts') NAME_RE = r'(?u)[^\W\d][-\w]*' # Valid section or attribute name. OR, AND = ',', '+' # Attribute list separators. #--------------------------------------------------------------------------- # Utility functions and classes. #--------------------------------------------------------------------------- class EAsciiDoc(Exception): pass class OrderedDict(dict): """ Dictionary ordered by insertion order. Python Cookbook: Ordered Dictionary, Submitter: David Benjamin. http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/107747 """ def __init__(self, d=None, **kwargs): self._keys = [] if d is None: d = kwargs dict.__init__(self, d) def __delitem__(self, key): dict.__delitem__(self, key) self._keys.remove(key) def __setitem__(self, key, item): dict.__setitem__(self, key, item) if key not in self._keys: self._keys.append(key) def clear(self): dict.clear(self) self._keys = [] def copy(self): d = dict.copy(self) d._keys = self._keys[:] return d def items(self): return zip(self._keys, self.values()) def keys(self): return self._keys def popitem(self): try: key = self._keys[-1] except IndexError: raise KeyError('dictionary is empty') val = self[key] del self[key] return (key, val) def setdefault(self, key, failobj = None): dict.setdefault(self, key, failobj) if key not in self._keys: self._keys.append(key) def update(self, d=None, **kwargs): if d is None: d = kwargs dict.update(self, d) for key in d.keys(): if key not in self._keys: self._keys.append(key) def values(self): return map(self.get, self._keys) class AttrDict(dict): """ Like a dictionary except values can be accessed as attributes i.e. obj.foo can be used in addition to obj['foo']. If an item is not present None is returned. """ def __getattr__(self, key): try: return self[key] except KeyError: return None def __setattr__(self, key, value): self[key] = value def __delattr__(self, key): try: del self[key] except KeyError, k: raise AttributeError, k def __repr__(self): return '' def __getstate__(self): return dict(self) def __setstate__(self,value): for k,v in value.items(): self[k]=v class InsensitiveDict(dict): """ Like a dictionary except key access is case insensitive. Keys are stored in lower case. """ def __getitem__(self, key): return dict.__getitem__(self, key.lower()) def __setitem__(self, key, value): dict.__setitem__(self, key.lower(), value) def has_key(self, key): return dict.has_key(self,key.lower()) def get(self, key, default=None): return dict.get(self, key.lower(), default) def update(self, dict): for k,v in dict.items(): self[k] = v def setdefault(self, key, default = None): return dict.setdefault(self, key.lower(), default) class Trace(object): """ Used in conjunction with the 'trace' attribute to generate diagnostic output. There is a single global instance of this class named trace. """ SUBS_NAMES = ('specialcharacters','quotes','specialwords', 'replacements', 'attributes','macros','callouts', 'replacements2','replacements3') def __init__(self): self.name_re = '' # Regexp pattern to match trace names. self.linenos = True self.offset = 0 def __call__(self, name, before, after=None): """ Print trace message if tracing is on and the trace 'name' matches the document 'trace' attribute (treated as a regexp). 'before' is the source text before substitution; 'after' text is the source text after substitutuion. The 'before' and 'after' messages are only printed if they differ. """ name_re = document.attributes.get('trace') if name_re == 'subs': # Alias for all the inline substitutions. name_re = '|'.join(self.SUBS_NAMES) self.name_re = name_re if self.name_re is not None: msg = message.format(name, 'TRACE: ', self.linenos, offset=self.offset) if before != after and re.match(self.name_re,name): if is_array(before): before = '\n'.join(before) if after is None: msg += '\n%s\n' % before else: if is_array(after): after = '\n'.join(after) msg += '\n<<<\n%s\n>>>\n%s\n' % (before,after) message.stderr(msg) class Message: """ Message functions. """ PROG = os.path.basename(os.path.splitext(__file__)[0]) def __init__(self): # Set to True or False to globally override line numbers method # argument. Has no effect when set to None. self.linenos = None self.messages = [] self.prev_msg = '' def stdout(self,msg): print msg def stderr(self,msg=''): if msg == self.prev_msg: # Suppress repeated messages. return self.messages.append(msg) if __name__ == '__main__': sys.stderr.write('%s: %s%s' % (self.PROG, msg, os.linesep)) self.prev_msg = msg def verbose(self, msg,linenos=True): if config.verbose: msg = self.format(msg,linenos=linenos) self.stderr(msg) def warning(self, msg,linenos=True,offset=0): msg = self.format(msg,'WARNING: ',linenos,offset=offset) document.has_warnings = True self.stderr(msg) def deprecated(self, msg, linenos=True): msg = self.format(msg, 'DEPRECATED: ', linenos) self.stderr(msg) def format(self, msg, prefix='', linenos=True, cursor=None, offset=0): """Return formatted message string.""" if self.linenos is not False and ((linenos or self.linenos) and reader.cursor): if cursor is None: cursor = reader.cursor prefix += '%s: line %d: ' % (os.path.basename(cursor[0]),cursor[1]+offset) return prefix + msg def error(self, msg, cursor=None, halt=False): """ Report fatal error. If halt=True raise EAsciiDoc exception. If halt=False don't exit application, continue in the hope of reporting all fatal errors finishing with a non-zero exit code. """ if halt: raise EAsciiDoc, self.format(msg,linenos=False,cursor=cursor) else: msg = self.format(msg,'ERROR: ',cursor=cursor) self.stderr(msg) document.has_errors = True def unsafe(self, msg): self.error('unsafe: '+msg) def userdir(): """ Return user's home directory or None if it is not defined. """ result = os.path.expanduser('~') if result == '~': result = None return result def localapp(): """ Return True if we are not executing the system wide version i.e. the configuration is in the executable's directory. """ return os.path.isfile(os.path.join(APP_DIR, 'asciidoc.conf')) def file_in(fname, directory): """Return True if file fname resides inside directory.""" assert os.path.isfile(fname) # Empty directory (not to be confused with None) is the current directory. if directory == '': directory = os.getcwd() else: assert os.path.isdir(directory) directory = os.path.realpath(directory) fname = os.path.realpath(fname) return os.path.commonprefix((directory, fname)) == directory def safe(): return document.safe def is_safe_file(fname, directory=None): # A safe file must reside in 'directory' (defaults to the source # file directory). if directory is None: if document.infile == '': return not safe() directory = os.path.dirname(document.infile) elif directory == '': directory = '.' return ( not safe() or file_in(fname, directory) or file_in(fname, APP_DIR) or file_in(fname, CONF_DIR) ) def safe_filename(fname, parentdir): """ Return file name which must reside in the parent file directory. Return None if file is not safe. """ if not os.path.isabs(fname): # Include files are relative to parent document # directory. fname = os.path.normpath(os.path.join(parentdir,fname)) if not is_safe_file(fname, parentdir): message.unsafe('include file: %s' % fname) return None return fname def assign(dst,src): """Assign all attributes from 'src' object to 'dst' object.""" for a,v in src.__dict__.items(): setattr(dst,a,v) def strip_quotes(s): """Trim white space and, if necessary, quote characters from s.""" s = s.strip() # Strip quotation mark characters from quoted strings. if len(s) >= 3 and s[0] == '"' and s[-1] == '"': s = s[1:-1] return s def is_re(s): """Return True if s is a valid regular expression else return False.""" try: re.compile(s) except: return False else: return True def re_join(relist): """Join list of regular expressions re1,re2,... to single regular expression (re1)|(re2)|...""" if len(relist) == 0: return None result = [] # Delete named groups to avoid ambiguity. for s in relist: result.append(re.sub(r'\?P<\S+?>','',s)) result = ')|('.join(result) result = '('+result+')' return result def lstrip_list(s): """ Return list with empty items from start of list removed. """ for i in range(len(s)): if s[i]: break else: return [] return s[i:] def rstrip_list(s): """ Return list with empty items from end of list removed. """ for i in range(len(s)-1,-1,-1): if s[i]: break else: return [] return s[:i+1] def strip_list(s): """ Return list with empty items from start and end of list removed. """ s = lstrip_list(s) s = rstrip_list(s) return s def is_array(obj): """ Return True if object is list or tuple type. """ return isinstance(obj,list) or isinstance(obj,tuple) def dovetail(lines1, lines2): """ Append list or tuple of strings 'lines2' to list 'lines1'. Join the last non-blank item in 'lines1' with the first non-blank item in 'lines2' into a single string. """ assert is_array(lines1) assert is_array(lines2) lines1 = strip_list(lines1) lines2 = strip_list(lines2) if not lines1 or not lines2: return list(lines1) + list(lines2) result = list(lines1[:-1]) result.append(lines1[-1] + lines2[0]) result += list(lines2[1:]) return result def dovetail_tags(stag,content,etag): """Merge the end tag with the first content line and the last content line with the end tag. This ensures verbatim elements don't include extraneous opening and closing line breaks.""" return dovetail(dovetail(stag,content), etag) # The following functions are so we don't have to use the dangerous # built-in eval() function. if float(sys.version[:3]) >= 2.6 or sys.platform[:4] == 'java': # Use AST module if CPython >= 2.6 or Jython. import ast from ast import literal_eval def get_args(val): d = {} args = ast.parse("d(" + val + ")", mode='eval').body.args i = 1 for arg in args: if isinstance(arg, ast.Name): d[str(i)] = literal_eval(arg.id) else: d[str(i)] = literal_eval(arg) i += 1 return d def get_kwargs(val): d = {} args = ast.parse("d(" + val + ")", mode='eval').body.keywords for arg in args: d[arg.arg] = literal_eval(arg.value) return d def parse_to_list(val): values = ast.parse("[" + val + "]", mode='eval').body.elts return [literal_eval(v) for v in values] else: # Use deprecated CPython compiler module. import compiler from compiler.ast import Const, Dict, Expression, Name, Tuple, UnarySub, Keyword # Code from: # http://mail.python.org/pipermail/python-list/2009-September/1219992.html # Modified to use compiler.ast.List as this module has a List def literal_eval(node_or_string): """ Safely evaluate an expression node or a string containing a Python expression. The string or node provided may only consist of the following Python literal structures: strings, numbers, tuples, lists, dicts, booleans, and None. """ _safe_names = {'None': None, 'True': True, 'False': False} if isinstance(node_or_string, basestring): node_or_string = compiler.parse(node_or_string, mode='eval') if isinstance(node_or_string, Expression): node_or_string = node_or_string.node def _convert(node): if isinstance(node, Const) and isinstance(node.value, (basestring, int, float, long, complex)): return node.value elif isinstance(node, Tuple): return tuple(map(_convert, node.nodes)) elif isinstance(node, compiler.ast.List): return list(map(_convert, node.nodes)) elif isinstance(node, Dict): return dict((_convert(k), _convert(v)) for k, v in node.items) elif isinstance(node, Name): if node.name in _safe_names: return _safe_names[node.name] elif isinstance(node, UnarySub): return -_convert(node.expr) raise ValueError('malformed string') return _convert(node_or_string) def get_args(val): d = {} args = compiler.parse("d(" + val + ")", mode='eval').node.args i = 1 for arg in args: if isinstance(arg, Keyword): break d[str(i)] = literal_eval(arg) i = i + 1 return d def get_kwargs(val): d = {} args = compiler.parse("d(" + val + ")", mode='eval').node.args i = 0 for arg in args: if isinstance(arg, Keyword): break i += 1 args = args[i:] for arg in args: d[str(arg.name)] = literal_eval(arg.expr) return d def parse_to_list(val): values = compiler.parse("[" + val + "]", mode='eval').node.asList() return [literal_eval(v) for v in values] def parse_attributes(attrs,dict): """Update a dictionary with name/value attributes from the attrs string. The attrs string is a comma separated list of values and keyword name=value pairs. Values must preceed keywords and are named '1','2'... The entire attributes list is named '0'. If keywords are specified string values must be quoted. Examples: attrs: '' dict: {} attrs: 'hello,world' dict: {'2': 'world', '0': 'hello,world', '1': 'hello'} attrs: '"hello", planet="earth"' dict: {'planet': 'earth', '0': '"hello",planet="earth"', '1': 'hello'} """ def f(*args,**keywords): # Name and add aguments '1','2'... to keywords. for i in range(len(args)): if not str(i+1) in keywords: keywords[str(i+1)] = args[i] return keywords if not attrs: return dict['0'] = attrs # Replace line separators with spaces so line spanning works. s = re.sub(r'\s', ' ', attrs) d = {} try: d.update(get_args(s)) d.update(get_kwargs(s)) for v in d.values(): if not (isinstance(v,str) or isinstance(v,int) or isinstance(v,float) or v is None): raise Exception except Exception: s = s.replace('"','\\"') s = s.split(',') s = map(lambda x: '"' + x.strip() + '"', s) s = ','.join(s) try: d = {} d.update(get_args(s)) d.update(get_kwargs(s)) except Exception: return # If there's a syntax error leave with {0}=attrs. for k in d.keys(): # Drop any empty positional arguments. if d[k] == '': del d[k] dict.update(d) assert len(d) > 0 def parse_named_attributes(s,attrs): """Update a attrs dictionary with name="value" attributes from the s string. Returns False if invalid syntax. Example: attrs: 'star="sun",planet="earth"' dict: {'planet':'earth', 'star':'sun'} """ def f(**keywords): return keywords try: d = {} d = get_kwargs(s) attrs.update(d) return True except Exception: return False def parse_list(s): """Parse comma separated string of Python literals. Return a tuple of of parsed values.""" try: result = tuple(parse_to_list(s)) except Exception: raise EAsciiDoc,'malformed list: '+s return result def parse_options(options,allowed,errmsg): """Parse comma separated string of unquoted option names and return as a tuple of valid options. 'allowed' is a list of allowed option values. If allowed=() then all legitimate names are allowed. 'errmsg' is an error message prefix if an illegal option error is thrown.""" result = [] if options: for s in re.split(r'\s*,\s*',options): if (allowed and s not in allowed) or not is_name(s): raise EAsciiDoc,'%s: %s' % (errmsg,s) result.append(s) return tuple(result) def symbolize(s): """Drop non-symbol characters and convert to lowercase.""" return re.sub(r'(?u)[^\w\-_]', '', s).lower() def is_name(s): """Return True if s is valid attribute, macro or tag name (starts with alpha containing alphanumeric and dashes only).""" return re.match(r'^'+NAME_RE+r'$',s) is not None def subs_quotes(text): """Quoted text is marked up and the resulting text is returned.""" keys = config.quotes.keys() for q in keys: i = q.find('|') if i != -1 and q != '|' and q != '||': lq = q[:i] # Left quote. rq = q[i+1:] # Right quote. else: lq = rq = q tag = config.quotes[q] if not tag: continue # Unconstrained quotes prefix the tag name with a hash. if tag[0] == '#': tag = tag[1:] # Unconstrained quotes can appear anywhere. reo = re.compile(r'(?msu)(^|.)(\[(?P[^[\]]+?)\])?' \ + r'(?:' + re.escape(lq) + r')' \ + r'(?P.+?)(?:'+re.escape(rq)+r')') else: # The text within constrained quotes must be bounded by white space. # Non-word (\W) characters are allowed at boundaries to accomodate # enveloping quotes and punctuation e.g. a='x', ('x'), 'x', ['x']. reo = re.compile(r'(?msu)(^|[^\w;:}])(\[(?P[^[\]]+?)\])?' \ + r'(?:' + re.escape(lq) + r')' \ + r'(?P\S|\S.*?\S)(?:'+re.escape(rq)+r')(?=\W|$)') pos = 0 while True: mo = reo.search(text,pos) if not mo: break if text[mo.start()] == '\\': # Delete leading backslash. text = text[:mo.start()] + text[mo.start()+1:] # Skip past start of match. pos = mo.start() + 1 else: attrlist = {} parse_attributes(mo.group('attrlist'), attrlist) stag,etag = config.tag(tag, attrlist) s = mo.group(1) + stag + mo.group('content') + etag text = text[:mo.start()] + s + text[mo.end():] pos = mo.start() + len(s) return text def subs_tag(tag,dict={}): """Perform attribute substitution and split tag string returning start, end tag tuple (c.f. Config.tag()).""" if not tag: return [None,None] s = subs_attrs(tag,dict) if not s: message.warning('tag \'%s\' dropped: contains undefined attribute' % tag) return [None,None] result = s.split('|') if len(result) == 1: return result+[None] elif len(result) == 2: return result else: raise EAsciiDoc,'malformed tag: %s' % tag def parse_entry(entry, dict=None, unquote=False, unique_values=False, allow_name_only=False, escape_delimiter=True): """Parse name=value entry to dictionary 'dict'. Return tuple (name,value) or None if illegal entry. If name= then value is set to ''. If name and allow_name_only=True then value is set to ''. If name! and allow_name_only=True then value is set to None. Leading and trailing white space is striped from 'name' and 'value'. 'name' can contain any printable characters. If the '=' delimiter character is allowed in the 'name' then it must be escaped with a backslash and escape_delimiter must be True. If 'unquote' is True leading and trailing double-quotes are stripped from 'name' and 'value'. If unique_values' is True then dictionary entries with the same value are removed before the parsed entry is added.""" if escape_delimiter: mo = re.search(r'(?:[^\\](=))',entry) else: mo = re.search(r'(=)',entry) if mo: # name=value entry. if mo.group(1): name = entry[:mo.start(1)] if escape_delimiter: name = name.replace(r'\=','=') # Unescape \= in name. value = entry[mo.end(1):] elif allow_name_only and entry: # name or name! entry. name = entry if name[-1] == '!': name = name[:-1] value = None else: value = '' else: return None if unquote: name = strip_quotes(name) if value is not None: value = strip_quotes(value) else: name = name.strip() if value is not None: value = value.strip() if not name: return None if dict is not None: if unique_values: for k,v in dict.items(): if v == value: del dict[k] dict[name] = value return name,value def parse_entries(entries, dict, unquote=False, unique_values=False, allow_name_only=False,escape_delimiter=True): """Parse name=value entries from from lines of text in 'entries' into dictionary 'dict'. Blank lines are skipped.""" entries = config.expand_templates(entries) for entry in entries: if entry and not parse_entry(entry, dict, unquote, unique_values, allow_name_only, escape_delimiter): raise EAsciiDoc,'malformed section entry: %s' % entry def dump_section(name,dict,f=sys.stdout): """Write parameters in 'dict' as in configuration file section format with section 'name'.""" f.write('[%s]%s' % (name,writer.newline)) for k,v in dict.items(): k = str(k) k = k.replace('=',r'\=') # Escape = in name. # Quote if necessary. if len(k) != len(k.strip()): k = '"'+k+'"' if v and len(v) != len(v.strip()): v = '"'+v+'"' if v is None: # Don't dump undefined attributes. continue else: s = k+'='+v if s[0] == '#': s = '\\' + s # Escape so not treated as comment lines. f.write('%s%s' % (s,writer.newline)) f.write(writer.newline) def update_attrs(attrs,dict): """Update 'attrs' dictionary with parsed attributes in dictionary 'dict'.""" for k,v in dict.items(): if not is_name(k): raise EAsciiDoc,'illegal attribute name: %s' % k attrs[k] = v def is_attr_defined(attrs,dic): """ Check if the sequence of attributes is defined in dictionary 'dic'. Valid 'attrs' sequence syntax: Return True if single attrbiute is defined. ,,... Return True if one or more attributes are defined. ++... Return True if all the attributes are defined. """ if OR in attrs: for a in attrs.split(OR): if dic.get(a.strip()) is not None: return True else: return False elif AND in attrs: for a in attrs.split(AND): if dic.get(a.strip()) is None: return False else: return True else: return dic.get(attrs.strip()) is not None def filter_lines(filter_cmd, lines, attrs={}): """ Run 'lines' through the 'filter_cmd' shell command and return the result. The 'attrs' dictionary contains additional filter attributes. """ def findfilter(name,dir,filter): """Find filter file 'fname' with style name 'name' in directory 'dir'. Return found file path or None if not found.""" if name: result = os.path.join(dir,'filters',name,filter) if os.path.isfile(result): return result result = os.path.join(dir,'filters',filter) if os.path.isfile(result): return result return None # Return input lines if there's not filter. if not filter_cmd or not filter_cmd.strip(): return lines # Perform attributes substitution on the filter command. s = subs_attrs(filter_cmd, attrs) if not s: message.error('undefined filter attribute in command: %s' % filter_cmd) return [] filter_cmd = s.strip() # Parse for quoted and unquoted command and command tail. # Double quoted. mo = re.match(r'^"(?P[^"]+)"(?P.*)$', filter_cmd) if not mo: # Single quoted. mo = re.match(r"^'(?P[^']+)'(?P.*)$", filter_cmd) if not mo: # Unquoted catch all. mo = re.match(r'^(?P\S+)(?P.*)$', filter_cmd) cmd = mo.group('cmd').strip() found = None if not os.path.dirname(cmd): # Filter command has no directory path so search filter directories. filtername = attrs.get('style') d = document.attributes.get('docdir') if d: found = findfilter(filtername, d, cmd) if not found: if USER_DIR: found = findfilter(filtername, USER_DIR, cmd) if not found: if localapp(): found = findfilter(filtername, APP_DIR, cmd) else: found = findfilter(filtername, CONF_DIR, cmd) else: if os.path.isfile(cmd): found = cmd else: message.warning('filter not found: %s' % cmd) if found: filter_cmd = '"' + found + '"' + mo.group('tail') if found: if cmd.endswith('.py'): filter_cmd = '"%s" %s' % (document.attributes['python'], filter_cmd) elif cmd.endswith('.rb'): filter_cmd = 'ruby ' + filter_cmd message.verbose('filtering: ' + filter_cmd) if os.name == 'nt': # Remove redundant quoting -- this is not just # cosmetic, unnecessary quoting appears to cause # command line truncation. filter_cmd = re.sub(r'"([^ ]+?)"', r'\1', filter_cmd) try: p = subprocess.Popen(filter_cmd, shell=True, stdin=subprocess.PIPE, stdout=subprocess.PIPE) output = p.communicate(os.linesep.join(lines))[0] except Exception: raise EAsciiDoc,'filter error: %s: %s' % (filter_cmd, sys.exc_info()[1]) if output: result = [s.rstrip() for s in output.split(os.linesep)] else: result = [] filter_status = p.wait() if filter_status: message.warning('filter non-zero exit code: %s: returned %d' % (filter_cmd, filter_status)) if lines and not result: message.warning('no output from filter: %s' % filter_cmd) return result def system(name, args, is_macro=False, attrs=None): """ Evaluate a system attribute ({name:args}) or system block macro (name::[args]). If is_macro is True then we are processing a system block macro otherwise it's a system attribute. The attrs dictionary is updated by the counter and set system attributes. NOTE: The include1 attribute is used internally by the include1::[] macro and is not for public use. """ if is_macro: syntax = '%s::[%s]' % (name,args) separator = '\n' else: syntax = '{%s:%s}' % (name,args) separator = writer.newline if name not in ('eval','eval3','sys','sys2','sys3','include','include1','counter','counter2','set','set2','template'): if is_macro: msg = 'illegal system macro name: %s' % name else: msg = 'illegal system attribute name: %s' % name message.warning(msg) return None if is_macro: s = subs_attrs(args) if s is None: message.warning('skipped %s: undefined attribute in: %s' % (name,args)) return None args = s if name != 'include1': message.verbose('evaluating: %s' % syntax) if safe() and name not in ('include','include1'): message.unsafe(syntax) return None result = None if name in ('eval','eval3'): try: result = eval(args) if result is True: result = '' elif result is False: result = None elif result is not None: result = str(result) except Exception: message.warning('%s: evaluation error' % syntax) elif name in ('sys','sys2','sys3'): result = '' fd,tmp = tempfile.mkstemp() os.close(fd) try: cmd = args cmd = cmd + (' > "%s"' % tmp) if name == 'sys2': cmd = cmd + ' 2>&1' if os.name == 'nt': # Remove redundant quoting -- this is not just # cosmetic, unnecessary quoting appears to cause # command line truncation. cmd = re.sub(r'"([^ ]+?)"', r'\1', cmd) message.verbose('shelling: %s' % cmd) if os.system(cmd): message.warning('%s: non-zero exit status' % syntax) try: if os.path.isfile(tmp): f = open(tmp) try: lines = [s.rstrip() for s in f] finally: f.close() else: lines = [] except Exception: raise EAsciiDoc,'%s: temp file read error' % syntax result = separator.join(lines) finally: if os.path.isfile(tmp): os.remove(tmp) elif name in ('counter','counter2'): mo = re.match(r'^(?P[^:]*?)(:(?P.*))?$', args) attr = mo.group('attr') seed = mo.group('seed') if seed and (not re.match(r'^\d+$', seed) and len(seed) > 1): message.warning('%s: illegal counter seed: %s' % (syntax,seed)) return None if not is_name(attr): message.warning('%s: illegal attribute name' % syntax) return None value = document.attributes.get(attr) if value: if not re.match(r'^\d+$', value) and len(value) > 1: message.warning('%s: illegal counter value: %s' % (syntax,value)) return None if re.match(r'^\d+$', value): expr = value + '+1' else: expr = 'chr(ord("%s")+1)' % value try: result = str(eval(expr)) except Exception: message.warning('%s: evaluation error: %s' % (syntax, expr)) else: if seed: result = seed else: result = '1' document.attributes[attr] = result if attrs is not None: attrs[attr] = result if name == 'counter2': result = '' elif name in ('set','set2'): mo = re.match(r'^(?P[^:]*?)(:(?P.*))?$', args) attr = mo.group('attr') value = mo.group('value') if value is None: value = '' if attr.endswith('!'): attr = attr[:-1] value = None if not is_name(attr): message.warning('%s: illegal attribute name' % syntax) else: if attrs is not None: attrs[attr] = value if name != 'set2': # set2 only updates local attributes. document.attributes[attr] = value if value is None: result = None else: result = '' elif name == 'include': if not os.path.exists(args): message.warning('%s: file does not exist' % syntax) elif not is_safe_file(args): message.unsafe(syntax) else: f = open(args) try: result = [s.rstrip() for s in f] finally: f.close() if result: result = subs_attrs(result) result = separator.join(result) result = result.expandtabs(reader.tabsize) else: result = '' elif name == 'include1': result = separator.join(config.include1[args]) elif name == 'template': if not args in config.sections: message.warning('%s: template does not exist' % syntax) else: result = [] for line in config.sections[args]: line = subs_attrs(line) if line is not None: result.append(line) result = '\n'.join(result) else: assert False if result and name in ('eval3','sys3'): macros.passthroughs.append(result) result = '\x07' + str(len(macros.passthroughs)-1) + '\x07' return result def subs_attrs(lines, dictionary=None): """Substitute 'lines' of text with attributes from the global document.attributes dictionary and from 'dictionary' ('dictionary' entries take precedence). Return a tuple of the substituted lines. 'lines' containing undefined attributes are deleted. If 'lines' is a string then return a string. - Attribute references are substituted in the following order: simple, conditional, system. - Attribute references inside 'dictionary' entry values are substituted. """ def end_brace(text,start): """Return index following end brace that matches brace at start in text.""" assert text[start] == '{' n = 0 result = start for c in text[start:]: # Skip braces that are followed by a backslash. if result == len(text)-1 or text[result+1] != '\\': if c == '{': n = n + 1 elif c == '}': n = n - 1 result = result + 1 if n == 0: break return result if type(lines) == str: string_result = True lines = [lines] else: string_result = False if dictionary is None: attrs = document.attributes else: # Remove numbered document attributes so they don't clash with # attribute list positional attributes. attrs = {} for k,v in document.attributes.items(): if not re.match(r'^\d+$', k): attrs[k] = v # Substitute attribute references inside dictionary values. for k,v in dictionary.items(): if v is None: del dictionary[k] else: v = subs_attrs(str(v)) if v is None: del dictionary[k] else: dictionary[k] = v attrs.update(dictionary) # Substitute all attributes in all lines. result = [] for line in lines: # Make it easier for regular expressions. line = line.replace('\\{','{\\') line = line.replace('\\}','}\\') # Expand simple attributes ({name}). # Nested attributes not allowed. reo = re.compile(r'(?su)\{(?P[^\\\W][-\w]*?)\}(?!\\)') pos = 0 while True: mo = reo.search(line,pos) if not mo: break s = attrs.get(mo.group('name')) if s is None: pos = mo.end() else: s = str(s) line = line[:mo.start()] + s + line[mo.end():] pos = mo.start() + len(s) # Expand conditional attributes. # Single name -- higher precedence. reo1 = re.compile(r'(?su)\{(?P[^\\\W][-\w]*?)' \ r'(?P\=|\?|!|#|%|@|\$)' \ r'(?P.*?)\}(?!\\)') # Multiple names (n1,n2,... or n1+n2+...) -- lower precedence. reo2 = re.compile(r'(?su)\{(?P[^\\\W][-\w'+OR+AND+r']*?)' \ r'(?P\=|\?|!|#|%|@|\$)' \ r'(?P.*?)\}(?!\\)') for reo in [reo1,reo2]: pos = 0 while True: mo = reo.search(line,pos) if not mo: break attr = mo.group() name = mo.group('name') if reo == reo2: if OR in name: sep = OR else: sep = AND names = [s.strip() for s in name.split(sep) if s.strip() ] for n in names: if not re.match(r'^[^\\\W][-\w]*$',n): message.error('illegal attribute syntax: %s' % attr) if sep == OR: # Process OR name expression: n1,n2,... for n in names: if attrs.get(n) is not None: lval = '' break else: lval = None else: # Process AND name expression: n1+n2+... for n in names: if attrs.get(n) is None: lval = None break else: lval = '' else: lval = attrs.get(name) op = mo.group('op') # mo.end() not good enough because '{x={y}}' matches '{x={y}'. end = end_brace(line,mo.start()) rval = line[mo.start('value'):end-1] UNDEFINED = '{zzzzz}' if lval is None: if op == '=': s = rval elif op == '?': s = '' elif op == '!': s = rval elif op == '#': s = UNDEFINED # So the line is dropped. elif op == '%': s = rval elif op in ('@','$'): s = UNDEFINED # So the line is dropped. else: assert False, 'illegal attribute: %s' % attr else: if op == '=': s = lval elif op == '?': s = rval elif op == '!': s = '' elif op == '#': s = rval elif op == '%': s = UNDEFINED # So the line is dropped. elif op in ('@','$'): v = re.split(r'(?@:[:]} else: if len(v) == 3: # {@::} s = v[2] else: # {@:} s = '' else: if re_mo: if len(v) == 2: # {$:} s = v[1] elif v[1] == '': # {$::} s = UNDEFINED # So the line is dropped. else: # {$::} s = v[1] else: if len(v) == 2: # {$:} s = UNDEFINED # So the line is dropped. else: # {$::} s = v[2] else: assert False, 'illegal attribute: %s' % attr s = str(s) line = line[:mo.start()] + s + line[end:] pos = mo.start() + len(s) # Drop line if it contains unsubstituted {name} references. skipped = re.search(r'(?su)\{[^\\\W][-\w]*?\}(?!\\)', line) if skipped: trace('dropped line', line) continue; # Expand system attributes (eval has precedence). reos = [ re.compile(r'(?su)\{(?Peval):(?P.*?)\}(?!\\)'), re.compile(r'(?su)\{(?P[^\\\W][-\w]*?):(?P.*?)\}(?!\\)'), ] skipped = False for reo in reos: pos = 0 while True: mo = reo.search(line,pos) if not mo: break expr = mo.group('expr') action = mo.group('action') expr = expr.replace('{\\','{') expr = expr.replace('}\\','}') s = system(action, expr, attrs=dictionary) if dictionary is not None and action in ('counter','counter2','set','set2'): # These actions create and update attributes. attrs.update(dictionary) if s is None: # Drop line if the action returns None. skipped = True break line = line[:mo.start()] + s + line[mo.end():] pos = mo.start() + len(s) if skipped: break if not skipped: # Remove backslash from escaped entries. line = line.replace('{\\','{') line = line.replace('}\\','}') result.append(line) if string_result: if result: return '\n'.join(result) else: return None else: return tuple(result) def char_encoding(): encoding = document.attributes.get('encoding') if encoding: try: codecs.lookup(encoding) except LookupError,e: raise EAsciiDoc,str(e) return encoding def char_len(s): return len(char_decode(s)) east_asian_widths = {'W': 2, # Wide 'F': 2, # Full-width (wide) 'Na': 1, # Narrow 'H': 1, # Half-width (narrow) 'N': 1, # Neutral (not East Asian, treated as narrow) 'A': 1} # Ambiguous (s/b wide in East Asian context, # narrow otherwise, but that doesn't work) """Mapping of result codes from `unicodedata.east_asian_width()` to character column widths.""" def column_width(s): text = char_decode(s) if isinstance(text, unicode): width = 0 for c in text: width += east_asian_widths[unicodedata.east_asian_width(c)] return width else: return len(text) def char_decode(s): if char_encoding(): try: return s.decode(char_encoding()) except Exception: raise EAsciiDoc, \ "'%s' codec can't decode \"%s\"" % (char_encoding(), s) else: return s def char_encode(s): if char_encoding(): return s.encode(char_encoding()) else: return s def time_str(t): """Convert seconds since the Epoch to formatted local time string.""" t = time.localtime(t) s = time.strftime('%H:%M:%S',t) if time.daylight and t.tm_isdst == 1: result = s + ' ' + time.tzname[1] else: result = s + ' ' + time.tzname[0] # Attempt to convert the localtime to the output encoding. try: result = char_encode(result.decode(locale.getdefaultlocale()[1])) except Exception: pass return result def date_str(t): """Convert seconds since the Epoch to formatted local date string.""" t = time.localtime(t) return time.strftime('%Y-%m-%d',t) class Lex: """Lexical analysis routines. Static methods and attributes only.""" prev_element = None prev_cursor = None def __init__(self): raise AssertionError,'no class instances allowed' @staticmethod def next(): """Returns class of next element on the input (None if EOF). The reader is assumed to be at the first line following a previous element, end of file or line one. Exits with the reader pointing to the first line of the next element or EOF (leading blank lines are skipped).""" reader.skip_blank_lines() if reader.eof(): return None # Optimization: If we've already checked for an element at this # position return the element. if Lex.prev_element and Lex.prev_cursor == reader.cursor: return Lex.prev_element if AttributeEntry.isnext(): result = AttributeEntry elif AttributeList.isnext(): result = AttributeList elif BlockTitle.isnext() and not tables_OLD.isnext(): result = BlockTitle elif Title.isnext(): if AttributeList.style() == 'float': result = FloatingTitle else: result = Title elif macros.isnext(): result = macros.current elif lists.isnext(): result = lists.current elif blocks.isnext(): result = blocks.current elif tables_OLD.isnext(): result = tables_OLD.current elif tables.isnext(): result = tables.current else: if not paragraphs.isnext(): raise EAsciiDoc,'paragraph expected' result = paragraphs.current # Optimization: Cache answer. Lex.prev_cursor = reader.cursor Lex.prev_element = result return result @staticmethod def canonical_subs(options): """Translate composite subs values.""" if len(options) == 1: if options[0] == 'none': options = () elif options[0] == 'normal': options = config.subsnormal elif options[0] == 'verbatim': options = config.subsverbatim return options @staticmethod def subs_1(s,options): """Perform substitution specified in 'options' (in 'options' order).""" if not s: return s if document.attributes.get('plaintext') is not None: options = ('specialcharacters',) result = s options = Lex.canonical_subs(options) for o in options: if o == 'specialcharacters': result = config.subs_specialchars(result) elif o == 'attributes': result = subs_attrs(result) elif o == 'quotes': result = subs_quotes(result) elif o == 'specialwords': result = config.subs_specialwords(result) elif o in ('replacements','replacements2','replacements3'): result = config.subs_replacements(result,o) elif o == 'macros': result = macros.subs(result) elif o == 'callouts': result = macros.subs(result,callouts=True) else: raise EAsciiDoc,'illegal substitution option: %s' % o trace(o, s, result) if not result: break return result @staticmethod def subs(lines,options): """Perform inline processing specified by 'options' (in 'options' order) on sequence of 'lines'.""" if not lines or not options: return lines options = Lex.canonical_subs(options) # Join lines so quoting can span multiple lines. para = '\n'.join(lines) if 'macros' in options: para = macros.extract_passthroughs(para) for o in options: if o == 'attributes': # If we don't substitute attributes line-by-line then a single # undefined attribute will drop the entire paragraph. lines = subs_attrs(para.split('\n')) para = '\n'.join(lines) else: para = Lex.subs_1(para,(o,)) if 'macros' in options: para = macros.restore_passthroughs(para) return para.splitlines() @staticmethod def set_margin(lines, margin=0): """Utility routine that sets the left margin to 'margin' space in a block of non-blank lines.""" # Calculate width of block margin. lines = list(lines) width = len(lines[0]) for s in lines: i = re.search(r'\S',s).start() if i < width: width = i # Strip margin width from all lines. for i in range(len(lines)): lines[i] = ' '*margin + lines[i][width:] return lines #--------------------------------------------------------------------------- # Document element classes parse AsciiDoc reader input and write DocBook writer # output. #--------------------------------------------------------------------------- class Document(object): # doctype property. def getdoctype(self): return self.attributes.get('doctype') def setdoctype(self,doctype): self.attributes['doctype'] = doctype doctype = property(getdoctype,setdoctype) # backend property. def getbackend(self): return self.attributes.get('backend') def setbackend(self,backend): if backend: backend = self.attributes.get('backend-alias-' + backend, backend) self.attributes['backend'] = backend backend = property(getbackend,setbackend) def __init__(self): self.infile = None # Source file name. self.outfile = None # Output file name. self.attributes = InsensitiveDict() self.level = 0 # 0 => front matter. 1,2,3 => sect1,2,3. self.has_errors = False # Set true if processing errors were flagged. self.has_warnings = False # Set true if warnings were flagged. self.safe = False # Default safe mode. def update_attributes(self,attrs=None): """ Set implicit attributes and attributes in 'attrs'. """ t = time.time() self.attributes['localtime'] = time_str(t) self.attributes['localdate'] = date_str(t) self.attributes['asciidoc-version'] = VERSION self.attributes['asciidoc-file'] = APP_FILE self.attributes['asciidoc-dir'] = APP_DIR if localapp(): self.attributes['asciidoc-confdir'] = APP_DIR else: self.attributes['asciidoc-confdir'] = CONF_DIR self.attributes['user-dir'] = USER_DIR if config.verbose: self.attributes['verbose'] = '' # Update with configuration file attributes. if attrs: self.attributes.update(attrs) # Update with command-line attributes. self.attributes.update(config.cmd_attrs) # Extract miscellaneous configuration section entries from attributes. if attrs: config.load_miscellaneous(attrs) config.load_miscellaneous(config.cmd_attrs) self.attributes['newline'] = config.newline # File name related attributes can't be overridden. if self.infile is not None: if self.infile and os.path.exists(self.infile): t = os.path.getmtime(self.infile) elif self.infile == '': t = time.time() else: t = None if t: self.attributes['doctime'] = time_str(t) self.attributes['docdate'] = date_str(t) if self.infile != '': self.attributes['infile'] = self.infile self.attributes['indir'] = os.path.dirname(self.infile) self.attributes['docfile'] = self.infile self.attributes['docdir'] = os.path.dirname(self.infile) self.attributes['docname'] = os.path.splitext( os.path.basename(self.infile))[0] if self.outfile: if self.outfile != '': self.attributes['outfile'] = self.outfile self.attributes['outdir'] = os.path.dirname(self.outfile) if self.infile == '': self.attributes['docname'] = os.path.splitext( os.path.basename(self.outfile))[0] ext = os.path.splitext(self.outfile)[1][1:] elif config.outfilesuffix: ext = config.outfilesuffix[1:] else: ext = '' if ext: self.attributes['filetype'] = ext self.attributes['filetype-'+ext] = '' def load_lang(self): """ Load language configuration file. """ lang = self.attributes.get('lang') if lang is None: filename = 'lang-en.conf' # Default language file. else: filename = 'lang-' + lang + '.conf' if config.load_from_dirs(filename): self.attributes['lang'] = lang # Reinstate new lang attribute. else: if lang is None: # The default language file must exist. message.error('missing conf file: %s' % filename, halt=True) else: message.warning('missing language conf file: %s' % filename) def set_deprecated_attribute(self,old,new): """ Ensures the 'old' name of an attribute that was renamed to 'new' is still honored. """ if self.attributes.get(new) is None: if self.attributes.get(old) is not None: self.attributes[new] = self.attributes[old] else: self.attributes[old] = self.attributes[new] def consume_attributes_and_comments(self,comments_only=False,noblanks=False): """ Returns True if one or more attributes or comments were consumed. If 'noblanks' is True then consumation halts if a blank line is encountered. """ result = False finished = False while not finished: finished = True if noblanks and not reader.read_next(): return result if blocks.isnext() and 'skip' in blocks.current.options: result = True finished = False blocks.current.translate() if noblanks and not reader.read_next(): return result if macros.isnext() and macros.current.name == 'comment': result = True finished = False macros.current.translate() if not comments_only: if AttributeEntry.isnext(): result = True finished = False AttributeEntry.translate() if AttributeList.isnext(): result = True finished = False AttributeList.translate() return result def parse_header(self,doctype,backend): """ Parses header, sets corresponding document attributes and finalizes document doctype and backend properties. Returns False if the document does not have a header. 'doctype' and 'backend' are the doctype and backend option values passed on the command-line, None if no command-line option was not specified. """ assert self.level == 0 # Skip comments and attribute entries that preceed the header. self.consume_attributes_and_comments() if doctype is not None: # Command-line overrides header. self.doctype = doctype elif self.doctype is None: # Was not set on command-line or in document header. self.doctype = DEFAULT_DOCTYPE # Process document header. has_header = (Title.isnext() and Title.level == 0 and AttributeList.style() != 'float') if self.doctype == 'manpage' and not has_header: message.error('manpage document title is mandatory',halt=True) if has_header: Header.parse() # Command-line entries override header derived entries. self.attributes.update(config.cmd_attrs) # DEPRECATED: revision renamed to revnumber. self.set_deprecated_attribute('revision','revnumber') # DEPRECATED: date renamed to revdate. self.set_deprecated_attribute('date','revdate') if doctype is not None: # Command-line overrides header. self.doctype = doctype if backend is not None: # Command-line overrides header. self.backend = backend elif self.backend is None: # Was not set on command-line or in document header. self.backend = DEFAULT_BACKEND else: # Has been set in document header. self.backend = self.backend # Translate alias in header. assert self.doctype in ('article','manpage','book'), 'illegal document type' return has_header def translate(self,has_header): if self.doctype == 'manpage': # Translate mandatory NAME section. if Lex.next() is not Title: message.error('name section expected') else: Title.translate() if Title.level != 1: message.error('name section title must be at level 1') if not isinstance(Lex.next(),Paragraph): message.error('malformed name section body') lines = reader.read_until(r'^$') s = ' '.join(lines) mo = re.match(r'^(?P.*?)\s+-\s+(?P.*)$',s) if not mo: message.error('malformed name section body') self.attributes['manname'] = mo.group('manname').strip() self.attributes['manpurpose'] = mo.group('manpurpose').strip() names = [s.strip() for s in self.attributes['manname'].split(',')] if len(names) > 9: message.warning('too many manpage names') for i,name in enumerate(names): self.attributes['manname%d' % (i+1)] = name if has_header: # Do postponed substitutions (backend confs have been loaded). self.attributes['doctitle'] = Title.dosubs(self.attributes['doctitle']) if config.header_footer: hdr = config.subs_section('header',{}) writer.write(hdr,trace='header') if 'title' in self.attributes: del self.attributes['title'] self.consume_attributes_and_comments() if self.doctype in ('article','book'): # Translate 'preamble' (untitled elements between header # and first section title). if Lex.next() is not Title: stag,etag = config.section2tags('preamble') writer.write(stag,trace='preamble open') Section.translate_body() writer.write(etag,trace='preamble close') elif self.doctype == 'manpage' and 'name' in config.sections: writer.write(config.subs_section('name',{}), trace='name') else: self.process_author_names() if config.header_footer: hdr = config.subs_section('header',{}) writer.write(hdr,trace='header') if Lex.next() is not Title: Section.translate_body() # Process remaining sections. while not reader.eof(): if Lex.next() is not Title: raise EAsciiDoc,'section title expected' Section.translate() Section.setlevel(0) # Write remaining unwritten section close tags. # Substitute document parameters and write document footer. if config.header_footer: ftr = config.subs_section('footer',{}) writer.write(ftr,trace='footer') def parse_author(self,s): """ Return False if the author is malformed.""" attrs = self.attributes # Alias for readability. s = s.strip() mo = re.match(r'^(?P[^<>\s]+)' '(\s+(?P[^<>\s]+))?' '(\s+(?P[^<>\s]+))?' '(\s+<(?P\S+)>)?$',s) if not mo: # Names that don't match the formal specification. if s: attrs['firstname'] = s return firstname = mo.group('name1') if mo.group('name3'): middlename = mo.group('name2') lastname = mo.group('name3') else: middlename = None lastname = mo.group('name2') firstname = firstname.replace('_',' ') if middlename: middlename = middlename.replace('_',' ') if lastname: lastname = lastname.replace('_',' ') email = mo.group('email') if firstname: attrs['firstname'] = firstname if middlename: attrs['middlename'] = middlename if lastname: attrs['lastname'] = lastname if email: attrs['email'] = email return def process_author_names(self): """ Calculate any missing author related attributes.""" attrs = self.attributes # Alias for readability. firstname = attrs.get('firstname','') middlename = attrs.get('middlename','') lastname = attrs.get('lastname','') author = attrs.get('author') initials = attrs.get('authorinitials') if author and not (firstname or middlename or lastname): self.parse_author(author) attrs['author'] = author.replace('_',' ') self.process_author_names() return if not author: author = '%s %s %s' % (firstname, middlename, lastname) author = author.strip() author = re.sub(r'\s+',' ', author) if not initials: initials = (char_decode(firstname)[:1] + char_decode(middlename)[:1] + char_decode(lastname)[:1]) initials = char_encode(initials).upper() names = [firstname,middlename,lastname,author,initials] for i,v in enumerate(names): v = config.subs_specialchars(v) v = subs_attrs(v) names[i] = v firstname,middlename,lastname,author,initials = names if firstname: attrs['firstname'] = firstname if middlename: attrs['middlename'] = middlename if lastname: attrs['lastname'] = lastname if author: attrs['author'] = author if initials: attrs['authorinitials'] = initials if author: attrs['authored'] = '' class Header: """Static methods and attributes only.""" REV_LINE_RE = r'^(\D*(?P.*?),)?(?P.*?)(:\s*(?P.*))?$' RCS_ID_RE = r'^\$Id: \S+ (?P\S+) (?P\S+) \S+ (?P\S+) (\S+ )?\$$' def __init__(self): raise AssertionError,'no class instances allowed' @staticmethod def parse(): assert Lex.next() is Title and Title.level == 0 attrs = document.attributes # Alias for readability. # Postpone title subs until backend conf files have been loaded. Title.translate(skipsubs=True) attrs['doctitle'] = Title.attributes['title'] document.consume_attributes_and_comments(noblanks=True) s = reader.read_next() mo = None if s: # Process first header line after the title that is not a comment # or an attribute entry. s = reader.read() mo = re.match(Header.RCS_ID_RE,s) if not mo: document.parse_author(s) document.consume_attributes_and_comments(noblanks=True) if reader.read_next(): # Process second header line after the title that is not a # comment or an attribute entry. s = reader.read() s = subs_attrs(s) if s: mo = re.match(Header.RCS_ID_RE,s) if not mo: mo = re.match(Header.REV_LINE_RE,s) document.consume_attributes_and_comments(noblanks=True) s = attrs.get('revnumber') if s: mo = re.match(Header.RCS_ID_RE,s) if mo: revnumber = mo.group('revnumber') if revnumber: attrs['revnumber'] = revnumber.strip() author = mo.groupdict().get('author') if author and 'firstname' not in attrs: document.parse_author(author) revremark = mo.groupdict().get('revremark') if revremark is not None: revremark = [revremark] # Revision remarks can continue on following lines. while reader.read_next(): if document.consume_attributes_and_comments(noblanks=True): break revremark.append(reader.read()) revremark = Lex.subs(revremark,['normal']) revremark = '\n'.join(revremark).strip() attrs['revremark'] = revremark revdate = mo.group('revdate') if revdate: attrs['revdate'] = revdate.strip() elif revnumber or revremark: # Set revision date to ensure valid DocBook revision. attrs['revdate'] = attrs['docdate'] document.process_author_names() if document.doctype == 'manpage': # manpage title formatted like mantitle(manvolnum). mo = re.match(r'^(?P.*)\((?P.*)\)$', attrs['doctitle']) if not mo: message.error('malformed manpage title') else: mantitle = mo.group('mantitle').strip() mantitle = subs_attrs(mantitle) if mantitle is None: message.error('undefined attribute in manpage title') # mantitle is lowered only if in ALL CAPS if mantitle == mantitle.upper(): mantitle = mantitle.lower() attrs['mantitle'] = mantitle; attrs['manvolnum'] = mo.group('manvolnum').strip() class AttributeEntry: """Static methods and attributes only.""" pattern = None subs = None name = None name2 = None value = None attributes = {} # Accumulates all the parsed attribute entries. def __init__(self): raise AssertionError,'no class instances allowed' @staticmethod def isnext(): result = False # Assume not next. if not AttributeEntry.pattern: pat = document.attributes.get('attributeentry-pattern') if not pat: message.error("[attributes] missing 'attributeentry-pattern' entry") AttributeEntry.pattern = pat line = reader.read_next() if line: # Attribute entry formatted like :[.]:[ ] mo = re.match(AttributeEntry.pattern,line) if mo: AttributeEntry.name = mo.group('attrname') AttributeEntry.name2 = mo.group('attrname2') AttributeEntry.value = mo.group('attrvalue') or '' AttributeEntry.value = AttributeEntry.value.strip() result = True return result @staticmethod def translate(): assert Lex.next() is AttributeEntry attr = AttributeEntry # Alias for brevity. reader.read() # Discard attribute entry from reader. while attr.value.endswith(' +'): if not reader.read_next(): break attr.value = attr.value[:-1] + reader.read().strip() if attr.name2 is not None: # Configuration file attribute. if attr.name2 != '': # Section entry attribute. section = {} # Some sections can have name! syntax. if attr.name in ('attributes','miscellaneous') and attr.name2[-1] == '!': section[attr.name] = [attr.name2] else: section[attr.name] = ['%s=%s' % (attr.name2,attr.value)] config.load_sections(section) config.load_miscellaneous(config.conf_attrs) else: # Markup template section attribute. config.sections[attr.name] = [attr.value] else: # Normal attribute. if attr.name[-1] == '!': # Names like name! undefine the attribute. attr.name = attr.name[:-1] attr.value = None # Strip white space and illegal name chars. attr.name = re.sub(r'(?u)[^\w\-_]', '', attr.name).lower() # Don't override most command-line attributes. if attr.name in config.cmd_attrs \ and attr.name not in ('trace','numbered'): return # Update document attributes with attribute value. if attr.value is not None: mo = re.match(r'^pass:(?P.*)\[(?P.*)\]$', attr.value) if mo: # Inline passthrough syntax. attr.subs = mo.group('attrs') attr.value = mo.group('value') # Passthrough. else: # Default substitution. # DEPRECATED: attributeentry-subs attr.subs = document.attributes.get('attributeentry-subs', 'specialcharacters,attributes') attr.subs = parse_options(attr.subs, SUBS_OPTIONS, 'illegal substitution option') attr.value = Lex.subs((attr.value,), attr.subs) attr.value = writer.newline.join(attr.value) document.attributes[attr.name] = attr.value elif attr.name in document.attributes: del document.attributes[attr.name] attr.attributes[attr.name] = attr.value class AttributeList: """Static methods and attributes only.""" pattern = None match = None attrs = {} def __init__(self): raise AssertionError,'no class instances allowed' @staticmethod def initialize(): if not 'attributelist-pattern' in document.attributes: message.error("[attributes] missing 'attributelist-pattern' entry") AttributeList.pattern = document.attributes['attributelist-pattern'] @staticmethod def isnext(): result = False # Assume not next. line = reader.read_next() if line: mo = re.match(AttributeList.pattern, line) if mo: AttributeList.match = mo result = True return result @staticmethod def translate(): assert Lex.next() is AttributeList reader.read() # Discard attribute list from reader. attrs = {} d = AttributeList.match.groupdict() for k,v in d.items(): if v is not None: if k == 'attrlist': v = subs_attrs(v) if v: parse_attributes(v, attrs) else: AttributeList.attrs[k] = v AttributeList.subs(attrs) AttributeList.attrs.update(attrs) @staticmethod def subs(attrs): '''Substitute single quoted attribute values normally.''' reo = re.compile(r"^'.*'$") for k,v in attrs.items(): if reo.match(str(v)): attrs[k] = Lex.subs_1(v[1:-1], config.subsnormal) @staticmethod def style(): return AttributeList.attrs.get('style') or AttributeList.attrs.get('1') @staticmethod def consume(d={}): """Add attribute list to the dictionary 'd' and reset the list.""" if AttributeList.attrs: d.update(AttributeList.attrs) AttributeList.attrs = {} # Generate option attributes. if 'options' in d: options = parse_options(d['options'], (), 'illegal option name') for option in options: d[option+'-option'] = '' class BlockTitle: """Static methods and attributes only.""" title = None pattern = None def __init__(self): raise AssertionError,'no class instances allowed' @staticmethod def isnext(): result = False # Assume not next. line = reader.read_next() if line: mo = re.match(BlockTitle.pattern,line) if mo: BlockTitle.title = mo.group('title') result = True return result @staticmethod def translate(): assert Lex.next() is BlockTitle reader.read() # Discard title from reader. # Perform title substitutions. if not Title.subs: Title.subs = config.subsnormal s = Lex.subs((BlockTitle.title,), Title.subs) s = writer.newline.join(s) if not s: message.warning('blank block title') BlockTitle.title = s @staticmethod def consume(d={}): """If there is a title add it to dictionary 'd' then reset title.""" if BlockTitle.title: d['title'] = BlockTitle.title BlockTitle.title = None class Title: """Processes Header and Section titles. Static methods and attributes only.""" # Class variables underlines = ('==','--','~~','^^','++') # Levels 0,1,2,3,4. subs = () pattern = None level = 0 attributes = {} sectname = None section_numbers = [0]*len(underlines) dump_dict = {} linecount = None # Number of lines in title (1 or 2). def __init__(self): raise AssertionError,'no class instances allowed' @staticmethod def translate(skipsubs=False): """Parse the Title.attributes and Title.level from the reader. The real work has already been done by parse().""" assert Lex.next() in (Title,FloatingTitle) # Discard title from reader. for i in range(Title.linecount): reader.read() Title.setsectname() if not skipsubs: Title.attributes['title'] = Title.dosubs(Title.attributes['title']) @staticmethod def dosubs(title): """ Perform title substitutions. """ if not Title.subs: Title.subs = config.subsnormal title = Lex.subs((title,), Title.subs) title = writer.newline.join(title) if not title: message.warning('blank section title') return title @staticmethod def isnext(): lines = reader.read_ahead(2) return Title.parse(lines) @staticmethod def parse(lines): """Parse title at start of lines tuple.""" if len(lines) == 0: return False if len(lines[0]) == 0: return False # Title can't be blank. # Check for single-line titles. result = False for level in range(len(Title.underlines)): k = 'sect%s' % level if k in Title.dump_dict: mo = re.match(Title.dump_dict[k], lines[0]) if mo: Title.attributes = mo.groupdict() Title.level = level Title.linecount = 1 result = True break if not result: # Check for double-line titles. if not Title.pattern: return False # Single-line titles only. if len(lines) < 2: return False title,ul = lines[:2] title_len = column_width(title) ul_len = char_len(ul) if ul_len < 2: return False # Fast elimination check. if ul[:2] not in Title.underlines: return False # Length of underline must be within +-3 of title. if not ((ul_len-3 < title_len < ul_len+3) # Next test for backward compatibility. or (ul_len-3 < char_len(title) < ul_len+3)): return False # Check for valid repetition of underline character pairs. s = ul[:2]*((ul_len+1)/2) if ul != s[:ul_len]: return False # Don't be fooled by back-to-back delimited blocks, require at # least one alphanumeric character in title. if not re.search(r'(?u)\w',title): return False mo = re.match(Title.pattern, title) if mo: Title.attributes = mo.groupdict() Title.level = list(Title.underlines).index(ul[:2]) Title.linecount = 2 result = True # Check for expected pattern match groups. if result: if not 'title' in Title.attributes: message.warning('[titles] entry has no group') Title.attributes['title'] = lines[0] for k,v in Title.attributes.items(): if v is None: del Title.attributes[k] try: Title.level += int(document.attributes.get('leveloffset','0')) except: pass Title.attributes['level'] = str(Title.level) return result @staticmethod def load(entries): """Load and validate [titles] section entries dictionary.""" if 'underlines' in entries: errmsg = 'malformed [titles] underlines entry' try: underlines = parse_list(entries['underlines']) except Exception: raise EAsciiDoc,errmsg if len(underlines) != len(Title.underlines): raise EAsciiDoc,errmsg for s in underlines: if len(s) !=2: raise EAsciiDoc,errmsg Title.underlines = tuple(underlines) Title.dump_dict['underlines'] = entries['underlines'] if 'subs' in entries: Title.subs = parse_options(entries['subs'], SUBS_OPTIONS, 'illegal [titles] subs entry') Title.dump_dict['subs'] = entries['subs'] if 'sectiontitle' in entries: pat = entries['sectiontitle'] if not pat or not is_re(pat): raise EAsciiDoc,'malformed [titles] sectiontitle entry' Title.pattern = pat Title.dump_dict['sectiontitle'] = pat if 'blocktitle' in entries: pat = entries['blocktitle'] if not pat or not is_re(pat): raise EAsciiDoc,'malformed [titles] blocktitle entry' BlockTitle.pattern = pat Title.dump_dict['blocktitle'] = pat # Load single-line title patterns. for k in ('sect0','sect1','sect2','sect3','sect4'): if k in entries: pat = entries[k] if not pat or not is_re(pat): raise EAsciiDoc,'malformed [titles] %s entry' % k Title.dump_dict[k] = pat # TODO: Check we have either a Title.pattern or at least one # single-line title pattern -- can this be done here or do we need # check routine like the other block checkers? @staticmethod def dump(): dump_section('titles',Title.dump_dict) @staticmethod def setsectname(): """ Set Title section name: If the first positional or 'template' attribute is set use it, next search for section title in [specialsections], if not found use default 'sect<level>' name. """ sectname = AttributeList.attrs.get('1') if sectname and sectname != 'float': Title.sectname = sectname elif 'template' in AttributeList.attrs: Title.sectname = AttributeList.attrs['template'] else: for pat,sect in config.specialsections.items(): mo = re.match(pat,Title.attributes['title']) if mo: title = mo.groupdict().get('title') if title is not None: Title.attributes['title'] = title.strip() else: Title.attributes['title'] = mo.group().strip() Title.sectname = sect break else: Title.sectname = 'sect%d' % Title.level @staticmethod def getnumber(level): """Return next section number at section 'level' formatted like 1.2.3.4.""" number = '' for l in range(len(Title.section_numbers)): n = Title.section_numbers[l] if l == 0: continue elif l < level: number = '%s%d.' % (number, n) elif l == level: number = '%s%d.' % (number, n + 1) Title.section_numbers[l] = n + 1 elif l > level: # Reset unprocessed section levels. Title.section_numbers[l] = 0 return number class FloatingTitle(Title): '''Floated titles are translated differently.''' @staticmethod def isnext(): return Title.isnext() and AttributeList.style() == 'float' @staticmethod def translate(): assert Lex.next() is FloatingTitle Title.translate() Section.set_id() AttributeList.consume(Title.attributes) template = 'floatingtitle' if template in config.sections: stag,etag = config.section2tags(template,Title.attributes) writer.write(stag,trace='floating title') else: message.warning('missing template section: [%s]' % template) class Section: """Static methods and attributes only.""" endtags = [] # Stack of currently open section (level,endtag) tuples. ids = [] # List of already used ids. def __init__(self): raise AssertionError,'no class instances allowed' @staticmethod def savetag(level,etag): """Save section end.""" Section.endtags.append((level,etag)) @staticmethod def setlevel(level): """Set document level and write open section close tags up to level.""" while Section.endtags and Section.endtags[-1][0] >= level: writer.write(Section.endtags.pop()[1],trace='section close') document.level = level @staticmethod def gen_id(title): """ The normalized value of the id attribute is an NCName according to the 'Namespaces in XML' Recommendation: NCName ::= NCNameStartChar NCNameChar* NCNameChar ::= NameChar - ':' NCNameStartChar ::= Letter | '_' NameChar ::= Letter | Digit | '.' | '-' | '_' | ':' """ # Replace non-alpha numeric characters in title with underscores and # convert to lower case. base_id = re.sub(r'(?u)\W+', '_', char_decode(title)).strip('_').lower() if 'ascii-ids' in document.attributes: # Replace non-ASCII characters with ASCII equivalents. import unicodedata base_id = unicodedata.normalize('NFKD', base_id).encode('ascii','ignore') base_id = char_encode(base_id) # Prefix the ID name with idprefix attribute or underscore if not # defined. Prefix ensures the ID does not clash with existing IDs. idprefix = document.attributes.get('idprefix','_') base_id = idprefix + base_id i = 1 while True: if i == 1: id = base_id else: id = '%s_%d' % (base_id, i) if id not in Section.ids: Section.ids.append(id) return id else: id = base_id i += 1 @staticmethod def set_id(): if not document.attributes.get('sectids') is None \ and 'id' not in AttributeList.attrs: # Generate ids for sections. AttributeList.attrs['id'] = Section.gen_id(Title.attributes['title']) @staticmethod def translate(): assert Lex.next() is Title prev_sectname = Title.sectname Title.translate() if Title.level == 0 and document.doctype != 'book': message.error('only book doctypes can contain level 0 sections') if Title.level > document.level \ and 'basebackend-docbook' in document.attributes \ and prev_sectname in ('colophon','abstract', \ 'dedication','glossary','bibliography'): message.error('%s section cannot contain sub-sections' % prev_sectname) if Title.level > document.level+1: # Sub-sections of multi-part book level zero Preface and Appendices # are meant to be out of sequence. if document.doctype == 'book' \ and document.level == 0 \ and Title.level == 2 \ and prev_sectname in ('preface','appendix'): pass else: message.warning('section title out of sequence: ' 'expected level %d, got level %d' % (document.level+1, Title.level)) Section.set_id() Section.setlevel(Title.level) if 'numbered' in document.attributes: Title.attributes['sectnum'] = Title.getnumber(document.level) else: Title.attributes['sectnum'] = '' AttributeList.consume(Title.attributes) stag,etag = config.section2tags(Title.sectname,Title.attributes) Section.savetag(Title.level,etag) writer.write(stag,trace='section open: level %d: %s' % (Title.level, Title.attributes['title'])) Section.translate_body() @staticmethod def translate_body(terminator=Title): isempty = True next = Lex.next() while next and next is not terminator: if isinstance(terminator,DelimitedBlock) and next is Title: message.error('section title not permitted in delimited block') next.translate() next = Lex.next() isempty = False # The section is not empty if contains a subsection. if next and isempty and Title.level > document.level: isempty = False # Report empty sections if invalid markup will result. if isempty: if document.backend == 'docbook' and Title.sectname != 'index': message.error('empty section is not valid') class AbstractBlock: blocknames = [] # Global stack of names for push_blockname() and pop_blockname(). def __init__(self): # Configuration parameter names common to all blocks. self.CONF_ENTRIES = ('delimiter','options','subs','presubs','postsubs', 'posattrs','style','.*-style','template','filter') self.start = None # File reader cursor at start delimiter. self.defname=None # Configuration file block definition section name. # Configuration parameters. self.delimiter=None # Regular expression matching block delimiter. self.delimiter_reo=None # Compiled delimiter. self.template=None # template section entry. self.options=() # options entry list. self.presubs=None # presubs/subs entry list. self.postsubs=() # postsubs entry list. self.filter=None # filter entry. self.posattrs=() # posattrs entry list. self.style=None # Default style. self.styles=OrderedDict() # Each entry is a styles dictionary. # Before a block is processed it's attributes (from it's # attributes list) are merged with the block configuration parameters # (by self.merge_attributes()) resulting in the template substitution # dictionary (self.attributes) and the block's processing parameters # (self.parameters). self.attributes={} # The names of block parameters. self.PARAM_NAMES=('template','options','presubs','postsubs','filter') self.parameters=None # Leading delimiter match object. self.mo=None def short_name(self): """ Return the text following the first dash in the section name.""" i = self.defname.find('-') if i == -1: return self.defname else: return self.defname[i+1:] def error(self, msg, cursor=None, halt=False): message.error('[%s] %s' % (self.defname,msg), cursor, halt) def is_conf_entry(self,param): """Return True if param matches an allowed configuration file entry name.""" for s in self.CONF_ENTRIES: if re.match('^'+s+'$',param): return True return False def load(self,defname,entries): """Update block definition from section 'entries' dictionary.""" self.defname = defname self.update_parameters(entries, self, all=True) def update_parameters(self, src, dst=None, all=False): """ Parse processing parameters from src dictionary to dst object. dst defaults to self.parameters. If all is True then copy src entries that aren't parameter names. """ dst = dst or self.parameters msg = '[%s] malformed entry %%s: %%s' % self.defname def copy(obj,k,v): if isinstance(obj,dict): obj[k] = v else: setattr(obj,k,v) for k,v in src.items(): if not re.match(r'\d+',k) and not is_name(k): raise EAsciiDoc, msg % (k,v) if k == 'template': if not is_name(v): raise EAsciiDoc, msg % (k,v) copy(dst,k,v) elif k == 'filter': copy(dst,k,v) elif k == 'options': if isinstance(v,str): v = parse_options(v, (), msg % (k,v)) # Merge with existing options. v = tuple(set(dst.options).union(set(v))) copy(dst,k,v) elif k in ('subs','presubs','postsubs'): # Subs is an alias for presubs. if k == 'subs': k = 'presubs' if isinstance(v,str): v = parse_options(v, SUBS_OPTIONS, msg % (k,v)) copy(dst,k,v) elif k == 'delimiter': if v and is_re(v): copy(dst,k,v) else: raise EAsciiDoc, msg % (k,v) elif k == 'style': if is_name(v): copy(dst,k,v) else: raise EAsciiDoc, msg % (k,v) elif k == 'posattrs': v = parse_options(v, (), msg % (k,v)) copy(dst,k,v) else: mo = re.match(r'^(?P<style>.*)-style$',k) if mo: if not v: raise EAsciiDoc, msg % (k,v) style = mo.group('style') if not is_name(style): raise EAsciiDoc, msg % (k,v) d = {} if not parse_named_attributes(v,d): raise EAsciiDoc, msg % (k,v) if 'subs' in d: # Subs is an alias for presubs. d['presubs'] = d['subs'] del d['subs'] self.styles[style] = d elif all or k in self.PARAM_NAMES: copy(dst,k,v) # Derived class specific entries. def get_param(self,name,params=None): """ Return named processing parameter from params dictionary. If the parameter is not in params look in self.parameters. """ if params and name in params: return params[name] elif name in self.parameters: return self.parameters[name] else: return None def get_subs(self,params=None): """ Return (presubs,postsubs) tuple. """ presubs = self.get_param('presubs',params) postsubs = self.get_param('postsubs',params) return (presubs,postsubs) def dump(self): """Write block definition to stdout.""" write = lambda s: sys.stdout.write('%s%s' % (s,writer.newline)) write('['+self.defname+']') if self.is_conf_entry('delimiter'): write('delimiter='+self.delimiter) if self.template: write('template='+self.template) if self.options: write('options='+','.join(self.options)) if self.presubs: if self.postsubs: write('presubs='+','.join(self.presubs)) else: write('subs='+','.join(self.presubs)) if self.postsubs: write('postsubs='+','.join(self.postsubs)) if self.filter: write('filter='+self.filter) if self.posattrs: write('posattrs='+','.join(self.posattrs)) if self.style: write('style='+self.style) if self.styles: for style,d in self.styles.items(): s = '' for k,v in d.items(): s += '%s=%r,' % (k,v) write('%s-style=%s' % (style,s[:-1])) def validate(self): """Validate block after the complete configuration has been loaded.""" if self.is_conf_entry('delimiter') and not self.delimiter: raise EAsciiDoc,'[%s] missing delimiter' % self.defname if self.style: if not is_name(self.style): raise EAsciiDoc, 'illegal style name: %s' % self.style if not self.style in self.styles: if not isinstance(self,List): # Lists don't have templates. message.warning('[%s] \'%s\' style not in %s' % ( self.defname,self.style,self.styles.keys())) # Check all styles for missing templates. all_styles_have_template = True for k,v in self.styles.items(): t = v.get('template') if t and not t in config.sections: # Defer check if template name contains attributes. if not re.search(r'{.+}',t): message.warning('missing template section: [%s]' % t) if not t: all_styles_have_template = False # Check we have a valid template entry or alternatively that all the # styles have templates. if self.is_conf_entry('template') and not 'skip' in self.options: if self.template: if not self.template in config.sections: # Defer check if template name contains attributes. if not re.search(r'{.+}',self.template): message.warning('missing template section: [%s]' % self.template) elif not all_styles_have_template: if not isinstance(self,List): # Lists don't have templates. message.warning('missing styles templates: [%s]' % self.defname) def isnext(self): """Check if this block is next in document reader.""" result = False reader.skip_blank_lines() if reader.read_next(): if not self.delimiter_reo: # Cache compiled delimiter optimization. self.delimiter_reo = re.compile(self.delimiter) mo = self.delimiter_reo.match(reader.read_next()) if mo: self.mo = mo result = True return result def translate(self): """Translate block from document reader.""" if not self.presubs: self.presubs = config.subsnormal if reader.cursor: self.start = reader.cursor[:] def push_blockname(self, blockname=None): ''' On block entry set the 'blockname' attribute. Only applies to delimited blocks, lists and tables. ''' if blockname is None: blockname = self.attributes.get('style', self.short_name()).lower() trace('push blockname', blockname) self.blocknames.append(blockname) document.attributes['blockname'] = blockname def pop_blockname(self): ''' On block exits restore previous (parent) 'blockname' attribute or undefine it if we're no longer inside a block. ''' assert len(self.blocknames) > 0 blockname = self.blocknames.pop() trace('pop blockname', blockname) if len(self.blocknames) == 0: document.attributes['blockname'] = None else: document.attributes['blockname'] = self.blocknames[-1] def merge_attributes(self,attrs,params=[]): """ Use the current block's attribute list (attrs dictionary) to build a dictionary of block processing parameters (self.parameters) and tag substitution attributes (self.attributes). 1. Copy the default parameters (self.*) to self.parameters. self.parameters are used internally to render the current block. Optional params array of additional parameters. 2. Copy attrs to self.attributes. self.attributes are used for template and tag substitution in the current block. 3. If a style attribute was specified update self.parameters with the corresponding style parameters; if there are any style parameters remaining add them to self.attributes (existing attribute list entries take precedence). 4. Set named positional attributes in self.attributes if self.posattrs was specified. 5. Finally self.parameters is updated with any corresponding parameters specified in attrs. """ def check_array_parameter(param): # Check the parameter is a sequence type. if not is_array(self.parameters[param]): message.error('malformed %s parameter: %s' % (param, self.parameters[param])) # Revert to default value. self.parameters[param] = getattr(self,param) params = list(self.PARAM_NAMES) + params self.attributes = {} if self.style: # If a default style is defined make it available in the template. self.attributes['style'] = self.style self.attributes.update(attrs) # Calculate dynamic block parameters. # Start with configuration file defaults. self.parameters = AttrDict() for name in params: self.parameters[name] = getattr(self,name) # Load the selected style attributes. posattrs = self.posattrs if posattrs and posattrs[0] == 'style': # Positional attribute style has highest precedence. style = self.attributes.get('1') else: style = None if not style: # Use explicit style attribute, fall back to default style. style = self.attributes.get('style',self.style) if style: if not is_name(style): message.error('illegal style name: %s' % style) style = self.style # Lists have implicit styles and do their own style checks. elif style not in self.styles and not isinstance(self,List): message.warning('missing style: [%s]: %s' % (self.defname,style)) style = self.style if style in self.styles: self.attributes['style'] = style for k,v in self.styles[style].items(): if k == 'posattrs': posattrs = v elif k in params: self.parameters[k] = v elif not k in self.attributes: # Style attributes don't take precedence over explicit. self.attributes[k] = v # Set named positional attributes. for i,v in enumerate(posattrs): if str(i+1) in self.attributes: self.attributes[v] = self.attributes[str(i+1)] # Override config and style attributes with attribute list attributes. self.update_parameters(attrs) check_array_parameter('options') check_array_parameter('presubs') check_array_parameter('postsubs') class AbstractBlocks: """List of block definitions.""" PREFIX = '' # Conf file section name prefix set in derived classes. BLOCK_TYPE = None # Block type set in derived classes. def __init__(self): self.current=None self.blocks = [] # List of Block objects. self.default = None # Default Block. self.delimiters = None # Combined delimiters regular expression. def load(self,sections): """Load block definition from 'sections' dictionary.""" for k in sections.keys(): if re.match(r'^'+ self.PREFIX + r'.+$',k): d = {} parse_entries(sections.get(k,()),d) for b in self.blocks: if b.defname == k: break else: b = self.BLOCK_TYPE() self.blocks.append(b) try: b.load(k,d) except EAsciiDoc,e: raise EAsciiDoc,'[%s] %s' % (k,str(e)) def dump(self): for b in self.blocks: b.dump() def isnext(self): for b in self.blocks: if b.isnext(): self.current = b return True; return False def validate(self): """Validate the block definitions.""" # Validate delimiters and build combined lists delimiter pattern. delimiters = [] for b in self.blocks: assert b.__class__ is self.BLOCK_TYPE b.validate() if b.delimiter: delimiters.append(b.delimiter) self.delimiters = re_join(delimiters) class Paragraph(AbstractBlock): def __init__(self): AbstractBlock.__init__(self) self.text=None # Text in first line of paragraph. def load(self,name,entries): AbstractBlock.load(self,name,entries) def dump(self): AbstractBlock.dump(self) write = lambda s: sys.stdout.write('%s%s' % (s,writer.newline)) write('') def isnext(self): result = AbstractBlock.isnext(self) if result: self.text = self.mo.groupdict().get('text') return result def translate(self): AbstractBlock.translate(self) attrs = self.mo.groupdict().copy() if 'text' in attrs: del attrs['text'] BlockTitle.consume(attrs) AttributeList.consume(attrs) self.merge_attributes(attrs) reader.read() # Discard (already parsed item first line). body = reader.read_until(paragraphs.terminators) if 'skip' in self.parameters.options: return body = [self.text] + list(body) presubs = self.parameters.presubs postsubs = self.parameters.postsubs if document.attributes.get('plaintext') is None: body = Lex.set_margin(body) # Move body to left margin. body = Lex.subs(body,presubs) template = self.parameters.template template = subs_attrs(template,attrs) stag = config.section2tags(template, self.attributes,skipend=True)[0] if self.parameters.filter: body = filter_lines(self.parameters.filter,body,self.attributes) body = Lex.subs(body,postsubs) etag = config.section2tags(template, self.attributes,skipstart=True)[1] # Write start tag, content, end tag. writer.write(dovetail_tags(stag,body,etag),trace='paragraph') class Paragraphs(AbstractBlocks): """List of paragraph definitions.""" BLOCK_TYPE = Paragraph PREFIX = 'paradef-' def __init__(self): AbstractBlocks.__init__(self) self.terminators=None # List of compiled re's. def initialize(self): self.terminators = [ re.compile(r'^\+$|^$'), re.compile(AttributeList.pattern), re.compile(blocks.delimiters), re.compile(tables.delimiters), re.compile(tables_OLD.delimiters), ] def load(self,sections): AbstractBlocks.load(self,sections) def validate(self): AbstractBlocks.validate(self) # Check we have a default paragraph definition, put it last in list. for b in self.blocks: if b.defname == 'paradef-default': self.blocks.append(b) self.default = b self.blocks.remove(b) break else: raise EAsciiDoc,'missing section: [paradef-default]' class List(AbstractBlock): NUMBER_STYLES= ('arabic','loweralpha','upperalpha','lowerroman', 'upperroman') def __init__(self): AbstractBlock.__init__(self) self.CONF_ENTRIES += ('type','tags') self.PARAM_NAMES += ('tags',) # listdef conf file parameters. self.type=None self.tags=None # Name of listtags-<tags> conf section. # Calculated parameters. self.tag=None # Current tags AttrDict. self.label=None # List item label (labeled lists). self.text=None # Text in first line of list item. self.index=None # Matched delimiter 'index' group (numbered lists). self.type=None # List type ('numbered','bulleted','labeled'). self.ordinal=None # Current list item ordinal number (1..) self.number_style=None # Current numbered list style ('arabic'..) def load(self,name,entries): AbstractBlock.load(self,name,entries) def dump(self): AbstractBlock.dump(self) write = lambda s: sys.stdout.write('%s%s' % (s,writer.newline)) write('type='+self.type) write('tags='+self.tags) write('') def validate(self): AbstractBlock.validate(self) tags = [self.tags] tags += [s['tags'] for s in self.styles.values() if 'tags' in s] for t in tags: if t not in lists.tags: self.error('missing section: [listtags-%s]' % t,halt=True) def isnext(self): result = AbstractBlock.isnext(self) if result: self.label = self.mo.groupdict().get('label') self.text = self.mo.groupdict().get('text') self.index = self.mo.groupdict().get('index') return result def translate_entry(self): assert self.type == 'labeled' entrytag = subs_tag(self.tag.entry, self.attributes) labeltag = subs_tag(self.tag.label, self.attributes) writer.write(entrytag[0],trace='list entry open') writer.write(labeltag[0],trace='list label open') # Write labels. while Lex.next() is self: reader.read() # Discard (already parsed item first line). writer.write_tag(self.tag.term, [self.label], self.presubs, self.attributes,trace='list term') if self.text: break writer.write(labeltag[1],trace='list label close') # Write item text. self.translate_item() writer.write(entrytag[1],trace='list entry close') def translate_item(self): if self.type == 'callout': self.attributes['coids'] = calloutmap.calloutids(self.ordinal) itemtag = subs_tag(self.tag.item, self.attributes) writer.write(itemtag[0],trace='list item open') # Write ItemText. text = reader.read_until(lists.terminators) if self.text: text = [self.text] + list(text) if text: writer.write_tag(self.tag.text, text, self.presubs, self.attributes,trace='list text') # Process explicit and implicit list item continuations. while True: continuation = reader.read_next() == '+' if continuation: reader.read() # Discard continuation line. while Lex.next() in (BlockTitle,AttributeList): # Consume continued element title and attributes. Lex.next().translate() if not continuation and BlockTitle.title: # Titled elements terminate the list. break next = Lex.next() if next in lists.open: break elif isinstance(next,List): next.translate() elif isinstance(next,Paragraph) and 'listelement' in next.options: next.translate() elif continuation: # This is where continued elements are processed. if next is Title: message.error('section title not allowed in list item',halt=True) next.translate() else: break writer.write(itemtag[1],trace='list item close') @staticmethod def calc_style(index): """Return the numbered list style ('arabic'...) of the list item index. Return None if unrecognized style.""" if re.match(r'^\d+[\.>]$', index): style = 'arabic' elif re.match(r'^[ivx]+\)$', index): style = 'lowerroman' elif re.match(r'^[IVX]+\)$', index): style = 'upperroman' elif re.match(r'^[a-z]\.$', index): style = 'loweralpha' elif re.match(r'^[A-Z]\.$', index): style = 'upperalpha' else: assert False return style @staticmethod def calc_index(index,style): """Return the ordinal number of (1...) of the list item index for the given list style.""" def roman_to_int(roman): roman = roman.lower() digits = {'i':1,'v':5,'x':10} result = 0 for i in range(len(roman)): digit = digits[roman[i]] # If next digit is larger this digit is negative. if i+1 < len(roman) and digits[roman[i+1]] > digit: result -= digit else: result += digit return result index = index[:-1] if style == 'arabic': ordinal = int(index) elif style == 'lowerroman': ordinal = roman_to_int(index) elif style == 'upperroman': ordinal = roman_to_int(index) elif style == 'loweralpha': ordinal = ord(index) - ord('a') + 1 elif style == 'upperalpha': ordinal = ord(index) - ord('A') + 1 else: assert False return ordinal def check_index(self): """Check calculated self.ordinal (1,2,...) against the item number in the document (self.index) and check the number style is the same as the first item (self.number_style).""" assert self.type in ('numbered','callout') if self.index: style = self.calc_style(self.index) if style != self.number_style: message.warning('list item style: expected %s got %s' % (self.number_style,style), offset=1) ordinal = self.calc_index(self.index,style) if ordinal != self.ordinal: message.warning('list item index: expected %s got %s' % (self.ordinal,ordinal), offset=1) def check_tags(self): """ Check that all necessary tags are present. """ tags = set(Lists.TAGS) if self.type != 'labeled': tags = tags.difference(['entry','label','term']) missing = tags.difference(self.tag.keys()) if missing: self.error('missing tag(s): %s' % ','.join(missing), halt=True) def translate(self): AbstractBlock.translate(self) if self.short_name() in ('bibliography','glossary','qanda'): message.deprecated('old %s list syntax' % self.short_name()) lists.open.append(self) attrs = self.mo.groupdict().copy() for k in ('label','text','index'): if k in attrs: del attrs[k] if self.index: # Set the numbering style from first list item. attrs['style'] = self.calc_style(self.index) BlockTitle.consume(attrs) AttributeList.consume(attrs) self.merge_attributes(attrs,['tags']) self.push_blockname() if self.type in ('numbered','callout'): self.number_style = self.attributes.get('style') if self.number_style not in self.NUMBER_STYLES: message.error('illegal numbered list style: %s' % self.number_style) # Fall back to default style. self.attributes['style'] = self.number_style = self.style self.tag = lists.tags[self.parameters.tags] self.check_tags() if 'width' in self.attributes: # Set horizontal list 'labelwidth' and 'itemwidth' attributes. v = str(self.attributes['width']) mo = re.match(r'^(\d{1,2})%?$',v) if mo: labelwidth = int(mo.group(1)) self.attributes['labelwidth'] = str(labelwidth) self.attributes['itemwidth'] = str(100-labelwidth) else: self.error('illegal attribute value: width="%s"' % v) stag,etag = subs_tag(self.tag.list, self.attributes) if stag: writer.write(stag,trace='list open') self.ordinal = 0 # Process list till list syntax changes or there is a new title. while Lex.next() is self and not BlockTitle.title: self.ordinal += 1 document.attributes['listindex'] = str(self.ordinal) if self.type in ('numbered','callout'): self.check_index() if self.type in ('bulleted','numbered','callout'): reader.read() # Discard (already parsed item first line). self.translate_item() elif self.type == 'labeled': self.translate_entry() else: raise AssertionError,'illegal [%s] list type' % self.defname if etag: writer.write(etag,trace='list close') if self.type == 'callout': calloutmap.validate(self.ordinal) calloutmap.listclose() lists.open.pop() if len(lists.open): document.attributes['listindex'] = str(lists.open[-1].ordinal) self.pop_blockname() class Lists(AbstractBlocks): """List of List objects.""" BLOCK_TYPE = List PREFIX = 'listdef-' TYPES = ('bulleted','numbered','labeled','callout') TAGS = ('list', 'entry','item','text', 'label','term') def __init__(self): AbstractBlocks.__init__(self) self.open = [] # A stack of the current and parent lists. self.tags={} # List tags dictionary. Each entry is a tags AttrDict. self.terminators=None # List of compiled re's. def initialize(self): self.terminators = [ re.compile(r'^\+$|^$'), re.compile(AttributeList.pattern), re.compile(lists.delimiters), re.compile(blocks.delimiters), re.compile(tables.delimiters), re.compile(tables_OLD.delimiters), ] def load(self,sections): AbstractBlocks.load(self,sections) self.load_tags(sections) def load_tags(self,sections): """ Load listtags-* conf file sections to self.tags. """ for section in sections.keys(): mo = re.match(r'^listtags-(?P<name>\w+)$',section) if mo: name = mo.group('name') if name in self.tags: d = self.tags[name] else: d = AttrDict() parse_entries(sections.get(section,()),d) for k in d.keys(): if k not in self.TAGS: message.warning('[%s] contains illegal list tag: %s' % (section,k)) self.tags[name] = d def validate(self): AbstractBlocks.validate(self) for b in self.blocks: # Check list has valid type. if not b.type in Lists.TYPES: raise EAsciiDoc,'[%s] illegal type' % b.defname b.validate() def dump(self): AbstractBlocks.dump(self) for k,v in self.tags.items(): dump_section('listtags-'+k, v) class DelimitedBlock(AbstractBlock): def __init__(self): AbstractBlock.__init__(self) def load(self,name,entries): AbstractBlock.load(self,name,entries) def dump(self): AbstractBlock.dump(self) write = lambda s: sys.stdout.write('%s%s' % (s,writer.newline)) write('') def isnext(self): return AbstractBlock.isnext(self) def translate(self): AbstractBlock.translate(self) reader.read() # Discard delimiter. self.merge_attributes(AttributeList.attrs) if not 'skip' in self.parameters.options: BlockTitle.consume(self.attributes) AttributeList.consume() self.push_blockname() options = self.parameters.options if 'skip' in options: reader.read_until(self.delimiter,same_file=True) elif safe() and self.defname == 'blockdef-backend': message.unsafe('Backend Block') reader.read_until(self.delimiter,same_file=True) else: template = self.parameters.template template = subs_attrs(template,self.attributes) name = self.short_name()+' block' if 'sectionbody' in options: # The body is treated like a section body. stag,etag = config.section2tags(template,self.attributes) writer.write(stag,trace=name+' open') Section.translate_body(self) writer.write(etag,trace=name+' close') else: stag = config.section2tags(template,self.attributes,skipend=True)[0] body = reader.read_until(self.delimiter,same_file=True) presubs = self.parameters.presubs postsubs = self.parameters.postsubs body = Lex.subs(body,presubs) if self.parameters.filter: body = filter_lines(self.parameters.filter,body,self.attributes) body = Lex.subs(body,postsubs) # Write start tag, content, end tag. etag = config.section2tags(template,self.attributes,skipstart=True)[1] writer.write(dovetail_tags(stag,body,etag),trace=name) trace(self.short_name()+' block close',etag) if reader.eof(): self.error('missing closing delimiter',self.start) else: delimiter = reader.read() # Discard delimiter line. assert re.match(self.delimiter,delimiter) self.pop_blockname() class DelimitedBlocks(AbstractBlocks): """List of delimited blocks.""" BLOCK_TYPE = DelimitedBlock PREFIX = 'blockdef-' def __init__(self): AbstractBlocks.__init__(self) def load(self,sections): """Update blocks defined in 'sections' dictionary.""" AbstractBlocks.load(self,sections) def validate(self): AbstractBlocks.validate(self) class Column: """Table column.""" def __init__(self, width=None, align_spec=None, style=None): self.width = width or '1' self.halign, self.valign = Table.parse_align_spec(align_spec) self.style = style # Style name or None. # Calculated attribute values. self.abswidth = None # 1.. (page units). self.pcwidth = None # 1..99 (percentage). class Cell: def __init__(self, data, span_spec=None, align_spec=None, style=None): self.data = data self.span, self.vspan = Table.parse_span_spec(span_spec) self.halign, self.valign = Table.parse_align_spec(align_spec) self.style = style self.reserved = False def __repr__(self): return '<Cell: %d.%d %s.%s %s "%s">' % ( self.span, self.vspan, self.halign, self.valign, self.style or '', self.data) def clone_reserve(self): """Return a clone of self to reserve vertically spanned cell.""" result = copy.copy(self) result.vspan = 1 result.reserved = True return result class Table(AbstractBlock): ALIGN = {'<':'left', '>':'right', '^':'center'} VALIGN = {'<':'top', '>':'bottom', '^':'middle'} FORMATS = ('psv','csv','dsv') SEPARATORS = dict( csv=',', dsv=r':|\n', # The count and align group matches are not exact. psv=r'((?<!\S)((?P<span>[\d.]+)(?P<op>[*+]))?(?P<align>[<\^>.]{,3})?(?P<style>[a-z])?)?\|' ) def __init__(self): AbstractBlock.__init__(self) self.CONF_ENTRIES += ('format','tags','separator') # tabledef conf file parameters. self.format='psv' self.separator=None self.tags=None # Name of tabletags-<tags> conf section. # Calculated parameters. self.abswidth=None # 1.. (page units). self.pcwidth = None # 1..99 (percentage). self.rows=[] # Parsed rows, each row is a list of Cells. self.columns=[] # List of Columns. @staticmethod def parse_align_spec(align_spec): """ Parse AsciiDoc cell alignment specifier and return 2-tuple with horizonatal and vertical alignment names. Unspecified alignments set to None. """ result = (None, None) if align_spec: mo = re.match(r'^([<\^>])?(\.([<\^>]))?$', align_spec) if mo: result = (Table.ALIGN.get(mo.group(1)), Table.VALIGN.get(mo.group(3))) return result @staticmethod def parse_span_spec(span_spec): """ Parse AsciiDoc cell span specifier and return 2-tuple with horizonatal and vertical span counts. Set default values (1,1) if not specified. """ result = (None, None) if span_spec: mo = re.match(r'^(\d+)?(\.(\d+))?$', span_spec) if mo: result = (mo.group(1) and int(mo.group(1)), mo.group(3) and int(mo.group(3))) return (result[0] or 1, result[1] or 1) def load(self,name,entries): AbstractBlock.load(self,name,entries) def dump(self): AbstractBlock.dump(self) write = lambda s: sys.stdout.write('%s%s' % (s,writer.newline)) write('format='+self.format) write('') def validate(self): AbstractBlock.validate(self) if self.format not in Table.FORMATS: self.error('illegal format=%s' % self.format,halt=True) self.tags = self.tags or 'default' tags = [self.tags] tags += [s['tags'] for s in self.styles.values() if 'tags' in s] for t in tags: if t not in tables.tags: self.error('missing section: [tabletags-%s]' % t,halt=True) if self.separator: # Evaluate escape characters. self.separator = literal_eval('"'+self.separator+'"') #TODO: Move to class Tables # Check global table parameters. elif config.pagewidth is None: self.error('missing [miscellaneous] entry: pagewidth') elif config.pageunits is None: self.error('missing [miscellaneous] entry: pageunits') def validate_attributes(self): """Validate and parse table attributes.""" # Set defaults. format = self.format tags = self.tags separator = self.separator abswidth = float(config.pagewidth) pcwidth = 100.0 for k,v in self.attributes.items(): if k == 'format': if v not in self.FORMATS: self.error('illegal %s=%s' % (k,v)) else: format = v elif k == 'tags': if v not in tables.tags: self.error('illegal %s=%s' % (k,v)) else: tags = v elif k == 'separator': separator = v elif k == 'width': if not re.match(r'^\d{1,3}%$',v) or int(v[:-1]) > 100: self.error('illegal %s=%s' % (k,v)) else: abswidth = float(v[:-1])/100 * config.pagewidth pcwidth = float(v[:-1]) # Calculate separator if it has not been specified. if not separator: separator = Table.SEPARATORS[format] if format == 'csv': if len(separator) > 1: self.error('illegal csv separator=%s' % separator) separator = ',' else: if not is_re(separator): self.error('illegal regular expression: separator=%s' % separator) self.parameters.format = format self.parameters.tags = tags self.parameters.separator = separator self.abswidth = abswidth self.pcwidth = pcwidth def get_tags(self,params): tags = self.get_param('tags',params) assert(tags and tags in tables.tags) return tables.tags[tags] def get_style(self,prefix): """ Return the style dictionary whose name starts with 'prefix'. """ if prefix is None: return None names = self.styles.keys() names.sort() for name in names: if name.startswith(prefix): return self.styles[name] else: self.error('missing style: %s*' % prefix) return None def parse_cols(self, cols, halign, valign): """ Build list of column objects from table 'cols', 'halign' and 'valign' attributes. """ # [<multiplier>*][<align>][<width>][<style>] COLS_RE1 = r'^((?P<count>\d+)\*)?(?P<align>[<\^>.]{,3})?(?P<width>\d+%?)?(?P<style>[a-z]\w*)?$' # [<multiplier>*][<width>][<align>][<style>] COLS_RE2 = r'^((?P<count>\d+)\*)?(?P<width>\d+%?)?(?P<align>[<\^>.]{,3})?(?P<style>[a-z]\w*)?$' reo1 = re.compile(COLS_RE1) reo2 = re.compile(COLS_RE2) cols = str(cols) if re.match(r'^\d+$',cols): for i in range(int(cols)): self.columns.append(Column()) else: for col in re.split(r'\s*,\s*',cols): mo = reo1.match(col) if not mo: mo = reo2.match(col) if mo: count = int(mo.groupdict().get('count') or 1) for i in range(count): self.columns.append( Column(mo.group('width'), mo.group('align'), self.get_style(mo.group('style'))) ) else: self.error('illegal column spec: %s' % col,self.start) # Set column (and indirectly cell) default alignments. for col in self.columns: col.halign = col.halign or halign or document.attributes.get('halign') or 'left' col.valign = col.valign or valign or document.attributes.get('valign') or 'top' # Validate widths and calculate missing widths. n = 0; percents = 0; props = 0 for col in self.columns: if col.width: if col.width[-1] == '%': percents += int(col.width[:-1]) else: props += int(col.width) n += 1 if percents > 0 and props > 0: self.error('mixed percent and proportional widths: %s' % cols,self.start) pcunits = percents > 0 # Fill in missing widths. if n < len(self.columns) and percents < 100: if pcunits: width = float(100 - percents)/float(len(self.columns) - n) else: width = 1 for col in self.columns: if not col.width: if pcunits: col.width = str(int(width))+'%' percents += width else: col.width = str(width) props += width # Calculate column alignment and absolute and percent width values. percents = 0 for col in self.columns: if pcunits: col.pcwidth = float(col.width[:-1]) else: col.pcwidth = (float(col.width)/props)*100 col.abswidth = self.abswidth * (col.pcwidth/100) if config.pageunits in ('cm','mm','in','em'): col.abswidth = '%.2f' % round(col.abswidth,2) else: col.abswidth = '%d' % round(col.abswidth) percents += col.pcwidth col.pcwidth = int(col.pcwidth) if round(percents) > 100: self.error('total width exceeds 100%%: %s' % cols,self.start) elif round(percents) < 100: self.error('total width less than 100%%: %s' % cols,self.start) def build_colspecs(self): """ Generate column related substitution attributes. """ cols = [] i = 1 for col in self.columns: colspec = self.get_tags(col.style).colspec if colspec: self.attributes['halign'] = col.halign self.attributes['valign'] = col.valign self.attributes['colabswidth'] = col.abswidth self.attributes['colpcwidth'] = col.pcwidth self.attributes['colnumber'] = str(i) s = subs_attrs(colspec, self.attributes) if not s: message.warning('colspec dropped: contains undefined attribute') else: cols.append(s) i += 1 if cols: self.attributes['colspecs'] = writer.newline.join(cols) def parse_rows(self, text): """ Parse the table source text into self.rows (a list of rows, each row is a list of Cells. """ reserved = {} # Reserved cells generated by rowspans. if self.parameters.format in ('psv','dsv'): colcount = len(self.columns) parsed_cells = self.parse_psv_dsv(text) ri = 0 # Current row index 0.. ci = 0 # Column counter 0..colcount row = [] i = 0 while True: resv = reserved.get(ri) and reserved[ri].get(ci) if resv: # We have a cell generated by a previous row span so # process it before continuing with the current parsed # cell. cell = resv else: if i >= len(parsed_cells): break # No more parsed or reserved cells. cell = parsed_cells[i] i += 1 if cell.vspan > 1: # Generate ensuing reserved cells spanned vertically by # the current cell. for j in range(1, cell.vspan): if not ri+j in reserved: reserved[ri+j] = {} reserved[ri+j][ci] = cell.clone_reserve() ci += cell.span if ci <= colcount: row.append(cell) if ci >= colcount: self.rows.append(row) ri += 1 row = [] ci = 0 elif self.parameters.format == 'csv': self.rows = self.parse_csv(text) else: assert True,'illegal table format' # Check for empty rows containing only reserved (spanned) cells. for ri,row in enumerate(self.rows): empty = True for cell in row: if not cell.reserved: empty = False break if empty: message.warning('table row %d: empty spanned row' % (ri+1)) # Check that all row spans match. for ri,row in enumerate(self.rows): row_span = 0 for cell in row: row_span += cell.span if ri == 0: header_span = row_span if row_span < header_span: message.warning('table row %d: does not span all columns' % (ri+1)) if row_span > header_span: message.warning('table row %d: exceeds columns span' % (ri+1)) def subs_rows(self, rows, rowtype='body'): """ Return a string of output markup from a list of rows, each row is a list of raw data text. """ tags = tables.tags[self.parameters.tags] if rowtype == 'header': rtag = tags.headrow elif rowtype == 'footer': rtag = tags.footrow else: rtag = tags.bodyrow result = [] stag,etag = subs_tag(rtag,self.attributes) for row in rows: result.append(stag) result += self.subs_row(row,rowtype) result.append(etag) return writer.newline.join(result) def subs_row(self, row, rowtype): """ Substitute the list of Cells using the data tag. Returns a list of marked up table cell elements. """ result = [] i = 0 for cell in row: if cell.reserved: # Skip vertically spanned placeholders. i += cell.span continue if i >= len(self.columns): break # Skip cells outside the header width. col = self.columns[i] self.attributes['halign'] = cell.halign or col.halign self.attributes['valign'] = cell.valign or col.valign self.attributes['colabswidth'] = col.abswidth self.attributes['colpcwidth'] = col.pcwidth self.attributes['colnumber'] = str(i+1) self.attributes['colspan'] = str(cell.span) self.attributes['colstart'] = self.attributes['colnumber'] self.attributes['colend'] = str(i+cell.span) self.attributes['rowspan'] = str(cell.vspan) self.attributes['morerows'] = str(cell.vspan-1) # Fill missing column data with blanks. if i > len(self.columns) - 1: data = '' else: data = cell.data if rowtype == 'header': # Use table style unless overriden by cell style. colstyle = cell.style else: # If the cell style is not defined use the column style. colstyle = cell.style or col.style tags = self.get_tags(colstyle) presubs,postsubs = self.get_subs(colstyle) data = [data] data = Lex.subs(data, presubs) data = filter_lines(self.get_param('filter',colstyle), data, self.attributes) data = Lex.subs(data, postsubs) if rowtype != 'header': ptag = tags.paragraph if ptag: stag,etag = subs_tag(ptag,self.attributes) text = '\n'.join(data).strip() data = [] for para in re.split(r'\n{2,}',text): data += dovetail_tags([stag],para.split('\n'),[etag]) if rowtype == 'header': dtag = tags.headdata elif rowtype == 'footer': dtag = tags.footdata else: dtag = tags.bodydata stag,etag = subs_tag(dtag,self.attributes) result = result + dovetail_tags([stag],data,[etag]) i += cell.span return result def parse_csv(self,text): """ Parse the table source text and return a list of rows, each row is a list of Cells. """ import StringIO import csv rows = [] rdr = csv.reader(StringIO.StringIO('\r\n'.join(text)), delimiter=self.parameters.separator, skipinitialspace=True) try: for row in rdr: rows.append([Cell(data) for data in row]) except Exception: self.error('csv parse error: %s' % row) return rows def parse_psv_dsv(self,text): """ Parse list of PSV or DSV table source text lines and return a list of Cells. """ def append_cell(data, span_spec, op, align_spec, style): op = op or '+' if op == '*': # Cell multiplier. span = Table.parse_span_spec(span_spec)[0] for i in range(span): cells.append(Cell(data, '1', align_spec, style)) elif op == '+': # Column spanner. cells.append(Cell(data, span_spec, align_spec, style)) else: self.error('illegal table cell operator') text = '\n'.join(text) separator = '(?msu)'+self.parameters.separator format = self.parameters.format start = 0 span = None op = None align = None style = None cells = [] data = '' for mo in re.finditer(separator,text): data += text[start:mo.start()] if data.endswith('\\'): data = data[:-1]+mo.group() # Reinstate escaped separators. else: append_cell(data, span, op, align, style) span = mo.groupdict().get('span') op = mo.groupdict().get('op') align = mo.groupdict().get('align') style = mo.groupdict().get('style') if style: style = self.get_style(style) data = '' start = mo.end() # Last cell follows final separator. data += text[start:] append_cell(data, span, op, align, style) # We expect a dummy blank item preceeding first PSV cell. if format == 'psv': if cells[0].data.strip() != '': self.error('missing leading separator: %s' % separator, self.start) else: cells.pop(0) return cells def translate(self): AbstractBlock.translate(self) reader.read() # Discard delimiter. # Reset instance specific properties. self.columns = [] self.rows = [] attrs = {} BlockTitle.consume(attrs) # Mix in document attribute list. AttributeList.consume(attrs) self.merge_attributes(attrs) self.validate_attributes() # Add global and calculated configuration parameters. self.attributes['pagewidth'] = config.pagewidth self.attributes['pageunits'] = config.pageunits self.attributes['tableabswidth'] = int(self.abswidth) self.attributes['tablepcwidth'] = int(self.pcwidth) # Read the entire table. text = reader.read_until(self.delimiter) if reader.eof(): self.error('missing closing delimiter',self.start) else: delimiter = reader.read() # Discard closing delimiter. assert re.match(self.delimiter,delimiter) if len(text) == 0: message.warning('[%s] table is empty' % self.defname) return self.push_blockname('table') cols = attrs.get('cols') if not cols: # Calculate column count from number of items in first line. if self.parameters.format == 'csv': cols = text[0].count(self.parameters.separator) + 1 else: cols = 0 for cell in self.parse_psv_dsv(text[:1]): cols += cell.span self.parse_cols(cols, attrs.get('halign'), attrs.get('valign')) # Set calculated attributes. self.attributes['colcount'] = len(self.columns) self.build_colspecs() self.parse_rows(text) # The 'rowcount' attribute is used by the experimental LaTeX backend. self.attributes['rowcount'] = str(len(self.rows)) # Generate headrows, footrows, bodyrows. # Headrow, footrow and bodyrow data replaces same named attributes in # the table markup template. In order to ensure this data does not get # a second attribute substitution (which would interfere with any # already substituted inline passthroughs) unique placeholders are used # (the tab character does not appear elsewhere since it is expanded on # input) which are replaced after template attribute substitution. headrows = footrows = bodyrows = None for option in self.parameters.options: self.attributes[option+'-option'] = '' if self.rows and 'header' in self.parameters.options: headrows = self.subs_rows(self.rows[0:1],'header') self.attributes['headrows'] = '\x07headrows\x07' self.rows = self.rows[1:] if self.rows and 'footer' in self.parameters.options: footrows = self.subs_rows( self.rows[-1:], 'footer') self.attributes['footrows'] = '\x07footrows\x07' self.rows = self.rows[:-1] if self.rows: bodyrows = self.subs_rows(self.rows) self.attributes['bodyrows'] = '\x07bodyrows\x07' table = subs_attrs(config.sections[self.parameters.template], self.attributes) table = writer.newline.join(table) # Before we finish replace the table head, foot and body place holders # with the real data. if headrows: table = table.replace('\x07headrows\x07', headrows, 1) if footrows: table = table.replace('\x07footrows\x07', footrows, 1) if bodyrows: table = table.replace('\x07bodyrows\x07', bodyrows, 1) writer.write(table,trace='table') self.pop_blockname() class Tables(AbstractBlocks): """List of tables.""" BLOCK_TYPE = Table PREFIX = 'tabledef-' TAGS = ('colspec', 'headrow','footrow','bodyrow', 'headdata','footdata', 'bodydata','paragraph') def __init__(self): AbstractBlocks.__init__(self) # Table tags dictionary. Each entry is a tags dictionary. self.tags={} def load(self,sections): AbstractBlocks.load(self,sections) self.load_tags(sections) def load_tags(self,sections): """ Load tabletags-* conf file sections to self.tags. """ for section in sections.keys(): mo = re.match(r'^tabletags-(?P<name>\w+)$',section) if mo: name = mo.group('name') if name in self.tags: d = self.tags[name] else: d = AttrDict() parse_entries(sections.get(section,()),d) for k in d.keys(): if k not in self.TAGS: message.warning('[%s] contains illegal table tag: %s' % (section,k)) self.tags[name] = d def validate(self): AbstractBlocks.validate(self) # Check we have a default table definition, for i in range(len(self.blocks)): if self.blocks[i].defname == 'tabledef-default': default = self.blocks[i] break else: raise EAsciiDoc,'missing section: [tabledef-default]' # Propagate defaults to unspecified table parameters. for b in self.blocks: if b is not default: if b.format is None: b.format = default.format if b.template is None: b.template = default.template # Check tags and propagate default tags. if not 'default' in self.tags: raise EAsciiDoc,'missing section: [tabletags-default]' default = self.tags['default'] for tag in ('bodyrow','bodydata','paragraph'): # Mandatory default tags. if tag not in default: raise EAsciiDoc,'missing [tabletags-default] entry: %s' % tag for t in self.tags.values(): if t is not default: if t.colspec is None: t.colspec = default.colspec if t.headrow is None: t.headrow = default.headrow if t.footrow is None: t.footrow = default.footrow if t.bodyrow is None: t.bodyrow = default.bodyrow if t.headdata is None: t.headdata = default.headdata if t.footdata is None: t.footdata = default.footdata if t.bodydata is None: t.bodydata = default.bodydata if t.paragraph is None: t.paragraph = default.paragraph # Use body tags if header and footer tags are not specified. for t in self.tags.values(): if not t.headrow: t.headrow = t.bodyrow if not t.footrow: t.footrow = t.bodyrow if not t.headdata: t.headdata = t.bodydata if not t.footdata: t.footdata = t.bodydata # Check table definitions are valid. for b in self.blocks: b.validate() def dump(self): AbstractBlocks.dump(self) for k,v in self.tags.items(): dump_section('tabletags-'+k, v) class Macros: # Default system macro syntax. SYS_RE = r'(?u)^(?P<name>[\\]?\w(\w|-)*?)::(?P<target>\S*?)' + \ r'(\[(?P<attrlist>.*?)\])$' def __init__(self): self.macros = [] # List of Macros. self.current = None # The last matched block macro. self.passthroughs = [] # Initialize default system macro. m = Macro() m.pattern = self.SYS_RE m.prefix = '+' m.reo = re.compile(m.pattern) self.macros.append(m) def load(self,entries): for entry in entries: m = Macro() m.load(entry) if m.name is None: # Delete undefined macro. for i,m2 in enumerate(self.macros): if m2.pattern == m.pattern: del self.macros[i] break else: message.warning('unable to delete missing macro: %s' % m.pattern) else: # Check for duplicates. for m2 in self.macros: if m2.pattern == m.pattern: message.verbose('macro redefinition: %s%s' % (m.prefix,m.name)) break else: self.macros.append(m) def dump(self): write = lambda s: sys.stdout.write('%s%s' % (s,writer.newline)) write('[macros]') # Dump all macros except the first (built-in system) macro. for m in self.macros[1:]: # Escape = in pattern. macro = '%s=%s%s' % (m.pattern.replace('=',r'\='), m.prefix, m.name) if m.subslist is not None: macro += '[' + ','.join(m.subslist) + ']' write(macro) write('') def validate(self): # Check all named sections exist. if config.verbose: for m in self.macros: if m.name and m.prefix != '+': m.section_name() def subs(self,text,prefix='',callouts=False): # If callouts is True then only callout macros are processed, if False # then all non-callout macros are processed. result = text for m in self.macros: if m.prefix == prefix: if callouts ^ (m.name != 'callout'): result = m.subs(result) return result def isnext(self): """Return matching macro if block macro is next on reader.""" reader.skip_blank_lines() line = reader.read_next() if line: for m in self.macros: if m.prefix == '#': if m.reo.match(line): self.current = m return m return False def match(self,prefix,name,text): """Return re match object matching 'text' with macro type 'prefix', macro name 'name'.""" for m in self.macros: if m.prefix == prefix: mo = m.reo.match(text) if mo: if m.name == name: return mo if re.match(name, mo.group('name')): return mo return None def extract_passthroughs(self,text,prefix=''): """ Extract the passthrough text and replace with temporary placeholders.""" self.passthroughs = [] for m in self.macros: if m.has_passthrough() and m.prefix == prefix: text = m.subs_passthroughs(text, self.passthroughs) return text def restore_passthroughs(self,text): """ Replace passthough placeholders with the original passthrough text.""" for i,v in enumerate(self.passthroughs): text = text.replace('\x07'+str(i)+'\x07', self.passthroughs[i]) return text class Macro: def __init__(self): self.pattern = None # Matching regular expression. self.name = '' # Conf file macro name (None if implicit). self.prefix = '' # '' if inline, '+' if system, '#' if block. self.reo = None # Compiled pattern re object. self.subslist = [] # Default subs for macros passtext group. def has_passthrough(self): return self.pattern.find(r'(?P<passtext>') >= 0 def section_name(self,name=None): """Return macro markup template section name based on macro name and prefix. Return None section not found.""" assert self.prefix != '+' if not name: assert self.name name = self.name if self.prefix == '#': suffix = '-blockmacro' else: suffix = '-inlinemacro' if name+suffix in config.sections: return name+suffix else: message.warning('missing macro section: [%s]' % (name+suffix)) return None def load(self,entry): e = parse_entry(entry) if e is None: # Only the macro pattern was specified, mark for deletion. self.name = None self.pattern = entry return if not is_re(e[0]): raise EAsciiDoc,'illegal macro regular expression: %s' % e[0] pattern, name = e if name and name[0] in ('+','#'): prefix, name = name[0], name[1:] else: prefix = '' # Parse passthrough subslist. mo = re.match(r'^(?P<name>[^[]*)(\[(?P<subslist>.*)\])?$', name) name = mo.group('name') if name and not is_name(name): raise EAsciiDoc,'illegal section name in macro entry: %s' % entry subslist = mo.group('subslist') if subslist is not None: # Parse and validate passthrough subs. subslist = parse_options(subslist, SUBS_OPTIONS, 'illegal subs in macro entry: %s' % entry) self.pattern = pattern self.reo = re.compile(pattern) self.prefix = prefix self.name = name self.subslist = subslist or [] def subs(self,text): def subs_func(mo): """Function called to perform macro substitution. Uses matched macro regular expression object and returns string containing the substituted macro body.""" # Check if macro reference is escaped. if mo.group()[0] == '\\': return mo.group()[1:] # Strip leading backslash. d = mo.groupdict() # Delete groups that didn't participate in match. for k,v in d.items(): if v is None: del d[k] if self.name: name = self.name else: if not 'name' in d: message.warning('missing macro name group: %s' % mo.re.pattern) return '' name = d['name'] section_name = self.section_name(name) if not section_name: return '' # If we're dealing with a block macro get optional block ID and # block title. if self.prefix == '#' and self.name != 'comment': AttributeList.consume(d) BlockTitle.consume(d) # Parse macro attributes. if 'attrlist' in d: if d['attrlist'] in (None,''): del d['attrlist'] else: if self.prefix == '': # Unescape ] characters in inline macros. d['attrlist'] = d['attrlist'].replace('\\]',']') parse_attributes(d['attrlist'],d) # Generate option attributes. if 'options' in d: options = parse_options(d['options'], (), '%s: illegal option name' % name) for option in options: d[option+'-option'] = '' # Substitute single quoted attribute values in block macros. if self.prefix == '#': AttributeList.subs(d) if name == 'callout': listindex =int(d['index']) d['coid'] = calloutmap.add(listindex) # The alt attribute is the first image macro positional attribute. if name == 'image' and '1' in d: d['alt'] = d['1'] # Unescape special characters in LaTeX target file names. if document.backend == 'latex' and 'target' in d and d['target']: if not '0' in d: d['0'] = d['target'] d['target']= config.subs_specialchars_reverse(d['target']) # BUG: We've already done attribute substitution on the macro which # means that any escaped attribute references are now unescaped and # will be substituted by config.subs_section() below. As a partial # fix have withheld {0} from substitution but this kludge doesn't # fix it for other attributes containing unescaped references. # Passthrough macros don't have this problem. a0 = d.get('0') if a0: d['0'] = chr(0) # Replace temporarily with unused character. body = config.subs_section(section_name,d) if len(body) == 0: result = '' elif len(body) == 1: result = body[0] else: if self.prefix == '#': result = writer.newline.join(body) else: # Internally processed inline macros use UNIX line # separator. result = '\n'.join(body) if a0: result = result.replace(chr(0), a0) return result return self.reo.sub(subs_func, text) def translate(self): """ Block macro translation.""" assert self.prefix == '#' s = reader.read() before = s if self.has_passthrough(): s = macros.extract_passthroughs(s,'#') s = subs_attrs(s) if s: s = self.subs(s) if self.has_passthrough(): s = macros.restore_passthroughs(s) if s: trace('macro block',before,s) writer.write(s) def subs_passthroughs(self, text, passthroughs): """ Replace macro attribute lists in text with placeholders. Substitute and append the passthrough attribute lists to the passthroughs list.""" def subs_func(mo): """Function called to perform inline macro substitution. Uses matched macro regular expression object and returns string containing the substituted macro body.""" # Don't process escaped macro references. if mo.group()[0] == '\\': return mo.group() d = mo.groupdict() if not 'passtext' in d: message.warning('passthrough macro %s: missing passtext group' % d.get('name','')) return mo.group() passtext = d['passtext'] if re.search('\x07\\d+\x07', passtext): message.warning('nested inline passthrough') return mo.group() if d.get('subslist'): if d['subslist'].startswith(':'): message.error('block macro cannot occur here: %s' % mo.group(), halt=True) subslist = parse_options(d['subslist'], SUBS_OPTIONS, 'illegal passthrough macro subs option') else: subslist = self.subslist passtext = Lex.subs_1(passtext,subslist) if passtext is None: passtext = '' if self.prefix == '': # Unescape ] characters in inline macros. passtext = passtext.replace('\\]',']') passthroughs.append(passtext) # Tabs guarantee the placeholders are unambiguous. result = ( text[mo.start():mo.start('passtext')] + '\x07' + str(len(passthroughs)-1) + '\x07' + text[mo.end('passtext'):mo.end()] ) return result return self.reo.sub(subs_func, text) class CalloutMap: def __init__(self): self.comap = {} # key = list index, value = callouts list. self.calloutindex = 0 # Current callout index number. self.listnumber = 1 # Current callout list number. def listclose(self): # Called when callout list is closed. self.listnumber += 1 self.calloutindex = 0 self.comap = {} def add(self,listindex): # Add next callout index to listindex map entry. Return the callout id. self.calloutindex += 1 # Append the coindex to a list in the comap dictionary. if not listindex in self.comap: self.comap[listindex] = [self.calloutindex] else: self.comap[listindex].append(self.calloutindex) return self.calloutid(self.listnumber, self.calloutindex) @staticmethod def calloutid(listnumber,calloutindex): return 'CO%d-%d' % (listnumber,calloutindex) def calloutids(self,listindex): # Retieve list of callout indexes that refer to listindex. if listindex in self.comap: result = '' for coindex in self.comap[listindex]: result += ' ' + self.calloutid(self.listnumber,coindex) return result.strip() else: message.warning('no callouts refer to list item '+str(listindex)) return '' def validate(self,maxlistindex): # Check that all list indexes referenced by callouts exist. for listindex in self.comap.keys(): if listindex > maxlistindex: message.warning('callout refers to non-existent list item ' + str(listindex)) #--------------------------------------------------------------------------- # Input stream Reader and output stream writer classes. #--------------------------------------------------------------------------- UTF8_BOM = '\xef\xbb\xbf' class Reader1: """Line oriented AsciiDoc input file reader. Processes include and conditional inclusion system macros. Tabs are expanded and lines are right trimmed.""" # This class is not used directly, use Reader class instead. READ_BUFFER_MIN = 10 # Read buffer low level. def __init__(self): self.f = None # Input file object. self.fname = None # Input file name. self.next = [] # Read ahead buffer containing # [filename,linenumber,linetext] lists. self.cursor = None # Last read() [filename,linenumber,linetext]. self.tabsize = 8 # Tab expansion number of spaces. self.parent = None # Included reader's parent reader. self._lineno = 0 # The last line read from file object f. self.current_depth = 0 # Current include depth. self.max_depth = 10 # Initial maxiumum allowed include depth. self.bom = None # Byte order mark (BOM). self.infile = None # Saved document 'infile' attribute. self.indir = None # Saved document 'indir' attribute. def open(self,fname): self.fname = fname message.verbose('reading: '+fname) if fname == '<stdin>': self.f = sys.stdin self.infile = None self.indir = None else: self.f = open(fname,'rb') self.infile = fname self.indir = os.path.dirname(fname) document.attributes['infile'] = self.infile document.attributes['indir'] = self.indir self._lineno = 0 # The last line read from file object f. self.next = [] # Prefill buffer by reading the first line and then pushing it back. if Reader1.read(self): if self.cursor[2].startswith(UTF8_BOM): self.cursor[2] = self.cursor[2][len(UTF8_BOM):] self.bom = UTF8_BOM self.unread(self.cursor) self.cursor = None def closefile(self): """Used by class methods to close nested include files.""" self.f.close() self.next = [] def close(self): self.closefile() self.__init__() def read(self, skip=False): """Read next line. Return None if EOF. Expand tabs. Strip trailing white space. Maintain self.next read ahead buffer. If skip=True then conditional exclusion is active (ifdef and ifndef macros).""" # Top up buffer. if len(self.next) <= self.READ_BUFFER_MIN: s = self.f.readline() if s: self._lineno = self._lineno + 1 while s: if self.tabsize != 0: s = s.expandtabs(self.tabsize) s = s.rstrip() self.next.append([self.fname,self._lineno,s]) if len(self.next) > self.READ_BUFFER_MIN: break s = self.f.readline() if s: self._lineno = self._lineno + 1 # Return first (oldest) buffer entry. if len(self.next) > 0: self.cursor = self.next[0] del self.next[0] result = self.cursor[2] # Check for include macro. mo = macros.match('+',r'^include[1]?$',result) if mo and not skip: # Parse include macro attributes. attrs = {} parse_attributes(mo.group('attrlist'),attrs) warnings = attrs.get('warnings', True) # Don't process include macro once the maximum depth is reached. if self.current_depth >= self.max_depth: message.warning('maximum include depth exceeded') return result # Perform attribute substitution on include macro file name. fname = subs_attrs(mo.group('target')) if not fname: return Reader1.read(self) # Return next input line. if self.fname != '<stdin>': fname = os.path.expandvars(os.path.expanduser(fname)) fname = safe_filename(fname, os.path.dirname(self.fname)) if not fname: return Reader1.read(self) # Return next input line. if not os.path.isfile(fname): if warnings: message.warning('include file not found: %s' % fname) return Reader1.read(self) # Return next input line. if mo.group('name') == 'include1': if not config.dumping: if fname not in config.include1: message.verbose('include1: ' + fname, linenos=False) # Store the include file in memory for later # retrieval by the {include1:} system attribute. f = open(fname) try: config.include1[fname] = [ s.rstrip() for s in f] finally: f.close() return '{include1:%s}' % fname else: # This is a configuration dump, just pass the macro # call through. return result # Clone self and set as parent (self assumes the role of child). parent = Reader1() assign(parent,self) self.parent = parent # Set attributes in child. if 'tabsize' in attrs: try: val = int(attrs['tabsize']) if not val >= 0: raise ValueError, 'not >= 0' self.tabsize = val except ValueError: raise EAsciiDoc, 'illegal include macro tabsize argument' else: self.tabsize = config.tabsize if 'depth' in attrs: try: val = int(attrs['depth']) if not val >= 1: raise ValueError, 'not >= 1' self.max_depth = self.current_depth + val except ValueError: raise EAsciiDoc, "include macro: illegal 'depth' argument" # Process included file. message.verbose('include: ' + fname, linenos=False) self.open(fname) self.current_depth = self.current_depth + 1 result = Reader1.read(self) else: if not Reader1.eof(self): result = Reader1.read(self) else: result = None return result def eof(self): """Returns True if all lines have been read.""" if len(self.next) == 0: # End of current file. if self.parent: self.closefile() assign(self,self.parent) # Restore parent reader. document.attributes['infile'] = self.infile document.attributes['indir'] = self.indir return Reader1.eof(self) else: return True else: return False def read_next(self): """Like read() but does not advance file pointer.""" if Reader1.eof(self): return None else: return self.next[0][2] def unread(self,cursor): """Push the line (filename,linenumber,linetext) tuple back into the read buffer. Note that it's up to the caller to restore the previous cursor.""" assert cursor self.next.insert(0,cursor) class Reader(Reader1): """ Wraps (well, sought of) Reader1 class and implements conditional text inclusion.""" def __init__(self): Reader1.__init__(self) self.depth = 0 # if nesting depth. self.skip = False # true if we're skipping ifdef...endif. self.skipname = '' # Name of current endif macro target. self.skipto = -1 # The depth at which skipping is reenabled. def read_super(self): result = Reader1.read(self,self.skip) if result is None and self.skip: raise EAsciiDoc,'missing endif::%s[]' % self.skipname return result def read(self): result = self.read_super() if result is None: return None while self.skip: mo = macros.match('+',r'ifdef|ifndef|ifeval|endif',result) if mo: name = mo.group('name') target = mo.group('target') attrlist = mo.group('attrlist') if name == 'endif': self.depth -= 1 if self.depth < 0: raise EAsciiDoc,'mismatched macro: %s' % result if self.depth == self.skipto: self.skip = False if target and self.skipname != target: raise EAsciiDoc,'mismatched macro: %s' % result else: if name in ('ifdef','ifndef'): if not target: raise EAsciiDoc,'missing macro target: %s' % result if not attrlist: self.depth += 1 elif name == 'ifeval': if not attrlist: raise EAsciiDoc,'missing ifeval condition: %s' % result self.depth += 1 result = self.read_super() if result is None: return None mo = macros.match('+',r'ifdef|ifndef|ifeval|endif',result) if mo: name = mo.group('name') target = mo.group('target') attrlist = mo.group('attrlist') if name == 'endif': self.depth = self.depth-1 else: if not target and name in ('ifdef','ifndef'): raise EAsciiDoc,'missing macro target: %s' % result defined = is_attr_defined(target, document.attributes) if name == 'ifdef': if attrlist: if defined: return attrlist else: self.skip = not defined elif name == 'ifndef': if attrlist: if not defined: return attrlist else: self.skip = defined elif name == 'ifeval': if safe(): message.unsafe('ifeval invalid') raise EAsciiDoc,'ifeval invalid safe document' if not attrlist: raise EAsciiDoc,'missing ifeval condition: %s' % result cond = False attrlist = subs_attrs(attrlist) if attrlist: try: cond = eval(attrlist) except Exception,e: raise EAsciiDoc,'error evaluating ifeval condition: %s: %s' % (result, str(e)) message.verbose('ifeval: %s: %r' % (attrlist, cond)) self.skip = not cond if not attrlist or name == 'ifeval': if self.skip: self.skipto = self.depth self.skipname = target self.depth = self.depth+1 result = self.read() if result: # Expand executable block macros. mo = macros.match('+',r'eval|sys|sys2',result) if mo: action = mo.group('name') cmd = mo.group('attrlist') result = system(action, cmd, is_macro=True) self.cursor[2] = result # So we don't re-evaluate. if result: # Unescape escaped system macros. if macros.match('+',r'\\eval|\\sys|\\sys2|\\ifdef|\\ifndef|\\endif|\\include|\\include1',result): result = result[1:] return result def eof(self): return self.read_next() is None def read_next(self): save_cursor = self.cursor result = self.read() if result is not None: self.unread(self.cursor) self.cursor = save_cursor return result def read_lines(self,count=1): """Return tuple containing count lines.""" result = [] i = 0 while i < count and not self.eof(): result.append(self.read()) return tuple(result) def read_ahead(self,count=1): """Same as read_lines() but does not advance the file pointer.""" result = [] putback = [] save_cursor = self.cursor try: i = 0 while i < count and not self.eof(): result.append(self.read()) putback.append(self.cursor) i = i+1 while putback: self.unread(putback.pop()) finally: self.cursor = save_cursor return tuple(result) def skip_blank_lines(self): reader.read_until(r'\s*\S+') def read_until(self,terminators,same_file=False): """Like read() but reads lines up to (but not including) the first line that matches the terminator regular expression, regular expression object or list of regular expression objects. If same_file is True then the terminating pattern must occur in the file the was being read when the routine was called.""" if same_file: fname = self.cursor[0] result = [] if not isinstance(terminators,list): if isinstance(terminators,basestring): terminators = [re.compile(terminators)] else: terminators = [terminators] while not self.eof(): save_cursor = self.cursor s = self.read() if not same_file or fname == self.cursor[0]: for reo in terminators: if reo.match(s): self.unread(self.cursor) self.cursor = save_cursor return tuple(result) result.append(s) return tuple(result) class Writer: """Writes lines to output file.""" def __init__(self): self.newline = '\r\n' # End of line terminator. self.f = None # Output file object. self.fname = None # Output file name. self.lines_out = 0 # Number of lines written. self.skip_blank_lines = False # If True don't output blank lines. def open(self,fname,bom=None): ''' bom is optional byte order mark. http://en.wikipedia.org/wiki/Byte-order_mark ''' self.fname = fname if fname == '<stdout>': self.f = sys.stdout else: self.f = open(fname,'wb+') message.verbose('writing: '+writer.fname,False) if bom: self.f.write(bom) self.lines_out = 0 def close(self): if self.fname != '<stdout>': self.f.close() def write_line(self, line=None): if not (self.skip_blank_lines and (not line or not line.strip())): self.f.write((line or '') + self.newline) self.lines_out = self.lines_out + 1 def write(self,*args,**kwargs): """Iterates arguments, writes tuple and list arguments one line per element, else writes argument as single line. If no arguments writes blank line. If argument is None nothing is written. self.newline is appended to each line.""" if 'trace' in kwargs and len(args) > 0: trace(kwargs['trace'],args[0]) if len(args) == 0: self.write_line() self.lines_out = self.lines_out + 1 else: for arg in args: if is_array(arg): for s in arg: self.write_line(s) elif arg is not None: self.write_line(arg) def write_tag(self,tag,content,subs=None,d=None,**kwargs): """Write content enveloped by tag. Substitutions specified in the 'subs' list are perform on the 'content'.""" if subs is None: subs = config.subsnormal stag,etag = subs_tag(tag,d) content = Lex.subs(content,subs) if 'trace' in kwargs: trace(kwargs['trace'],[stag]+content+[etag]) if stag: self.write(stag) if content: self.write(content) if etag: self.write(etag) #--------------------------------------------------------------------------- # Configuration file processing. #--------------------------------------------------------------------------- def _subs_specialwords(mo): """Special word substitution function called by Config.subs_specialwords().""" word = mo.re.pattern # The special word. template = config.specialwords[word] # The corresponding markup template. if not template in config.sections: raise EAsciiDoc,'missing special word template [%s]' % template if mo.group()[0] == '\\': return mo.group()[1:] # Return escaped word. args = {} args['words'] = mo.group() # The full match string is argument 'words'. args.update(mo.groupdict()) # Add other named match groups to the arguments. # Delete groups that didn't participate in match. for k,v in args.items(): if v is None: del args[k] lines = subs_attrs(config.sections[template],args) if len(lines) == 0: result = '' elif len(lines) == 1: result = lines[0] else: result = writer.newline.join(lines) return result class Config: """Methods to process configuration files.""" # Non-template section name regexp's. ENTRIES_SECTIONS= ('tags','miscellaneous','attributes','specialcharacters', 'specialwords','macros','replacements','quotes','titles', r'paradef-.+',r'listdef-.+',r'blockdef-.+',r'tabledef-.+', r'tabletags-.+',r'listtags-.+','replacements[23]', r'old_tabledef-.+') def __init__(self): self.sections = OrderedDict() # Keyed by section name containing # lists of section lines. # Command-line options. self.verbose = False self.header_footer = True # -s, --no-header-footer option. # [miscellaneous] section. self.tabsize = 8 self.textwidth = 70 # DEPRECATED: Old tables only. self.newline = '\r\n' self.pagewidth = None self.pageunits = None self.outfilesuffix = '' self.subsnormal = SUBS_NORMAL self.subsverbatim = SUBS_VERBATIM self.tags = {} # Values contain (stag,etag) tuples. self.specialchars = {} # Values of special character substitutions. self.specialwords = {} # Name is special word pattern, value is macro. self.replacements = OrderedDict() # Key is find pattern, value is #replace pattern. self.replacements2 = OrderedDict() self.replacements3 = OrderedDict() self.specialsections = {} # Name is special section name pattern, value # is corresponding section name. self.quotes = OrderedDict() # Values contain corresponding tag name. self.fname = '' # Most recently loaded configuration file name. self.conf_attrs = {} # Attributes entries from conf files. self.cmd_attrs = {} # Attributes from command-line -a options. self.loaded = [] # Loaded conf files. self.include1 = {} # Holds include1::[] files for {include1:}. self.dumping = False # True if asciidoc -c option specified. self.filters = [] # Filter names specified by --filter option. def init(self, cmd): """ Check Python version and locate the executable and configuration files directory. cmd is the asciidoc command or asciidoc.py path. """ if float(sys.version[:3]) < float(MIN_PYTHON_VERSION): message.stderr('FAILED: Python %s or better required' % MIN_PYTHON_VERSION) sys.exit(1) if not os.path.exists(cmd): message.stderr('FAILED: Missing asciidoc command: %s' % cmd) sys.exit(1) global APP_FILE APP_FILE = os.path.realpath(cmd) global APP_DIR APP_DIR = os.path.dirname(APP_FILE) global USER_DIR USER_DIR = userdir() if USER_DIR is not None: USER_DIR = os.path.join(USER_DIR,'.asciidoc') if not os.path.isdir(USER_DIR): USER_DIR = None def load_file(self, fname, dir=None, include=[], exclude=[]): """ Loads sections dictionary with sections from file fname. Existing sections are overlaid. The 'include' list contains the section names to be loaded. The 'exclude' list contains section names not to be loaded. Return False if no file was found in any of the locations. """ def update_section(section): """ Update section in sections with contents. """ if section and contents: if section in sections and self.entries_section(section): if ''.join(contents): # Merge entries. sections[section] += contents else: del sections[section] else: if section.startswith('+'): # Append section. if section in sections: sections[section] += contents else: sections[section] = contents else: # Replace section. sections[section] = contents if dir: fname = os.path.join(dir, fname) # Sliently skip missing configuration file. if not os.path.isfile(fname): return False # Don't load conf files twice (local and application conf files are the # same if the source file is in the application directory). if os.path.realpath(fname) in self.loaded: return True rdr = Reader() # Reader processes system macros. message.linenos = False # Disable document line numbers. rdr.open(fname) message.linenos = None self.fname = fname reo = re.compile(r'(?u)^\[(?P<section>\+?[^\W\d][\w-]*)\]\s*$') sections = OrderedDict() section,contents = '',[] while not rdr.eof(): s = rdr.read() if s and s[0] == '#': # Skip comment lines. continue if s[:2] == '\\#': # Unescape lines starting with '#'. s = s[1:] s = s.rstrip() found = reo.findall(s) if found: update_section(section) # Store previous section. section = found[0].lower() contents = [] else: contents.append(s) update_section(section) # Store last section. rdr.close() if include: for s in set(sections) - set(include): del sections[s] if exclude: for s in set(sections) & set(exclude): del sections[s] attrs = {} self.load_sections(sections,attrs) if not include: # If all sections are loaded mark this file as loaded. self.loaded.append(os.path.realpath(fname)) document.update_attributes(attrs) # So they are available immediately. return True def load_sections(self,sections,attrs=None): """ Loads sections dictionary. Each dictionary entry contains a list of lines. Updates 'attrs' with parsed [attributes] section entries. """ # Delete trailing blank lines from sections. for k in sections.keys(): for i in range(len(sections[k])-1,-1,-1): if not sections[k][i]: del sections[k][i] elif not self.entries_section(k): break # Update new sections. for k,v in sections.items(): if k.startswith('+'): # Append section. k = k[1:] if k in self.sections: self.sections[k] += v else: self.sections[k] = v else: # Replace section. self.sections[k] = v self.parse_tags() # Internally [miscellaneous] section entries are just attributes. d = {} parse_entries(sections.get('miscellaneous',()), d, unquote=True, allow_name_only=True) parse_entries(sections.get('attributes',()), d, unquote=True, allow_name_only=True) update_attrs(self.conf_attrs,d) if attrs is not None: attrs.update(d) d = {} parse_entries(sections.get('titles',()),d) Title.load(d) parse_entries(sections.get('specialcharacters',()),self.specialchars,escape_delimiter=False) parse_entries(sections.get('quotes',()),self.quotes) self.parse_specialwords() self.parse_replacements() self.parse_replacements('replacements2') self.parse_replacements('replacements3') self.parse_specialsections() paragraphs.load(sections) lists.load(sections) blocks.load(sections) tables_OLD.load(sections) tables.load(sections) macros.load(sections.get('macros',())) def get_load_dirs(self): """ Return list of well known paths with conf files. """ result = [] if localapp(): # Load from folders in asciidoc executable directory. result.append(APP_DIR) else: # Load from global configuration directory. result.append(CONF_DIR) # Load configuration files from ~/.asciidoc if it exists. if USER_DIR is not None: result.append(USER_DIR) return result def find_in_dirs(self, filename, dirs=None): """ Find conf files from dirs list. Return list of found file paths. Return empty list if not found in any of the locations. """ result = [] if dirs is None: dirs = self.get_load_dirs() for d in dirs: f = os.path.join(d,filename) if os.path.isfile(f): result.append(f) return result def load_from_dirs(self, filename, dirs=None, include=[]): """ Load conf file from dirs list. If dirs not specified try all the well known locations. Return False if no file was sucessfully loaded. """ count = 0 for f in self.find_in_dirs(filename,dirs): if self.load_file(f, include=include): count += 1 return count != 0 def load_backend(self, dirs=None): """ Load the backend configuration files from dirs list. If dirs not specified try all the well known locations. If a <backend>.conf file was found return it's full path name, if not found return None. """ result = None if dirs is None: dirs = self.get_load_dirs() conf = document.backend + '.conf' conf2 = document.backend + '-' + document.doctype + '.conf' # First search for filter backends. for d in [os.path.join(d, 'backends', document.backend) for d in dirs]: if self.load_file(conf,d): result = os.path.join(d, conf) self.load_file(conf2,d) if not result: # Search in the normal locations. for d in dirs: if self.load_file(conf,d): result = os.path.join(d, conf) self.load_file(conf2,d) return result def load_filters(self, dirs=None): """ Load filter configuration files from 'filters' directory in dirs list. If dirs not specified try all the well known locations. Suppress loading if a file named __noautoload__ is in same directory as the conf file unless the filter has been specified with the --filter command-line option (in which case it is loaded unconditionally). """ if dirs is None: dirs = self.get_load_dirs() for d in dirs: # Load filter .conf files. filtersdir = os.path.join(d,'filters') for dirpath,dirnames,filenames in os.walk(filtersdir): subdirs = dirpath[len(filtersdir):].split(os.path.sep) # True if processing a filter specified by a --filter option. filter_opt = len(subdirs) > 1 and subdirs[1] in self.filters if '__noautoload__' not in filenames or filter_opt: for f in filenames: if re.match(r'^.+\.conf$',f): self.load_file(f,dirpath) def find_config_dir(self, *dirnames): """ Return path of configuration directory. Try all the well known locations. Return None if directory not found. """ for d in [os.path.join(d, *dirnames) for d in self.get_load_dirs()]: if os.path.isdir(d): return d return None def set_theme_attributes(self): theme = document.attributes.get('theme') if theme and 'themedir' not in document.attributes: themedir = self.find_config_dir('themes', theme) if themedir: document.attributes['themedir'] = themedir iconsdir = os.path.join(themedir, 'icons') if 'data-uri' in document.attributes and os.path.isdir(iconsdir): document.attributes['iconsdir'] = iconsdir else: message.warning('missing theme: %s' % theme, linenos=False) def load_miscellaneous(self,d): """Set miscellaneous configuration entries from dictionary 'd'.""" def set_if_int_ge(name, d, min_value): if name in d: try: val = int(d[name]) if not val >= min_value: raise ValueError, "not >= " + str(min_value) setattr(self, name, val) except ValueError: raise EAsciiDoc, 'illegal [miscellaneous] %s entry' % name set_if_int_ge('tabsize', d, 0) set_if_int_ge('textwidth', d, 1) # DEPRECATED: Old tables only. if 'pagewidth' in d: try: val = float(d['pagewidth']) self.pagewidth = val except ValueError: raise EAsciiDoc, 'illegal [miscellaneous] pagewidth entry' if 'pageunits' in d: self.pageunits = d['pageunits'] if 'outfilesuffix' in d: self.outfilesuffix = d['outfilesuffix'] if 'newline' in d: # Convert escape sequences to their character values. self.newline = literal_eval('"'+d['newline']+'"') if 'subsnormal' in d: self.subsnormal = parse_options(d['subsnormal'],SUBS_OPTIONS, 'illegal [%s] %s: %s' % ('miscellaneous','subsnormal',d['subsnormal'])) if 'subsverbatim' in d: self.subsverbatim = parse_options(d['subsverbatim'],SUBS_OPTIONS, 'illegal [%s] %s: %s' % ('miscellaneous','subsverbatim',d['subsverbatim'])) def validate(self): """Check the configuration for internal consistancy. Called after all configuration files have been loaded.""" message.linenos = False # Disable document line numbers. # Heuristic to validate that at least one configuration file was loaded. if not self.specialchars or not self.tags or not lists: raise EAsciiDoc,'incomplete configuration files' # Check special characters are only one character long. for k in self.specialchars.keys(): if len(k) != 1: raise EAsciiDoc,'[specialcharacters] ' \ 'must be a single character: %s' % k # Check all special words have a corresponding inline macro body. for macro in self.specialwords.values(): if not is_name(macro): raise EAsciiDoc,'illegal special word name: %s' % macro if not macro in self.sections: message.warning('missing special word macro: [%s]' % macro) # Check all text quotes have a corresponding tag. for q in self.quotes.keys()[:]: tag = self.quotes[q] if not tag: del self.quotes[q] # Undefine quote. else: if tag[0] == '#': tag = tag[1:] if not tag in self.tags: message.warning('[quotes] %s missing tag definition: %s' % (q,tag)) # Check all specialsections section names exist. for k,v in self.specialsections.items(): if not v: del self.specialsections[k] elif not v in self.sections: message.warning('missing specialsections section: [%s]' % v) paragraphs.validate() lists.validate() blocks.validate() tables_OLD.validate() tables.validate() macros.validate() message.linenos = None def entries_section(self,section_name): """ Return True if conf file section contains entries, not a markup template. """ for name in self.ENTRIES_SECTIONS: if re.match(name,section_name): return True return False def dump(self): """Dump configuration to stdout.""" # Header. hdr = '' hdr = hdr + '#' + writer.newline hdr = hdr + '# Generated by AsciiDoc %s for %s %s.%s' % \ (VERSION,document.backend,document.doctype,writer.newline) t = time.asctime(time.localtime(time.time())) hdr = hdr + '# %s%s' % (t,writer.newline) hdr = hdr + '#' + writer.newline sys.stdout.write(hdr) # Dump special sections. # Dump only the configuration file and command-line attributes. # [miscellanous] entries are dumped as part of the [attributes]. d = {} d.update(self.conf_attrs) d.update(self.cmd_attrs) dump_section('attributes',d) Title.dump() dump_section('quotes',self.quotes) dump_section('specialcharacters',self.specialchars) d = {} for k,v in self.specialwords.items(): if v in d: d[v] = '%s "%s"' % (d[v],k) # Append word list. else: d[v] = '"%s"' % k dump_section('specialwords',d) dump_section('replacements',self.replacements) dump_section('replacements2',self.replacements2) dump_section('replacements3',self.replacements3) dump_section('specialsections',self.specialsections) d = {} for k,v in self.tags.items(): d[k] = '%s|%s' % v dump_section('tags',d) paragraphs.dump() lists.dump() blocks.dump() tables_OLD.dump() tables.dump() macros.dump() # Dump remaining sections. for k in self.sections.keys(): if not self.entries_section(k): sys.stdout.write('[%s]%s' % (k,writer.newline)) for line in self.sections[k]: sys.stdout.write('%s%s' % (line,writer.newline)) sys.stdout.write(writer.newline) def subs_section(self,section,d): """Section attribute substitution using attributes from document.attributes and 'd'. Lines containing undefinded attributes are deleted.""" if section in self.sections: return subs_attrs(self.sections[section],d) else: message.warning('missing section: [%s]' % section) return () def parse_tags(self): """Parse [tags] section entries into self.tags dictionary.""" d = {} parse_entries(self.sections.get('tags',()),d) for k,v in d.items(): if v is None: if k in self.tags: del self.tags[k] elif v == '': self.tags[k] = (None,None) else: mo = re.match(r'(?P<stag>.*)\|(?P<etag>.*)',v) if mo: self.tags[k] = (mo.group('stag'), mo.group('etag')) else: raise EAsciiDoc,'[tag] %s value malformed' % k def tag(self, name, d=None): """Returns (starttag,endtag) tuple named name from configuration file [tags] section. Raise error if not found. If a dictionary 'd' is passed then merge with document attributes and perform attribute substitution on tags.""" if not name in self.tags: raise EAsciiDoc, 'missing tag: %s' % name stag,etag = self.tags[name] if d is not None: # TODO: Should we warn if substitution drops a tag? if stag: stag = subs_attrs(stag,d) if etag: etag = subs_attrs(etag,d) if stag is None: stag = '' if etag is None: etag = '' return (stag,etag) def parse_specialsections(self): """Parse specialsections section to self.specialsections dictionary.""" # TODO: This is virtually the same as parse_replacements() and should # be factored to single routine. d = {} parse_entries(self.sections.get('specialsections',()),d,unquote=True) for pat,sectname in d.items(): pat = strip_quotes(pat) if not is_re(pat): raise EAsciiDoc,'[specialsections] entry ' \ 'is not a valid regular expression: %s' % pat if sectname is None: if pat in self.specialsections: del self.specialsections[pat] else: self.specialsections[pat] = sectname def parse_replacements(self,sect='replacements'): """Parse replacements section into self.replacements dictionary.""" d = OrderedDict() parse_entries(self.sections.get(sect,()), d, unquote=True) for pat,rep in d.items(): if not self.set_replacement(pat, rep, getattr(self,sect)): raise EAsciiDoc,'[%s] entry in %s is not a valid' \ ' regular expression: %s' % (sect,self.fname,pat) @staticmethod def set_replacement(pat, rep, replacements): """Add pattern and replacement to replacements dictionary.""" pat = strip_quotes(pat) if not is_re(pat): return False if rep is None: if pat in replacements: del replacements[pat] else: replacements[pat] = strip_quotes(rep) return True def subs_replacements(self,s,sect='replacements'): """Substitute patterns from self.replacements in 's'.""" result = s for pat,rep in getattr(self,sect).items(): result = re.sub(pat, rep, result) return result def parse_specialwords(self): """Parse special words section into self.specialwords dictionary.""" reo = re.compile(r'(?:\s|^)(".+?"|[^"\s]+)(?=\s|$)') for line in self.sections.get('specialwords',()): e = parse_entry(line) if not e: raise EAsciiDoc,'[specialwords] entry in %s is malformed: %s' \ % (self.fname,line) name,wordlist = e if not is_name(name): raise EAsciiDoc,'[specialwords] name in %s is illegal: %s' \ % (self.fname,name) if wordlist is None: # Undefine all words associated with 'name'. for k,v in self.specialwords.items(): if v == name: del self.specialwords[k] else: words = reo.findall(wordlist) for word in words: word = strip_quotes(word) if not is_re(word): raise EAsciiDoc,'[specialwords] entry in %s ' \ 'is not a valid regular expression: %s' \ % (self.fname,word) self.specialwords[word] = name def subs_specialchars(self,s): """Perform special character substitution on string 's'.""" """It may seem like a good idea to escape special characters with a '\' character, the reason we don't is because the escape character itself then has to be escaped and this makes including code listings problematic. Use the predefined {amp},{lt},{gt} attributes instead.""" result = '' for ch in s: result = result + self.specialchars.get(ch,ch) return result def subs_specialchars_reverse(self,s): """Perform reverse special character substitution on string 's'.""" result = s for k,v in self.specialchars.items(): result = result.replace(v, k) return result def subs_specialwords(self,s): """Search for word patterns from self.specialwords in 's' and substitute using corresponding macro.""" result = s for word in self.specialwords.keys(): result = re.sub(word, _subs_specialwords, result) return result def expand_templates(self,entries): """Expand any template::[] macros in a list of section entries.""" result = [] for line in entries: mo = macros.match('+',r'template',line) if mo: s = mo.group('attrlist') if s in self.sections: result += self.expand_templates(self.sections[s]) else: message.warning('missing section: [%s]' % s) result.append(line) else: result.append(line) return result def expand_all_templates(self): for k,v in self.sections.items(): self.sections[k] = self.expand_templates(v) def section2tags(self, section, d={}, skipstart=False, skipend=False): """Perform attribute substitution on 'section' using document attributes plus 'd' attributes. Return tuple (stag,etag) containing pre and post | placeholder tags. 'skipstart' and 'skipend' are used to suppress substitution.""" assert section is not None if section in self.sections: body = self.sections[section] else: message.warning('missing section: [%s]' % section) body = () # Split macro body into start and end tag lists. stag = [] etag = [] in_stag = True for s in body: if in_stag: mo = re.match(r'(?P<stag>.*)\|(?P<etag>.*)',s) if mo: if mo.group('stag'): stag.append(mo.group('stag')) if mo.group('etag'): etag.append(mo.group('etag')) in_stag = False else: stag.append(s) else: etag.append(s) # Do attribute substitution last so {brkbar} can be used to escape |. # But don't do attribute substitution on title -- we've already done it. title = d.get('title') if title: d['title'] = chr(0) # Replace with unused character. if not skipstart: stag = subs_attrs(stag, d) if not skipend: etag = subs_attrs(etag, d) # Put the {title} back. if title: stag = map(lambda x: x.replace(chr(0), title), stag) etag = map(lambda x: x.replace(chr(0), title), etag) d['title'] = title return (stag,etag) #--------------------------------------------------------------------------- # Deprecated old table classes follow. # Naming convention is an _OLD name suffix. # These will be removed from future versions of AsciiDoc def join_lines_OLD(lines): """Return a list in which lines terminated with the backslash line continuation character are joined.""" result = [] s = '' continuation = False for line in lines: if line and line[-1] == '\\': s = s + line[:-1] continuation = True continue if continuation: result.append(s+line) s = '' continuation = False else: result.append(line) if continuation: result.append(s) return result class Column_OLD: """Table column.""" def __init__(self): self.colalign = None # 'left','right','center' self.rulerwidth = None self.colwidth = None # Output width in page units. class Table_OLD(AbstractBlock): COL_STOP = r"(`|'|\.)" # RE. ALIGNMENTS = {'`':'left', "'":'right', '.':'center'} FORMATS = ('fixed','csv','dsv') def __init__(self): AbstractBlock.__init__(self) self.CONF_ENTRIES += ('template','fillchar','format','colspec', 'headrow','footrow','bodyrow','headdata', 'footdata', 'bodydata') # Configuration parameters. self.fillchar=None self.format=None # 'fixed','csv','dsv' self.colspec=None self.headrow=None self.footrow=None self.bodyrow=None self.headdata=None self.footdata=None self.bodydata=None # Calculated parameters. self.underline=None # RE matching current table underline. self.isnumeric=False # True if numeric ruler. self.tablewidth=None # Optional table width scale factor. self.columns=[] # List of Columns. # Other. self.check_msg='' # Message set by previous self.validate() call. def load(self,name,entries): AbstractBlock.load(self,name,entries) """Update table definition from section entries in 'entries'.""" for k,v in entries.items(): if k == 'fillchar': if v and len(v) == 1: self.fillchar = v else: raise EAsciiDoc,'malformed table fillchar: %s' % v elif k == 'format': if v in Table_OLD.FORMATS: self.format = v else: raise EAsciiDoc,'illegal table format: %s' % v elif k == 'colspec': self.colspec = v elif k == 'headrow': self.headrow = v elif k == 'footrow': self.footrow = v elif k == 'bodyrow': self.bodyrow = v elif k == 'headdata': self.headdata = v elif k == 'footdata': self.footdata = v elif k == 'bodydata': self.bodydata = v def dump(self): AbstractBlock.dump(self) write = lambda s: sys.stdout.write('%s%s' % (s,writer.newline)) write('fillchar='+self.fillchar) write('format='+self.format) if self.colspec: write('colspec='+self.colspec) if self.headrow: write('headrow='+self.headrow) if self.footrow: write('footrow='+self.footrow) write('bodyrow='+self.bodyrow) if self.headdata: write('headdata='+self.headdata) if self.footdata: write('footdata='+self.footdata) write('bodydata='+self.bodydata) write('') def validate(self): AbstractBlock.validate(self) """Check table definition and set self.check_msg if invalid else set self.check_msg to blank string.""" # Check global table parameters. if config.textwidth is None: self.check_msg = 'missing [miscellaneous] textwidth entry' elif config.pagewidth is None: self.check_msg = 'missing [miscellaneous] pagewidth entry' elif config.pageunits is None: self.check_msg = 'missing [miscellaneous] pageunits entry' elif self.headrow is None: self.check_msg = 'missing headrow entry' elif self.footrow is None: self.check_msg = 'missing footrow entry' elif self.bodyrow is None: self.check_msg = 'missing bodyrow entry' elif self.headdata is None: self.check_msg = 'missing headdata entry' elif self.footdata is None: self.check_msg = 'missing footdata entry' elif self.bodydata is None: self.check_msg = 'missing bodydata entry' else: # No errors. self.check_msg = '' def isnext(self): return AbstractBlock.isnext(self) def parse_ruler(self,ruler): """Parse ruler calculating underline and ruler column widths.""" fc = re.escape(self.fillchar) # Strip and save optional tablewidth from end of ruler. mo = re.match(r'^(.*'+fc+r'+)([\d\.]+)$',ruler) if mo: ruler = mo.group(1) self.tablewidth = float(mo.group(2)) self.attributes['tablewidth'] = str(float(self.tablewidth)) else: self.tablewidth = None self.attributes['tablewidth'] = '100.0' # Guess whether column widths are specified numerically or not. if ruler[1] != self.fillchar: # If the first column does not start with a fillchar then numeric. self.isnumeric = True elif ruler[1:] == self.fillchar*len(ruler[1:]): # The case of one column followed by fillchars is numeric. self.isnumeric = True else: self.isnumeric = False # Underlines must be 3 or more fillchars. self.underline = r'^' + fc + r'{3,}$' splits = re.split(self.COL_STOP,ruler)[1:] # Build self.columns. for i in range(0,len(splits),2): c = Column_OLD() c.colalign = self.ALIGNMENTS[splits[i]] s = splits[i+1] if self.isnumeric: # Strip trailing fillchars. s = re.sub(fc+r'+$','',s) if s == '': c.rulerwidth = None else: try: val = int(s) if not val > 0: raise ValueError, 'not > 0' c.rulerwidth = val except ValueError: raise EAsciiDoc, 'malformed ruler: bad width' else: # Calculate column width from inter-fillchar intervals. if not re.match(r'^'+fc+r'+$',s): raise EAsciiDoc,'malformed ruler: illegal fillchars' c.rulerwidth = len(s)+1 self.columns.append(c) # Fill in unspecified ruler widths. if self.isnumeric: if self.columns[0].rulerwidth is None: prevwidth = 1 for c in self.columns: if c.rulerwidth is None: c.rulerwidth = prevwidth prevwidth = c.rulerwidth def build_colspecs(self): """Generate colwidths and colspecs. This can only be done after the table arguments have been parsed since we use the table format.""" self.attributes['cols'] = len(self.columns) # Calculate total ruler width. totalwidth = 0 for c in self.columns: totalwidth = totalwidth + c.rulerwidth if totalwidth <= 0: raise EAsciiDoc,'zero width table' # Calculate marked up colwidths from rulerwidths. for c in self.columns: # Convert ruler width to output page width. width = float(c.rulerwidth) if self.format == 'fixed': if self.tablewidth is None: # Size proportional to ruler width. colfraction = width/config.textwidth else: # Size proportional to page width. colfraction = width/totalwidth else: # Size proportional to page width. colfraction = width/totalwidth c.colwidth = colfraction * config.pagewidth # To page units. if self.tablewidth is not None: c.colwidth = c.colwidth * self.tablewidth # Scale factor. if self.tablewidth > 1: c.colwidth = c.colwidth/100 # tablewidth is in percent. # Build colspecs. if self.colspec: cols = [] i = 0 for c in self.columns: i += 1 self.attributes['colalign'] = c.colalign self.attributes['colwidth'] = str(int(c.colwidth)) self.attributes['colnumber'] = str(i + 1) s = subs_attrs(self.colspec,self.attributes) if not s: message.warning('colspec dropped: contains undefined attribute') else: cols.append(s) self.attributes['colspecs'] = writer.newline.join(cols) def split_rows(self,rows): """Return a two item tuple containing a list of lines up to but not including the next underline (continued lines are joined ) and the tuple of all lines after the underline.""" reo = re.compile(self.underline) i = 0 while not reo.match(rows[i]): i = i+1 if i == 0: raise EAsciiDoc,'missing table rows' if i >= len(rows): raise EAsciiDoc,'closing [%s] underline expected' % self.defname return (join_lines_OLD(rows[:i]), rows[i+1:]) def parse_rows(self, rows, rtag, dtag): """Parse rows list using the row and data tags. Returns a substituted list of output lines.""" result = [] # Source rows are parsed as single block, rather than line by line, to # allow the CSV reader to handle multi-line rows. if self.format == 'fixed': rows = self.parse_fixed(rows) elif self.format == 'csv': rows = self.parse_csv(rows) elif self.format == 'dsv': rows = self.parse_dsv(rows) else: assert True,'illegal table format' # Substitute and indent all data in all rows. stag,etag = subs_tag(rtag,self.attributes) for row in rows: result.append(' '+stag) for data in self.subs_row(row,dtag): result.append(' '+data) result.append(' '+etag) return result def subs_row(self, data, dtag): """Substitute the list of source row data elements using the data tag. Returns a substituted list of output table data items.""" result = [] if len(data) < len(self.columns): message.warning('fewer row data items then table columns') if len(data) > len(self.columns): message.warning('more row data items than table columns') for i in range(len(self.columns)): if i > len(data) - 1: d = '' # Fill missing column data with blanks. else: d = data[i] c = self.columns[i] self.attributes['colalign'] = c.colalign self.attributes['colwidth'] = str(int(c.colwidth)) self.attributes['colnumber'] = str(i + 1) stag,etag = subs_tag(dtag,self.attributes) # Insert AsciiDoc line break (' +') where row data has newlines # ('\n'). This is really only useful when the table format is csv # and the output markup is HTML. It's also a bit dubious in that it # assumes the user has not modified the shipped line break pattern. subs = self.get_subs()[0] if 'replacements2' in subs: # Insert line breaks in cell data. d = re.sub(r'(?m)\n',r' +\n',d) d = d.split('\n') # So writer.newline is written. else: d = [d] result = result + [stag] + Lex.subs(d,subs) + [etag] return result def parse_fixed(self,rows): """Parse the list of source table rows. Each row item in the returned list contains a list of cell data elements.""" result = [] for row in rows: data = [] start = 0 # build an encoded representation row = char_decode(row) for c in self.columns: end = start + c.rulerwidth if c is self.columns[-1]: # Text in last column can continue forever. # Use the encoded string to slice, but convert back # to plain string before further processing data.append(char_encode(row[start:]).strip()) else: data.append(char_encode(row[start:end]).strip()) start = end result.append(data) return result def parse_csv(self,rows): """Parse the list of source table rows. Each row item in the returned list contains a list of cell data elements.""" import StringIO import csv result = [] rdr = csv.reader(StringIO.StringIO('\r\n'.join(rows)), skipinitialspace=True) try: for row in rdr: result.append(row) except Exception: raise EAsciiDoc,'csv parse error: %s' % row return result def parse_dsv(self,rows): """Parse the list of source table rows. Each row item in the returned list contains a list of cell data elements.""" separator = self.attributes.get('separator',':') separator = literal_eval('"'+separator+'"') if len(separator) != 1: raise EAsciiDoc,'malformed dsv separator: %s' % separator # TODO If separator is preceeded by an odd number of backslashes then # it is escaped and should not delimit. result = [] for row in rows: # Skip blank lines if row == '': continue # Unescape escaped characters. row = literal_eval('"'+row.replace('"','\\"')+'"') data = row.split(separator) data = [s.strip() for s in data] result.append(data) return result def translate(self): message.deprecated('old tables syntax') AbstractBlock.translate(self) # Reset instance specific properties. self.underline = None self.columns = [] attrs = {} BlockTitle.consume(attrs) # Add relevant globals to table substitutions. attrs['pagewidth'] = str(config.pagewidth) attrs['pageunits'] = config.pageunits # Mix in document attribute list. AttributeList.consume(attrs) # Validate overridable attributes. for k,v in attrs.items(): if k == 'format': if v not in self.FORMATS: raise EAsciiDoc, 'illegal [%s] %s: %s' % (self.defname,k,v) self.format = v elif k == 'tablewidth': try: self.tablewidth = float(attrs['tablewidth']) except Exception: raise EAsciiDoc, 'illegal [%s] %s: %s' % (self.defname,k,v) self.merge_attributes(attrs) # Parse table ruler. ruler = reader.read() assert re.match(self.delimiter,ruler) self.parse_ruler(ruler) # Read the entire table. table = [] while True: line = reader.read_next() # Table terminated by underline followed by a blank line or EOF. if len(table) > 0 and re.match(self.underline,table[-1]): if line in ('',None): break; if line is None: raise EAsciiDoc,'closing [%s] underline expected' % self.defname table.append(reader.read()) # EXPERIMENTAL: The number of lines in the table, requested by Benjamin Klum. self.attributes['rows'] = str(len(table)) if self.check_msg: # Skip if table definition was marked invalid. message.warning('skipping [%s] table: %s' % (self.defname,self.check_msg)) return self.push_blockname('table') # Generate colwidths and colspecs. self.build_colspecs() # Generate headrows, footrows, bodyrows. # Headrow, footrow and bodyrow data replaces same named attributes in # the table markup template. In order to ensure this data does not get # a second attribute substitution (which would interfere with any # already substituted inline passthroughs) unique placeholders are used # (the tab character does not appear elsewhere since it is expanded on # input) which are replaced after template attribute substitution. headrows = footrows = [] bodyrows,table = self.split_rows(table) if table: headrows = bodyrows bodyrows,table = self.split_rows(table) if table: footrows,table = self.split_rows(table) if headrows: headrows = self.parse_rows(headrows, self.headrow, self.headdata) headrows = writer.newline.join(headrows) self.attributes['headrows'] = '\x07headrows\x07' if footrows: footrows = self.parse_rows(footrows, self.footrow, self.footdata) footrows = writer.newline.join(footrows) self.attributes['footrows'] = '\x07footrows\x07' bodyrows = self.parse_rows(bodyrows, self.bodyrow, self.bodydata) bodyrows = writer.newline.join(bodyrows) self.attributes['bodyrows'] = '\x07bodyrows\x07' table = subs_attrs(config.sections[self.template],self.attributes) table = writer.newline.join(table) # Before we finish replace the table head, foot and body place holders # with the real data. if headrows: table = table.replace('\x07headrows\x07', headrows, 1) if footrows: table = table.replace('\x07footrows\x07', footrows, 1) table = table.replace('\x07bodyrows\x07', bodyrows, 1) writer.write(table,trace='table') self.pop_blockname() class Tables_OLD(AbstractBlocks): """List of tables.""" BLOCK_TYPE = Table_OLD PREFIX = 'old_tabledef-' def __init__(self): AbstractBlocks.__init__(self) def load(self,sections): AbstractBlocks.load(self,sections) def validate(self): # Does not call AbstractBlocks.validate(). # Check we have a default table definition, for i in range(len(self.blocks)): if self.blocks[i].defname == 'old_tabledef-default': default = self.blocks[i] break else: raise EAsciiDoc,'missing section: [OLD_tabledef-default]' # Set default table defaults. if default.format is None: default.subs = 'fixed' # Propagate defaults to unspecified table parameters. for b in self.blocks: if b is not default: if b.fillchar is None: b.fillchar = default.fillchar if b.format is None: b.format = default.format if b.template is None: b.template = default.template if b.colspec is None: b.colspec = default.colspec if b.headrow is None: b.headrow = default.headrow if b.footrow is None: b.footrow = default.footrow if b.bodyrow is None: b.bodyrow = default.bodyrow if b.headdata is None: b.headdata = default.headdata if b.footdata is None: b.footdata = default.footdata if b.bodydata is None: b.bodydata = default.bodydata # Check all tables have valid fill character. for b in self.blocks: if not b.fillchar or len(b.fillchar) != 1: raise EAsciiDoc,'[%s] missing or illegal fillchar' % b.defname # Build combined tables delimiter patterns and assign defaults. delimiters = [] for b in self.blocks: # Ruler is: # (ColStop,(ColWidth,FillChar+)?)+, FillChar+, TableWidth? b.delimiter = r'^(' + Table_OLD.COL_STOP \ + r'(\d*|' + re.escape(b.fillchar) + r'*)' \ + r')+' \ + re.escape(b.fillchar) + r'+' \ + '([\d\.]*)$' delimiters.append(b.delimiter) if not b.headrow: b.headrow = b.bodyrow if not b.footrow: b.footrow = b.bodyrow if not b.headdata: b.headdata = b.bodydata if not b.footdata: b.footdata = b.bodydata self.delimiters = re_join(delimiters) # Check table definitions are valid. for b in self.blocks: b.validate() if config.verbose: if b.check_msg: message.warning('[%s] table definition: %s' % (b.defname,b.check_msg)) # End of deprecated old table classes. #--------------------------------------------------------------------------- #--------------------------------------------------------------------------- # filter and theme plugin commands. #--------------------------------------------------------------------------- import shutil, zipfile def die(msg): message.stderr(msg) sys.exit(1) def extract_zip(zip_file, destdir): """ Unzip Zip file to destination directory. Throws exception if error occurs. """ zipo = zipfile.ZipFile(zip_file, 'r') try: for zi in zipo.infolist(): outfile = zi.filename if not outfile.endswith('/'): d, outfile = os.path.split(outfile) directory = os.path.normpath(os.path.join(destdir, d)) if not os.path.isdir(directory): os.makedirs(directory) outfile = os.path.join(directory, outfile) perms = (zi.external_attr >> 16) & 0777 message.verbose('extracting: %s' % outfile) flags = os.O_CREAT | os.O_WRONLY if sys.platform == 'win32': flags |= os.O_BINARY if perms == 0: # Zip files created under Windows do not include permissions. fh = os.open(outfile, flags) else: fh = os.open(outfile, flags, perms) try: os.write(fh, zipo.read(zi.filename)) finally: os.close(fh) finally: zipo.close() def create_zip(zip_file, src, skip_hidden=False): """ Create Zip file. If src is a directory archive all contained files and subdirectories, if src is a file archive the src file. Files and directories names starting with . are skipped if skip_hidden is True. Throws exception if error occurs. """ zipo = zipfile.ZipFile(zip_file, 'w') try: if os.path.isfile(src): arcname = os.path.basename(src) message.verbose('archiving: %s' % arcname) zipo.write(src, arcname, zipfile.ZIP_DEFLATED) elif os.path.isdir(src): srcdir = os.path.abspath(src) if srcdir[-1] != os.path.sep: srcdir += os.path.sep for root, dirs, files in os.walk(srcdir): arcroot = os.path.abspath(root)[len(srcdir):] if skip_hidden: for d in dirs[:]: if d.startswith('.'): message.verbose('skipping: %s' % os.path.join(arcroot, d)) del dirs[dirs.index(d)] for f in files: filename = os.path.join(root,f) arcname = os.path.join(arcroot, f) if skip_hidden and f.startswith('.'): message.verbose('skipping: %s' % arcname) continue message.verbose('archiving: %s' % arcname) zipo.write(filename, arcname, zipfile.ZIP_DEFLATED) else: raise ValueError,'src must specify directory or file: %s' % src finally: zipo.close() class Plugin: """ --filter and --theme option commands. """ CMDS = ('install','remove','list','build') type = None # 'backend', 'filter' or 'theme'. @staticmethod def get_dir(): """ Return plugins path (.asciidoc/filters or .asciidoc/themes) in user's home direcory or None if user home not defined. """ result = userdir() if result: result = os.path.join(result, '.asciidoc', Plugin.type+'s') return result @staticmethod def install(args): """ Install plugin Zip file. args[0] is plugin zip file path. args[1] is optional destination plugins directory. """ if len(args) not in (1,2): die('invalid number of arguments: --%s install %s' % (Plugin.type, ' '.join(args))) zip_file = args[0] if not os.path.isfile(zip_file): die('file not found: %s' % zip_file) reo = re.match(r'^\w+',os.path.split(zip_file)[1]) if not reo: die('file name does not start with legal %s name: %s' % (Plugin.type, zip_file)) plugin_name = reo.group() if len(args) == 2: plugins_dir = args[1] if not os.path.isdir(plugins_dir): die('directory not found: %s' % plugins_dir) else: plugins_dir = Plugin.get_dir() if not plugins_dir: die('user home directory is not defined') plugin_dir = os.path.join(plugins_dir, plugin_name) if os.path.exists(plugin_dir): die('%s is already installed: %s' % (Plugin.type, plugin_dir)) try: os.makedirs(plugin_dir) except Exception,e: die('failed to create %s directory: %s' % (Plugin.type, str(e))) try: extract_zip(zip_file, plugin_dir) except Exception,e: if os.path.isdir(plugin_dir): shutil.rmtree(plugin_dir) die('failed to extract %s: %s' % (Plugin.type, str(e))) @staticmethod def remove(args): """ Delete plugin directory. args[0] is plugin name. args[1] is optional plugin directory (defaults to ~/.asciidoc/<plugin_name>). """ if len(args) not in (1,2): die('invalid number of arguments: --%s remove %s' % (Plugin.type, ' '.join(args))) plugin_name = args[0] if not re.match(r'^\w+$',plugin_name): die('illegal %s name: %s' % (Plugin.type, plugin_name)) if len(args) == 2: d = args[1] if not os.path.isdir(d): die('directory not found: %s' % d) else: d = Plugin.get_dir() if not d: die('user directory is not defined') plugin_dir = os.path.join(d, plugin_name) if not os.path.isdir(plugin_dir): die('cannot find %s: %s' % (Plugin.type, plugin_dir)) try: message.verbose('removing: %s' % plugin_dir) shutil.rmtree(plugin_dir) except Exception,e: die('failed to delete %s: %s' % (Plugin.type, str(e))) @staticmethod def list(args): """ List all plugin directories (global and local). """ for d in [os.path.join(d, Plugin.type+'s') for d in config.get_load_dirs()]: if os.path.isdir(d): for f in os.walk(d).next()[1]: message.stdout(os.path.join(d,f)) @staticmethod def build(args): """ Create plugin Zip file. args[0] is Zip file name. args[1] is plugin directory. """ if len(args) != 2: die('invalid number of arguments: --%s build %s' % (Plugin.type, ' '.join(args))) zip_file = args[0] plugin_source = args[1] if not (os.path.isdir(plugin_source) or os.path.isfile(plugin_source)): die('plugin source not found: %s' % plugin_source) try: create_zip(zip_file, plugin_source, skip_hidden=True) except Exception,e: die('failed to create %s: %s' % (zip_file, str(e))) #--------------------------------------------------------------------------- # Application code. #--------------------------------------------------------------------------- # Constants # --------- APP_FILE = None # This file's full path. APP_DIR = None # This file's directory. USER_DIR = None # ~/.asciidoc # Global configuration files directory (set by Makefile build target). CONF_DIR = '/etc/asciidoc' HELP_FILE = 'help.conf' # Default (English) help file. # Globals # ------- document = Document() # The document being processed. config = Config() # Configuration file reader. reader = Reader() # Input stream line reader. writer = Writer() # Output stream line writer. message = Message() # Message functions. paragraphs = Paragraphs() # Paragraph definitions. lists = Lists() # List definitions. blocks = DelimitedBlocks() # DelimitedBlock definitions. tables_OLD = Tables_OLD() # Table_OLD definitions. tables = Tables() # Table definitions. macros = Macros() # Macro definitions. calloutmap = CalloutMap() # Coordinates callouts and callout list. trace = Trace() # Implements trace attribute processing. ### Used by asciidocapi.py ### # List of message strings written to stderr. messages = message.messages def asciidoc(backend, doctype, confiles, infile, outfile, options): """Convert AsciiDoc document to DocBook document of type doctype The AsciiDoc document is read from file object src the translated DocBook file written to file object dst.""" def load_conffiles(include=[], exclude=[]): # Load conf files specified on the command-line and by the conf-files attribute. files = document.attributes.get('conf-files','') files = [f.strip() for f in files.split('|') if f.strip()] files += confiles if files: for f in files: if os.path.isfile(f): config.load_file(f, include=include, exclude=exclude) else: raise EAsciiDoc,'missing configuration file: %s' % f try: document.attributes['python'] = sys.executable for f in config.filters: if not config.find_config_dir('filters', f): raise EAsciiDoc,'missing filter: %s' % f if doctype not in (None,'article','manpage','book'): raise EAsciiDoc,'illegal document type' # Set processing options. for o in options: if o == '-c': config.dumping = True if o == '-s': config.header_footer = False if o == '-v': config.verbose = True document.update_attributes() if '-e' not in options: # Load asciidoc.conf files in two passes: the first for attributes # the second for everything. This is so that locally set attributes # available are in the global asciidoc.conf if not config.load_from_dirs('asciidoc.conf',include=['attributes']): raise EAsciiDoc,'configuration file asciidoc.conf missing' load_conffiles(include=['attributes']) config.load_from_dirs('asciidoc.conf') if infile != '<stdin>': indir = os.path.dirname(infile) config.load_file('asciidoc.conf', indir, include=['attributes','titles','specialchars']) else: load_conffiles(include=['attributes','titles','specialchars']) document.update_attributes() # Check the infile exists. if infile != '<stdin>': if not os.path.isfile(infile): raise EAsciiDoc,'input file %s missing' % infile document.infile = infile AttributeList.initialize() # Open input file and parse document header. reader.tabsize = config.tabsize reader.open(infile) has_header = document.parse_header(doctype,backend) # doctype is now finalized. document.attributes['doctype-'+document.doctype] = '' config.set_theme_attributes() # Load backend configuration files. if '-e' not in options: f = document.backend + '.conf' conffile = config.load_backend() if not conffile: raise EAsciiDoc,'missing backend conf file: %s' % f document.attributes['backend-confdir'] = os.path.dirname(conffile) # backend is now known. document.attributes['backend-'+document.backend] = '' document.attributes[document.backend+'-'+document.doctype] = '' doc_conffiles = [] if '-e' not in options: # Load filters and language file. config.load_filters() document.load_lang() if infile != '<stdin>': # Load local conf files (files in the source file directory). config.load_file('asciidoc.conf', indir) config.load_backend([indir]) config.load_filters([indir]) # Load document specific configuration files. f = os.path.splitext(infile)[0] doc_conffiles = [ f for f in (f+'.conf', f+'-'+document.backend+'.conf') if os.path.isfile(f) ] for f in doc_conffiles: config.load_file(f) load_conffiles() # Build asciidoc-args attribute. args = '' # Add custom conf file arguments. for f in doc_conffiles + confiles: args += ' --conf-file "%s"' % f # Add command-line and header attributes. attrs = {} attrs.update(AttributeEntry.attributes) attrs.update(config.cmd_attrs) if 'title' in attrs: # Don't pass the header title. del attrs['title'] for k,v in attrs.items(): if v: args += ' --attribute "%s=%s"' % (k,v) else: args += ' --attribute "%s"' % k document.attributes['asciidoc-args'] = args # Build outfile name. if outfile is None: outfile = os.path.splitext(infile)[0] + '.' + document.backend if config.outfilesuffix: # Change file extension. outfile = os.path.splitext(outfile)[0] + config.outfilesuffix document.outfile = outfile # Document header attributes override conf file attributes. document.attributes.update(AttributeEntry.attributes) document.update_attributes() # Set the default embedded icons directory. if 'data-uri' in document.attributes and not os.path.isdir(document.attributes['iconsdir']): document.attributes['iconsdir'] = os.path.join( document.attributes['asciidoc-confdir'], 'images/icons') # Configuration is fully loaded. config.expand_all_templates() # Check configuration for consistency. config.validate() # Initialize top level block name. if document.attributes.get('blockname'): AbstractBlock.blocknames.append(document.attributes['blockname']) paragraphs.initialize() lists.initialize() if config.dumping: config.dump() else: writer.newline = config.newline try: writer.open(outfile, reader.bom) try: document.translate(has_header) # Generate the output. finally: writer.close() finally: reader.closefile() except KeyboardInterrupt: raise except Exception,e: # Cleanup. if outfile and outfile != '<stdout>' and os.path.isfile(outfile): os.unlink(outfile) # Build and print error description. msg = 'FAILED: ' if reader.cursor: msg = message.format('', msg) if isinstance(e, EAsciiDoc): message.stderr('%s%s' % (msg,str(e))) else: if __name__ == '__main__': message.stderr(msg+'unexpected error:') message.stderr('-'*60) traceback.print_exc(file=sys.stderr) message.stderr('-'*60) else: message.stderr('%sunexpected error: %s' % (msg,str(e))) sys.exit(1) def usage(msg=''): if msg: message.stderr(msg) show_help('default', sys.stderr) def show_help(topic, f=None): """Print help topic to file object f.""" if f is None: f = sys.stdout # Select help file. lang = config.cmd_attrs.get('lang') if lang and lang != 'en': help_file = 'help-' + lang + '.conf' else: help_file = HELP_FILE # Print [topic] section from help file. config.load_from_dirs(help_file) if len(config.sections) == 0: # Default to English if specified language help files not found. help_file = HELP_FILE config.load_from_dirs(help_file) if len(config.sections) == 0: message.stderr('no help topics found') sys.exit(1) n = 0 for k in config.sections: if re.match(re.escape(topic), k): n += 1 lines = config.sections[k] if n == 0: if topic != 'topics': message.stderr('help topic not found: [%s] in %s' % (topic, help_file)) message.stderr('available help topics: %s' % ', '.join(config.sections.keys())) sys.exit(1) elif n > 1: message.stderr('ambiguous help topic: %s' % topic) else: for line in lines: print >>f, line ### Used by asciidocapi.py ### def execute(cmd,opts,args): """ Execute asciidoc with command-line options and arguments. cmd is asciidoc command or asciidoc.py path. opts and args conform to values returned by getopt.getopt(). Raises SystemExit if an error occurs. Doctests: 1. Check execution: >>> import StringIO >>> infile = StringIO.StringIO('Hello *{author}*') >>> outfile = StringIO.StringIO() >>> opts = [] >>> opts.append(('--backend','html4')) >>> opts.append(('--no-header-footer',None)) >>> opts.append(('--attribute','author=Joe Bloggs')) >>> opts.append(('--out-file',outfile)) >>> execute(__file__, opts, [infile]) >>> print outfile.getvalue() <p>Hello <strong>Joe Bloggs</strong></p> >>> """ config.init(cmd) if len(args) > 1: usage('Too many arguments') sys.exit(1) backend = None doctype = None confiles = [] outfile = None options = [] help_option = False for o,v in opts: if o in ('--help','-h'): help_option = True #DEPRECATED: --unsafe option. if o == '--unsafe': document.safe = False if o == '--safe': document.safe = True if o == '--version': print('asciidoc %s' % VERSION) sys.exit(0) if o in ('-b','--backend'): backend = v if o in ('-c','--dump-conf'): options.append('-c') if o in ('-d','--doctype'): doctype = v if o in ('-e','--no-conf'): options.append('-e') if o in ('-f','--conf-file'): confiles.append(v) if o == '--filter': config.filters.append(v) if o in ('-n','--section-numbers'): o = '-a' v = 'numbered' if o == '--theme': o = '-a' v = 'theme='+v if o in ('-a','--attribute'): e = parse_entry(v, allow_name_only=True) if not e: usage('Illegal -a option: %s' % v) sys.exit(1) k,v = e # A @ suffix denotes don't override existing document attributes. if v and v[-1] == '@': document.attributes[k] = v[:-1] else: config.cmd_attrs[k] = v if o in ('-o','--out-file'): outfile = v if o in ('-s','--no-header-footer'): options.append('-s') if o in ('-v','--verbose'): options.append('-v') if help_option: if len(args) == 0: show_help('default') else: show_help(args[-1]) sys.exit(0) if len(args) == 0 and len(opts) == 0: usage() sys.exit(0) if len(args) == 0: usage('No source file specified') sys.exit(1) stdin,stdout = sys.stdin,sys.stdout try: infile = args[0] if infile == '-': infile = '<stdin>' elif isinstance(infile, str): infile = os.path.abspath(infile) else: # Input file is file object from API call. sys.stdin = infile infile = '<stdin>' if outfile == '-': outfile = '<stdout>' elif isinstance(outfile, str): outfile = os.path.abspath(outfile) elif outfile is None: if infile == '<stdin>': outfile = '<stdout>' else: # Output file is file object from API call. sys.stdout = outfile outfile = '<stdout>' # Do the work. asciidoc(backend, doctype, confiles, infile, outfile, options) if document.has_errors: sys.exit(1) finally: sys.stdin,sys.stdout = stdin,stdout if __name__ == '__main__': # Process command line options. import getopt try: #DEPRECATED: --unsafe option. opts,args = getopt.getopt(sys.argv[1:], 'a:b:cd:ef:hno:svw:', ['attribute=','backend=','conf-file=','doctype=','dump-conf', 'help','no-conf','no-header-footer','out-file=', 'section-numbers','verbose','version','safe','unsafe', 'doctest','filter=','theme=']) except getopt.GetoptError: message.stderr('illegal command options') sys.exit(1) opt_names = [opt[0] for opt in opts] if '--doctest' in opt_names: # Run module doctests. import doctest options = doctest.NORMALIZE_WHITESPACE + doctest.ELLIPSIS failures,tries = doctest.testmod(optionflags=options) if failures == 0: message.stderr('All doctests passed') sys.exit(0) else: sys.exit(1) # Look for plugin management commands. count = 0 for o,v in opts: if o in ('-b','--backend','--filter','--theme'): if o == '-b': o = '--backend' plugin = o[2:] cmd = v if cmd not in Plugin.CMDS: continue count += 1 if count > 1: die('--backend, --filter and --theme options are mutually exclusive') if count == 1: # Execute plugin management commands. if not cmd: die('missing --%s command' % plugin) if cmd not in Plugin.CMDS: die('illegal --%s command: %s' % (plugin, cmd)) Plugin.type = plugin config.init(sys.argv[0]) config.verbose = bool(set(['-v','--verbose']) & set(opt_names)) getattr(Plugin,cmd)(args) else: # Execute asciidoc. try: execute(sys.argv[0],opts,args) except KeyboardInterrupt: sys.exit(1) ����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������asciidoc-8.6.9/asciidocapi.py�����������������������������������������������������������������������0000664�0001751�0001751�00000020350�12031161152�016276� 0����������������������������������������������������������������������������������������������������ustar �srackham������������������������srackham���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������#!/usr/bin/env python """ asciidocapi - AsciiDoc API wrapper class. The AsciiDocAPI class provides an API for executing asciidoc. Minimal example compiles `mydoc.txt` to `mydoc.html`: import asciidocapi asciidoc = asciidocapi.AsciiDocAPI() asciidoc.execute('mydoc.txt') - Full documentation in asciidocapi.txt. - See the doctests below for more examples. Doctests: 1. Check execution: >>> import StringIO >>> infile = StringIO.StringIO('Hello *{author}*') >>> outfile = StringIO.StringIO() >>> asciidoc = AsciiDocAPI() >>> asciidoc.options('--no-header-footer') >>> asciidoc.attributes['author'] = 'Joe Bloggs' >>> asciidoc.execute(infile, outfile, backend='html4') >>> print outfile.getvalue() <p>Hello <strong>Joe Bloggs</strong></p> >>> asciidoc.attributes['author'] = 'Bill Smith' >>> infile = StringIO.StringIO('Hello _{author}_') >>> outfile = StringIO.StringIO() >>> asciidoc.execute(infile, outfile, backend='docbook') >>> print outfile.getvalue() <simpara>Hello <emphasis>Bill Smith</emphasis></simpara> 2. Check error handling: >>> import StringIO >>> asciidoc = AsciiDocAPI() >>> infile = StringIO.StringIO('---------') >>> outfile = StringIO.StringIO() >>> asciidoc.execute(infile, outfile) Traceback (most recent call last): File "<stdin>", line 1, in <module> File "asciidocapi.py", line 189, in execute raise AsciiDocError(self.messages[-1]) AsciiDocError: ERROR: <stdin>: line 1: [blockdef-listing] missing closing delimiter Copyright (C) 2009 Stuart Rackham. Free use of this software is granted under the terms of the GNU General Public License (GPL). """ import sys,os,re,imp API_VERSION = '0.1.2' MIN_ASCIIDOC_VERSION = '8.4.1' # Minimum acceptable AsciiDoc version. def find_in_path(fname, path=None): """ Find file fname in paths. Return None if not found. """ if path is None: path = os.environ.get('PATH', '') for dir in path.split(os.pathsep): fpath = os.path.join(dir, fname) if os.path.isfile(fpath): return fpath else: return None class AsciiDocError(Exception): pass class Options(object): """ Stores asciidoc(1) command options. """ def __init__(self, values=[]): self.values = values[:] def __call__(self, name, value=None): """Shortcut for append method.""" self.append(name, value) def append(self, name, value=None): if type(value) in (int,float): value = str(value) self.values.append((name,value)) class Version(object): """ Parse and compare AsciiDoc version numbers. Instance attributes: string: String version number '<major>.<minor>[.<micro>][suffix]'. major: Integer major version number. minor: Integer minor version number. micro: Integer micro version number. suffix: Suffix (begins with non-numeric character) is ignored when comparing. Doctest examples: >>> Version('8.2.5') < Version('8.3 beta 1') True >>> Version('8.3.0') == Version('8.3. beta 1') True >>> Version('8.2.0') < Version('8.20') True >>> Version('8.20').major 8 >>> Version('8.20').minor 20 >>> Version('8.20').micro 0 >>> Version('8.20').suffix '' >>> Version('8.20 beta 1').suffix 'beta 1' """ def __init__(self, version): self.string = version reo = re.match(r'^(\d+)\.(\d+)(\.(\d+))?\s*(.*?)\s*$', self.string) if not reo: raise ValueError('invalid version number: %s' % self.string) groups = reo.groups() self.major = int(groups[0]) self.minor = int(groups[1]) self.micro = int(groups[3] or '0') self.suffix = groups[4] or '' def __cmp__(self, other): result = cmp(self.major, other.major) if result == 0: result = cmp(self.minor, other.minor) if result == 0: result = cmp(self.micro, other.micro) return result class AsciiDocAPI(object): """ AsciiDoc API class. """ def __init__(self, asciidoc_py=None): """ Locate and import asciidoc.py. Initialize instance attributes. """ self.options = Options() self.attributes = {} self.messages = [] # Search for the asciidoc command file. # Try ASCIIDOC_PY environment variable first. cmd = os.environ.get('ASCIIDOC_PY') if cmd: if not os.path.isfile(cmd): raise AsciiDocError('missing ASCIIDOC_PY file: %s' % cmd) elif asciidoc_py: # Next try path specified by caller. cmd = asciidoc_py if not os.path.isfile(cmd): raise AsciiDocError('missing file: %s' % cmd) else: # Try shell search paths. for fname in ['asciidoc.py','asciidoc.pyc','asciidoc']: cmd = find_in_path(fname) if cmd: break else: # Finally try current working directory. for cmd in ['asciidoc.py','asciidoc.pyc','asciidoc']: if os.path.isfile(cmd): break else: raise AsciiDocError('failed to locate asciidoc') self.cmd = os.path.realpath(cmd) self.__import_asciidoc() def __import_asciidoc(self, reload=False): ''' Import asciidoc module (script or compiled .pyc). See http://groups.google.com/group/asciidoc/browse_frm/thread/66e7b59d12cd2f91 for an explanation of why a seemingly straight-forward job turned out quite complicated. ''' if os.path.splitext(self.cmd)[1] in ['.py','.pyc']: sys.path.insert(0, os.path.dirname(self.cmd)) try: try: if reload: import __builtin__ # Because reload() is shadowed. __builtin__.reload(self.asciidoc) else: import asciidoc self.asciidoc = asciidoc except ImportError: raise AsciiDocError('failed to import ' + self.cmd) finally: del sys.path[0] else: # The import statement can only handle .py or .pyc files, have to # use imp.load_source() for scripts with other names. try: imp.load_source('asciidoc', self.cmd) import asciidoc self.asciidoc = asciidoc except ImportError: raise AsciiDocError('failed to import ' + self.cmd) if Version(self.asciidoc.VERSION) < Version(MIN_ASCIIDOC_VERSION): raise AsciiDocError( 'asciidocapi %s requires asciidoc %s or better' % (API_VERSION, MIN_ASCIIDOC_VERSION)) def execute(self, infile, outfile=None, backend=None): """ Compile infile to outfile using backend format. infile can outfile can be file path strings or file like objects. """ self.messages = [] opts = Options(self.options.values) if outfile is not None: opts('--out-file', outfile) if backend is not None: opts('--backend', backend) for k,v in self.attributes.items(): if v == '' or k[-1] in '!@': s = k elif v is None: # A None value undefines the attribute. s = k + '!' else: s = '%s=%s' % (k,v) opts('--attribute', s) args = [infile] # The AsciiDoc command was designed to process source text then # exit, there are globals and statics in asciidoc.py that have # to be reinitialized before each run -- hence the reload. self.__import_asciidoc(reload=True) try: try: self.asciidoc.execute(self.cmd, opts.values, args) finally: self.messages = self.asciidoc.messages[:] except SystemExit, e: if e.code: raise AsciiDocError(self.messages[-1]) if __name__ == "__main__": """ Run module doctests. """ import doctest options = doctest.NORMALIZE_WHITESPACE + doctest.ELLIPSIS doctest.testmod(optionflags=options) ����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������asciidoc-8.6.9/BUGS���������������������������������������������������������������������������������0000644�0001751�0001751�00000002171�12236330766�014156� 0����������������������������������������������������������������������������������������������������ustar �srackham������������������������srackham��������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������� Bugs and Known Problems version 8.6.9, 9 November 2013 __________________________________________________________________ 1. AsciiDoc * A benign warning with will become a reserved keyword in Python 2.6 sometimes occurs when using Python 2.5 — it’s harmless and will disappear with Python 3. * Reported line numbers in diagnostic messages are sometimes wrong. * Attribute references in macro attribute lists can’t be unescaped (with the exception of attribute list entry {0}). * Section numbering is incorrect when outputting HTML from a multi-part book type document. This is not a biggy since multi-part books are generally processed to DocBook. * A row of apostrophes in an inline context throws AsciiDoc into an endless loop. The problem seems to be in the input file Reader. __________________________________________________________________ 2. dblatex See ./dblatex/dblatex-readme.txt. __________________________________________________________________ Version 8.6.9 Last updated 2012-09-28 11:34:02 NZST �������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������asciidoc-8.6.9/BUGS.txt�����������������������������������������������������������������������������0000664�0001751�0001751�00000001421�12031161152�014753� 0����������������������������������������������������������������������������������������������������ustar �srackham������������������������srackham���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������Bugs and Known Problems ======================= AsciiDoc -------- - A benign warning 'with will become a reserved keyword in Python 2.6' sometimes occurs when using Python 2.5 -- it's harmless and will disappear with Python 3. - Reported line numbers in diagnostic messages are sometimes wrong. - Attribute references in macro attribute lists can't be unescaped (with the exception of attribute list entry `{0}`). - Section numbering is incorrect when outputting HTML from a multi-part book type document. This is not a biggy since multi-part books are generally processed to DocBook. - A row of apostrophes in an inline context throws AsciiDoc into an endless loop. The problem seems to be in the input file 'Reader'. dblatex ------- See `./dblatex/dblatex-readme.txt`. �����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������asciidoc-8.6.9/MANIFEST�����������������������������������������������������������������������������0000664�0001751�0001751�00000003313�12070160370�014611� 0����������������������������������������������������������������������������������������������������ustar �srackham������������������������srackham���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������a2x.py asciidoc.py asciidocapi.py BUGS BUGS.txt MANIFEST main.aap common.aap CHANGELOG CHANGELOG.txt asciidoc.conf docbook45.conf help.conf html4.conf html5.conf lang-*.conf latex.conf slidy.conf text.conf xhtml11.conf xhtml11-quirks.conf COPYING COPYRIGHT dblatex/asciidoc-dblatex.sty dblatex/asciidoc-dblatex.xsl dblatex/dblatex-readme.txt doc/a2x.1 doc/book.epub doc/asciidoc.1 doc/asciidoc.conf doc/article-docinfo.xml doc/customers.csv doc/images/ doc/main.aap doc/article.pdf doc/latex-filter.pdf doc/music-filter.pdf doc/source-highlight-filter.pdf doc/*.txt doc/asciidoc.dict docbook-xsl/*.txt docbook-xsl/*.xsl examples/website/main.aap examples/website/build-website.sh examples/website/*.css examples/website/*.js examples/website/customers.csv examples/website/images/ examples/website/layout?.conf examples/website/*.txt filters/code/code-filter.conf filters/code/code-filter.py filters/code/code-filter-readme.txt filters/code/code-filter-test.txt filters/latex/latex2png.py filters/latex/latex-filter.conf filters/music/music-filter.conf filters/music/music2png.py filters/music/music-filter-test.txt filters/source/source-highlight-filter.conf filters/source/source-highlight-filter-test.txt filters/graphviz/graphviz-filter.conf filters/graphviz/graphviz2png.py filters/graphviz/asciidoc-graphviz-sample.txt images/icons/callouts/*.png images/icons/*.png images/icons/README images/smallnew.png images/tiger.png images/highlighter.png INSTALL INSTALL.txt configure configure.ac Makefile.in install-sh javascripts/*.js README README.txt stylesheets/*.css tests/testasciidoc.py tests/testasciidoc.conf tests/asciidocapi.py tests/data/*.conf tests/data/*.txt themes/flask/*.css themes/volnitsky/*.css vim/syntax/asciidoc.vim ���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������asciidoc-8.6.9/main.aap�����������������������������������������������������������������������������0000644�0001751�0001751�00000005271�11527017622�015101� 0����������������������������������������������������������������������������������������������������ustar �srackham������������������������srackham���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������##################################################################### # # A-A-P file for making AsciiDoc distribution. # (you can obtain A-A-P from http://www.a-a-p.org) # # Stuart Rackham <srackham@gmail.com> ##################################################################### :execute ./common.aap all: distribution vers: :print Version: $VERS (released $DATE) vers_update: # Propagate version number in common.aap to other versioned files. :syseval grep "$$VERSION = '$(VERS)'" asciidoc.py | :assign dummy @if exit != 0: :print updating version numbers... @for (fname,match) in (('asciidoc.py',r'^VERSION = '),('a2x.py',r'^VERSION = '),('configure.ac',r'^AC_INIT\(.*\)')): :sys sed '/$match/ s/[0-9.][0-9.a-zA-Z_]\+/$VERS/' <$fname >$(fname).tmp :sys mv -f $(fname).tmp $fname @if fname in ('asciidoc.py','a2x.py'): :sys chmod +x $fname tags: :sys rm -f tags :sys ctags asciidoc.py asciidocapi.py tests/testasciidoc.py docs: :execute ./doc/main.aap website: :execute ./examples/website/main.aap distribution: vers_update docs website NAME = asciidoc-$(VERS) # Make configure script. :sys autoconf :sys ln -s . $(NAME) # Make tarball of all files in MANIFEST. :sys tar -czf $(NAME).tar.gz \ ``sed s:^:$(NAME)/: MANIFEST`` # Make zip file. ZIP = `program_path("zip")` @if ZIP: :sys rm -f $(NAME).zip :sys ls ``sed s:^:$(NAME)/: MANIFEST`` | $ZIP $(NAME).zip -@ # Zip files don't know about symlinks so just duplicate the # files. :sys $ZIP $(NAME).zip \ $(NAME)/doc/images/tiger.png \ $(NAME)/doc/images/smallnew.png \ $(NAME)/doc/images/icons/README \ $(NAME)/doc/images/icons/*.png \ $(NAME)/doc/images/icons/callouts/*.png \ $(NAME)/examples/website/images/tiger.png \ $(NAME)/examples/website/images/highlighter.png \ $(NAME)/examples/website/images/smallnew.png \ $(NAME)/examples/website/images/icons/README \ $(NAME)/examples/website/images/icons/*.png \ $(NAME)/examples/website/images/icons/callouts/*.png :sys rm -f $(NAME) @else: :print WARNING: zip(1) unavailable, skipping zip file creation :sys rm -f $(NAME) test: :sys python ./asciidoc.py --doctest :sys python ./asciidocapi.py :execute ./doc/main.aap test :syseval ls ./tests/data/*.html | :assign TESTFILES @if _no.TESTFILES: :sys python ./tests/testasciidoc.py run @else: :print WARNING: no test files, run './tests/testasciidoc.py update' ���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������asciidoc-8.6.9/common.aap���������������������������������������������������������������������������0000664�0001751�0001751�00000000174�12236306446�015447� 0����������������������������������������������������������������������������������������������������ustar �srackham������������������������srackham���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������# # Executed by all main.aap's before anything else. # _parent.VERS = 8.6.9 _parent.DATE = 9 November 2013 all: :pass ����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������asciidoc-8.6.9/CHANGELOG����������������������������������������������������������������������������0000644�0001751�0001751�00000537221�12236330770�014711� 0����������������������������������������������������������������������������������������������������ustar �srackham������������������������srackham��������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������� AsciiDoc ChangeLog version 8.6.9, 9 November 2013 __________________________________________________________________ 1. Version 8.6.9 (2013-11-09) Additions and changes * html5, xhtml11 and slidy outputs now wrap pre element contents at right margin (see [1]https://groups.google.com/group/asciidoc/browse_thread/thread/98 77a316b7a47309). * Vim syntax file: highlight line breaks in lists (patch submitted by Alex Efros). See [2]https://groups.google.com/group/asciidoc/browse_thread/thread/51 45e4c0b65cde0a). * Vim syntax file: fixed highlighting of lines with spaces preceding an indented paragraph. See [3]https://groups.google.com/group/asciidoc/browse_thread/thread/51 45e4c0b65cde0a * Vim syntax file: dropped ) from list of illegal characters following opening quote. See [4]https://groups.google.com/group/asciidoc/browse_thread/thread/1a 60eb4507a0555f/264c39c6a89fc7a0 * Added + intrinsic attribute. See [5]http://code.google.com/p/asciidoc/issues/detail?id=14 * Allow tabsize=0 in configuration file. See [6]https://groups.google.com/group/asciidoc/browse_thread/thread/c8 8457020288ce1d * Removed wordpress backend into the blogpost project (where it belongs) as an AsciiDoc backend plugin. * Added HTML5 footer badges. * Added favicon to AsciiDoc website. * Changed AsciiDoc website domain to asciidoc.org. * Vim syntax file: closing quote character cannot be immediately followed by same closing quote character. * Documentation updates. * If admonition icons are embedded using the Data URI Scheme and the icons directory is undefined or does not exist then the iconsdir attribute is set to the location of the icons installed in the AsciiDoc configuration directory. * Updated ./stylesheets/pygments.css from pygments 1.4. * HTML backends: Align inline images to text-bottom. * html4 backend: Added hr attribute to make the inter-section horizontal ruler element optional. * Documented Callout lists cannot be used within tables. See: [7]https://groups.google.com/group/asciidoc/browse_thread/thread/26 8f9b46ebc192d3 * Removed Vim related stuff from the installer makefile. See: [8]https://groups.google.com/group/asciidoc/browse_thread/thread/75 3a52b2af85fcfc/04c9091b0856fc13 and [9]https://groups.google.com/group/asciidoc/browse_thread/thread/cd 07629fa7a53fb3 * Dropped vim/ftdetect/asciidoc_filetype.vim from distribution, the file detection was broken and the default settings satisfied noone. * Vim syntax highlighter: increase sync backtracking to catch changes to large block elements. * Added Romanian language configuration file. Contributed by Vitalie Lazu. See [10]https://groups.google.com/group/asciidoc/browse_thread/thread/2 fe14a10dbf20d20/27726e7e13f7bfc7?lnk=gst&q=romanian#27726e7e13f7bfc 7 * Added ruler and line-break outputs to HTML Help outputs. Patch submitted by DonM. See [11]https://groups.google.com/group/asciidoc/browse_thread/thread/b 131d0155eccd73e * Added Czech language configuration file. Contributed by Petr Klíma. * html4 backend: allow embedded images and icons (data-uri attribute). * html4 backend: table and example block caption place at bottom for consistency. * html4 backend: dropped border around example block. * html4 backend: cellpaddings made equal to 4 for consistency. * Vim syntax highligher: Highlight closing OpenBlock delimiter when it immediately follows a list. * Updated html5 backend (previous commit was xhtml11 only). See: [12]https://groups.google.com/group/asciidoc/browse_thread/thread/d bdfaf838f93e020 * Embedded data-uri images now figure file mimetype from file contents rather than the file extension. Patch submitted by Lex Trotman. See: [13]https://groups.google.com/group/asciidoc/browse_thread/thread/d bdfaf838f93e020 Bug fixes * indexterm2:[] macro syntax now recognized. See [14]https://groups.google.com/group/asciidoc/browse_thread/thread/1 b3f1a0f0a21425e * Synthesised *-option attributes for options set in table conf file style entries. See [15]https://groups.google.com/group/asciidoc/browse_thread/thread/8 aa340a3069ef5f1/a727a8a564eea76c * Makefile: Fixed sh compatibility issue. See [16]https://groups.google.com/group/asciidoc/browse_thread/thread/7 53a52b2af85fcfc/04c9091b0856fc13 __________________________________________________________________ 2. Version 8.6.8 (2012-07-17) Release highlights Added full complement of styles to Open Blocks and Normal Paragraphs — those with a minimalist bent could construct virtually any document using just Title, Normal Paragraph and Open Block syntaxes. Other additions and changes * Increased default maximum include depth from 5 to 10. * Emit warning if maximum include depth is exceeded. * Suppress repeated console messages. * Music filter: removed --beams=None option from abc2ly invocation because it is broken on LilyPond 2.14 (Ubuntu 12.04). * Replaced obsolete <tt> tag with <code> in HTML backends. * Allow configuration attribute entries to create a new section (previously you could only modify existing sections). See: [17]discussion list. * Documented {wj} (word-joiner) attribute and updated FAQ. See: [18]discussion list. * FAQ: Added How can I place a footnote immediately following quoted text? See [19]discussion list. * Added Greek language configuration file. Contributed by Michael Dourmousoglou. See [20]discussion list. * FAQ: Added Using roles to select fonts for PDF. Submitted by Lex Trotman and based on solution by Antonio Borneo. See: [21]discussion list. * Apply same monospaced font size to all monospaced text. * Changed 0 number padding to spaces in numbered GNU source-highlight outputs. * Allow highlight source highlighter to use python for Python {language} name. r1142: Update the AsciiDoc source filter to allow the use of the highlight source code highlighter. See [22]discussion list. Note The pygments attribute has been deprecated in favor of the new source-highlighter attribute. * Vim syntax highlighter: Don’t confuse trailing open block delimiter with section underline. * Added skip option to paragraphs (c.f. Delimited Block skip option). Bug fixes * FIXED: latex, music and graphviz filters: When the filter output image is data-uri encoded write it to the indir (instead of the outdir) so that encoder can find it. See [23]discussion list. * FIXED: Escape the ] character inside inline macros. See [24]discussion list. * FIXED: source highlighter filter: Pass role attribute to HTML backends. * FIXED: source highlight filter: docbook backend: role attribute was not passed to listings without a title. Patch submitted by Lex Trotman. See [25]discussion list. * FIXED: music2png.py: FOPException: Raster ByteInterleavedRaster error (FOP 1.0, ImageMagick 6.6.9-7). __________________________________________________________________ 3. Version 8.6.7 (2012-03-17) Release highlights No major enhancements but quite a few bug fixes which, among other things, fixes Jython compatibility and improves Windows compatibility. All additions and changes * Vim syntax highlighter: highlight entity refs in macro arguments. * Added files with .asciidoc extension to Vim file type detection. [26]Patch submitted by Dag Wiers. * Added replacement3 substitution to enable [27]ODT whitespace processing. * Added unbreakable option to XHTML and HTML 5 backends. * Implemented toc::[] block macro and toc-placement attribute for HTML backends to allow the Table of Contents placement to be set manually by the author. * Added FAQs: How can I control page breaks when printing HTML outputs? and Is it possible to reposition the Table of Contents in HTML outputs?. * Added --backend and --backend-opts options to the a2x command to allow a2x to use backend plugin code extensions. [28]Patch submitted by Lex Trotman. * Added [29]args block attribute to source highlight blocks to allow arbitrary parameters to be passed to the source highlighters. * If the ascii-ids attribute is defined then non-ascii characters in auto-generated IDs [30]are replaced by their nearest ascii equivalents (to work around DocBook processor limitations). * Added global blockname attribute which is dynamically updated to identify the current block. See [31]discussion list. * xhtml11, html5 backends: Include book part TOC entries for multi-part books. Patch submitted by Loïc Paillotin. * Removed code filter example from the AsciiDoc User Guide so that backends implemented as external plugins can compile the manual. See [32]discussion list. * If the delimited block skip option is set then do not consume block title and attributes. This makes it possible for the comment delimited blocks to use an attribute list (previously the comment delimited block was hardwired to skip preceding attributes and titles). See [33]discussion list. * Added backend-confdir intrinsic attribute. Bug fixes * FIXED: slidy backend: broken stylesheet attribute. [34]Patch submitted by Micheal Hackett. * FIXED: Restored [35]missing themes to zip file distribution archive. * FIXED: Grammatical error in error messages. [36]Patch submitted by Dag Wieers. * FIXED: Use configured normal substitution in preference to the default one. * FIXED: The eval block macro would execute multiple times if it evaluated to None. * FIXED: Duplicated entries in TOC of large document. [37]Patch submitted by Sebastien Helleu. * FIXED: Python 2.4 backward [38]incompatibility. * FIXED: 8.6.6 regression broke Jython compatibility. See [39]discussion list. * FIXED: Leaky file handles in a2x and music and latex filters which created incompatibility problems for Jython. * FIXED: All Python filters are executed with the same Python interpreter that executes the asciidoc parent (previously filters were hardwired to execute the python interpreter). This prevents [40]Python mix-ups. * FIXED: Microsoft Windows shelled command-line truncation that caused shelled commands to fail e.g. the data-uri attribute failure. __________________________________________________________________ 4. Version 8.6.6 (2011-09-04) Release highlights * The AsciiDoc plugin architecture has been enhanced, unified and extended: + Plugin commands have been added to the asciidoc(1) --backend option. + An asciidoc(1) --theme option has been implemented to specify a theme and to manage theme plugins. + A plugin build command (for creating plugins) added. + build, install, list and remove plugin commands are all recognized by asciidoc(1) --backend, --filter and --theme options. * A security update by Kenny MacDermid removes the use of eval() on untrusted input (to disallow code malicious execution). All additions and changes * xhtml11, html5: Made verse and quote block text darker to print legibly in Google Chrome browser. * Added plugin build command for plugin file creation. * Merged --help plugins back to --help manpage so it matches the asciidoc(1) manpage. * The --filter command-line option can specify the name of filters that will be unconditionally loaded. * If a filter directory contains a file named __noautoload__ then the filter is not automatically loaded (you can used the --filter command-line option to override this behavior). * tests: Add Italian language tests. Patch submitted by Simon Ruderich. See: [41]http://groups.google.com/group/asciidoc/browse_thread/thread/5e 2e6f4dd740d51a * tests: Add tests for localized man pages. Patch submitted by Simon Ruderich. See: [42]http://groups.google.com/group/asciidoc/browse_thread/thread/5e 2e6f4dd740d51a * 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 (the default behavior is to replace the the section). * If a configuration file section named docinfo is 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. * Added {sp} intrinsic attribute for single space character. See [43]http://groups.google.com/group/asciidoc/browse_thread/thread/a8 39aa01db0765d2 * Fixed TOC and footnotes generator. Patch submitted by Will. See [44]http://groups.google.com/group/asciidoc/browse_thread/thread/73 4ac5afed736987 * The asciidoc-confdir attribute is set to the asciidoc executable directory if it contains global configuration files i.e. a local asciidoc installation. * asciidoc now throws an error instead of just a warning of the backend configuration file is not found. * latex filter: write MD5 file after successful PNG file generation. Always delete temp files irrespective of outcome. * Added truecolor option to LaTeX filter. Patch submitted by Michel Krämer. See: [45]http://groups.google.com/group/asciidoc/browse_thread/thread/64 36788a10561851 * Unit test for table column specifiers with merged cells. Patch submitted by Simon Ruderich. See: [46]http://groups.google.com/group/asciidoc/browse_thread/thread/c9 238380a1f2507a * Added verbose message for ifeval::[] macro evaluation. * Added test case for ifeval::[] evaluation. * Security update to remove the use of eval() on untrusted input (to disallow code malicious execution). Patch submitted by Kenny MacDermid. * Changed web site layout from table to CSS based. See [47]http://groups.google.com/group/asciidoc/browse_thread/thread/ec 8e8481eb0e27b0/d1c035092b5bb7a4?lnk=gst&q=caption+option#d1c035092b 5bb7a4 * a2x: Pass --format option value to asciidoc as a2x-format attribute. Patch submitted by Lex Trotman ([48]http://groups.google.com/group/asciidoc/browse_thread/thread/3 e177b84bc133ca9/659796dfadad30ea?lnk=gst&q=a2x+format#659796dfadad3 0ea). * Added two FAQs submitted by Lex Trotman. See: [49]http://groups.google.com/group/asciidoc/browse_thread/thread/16 d3fb9672a408e7 * html5,xhtml11: Implemented themes directory structure. * html5,xhtml11: Implemented asciidoc --theme management option (install, list, build and remove commands). * html5,xhtml11: A theme can now optionally include a JavaScript file <theme>.js * html5,xhtml11: If the data-uri attribute is defined then icons from the theme icons directory (if they exist) will be embedded in the generated document. * Added optional warnings argument to include macros. * The asciidoc --verbose option now prints file inclusion messages. * xhtml11, html5: Remove necessity for separate manpage CSS files. * Added css-signature attribute to tests. * Add css-signature attribute to set a CSS signature for the document. Patch submitted by Peg Russell, see: [50]http://groups.google.com/group/asciidoc/browse_thread/thread/ba cbf8aeb8ad6a3a * White background for toc2 TOC viewport so that horizontally scrolled content does not obscure the the TOC. Patch submitted by Lionel Orry, see: [51]http://code.google.com/p/asciidoc/issues/detail?id=8 Bug fixes * FIXED: Plugin install command: Delete backend directory is install fails. * FIXED: Plugin install command: Fixed bug extracting binary files on Windows (reported by Jean-Michel Inglebert). * FIXED: tests: Skip blank sections in testasciidoc.conf test configuration file instead of throwing an exception (reported by Jean-Michel Inglebert). * FIXED: If a plugin Zip file does not contain file permissions (probably because it was created under Windows) then install it using the default permissions. * FIXED: Fixed missing quote in preceding LaTeX filter patch. Fix submitted by Simon Ruderich. See: [52]http://groups.google.com/group/asciidoc/browse_thread/thread/64 36788a10561851 * FIXED: Some path attributes were processed as escaped Python strings which could result in corrupted path names with backslash separated Windows path names. Reported by Will. See: [53]http://groups.google.com/group/asciidoc/browse_thread/thread/e8 f3938bcb4c8bb4/44d13113a35738ef * FIXED: Vertically spanned table cells resulted in incorrect column styles being applied to some cells. Reported by Will: [54]http://groups.google.com/group/asciidoc/browse_thread/thread/c9 238380a1f2507a/9afc4559d51e1dbd * FIXED: LaTeX backend: fixed bad escapes. Patch submitted by Mark McCurry: [55]http://groups.google.com/group/asciidoc/browse_thread/thread/8c 111f1046b33691/158a944cf4d5ff0d?lnk=gst&q=latex+escapes#158a944cf4d 5ff0d * FIXED: When using slidy backend, display of characters with accents is wrong because of meta http-equiv line missing. Reported by Fabrice Flore-Thebault. See: [56]http://groups.google.com/group/asciidoc/browse_thread/thread/ea f25f21d1da180a __________________________________________________________________ 5. Version 8.6.5 (2011-05-20) Release highlights * The addition of an html5 backend to generate HTML 5 output. Apart from the inclusion of audio and video block macros the html5 backend is functionally identical to the xhtml11 backend. * A new flask theme for xhtml11 and html5 backends inspired by the [57]Flask website styling (see toc2 example in the next item below). * The new toc2 attribute generates a table of contents in the left hand margin (xhtml11 and html5 backends). [58]This example was generated using the following command: asciidoc -b html5 -a icons -a toc2 -a theme=flask article.txt * a2x(1) now has a flexible mechanism for copying arbitrary resource files to HTML based outputs — this is very handy for generating EPUB files with embedded fonts and other resources. + The a2x(1) --resource option can be used to inject any file into EPUB output documents e.g. CSS resources such as fonts and background images. + Explicitly specified resources are added to the EPUB OPF manifest automatically. + You can explicitly specify file extension MIME types. + The enhanced resource processing works around a couple of DocBook XSL bugs (see [59]EPUB Notes). All additions and changes * A new flask theme for xhtml11 and html5 backends. A shameless knock-off of the [60]Flask website styling. * Added HTML 5 article with toc2 table of contents to the example on the AsciiDoc website home page. * Added filters and topics help topics. Fixed documentation errors in help text. Patch submitted by Lionel Orry, see: [61]http://groups.google.com/group/asciidoc/browse_thread/thread/9d a9d48a6461ff14 * Pass parent configuration files, command-line attributes and header attributes to table asciidoc filters. Based on patch submitted by Simon Ruderich, see: [62]http://groups.google.com/group/asciidoc/browse_thread/thread/5c 792cbb395b753b * Allow a title attribute entry in the document header so that HTML backends can set the title element separately from the displayed document title (the doctitle attribute). * Pass lang attribute to asciidoc table style filter. Patch submitted by Simon Ruderich, see: [63]http://groups.google.com/group/asciidoc/browse_thread/thread/e2 100b7cb29283ce * xhtml11,html5: Added toc2 attribute which generates a scrollable table of contents in the left hand margin. Based on customized CSS written by Suraj Kurapati, see [64]http://groups.google.com/group/asciidoc/browse_thread/thread/c5 e30ee5555877f5 * Added asciidoc-confdir intrinsic attribute which expands to the global conf directory. * Documented that you can specify multiple CSS files with the a2x(1) --stylesheet command option. See: [65]http://groups.google.com/group/asciidoc/browse_thread/thread/ba f3218551d05a05 * Improved xhtml11 backend’s table of contents generation latency. Patch submitted by Hongli Lai. See: [66]http://groups.google.com/group/asciidoc/browse_thread/thread/5a 7fe64fbfd65ad * Added html5 backend. * For consistency converted all DOS formatted configuration and text files to UNIX format. * html4: Added ability to use role attribute with most block elements. Patch contributed by Simon Ruderich. See [67]http://groups.google.com/group/asciidoc/browse_thread/thread/56 20ba634fdb030a * Added Dutch language configuration file and accompanying test file (contributed by Dag Wieers, see [68]http://groups.google.com/group/asciidoc/browse_thread/thread/f9 69b9ce987d7f5d). * Configuration files are loaded in two passes when the -e command-line option is used (the same behavior as when the -e option is not used). Patch submitted by haad. See [69]http://groups.google.com/group/asciidoc/browse_thread/thread/cd 0f47495fd04181 and [70]http://code.google.com/p/asciidoc/issues/detail?id=6&q=label%3A Priority-Medium * Documented how to include embedded fonts in an EPUB document. * a2x: Added .<ext>=<mimetype> resource specifier syntax. * a2x: Enable admonition icons in example EPUBs. * a2x: allow environment variables and tilde home directories in resource manifest files. * a2x: don’t process non-existent resource directories. * a2x: assume resource option is a directory if the name ends with a directory separator. * a2x: Added a new syntax to the --resource option specifier which allows the destination path to be specified. * a2x: Copy resources referenced in the OPF and resources referenced by the generated HTML (in theory DocBook XSL should ensure they are identical but this is not always the case e.g. [71]http://sourceforge.net/tracker/?func=detail&atid=373747&aid=285 4075&group_id=21935). * Drop border from callout list image links. * html4: Moved manpage NAME section out of header so that the name section is rendered when the asciidoc(1) --no-header-footer option is specified (so that manpages processed blogpost include the NAME section). * Vim syntax highlighter: TODO markers now appear in list items and literal paragraphs and blocks. * Constrained quotes can now be bounded on the left by a } character. See: [72]http://groups.google.com/group/asciidoc/browse_thread/thread/b2 4cc3362f35b801 * Added text-decoration roles (underline, overline, line-through, blink) for xhtml11 and html5 outputs. Bug fixes * FIXED: epubcheck 1.1 previously issued a warning for files not registered in the manifest (epubcheck 1.0.5 did not). This resulted in a problem compiling the adventures-of-sherlock-holmes.txt example (the underline.png resource was not in the manifest). __________________________________________________________________ 6. Version 8.6.4 (2011-02-20) Additions and changes * Added text foreground and background color along with text size CSS styles for XHTML outputs, see [73]http://asciidoc.org/userguide.html#X96. * Vim syntax highlighter: highlight macros that start with an attribute reference (a common idiom). * Vim syntax highlighter: highlight attribute references in macro attribute lists. * Attribute entries can be used to set configuration markup templates. * Double-width East Asian characters in titles now correctly match the title underline widths. Submitted by Changjian Gao (see [74]http://groups.google.com/group/asciidoc/browse_thread/thread/77 f28b0dfe60d262). * Implemented [75]asciidoc(1) filter commands, see: [76]http://groups.google.com/group/asciidoc/browse_thread/thread/40 c64cd33ee1905c * User’s home directory now calculated in a platform independent manner. * Added double-quote characters to French language file. Patch contributed Yves-Alexis Perez, see: [77]http://groups.google.com/group/asciidoc/browse_thread/thread/e1 5282f072413940 * Vim Syntax highlighter: Highlight closing OpenBlocks which immediately follow a literal paragraph. * Changed UNIX /dev/null to OS independent os.devnull in filters code. Suggested by Henrik Maier: [78]http://groups.google.com/group/asciidoc/browse_thread/thread/5a c8e8ea895147e9 * Vim syntax highlighter: Single and double quoted text now highlights correctly when preceded by an attributes list. * Added Ukrainian language file (lang-uk.conf). Added double-quote characters to Russian language file.conf). Patches contributed by Lavruschenko Oleksandr, see [79]http://groups.google.com/group/asciidoc/browse_thread/thread/e1 5282f072413940 * Single and double quote characters are now set using the {lsquo}, {rsquo}, {ldquo} and {rdquo} attributes. This makes is easy to customise language specific quotes. See: [80]http://groups.google.com/group/asciidoc/browse_thread/thread/e1 5282f072413940 * Implemented conf-files attribute to allow configuration files to be specified in the source document. Suggested by Lex Trotman, see: [81]http://groups.google.com/group/asciidoc/browse_thread/thread/b1 1066a828ab45b9 Bug fixes * FIXED: Auto-generated section title ids are now Unicode aware. * FIXED: Setting quotes configuration entries using document attribute entries failed if the attribute entry was not in the document header. See: [82]http://groups.google.com/group/asciidoc/browse_thread/thread/a1 dd0562dee8b939 * FIXED: If the input and output file names were different then the output file name was incorrectly used to synthesize docinfo file names. Reported by Christian Zuckschwerdt. * FIXED: An error can occur when more than one consecutive quotes are defined as a blank string. Reported by Peggy Russell. * FIXED: Encoding error in automatically generated author initials. Patch submitted by Xin Wang. See: [83]http://groups.google.com/group/asciidoc/browse_thread/thread/f4 4615dca0b834e9 __________________________________________________________________ 7. Version 8.6.3 (2010-11-14) Additions and changes * Added and unbreakable option to bulleted and numbered lists (thanks to Henrik Maier for this patch). * Added ifeval::[] system macro (thanks to Henrik Maier for suggesting this feature). * The image scale attribute sets the DocBook imagedata element scale attribute. Patch submitted by Henrik Maier. * DocBook preface, colophon and dedication style section titles now work. Based on patch submitted by Henrik Maier. * a2x: Do not inject xsltproc parameters if they were specified on the command-line (parameter double-ups generate xsltproc Global parameter already defined errors). * a2x: Refactored xsltproc parameter injection. * a2x: articles chunked at section level by default. * attributes, titles and specialcharacters sections are now read from the local asciidoc.conf file before the header is parsed. This fixes a regression problem. See [84]http://groups.google.com/group/asciidoc/browse_thread/thread/1b 3f88f1f8118ab3 * Document header attributes take precedence over configuration file attributes. * Refactored music, graphviz and latex filter configurations. * Refactored source filter configuration and added literal paragraph source style. * Separated paragraph styles from paragraph syntax — any style can be applied to any syntax. * Added listing and quote paragraph styles. * Renamed paragraph default style to normal. * Updated --help option text. * a2x: The asciidoc_opts, dblatex_opts, fop_opts and xsltproc_opts command-line options can be specified multiple times. This makes embedding multiple a2x options in document headers easier to manage and less error prone. * Added ASCIIMathML and LaTeXMathML support to slidy backend. * Pass the encoding attribute to the Pygments source highlight filter command. * a2x: HTML Help .hhk file named after AsciiDoc source file. * a2x: Added --xsl-file option to allow custom XSL stylesheets to be specified. * Make builds the man pages. Patch submitted by Sebastian Pipping. See [85]http://groups.google.com/group/asciidoc/browse_thread/thread/c2 1c2902c29bae64 Bug fixes * FIXED: Sometimes double backquotes were misinterpreted as inline literal macros. See: [86]http://groups.google.com/group/asciidoc/browse_thread/thread/f5 10ea82a88aaee8 * FIXED: Regression in 8.6.2: command-line attributes were not available to the global asciidoc.conf. * FIXED: Postponed document title substitutions until backend conf files have been loaded (8.6.2 regression). See [87]http://groups.google.com/group/asciidoc/browse_thread/thread/42 b63ce90c2563b8 * FIXED: The XSL Stylesheets customizations were preventing chapter and section level TOCs from being generated when using XSL Stylesheets via a2x. See [88]http://groups.google.com/group/asciidoc/browse_thread/thread/42 b63ce90c2563b8 * FIXED: “UnicodeDecodeError: 'ascii' codec can’t decode byte” error. This error is due to a limitation in the Python HTMLParser module, see: [89]http://bugs.python.org/issue3932 * FIXED: Broken --no-conf option (8.6.2 regression). * FIXED: Regression in 8.6.2: configuration attribute entries set in the document header may cause a FAILED: incomplete configuration files error. * FIXED: html4: corrected self closed meta tags. * FIXED: a2x regression in 8.6.2: HTML Help .hhp file name had reverted to default name instead of the AsciiDoc source file name. See: [90]http://groups.google.com/group/asciidoc/browse_thread/thread/de dc961b23e9ac56 * FIXED: Attributes in man page title caused it to be dropped resulting in invalid DocBook output. * FIXED: make uninstall now deletes the asciidoc.1 and a2x.1 man pages. __________________________________________________________________ 8. Version 8.6.2 (2010-10-03) Additions and changes * docbook45: Enclosed bibliographic lists in a bibliodiv — you can now include block titles with bibliographic lists. * Added optional keywords, description and title document header meta-data attributes to HTML backends for SEO. * AttributeEntry values can span multiple lines with a ' +' line continuation. * Added slidy backend (based on Phillip Lord’s slidy backend [91]https://phillordbio-asciidoc-fixes.googlecode.com/hg/). * Implemented OpenBlock partintro style for book part introductions. * Comment lines substitute special characters only. * Backend specific global configuration files (all except asciidoc.conf) are loaded after the header has been parsed — virtually any attribute can now be specified in the document header. * xhtml11: Volnitsky theme: allow bulleted lists to have intervening children. * xhtml11: refactored CSS font-family rules to start of file. * xhtml11: list bullets colored gray. * ifdef and ifndef system block macros accept multiple attribute names: multiple names separated by commas are ored; multiple attribute names separated by pluses are anded. * xhtml11: Volnitsky theme: set max-width on labeled lists. * Vim syntax highlighter: Entities inside quoted text are now highlighted. * Added role and id attributes to HTML outputs generated by OpenBlocks. * Allow floating titles to generate h1 (level 0) titles in HTML outputs. * Added a start attribute to numbered lists to set the start number. See: [92]http://groups.google.com/group/asciidoc/browse_thread/thread/c1 4a4c3b1e4f6dc5 * Added two more docinfo attributes docinfo1 and docinfo2 to allow and control inclusion of a shared docinfo file. See [93]http://groups.google.com/group/asciidoc/browse_thread/thread/c9 48697943432e24 * Vim syntax highlighter highlights multi-name conditional attributes. * LaTeX backend patch submitted by Andreas Hermann Braml (see [94]http://groups.google.com/group/asciidoc/browse_thread/thread/1c 415fc4540ce5e5). * Implemented backend aliases; renamed docbook.conf to docbook45.conf and aliased docbook45 backend to docbook; aliased xhtml11 to html. Bug fixes * FIXED: Filter commands located in filter directories local to the source document that where not in the search PATH where not found. * FIXED: Volnitsky theme: Verseblock font set normal instead of monospaced. * FIXED: xhtml11: Callout icons were not rendered as Data URIs when icons and data-uri attributes were specified. * FIXED: Long standing bug: nested include macros did not restore the parent document infile and indir attributes. See: [95]http://groups.google.com/group/asciidoc/browse_thread/thread/87 12a95e95a292a7 * FIXED: html4: set preamble ID anchor. * FIXED: xhtml11: dropped unusable id and role attributes from preamble template. * FIXED: Bug in multi-name conditional attributes e.g. {x,y#} fails if x or y is undefined. * FIXED: latex filter not being installed by Makefile. Thanks to Grant Edwards for this patch. See [96]http://groups.google.com/group/asciidoc/browse_thread/thread/c4 427a3902d130a8 * FIXED: a2x: Long-standing bug in a2x which always passes --string-param navig.graphics 0 to xsltproc, regardless of whether icons are enabled or not. Reported by Michael Wild: [97]http://groups.google.com/group/asciidoc/browse_thread/thread/59 a610068e4acb58 __________________________________________________________________ 9. Version 8.6.1 (2010-08-22) Additions and changes * a2x: --resource-dir option renamed to --resource. * a2x: --resource option accepts both file and directory names. * a2x: Added -m,--resource-manifest option. * Added Vim syntax highlighting for quote attribute lists. * Load asciidoc.conf from all configuration directories before any other configuration files. This ensures that attributes used for conditional inclusion are set before backend configuration files are processed. Previously if you wanted to control global conf file inclusion your only choice was to modify the global asciidoc.conf file. * AsciiDoc Quote element attributes have been simplified and generalized — positional color and size attributes and named role attribute have been replaced by a single positional attribute. Bug fixes * FIXED: testasciidoc.py: BACKEND command argument was being ignored. * FIXED: Broken docinfo file functionality in html4 and xhtml11 backends (previously the docinfo file was included in the body instead of the header). 9.1. Regression issues This release breaks compatibility with quoted element positional color and size attributes (HTML backends). To revert to the deprecated quote behavior define the deprecated-quotes attribute in the global asciidoc.conf file or on the command-line. For a more detailed explanation of the rationale behind this change see [98]http://groups.google.com/group/asciidoc/browse_thread/thread/b22603 bfb879418c. __________________________________________________________________ 10. Version 8.6.0 (2010-08-16) Additions and changes * The AsciiDoc distribution can now be built “out of the box” from the distribution tarball or the Mercurial repository (provided you have the requisite build applications installed). * The global configuration files directory is ignored by both asciidoc and a2x if AsciiDoc configuration files are installed in the same directory as the asciidoc executable. This change allows both a system wide copy and multiple local copies of AsciiDoc to coexist on the same host PC. * CSS quirks mode is no longer the default xhtml11 output ([99]http://groups.google.com/group/asciidoc/browse_thread/thread/1 c02d27d49221aa2). * Relaxed anchor ID name syntax ([100]http://groups.google.com/group/asciidoc/browse_thread/thread/ 5f3e825c74ed30c). * Added document files: doc/epub-notes.txt, doc/publishing-ebooks-with-asciidoc.txt. * a2x: If all other resource locations are exhausted then recursively search directories named images and stylesheets in the asciidoc configuration files directory. * a2x: options can also be set in the AsciiDoc source file. If the source file contains a line beginning with // a2x: then the remainder of the line will be treated as a2x command-line options. * Added dblatex table-width processing instruction — tables generated by dblatex now observe the AsciiDoc table width as a percentage (thanks to Gustav Broberg for suggesting this enhancement). * a2x: Don’t exit if the --epubcheck option is set and epubcheck is missing, issue warning and continue. * Added a global plaintext attribute for dealing with large amounts of imported text. * The author name format has been relaxed, if the the author does not match the formal specification then it is assigned to the firstname attribute (previously asciidoc exited with an error message). * FAQ and documentation updates. * Refactored chunked.xsl and epub.xsl files. * Exchanged article.epub for more relevant book.epub on website. * Put asciidoc.epub User Guide on website. * a2x: Chunking EPUB and HTML outputs set to a per chapter basis and the first chapter is separate from preceding contents. * Changed dates format in example article and books to suppress EPUB validation error. * Added style and role CSS classes to xhtml11 section templates. * Added the role element to xhtml11 backend block templates. * Suppressed md5 module deprecation warning from music and Graphviz filters. * Pygments ([101]http://pygments.org/) option added to source code highlight filter. Based on Pygments source code filter written by David Hajage ([102]http://groups.google.com/group/asciidoc/browse_thread/thread/ d8d042f5a3021369/8934ebbb8cb7144b). * xhtml11: Added a new theme (volnitsky). Written and contributed by Leonid V. Volnitsky. * xhtml11: Set body element class name to document type. * Added refentryinfo element and contents (including revdate) to man page DocBook output. Man pages are now dated using the revdate attribute value if it has been defined. Based on patch supplied by Rainer Muller [103]http://groups.google.com/group/asciidoc/browse_frm/thread/319e 5cd94493e330/3fcb83fab067af42. * Added {template:...} system attribute. * Table of contents attribute toc can now be specified in the document header. * Reimplemented music and latex filter -m option functionality when the input is stdin using MD5 checksums. * Added latex filter. * Added auto file name generation to image generating filters (latex,music, graphviz). * Added counter2 and set2 system attributes (to implement image auto file name generation). * Undefined attribute in filter command generates error but does not exit. * Attribute substitution proceeds from start line to end line (previously was in reverse order which was really confusing). * Tidied up music filter code: + Format option is optional and default to abc unless Lilypond notation detected. + The -m option does not apply to stdin input. * Added paragraph styles to music and graphviz filters. * Documented dynamic template names. 753: Graphviz filter can now generate SVG format images. Patch submitted by Elmo Todurov, see: [104]http://groups.google.com/group/asciidoc/browse_frm/thread/fe9b 33d8f5f1e0af The xhtml11 SVG Graphviz template marked EXPERIMENTAL. No SVG support for other backends. * AsciiDoc template names can now contain embedded attribute references. * Added legalnotice tag to doc/article-docinfo.xml example. * xhtml11 backend: Callouts and callout lists display callout icons when the icons attribute is defined. See [105]http://groups.google.com/group/asciidoc/browse_frm/thread/8eda 3ea812968854 * Document attribute names are case insensitive everywhere, this makes using attribute entries more consistent e.g. previously :VERS: had to be refered to * Hungarian translation of footer-text (submitted by Miklos Vajna). See [106]http://groups.google.com/group/asciidoc/browse_frm/thread/7174 cb7598993c72# * asciidocapi.py 0.1.2: Can now load AsciiDoc script named asciidoc. See [107]http://groups.google.com/group/asciidoc/browse_frm/thread/66e7 b59d12cd2f91 Based on patch submitted by Phillip Lord. * German translation of footer-text (submitted by Simon Ruderich). See [108]http://groups.google.com/group/asciidoc/browse_frm/thread/7174 cb7598993c72 * Pushed HTML footer text into language conf files with the introduction of a [footer-text] configuration file template section. See [109]http://groups.google.com/group/asciidoc/browse_frm/thread/7174 cb7598993c72 Bug fixes * FIXED: Sometimes multiple double quoted text elements in the same paragraph were mistakenly seen as starting with an inline literal. See [110]http://groups.google.com/group/asciidoc/browse_frm/thread/219c 86ae25b79a21 * FIXED: localtime and doctime attributes calculated incorrect daylight saving / non daylight saving timezones and consequently so did HTML footers. Patch submitted by Slawomir Testowy. See [111]http://groups.google.com/group/asciidoc/browse_frm/thread/af65 2507caf6cec9 * FIXED: Missing selector for List of examples title in DocBook CSS file. Patch submitted by Laurent Laville. See [112]http://groups.google.com/group/asciidoc/browse_frm/thread/3f96 900f7fbf5620 * FIXED: Broken accents in lang-hu.conf. See: [113]http://groups.google.com/group/asciidoc/browse_frm/thread/7174 cb7598993c72 * FIXED: DocBook XSL generated HTML callout lists are properly aligned. Submitted by Lionel Orry. See [114]http://groups.google.com/group/asciidoc/browse_frm/thread/2ff8 02547b6a75ea * FIXED: Filter execution now occurs prior to filter markup template substitution to ensure image data URI encoding happens after image generation (see [115]http://groups.google.com/group/asciidoc/browse_thread/thread/1 4e8fcb289a135b). * FIXED: The section numbers no longer increment when the numbered attribute is undefined (see [116]http://groups.google.com/group/asciidoc/browse_thread/thread/f aa36e9e5c7da019/d24cab3fe363e58d). __________________________________________________________________ 11. Version 8.5.3 (2010-01-18) Additions and changes * a2x: Added a2x configuration file options ASCIIDOC_OPTS, DBLATEX_OPTS, FOP_OPTS, XSLTPROC_OPTS (appended to same-named command-line options). See [117]http://groups.google.com/group/asciidoc/browse_frm/thread/ac4b 9bfa2116db28 * Dropped .hgignore from the repository. See [118]http://groups.google.com/group/asciidoc/browse_frm/thread/c17a bd175778f5ea * Don’t pass verbose options to asciidoc table filter so that asciidocapi messages are not discarded. See: [119]http://groups.google.com/group/asciidoc/browse_frm/thread/c17a bd175778f5ea * Added ./tests/data/lang-pt-BR-test.txt file to the repository. * xhtml11: Verse block and verse paragraph content enveloped in a pre tag (instead of a div) so it renders better in text-only browsers. See: [120]http://groups.google.com/group/asciidoc/browse_frm/thread/1b6b 66adb24e710 * User Guide: Clarified Passthrough Blocks (suggested by Simon Ruderich). * FAQ: How can I include lines of dashes inside a listing block? * FAQ errata and updates (submitted by Simon Ruderich). * User Guide errata. * Simplified asciidoc-toc processing instruction and included lists of figures, tables, examples and equations in books (i.e. revert to pre-8.5.0 behavior). * Attempted to have dblatex recognise the asciidoc-toc processing instruction but couldn’t get it to work. * Added notitle attribute to allow the document title to be hidden. Bug fixes * FIXED: Regression: system attribute escaping did not work. * FIXED: Website: broken image links in chunked User Guide. __________________________________________________________________ 12. Version 8.5.2 (2009-12-07) Additions and changes * Updated example article and book documents with the recommended explicit section name syntax (see the Special section titles vs. explicit template names sidebar in the AsciiDoc User Guide). * Added Italian language configuration file (contributed by Fabio Inguaggiato). * Added header table style. See: [121]http://groups.google.com/group/asciidoc/browse_frm/thread/a23f ea28394c8ca9 * Pass icons, data-uri, imagesdir, iconsdir attributes to asciidoc table style filter so that images are rendered in table cells. * Pass trace and verbose attributes to asciidoc table style filter so diagnostic information is printed from table cell source. * The eval system attribute can be nested inside other system attributes. * HTML outputs: Table and figure caption punctuation set to more usual syntax. * docbook backend: footnotes can now contain embedded images. See [122]http://groups.google.com/group/asciidoc/browse_frm/thread/50b2 8f6941de111a * CSS tweaks so that tables processed by DocBook XSL Stylesheets have the default asciidoc xhtml11 backend styling. See [123]http://groups.google.com/group/asciidoc/browse_frm/thread/dfe5 204d5b2c9685 * Block titles take precedence over section titles to avoid titled delimited blocks being mistaken for two line section titles (see [124]http://groups.google.com/group/asciidoc/browse_frm/thread/f0b6 f9989f828c3). * Section title trace displays level and title text. * FAQ additions. * Added {zwsp} (zero width space) attribute. * Undefined paragraph styles are reported (previously threw a runtime error). * Eliminated empty preamble generation. * Floating titles now processed in all contexts. * Implemented auto-lettered appendix names and updated example documents. * Section numbering can be disabled in HTML outputs with a :numbered!: AttributeEntry. * xhtml11: Nicer default quote block styling. * Exclude floating titles from xhtml11 table of contents. Patch submitted by Mark Burton (see [125]http://groups.google.com/group/asciidoc/browse_frm/thread/14ae fc1cb6bd85f5). * Enhanced doc/article-docinfo.xml example docinfo file. * Vim syntax highlighter improvements. Bug fixes * FIXED: Absolute imagesdir and iconsdir attribute path names do not work with the xhtml11 data-uri encoding. See [126]http://groups.google.com/group/asciidoc/browse_frm/thread/cb8b 7694bbc82a6 * FIXED: Regression issue with inline data-uri images. See [127]http://groups.google.com/group/asciidoc/browse_frm/thread/cb8b 7694bbc82a6 * FIXED: An unexpected error occurred when processing a table containing CSV data if the cols attribute was not explicitly specified. See [128]http://groups.google.com/group/asciidoc/browse_frm/thread/4b0f 364b477ec165 __________________________________________________________________ 13. Version 8.5.1 (2009-10-31) Additions and changes * If an AsciiDoc document file begins with a UTF-8 BOM (byte order mark) then it is passed transparently through to the output file. The BOM is stripped from included files. See [129]http://groups.google.com/group/asciidoc/browse_frm/thread/e5e6 1823ff4203cd * Added AsciiDoc role attribute to quoted text. Sets class attribute in HTML outputs; role attribute in DocBook outputs. See: [130]http://groups.google.com/group/asciidoc/browse_frm/thread/2aa3 e5711d243045 * Conditional attribute syntax extended: they now accept multiple ORed or ANDed attribute names. * The xhtml11 backend dynamically processes footnotes using JavaScript. * Tidied up and namespaced xhtml11 JavaScript. * Superceded javascripts/toc.js with javascripts/asciidoc-xhtml11.js. * Added disable-javascript attribute (xhtml11 backend). * Styled HTML footnotes. * Added links to HTML footnote refs. * Added title attribute to inline image macros to display popup “tooltip” (HTML outputs only). * Single-quoted attribute values are substituted in block macros (just like the AttributeList element). * For consistency changed underscores to dashes in attribute names. Public attributes with underscores retained for compatibility. * Added Brazilian Portuguese language configuration file (contributed by Thiago Farina). * Added leveloffset attribute to make it easier to combine documents. Bug fixes * FIXED: a2x: --dblatex-opts is now processed last so asciidoc-dblatex.xsl params can be overridden. Patch submitted by Mark Fernandes (see [131]http://groups.google.com/group/asciidoc/browse_frm/thread/5215 c99dcc865e7d). * FIXED: An error occurred if a directory in current path with same name as executable. 13.1. Regression issues There’s been quite a bit of tiding up to the xhtml11 JavaScript. The most obvious change is that the toc.js script has been superceded by asciidoc-xhtml11.js so if you’re linking you’ll need get a copy of the new file from the distribution javascripts directory. If you use customised xhtml11 configuration file [header] and [footer] sections and you want them to use the new footnotes feature then you’ve got a bit more work to do: 1. The onload event expression changed. 2. The new <div id="content">...</div> div envelopes document content. 3. You need to add <div id="footnotes">...</div> div to the [footnotes] section for footnotes to work. 4. Drop the ifdef::toc[] macro that surround JavaScript inclusion. Take a look at the [header] and [footer] changes in the xhtml11.conf diff to see what’s going on: [132]http://hg.sharesource.org/asciidoc/diff/55a5999bfd04/xhtml11.conf __________________________________________________________________ 14. Version 8.5.0 (2009-10-04) Additions and changes * Implemented a float attribute for tables and block images (HTML outputs only). * Added unfloat::[] block macro to cancel floating. * Added table align attribute to (HTML outputs only). * The image align attribute now works with HTML backends. * Renamed table cell align attribute to halign so it doesn’t clash with the new table align attribute. * Added breakable and unbreakable options to AsciiDoc example and block image elements. * [miscellaneous] section entries now update properly when set from a document AttributeEntry. * [miscellaneous] section pagewidth entry accepts fractional values. * Fractional column widths are now calculated correctly when using fractional pageunits (DocBook tables). * Use DocBook XSL table width processing instructions. * asciidoc KeyboardInterrupt exits with error code 1. * Added set system attribute to allow attributes to be set from configuration file templates. * Allow constrained quotes to be bounded on the left by a colons and semicolons, see [133]http://groups.google.com/group/asciidoc/browse_frm/thread/b276 a927fdc87995 * Titled listing and literal blocks (DocBook outputs) no longer default to examples. See [134]http://groups.google.com/group/asciidoc/browse_frm/thread/f4df 7c9eec01a9bd * Updated language file table, figure and example captions to accommodate new auto-numbering in html4 and xhtml11 backends. * Titled source highlight filter listings generated by docbook backend are now rendered as examples. See [135]http://groups.google.com/group/asciidoc/browse_frm/thread/f4df 7c9eec01a9bd * Implemented counter system attribute. * Use counter system attributes to number titled tables and block images in HTML backends. * Added program name suffix to console messages. * Added substitution to the AttributeEntry passthrough syntax, this replaces the now unnecessary attributeentry-subs attribute. * Allow passthrough inline macro syntax to be used in AttributeEntrys. * Reinstated 8.4.4 default lang attribute behavior. See [136]http://groups.google.com/group/asciidoc/browse_frm/thread/d299 24043e21cb6a. * Added max-width attribute to the xhtml11 backend to set maximum display width. See [137]http://groups.google.com/group/asciidoc/browse_frm/thread/74d9 a542b79ccd50. * Added a2x.py, a rewritten and much enhanced version of the old a2x bash script. * The new a2x can output EPUB formatted documents. * Added --safe option and deprecated --unsafe option. Patch submitted by Todd Zullinger. See [138]http://groups.google.com/group/asciidoc/browse_frm/thread/ea3a 8ea399ae5d2a and [139]http://groups.google.com/group/asciidoc/browse_frm/thread/69b3 183fdab7c6a5 * Added CHECK and TEST todo highlight words to Vim syntax highlighter. * Line breaks, page breaks, and horizontal rulers are now processed by dblatex, thanks to a patch submitted by Mark Fernandes ([140]http://groups.google.com/group/asciidoc/browse_frm/thread/a25 4cf949ea7c6c5). * Allow footnote macros hard up against the preceding word so the rendered footnote mark can be placed against the noted text without an intervening space (patch submitted by Stas Bushuev, [141]http://groups.google.com/group/asciidoc/browse_frm/thread/e1dc b7ee0efc17b5). * Normalized path in safe_filename function (submitted by Todd Zullinger, [142]http://groups.google.com/group/asciidoc/browse_frm/thread/69b3 183fdab7c6a5). * The Asciidoc numbered and toc attributes cause DocBook outputs to include asciidoc-numbered and asciidoc-toc processing instructions, these are used by DocBook XSL to include section numbering and table of contents (like Asciidoc HTML backends). For backward compatibility both numbered and toc attributes are defined by default when the docbook backend is used. See [143]http://groups.google.com/group/asciidoc/browse_frm/thread/1bad ad21ff9447ac. * data-uri attribute is now evaluated dynamically and can be set in document body (previously could only be set from command-line). * Added sys3 and eval3 system attributes to passthrough generated output, this fixes the data-uri inline image problem: [144]http://groups.google.com/group/asciidoc/browse_frm/thread/a42d b6bc54c2c537. * Missing language file generates a warning instead of an error. * Updated Spanish language file (updates contributed by Gustavo Andrés Gómez Farhat). Bug fixes * FIXED: Options in an AttributeList option attribute are merged with (rather than replace) configuration file options. * FIXED: Comment blocks and comment block macros no longer consume preceding block titles and attribute lists. * FIXED: examples/website/layout1.conf and examples/website/layout2.conf TOC problem. Submitted by Mark (burtoogle). See [145]http://groups.google.com/group/asciidoc/browse_frm/thread/b9c6 3be67dd1d11c * FIXED: Only the first occurrence of passthrough macro was substituted. Patch submitted by Peter Johnson. See [146]http://groups.google.com/group/asciidoc/browse_frm/thread/1269 dc2feb1a482c * FIXED: asciidoc now runs on Jython 2.5.0. * FIXED: Wordpress margins and pads in a number of block elements ([147]http://groups.google.com/group/asciidoc/browse_frm/thread/36f f073c79cbc20a). 14.1. Regression issues * Tables generated by dblatex occupy 100% of the available space regardless of the width attribute setting. To restore width behavior change the pageunits miscellaneous parameter to pt. You can do this from the command-line with the -a pageunits=pt option. See [148]DocBook table widths. __________________________________________________________________ 15. Version 8.4.5 (2009-05-24) Additions and changes * Added manpage Name and Synopsis section title customization to languages configuration files. * Synopsis manpage section no longer mandatory. * Section markup templates can be specified by setting the title’s first positional attribute or template attribute. * The article and book document header can now include a revision remark. * A role attribute can now be applied to block elements. This adds the role attribute to DocBook elements. Patch submitted by [149]Noah Slater). * Renamed revision and date attributes to more sensible and consistent revnumber and revdate (old names deprecated but still recognized). * Moved backend specific attributes to Appendix H in User Guide. * Renamed and generalized the docbook backend revision history inclusion mechanism to docinfo to reflect the use of all article or book information elements. The old revision history names still work but have been deprecated. * Refactored docbook.conf headers. * Moved line break replacement from [replacements] to [replacements2] so the replacement occurs after the mailto macro. This fixes bug [150]http://groups.google.com/group/asciidoc/browse_thread/thread/4 bdcdfb0af773e2 * The typewriter to punctuation apostrophe replacement can be escaped with a backslash. * Graphviz filter outputs images to imagesdir if it is defined. * Made the block image macro generic so that it can be used for filter outputs. As a result Music and Graphviz filters: + Have been greatly simplified. + Honor the data-uri attribute. + html4 outputs no longer generate W3C validation warning. * The iconsdir attribute no longer requires a trailing directory separator character. * Removed borders around linked html4 images. * Added html4 specific HTML output for music filter. * a2x: Added --unsafe option (shortcut for --asciidoc-opts=--unsafe). * a2x: The FOP executable can now be named fop (this is the default name in some distributions). * Attributes are now substituted in the system macro attribute list. * If the output is set to stdout (i.e. no output directory is defined) then Music and Graphviz filters will output included images to the source file directory. * Added name directive to testasciidoc. * Added lots of testasciidoc new tests. * Moved language specific configuration parameters into lang-en.conf file. * lang attribute entry can be specified in the AsciiDoc source file (preceding the header). * Removed cruft from A-A-P scripts and documented them. * Added German language config file (lang-de.conf) contributed by Michael Wild. * Added French language config file (lang-fr.conf) contributed by Yves-Alexis Perez. * Added Russian language config file (lang-ru.conf) contributed by Artem Zolochevskiy. * Added Hungarian language config file (lang-hu.conf) contributed by Miklos Vajna. Bug fixes * FIXED: Multiple manpage names are now handled correctly when generating DocBook output, each name now generates a separate DocBook <refname> element. See [151]http://groups.google.com/group/asciidoc/browse_thread/thread/c 93bb4db025225d8 * FIXED: A problem that caused AttributeEntries preceding the header to be overwritten when the language conf file loaded. * FIXED: Possible inline macro name ambiguity e.g. link matches olink. * FIXED: The documented macro definition deletion behavior had been broken for a long time. * FIXED: Email addresses not recognized when followed by a period character. * FIXED: Hyphens in mailto macros can delimit nested addresses e.g. bloggs@mail was processed inside mailto:joe-bloggs@mail-server.com[Mail]. * FIXED: User name in FTP URI generated incorrect FTP link. See [152]http://groups.google.com/group/asciidoc/browse_thread/thread/1 d796a9c9ddb2855 * FIXED: Source highlighter now works with Wordpress backend (see [153]http://groups.google.com/group/asciidoc/browse_thread/thread/6 d8c716748b109e3). 15.1. Regression issues 1. A colon following the date in the AsciiDoc header is treated as a revision remark delimiter — this could be an issue if you have used a colon in the header date. __________________________________________________________________ 16. Version 8.4.4 (2009-04-26) Additions and changes * Added table column and row spanning. * Table styles can now be applied per cell. * Vertical cell alignment can be applied to columns and individual cells. * Added table align attribute to set horizontal alignment for entire table. * Included Geoff Eddy’s update of the experimental LaTeX backend. * A new attribute named trace controls the output of diagnostic information. If the trace attribute is defined then element-by-element diagnostic messages detailing output markup generation are printed to stderr. * Added literal paragraph style (allows literal style to be applied to normal paragraphs). * Deleted unused replacements2 from xhtml11.conf. * Added replacements2 to default substitutions. * testasciidoc.py: messages to stdout, only diffs to stderr. * Added transparency to smallnew.png image. Bug fixes * All combinations of leading comments and attribute entries at the start of a document are now skipped correctly. * FIXED: ./configure doesn’t support --docdir as expected (patch submitted by Artem Zolochevskiy) * FIXED: Constrained quotes were incorrectly matched across line boundaries e.g. the string +\nabc+ incorrectly matched a monospace quote. __________________________________________________________________ 17. Version 8.4.3 (2009-04-13) Additions and changes * DocBook outputs default to DocBook version 4.5 doctype (previously 4.2). * Configuration file [specialsections] definitions can be undefined by setting their configuration entry values blank. * The Makefile install target depends on the all target to ensure pre-install patches are applied. * testasciidoc.py now emits user friendly messages if: 1. the configuration file is missing. 2. an illegal backend is specified. 3. an illegal test number is specified. Bug fixes * Fixed [154]missing template section error. * The testasciidoc.py --force option no longer deletes test data files that were not specified. * Dropped second quotes substitution in table cells — it had effectively disabled quote escaping in table cells. __________________________________________________________________ 18. Version 8.4.2 (2009-03-19) Additions and changes * Added [155]testasciidoc, a tool to verify AsciiDoc conformance. * A warning is issued if nested inline passthroughs are encountered. * asciidocapi: setting an attribute value to None will undefine (delete) the attribute (this in addition to the name! attribute name format that the asciidoc(1) command uses). __________________________________________________________________ 19. Version 8.4.1 (2009-03-10) Additions and changes * AsciiDoc now has a [156]Python API. The following minimal example compiles mydoc.txt to mydoc.html: from asciidocapi import AsciiDocAPI asciidoc = AsciiDocAPI() asciidoc.execute('mydoc.txt') * Backtick quoting for monospaced text is now implemented as an inline literal passthrough. This makes more sense since monospace text is usually intended to be rendered literally. See [157]Regression issues below for the impact this may have on existing documents. Here are some examples that would previously have had to be escaped: The `++i` and `++j` auto-increments. Paths `~/.vim` and `~/docs`. The `__init__` method. The `{id}` attribute. * Added --doctest option to asciidoc(1) command. * Added an optional second argument to BlockId element, this sets the {reftext} attribute which in turn is used to set the xreflabel attribute in DocBook elements. * Added lists to --help syntax summary. * {infile} and {indir} attributes reflect the current input file (previously always referred to the root document). * {docfile} (new) and {docdir} (previously deprecated) attributes refer to the root document specified on the asciidoc(1) command-line. * Vim syntax highlighter improvements. * Syntax summary command (asciidoc -h syntax) additions. * Admonition icons now have transparent backgrounds. * Changed yellow W3C badges to blue ones in page footers. Bug fixes * Dropped asciidoc(1) broken undocumented --profile option. * Em dash replacement now recognized at start of block. 19.1. Regression issues Replacing backtick quoting with the inline literal passthrough raises two regression scenarios for existing documents: 1. You have escaped the expansion of enclosed inline elements, for example: \{id}. You would need to delete the backslashes: {id} (if you don’t the backslashes will be printed). Mostly it’s just a case of interactively finding and replacing of all occurrences of `\. 2. There are enclosed inline elements, for example: some *bold* monospaced. You would need to switch to plus character monospace quoting: +some *bold* monospaced+ (if you don’t the enclosed elements won’t be expanded). If your existing documents include these cases and you don’t want to upgrade then use the -a no-inline-literal command-line option, alternatively put this in ~/.asciidoc/asciidoc.conf: [attributes] no-inline-literal= __________________________________________________________________ 20. Version 8.3.5 (2009-02-02) Additions and changes * Cached compiled regular expression delimiters (speed up User Manual compilation by 250%). * Created distinct list definitions for each numbered list style to allow nesting of all styles. * Roman numbers in numbered lists are followed by a closing parenthesis instead of a period to eliminate i, v, x item ambiguity with respect to alpha numbered list items. * Added **, ***, ****, ***** bulleted lists. * Added ..., ...., ..... implicit numbered lists. * Added :::, :::: labeled lists. * Updated User Guide for new list syntaxes. * Optimized paragraph and list termination detection with separate precompiled regular expressions for performance and to prevent reaching Python 100 named group limit. * Updated Vim syntax highlighter for new list syntaxes. * Allow template::[] macros in conf file entries sections (not just in template sections). * Dropped unused [listdef-numbered2] conf file sections. * Renamed ListBlock to more appropriate OpenBlock. * Implemented single-line versions of ifdef::[] and ifndef::[] macros. * html4 backend styling: + Underlined admonition captions. + Added side border to Example Blocks. * xhtml11 backend styling: + Dropped right hand margin from all but quote and verse blocks. + html4 backend: corrected over-sized width of caption in admonition block. Bug fixes * Fixed broken numbered list nesting. 20.1. Compatibility issues The roman numbered list parenthesis syntax is incompatible with the potentially ambiguous roman period syntax introduced in 8.3.2. __________________________________________________________________ 21. Version 8.3.4 (2009-01-20) Additions and changes * Implemented a title float style. A floating title (or bridgehead) is rendered just like a normal section 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. * Implemented inline comment macro so comment lines can now appear inside block elements. * Comment lines are sent to the output if the showcomments attribute is defined (comment blocks are never sent to the output). * Single quoting attribute values in AttributeList elements causes them to be substituted like normal inline text (without single quoting only attribute substitution is performed). * Rewrote list item processing (was very crufty). List continuation and list blocks now work as expected. Updated and clarified list documentation in User Guide. * The revision attribute now recognizes the RCS $Id$ marker format. * An RCS $Id$ marker formatted revision line in the header does not need to be preceded by an author line. * If an RCS $Id$ formatted revision is specified and the author name has not already been set then the author name in the $Id$ marker will be used. * Updated Gouichi Iisaka’s Graphviz filter to version 1.1.3. * Added autowidth table attribute option for (X)HTML outputs. * DocBook backend now puts orgname optional attribute in DocBook header. * Deprecated undocumented companyname attribute in favor of DocBook’s corpname. * Removed explicit closing backslash from HTML4 self-closing tags to comply with WC3 recommendation. Bug fixes * Fixed 8.3.3 regression whereby adjacent lists with the same syntax but different list styles were incorrectly treated as a single list. __________________________________________________________________ 22. Version 8.3.3 (2009-01-02) This release supersedes 8.3.2. Bug fixes * The broken and confusing numeration and numeration2 numbered list attributes have been dropped, use the style attribute instead. __________________________________________________________________ 23. Version 8.3.2 (2009-01-01) Additions and changes * Added Gouichi Iisaka’s Graphviz filter to distribution. * The SidebarBlock element can now be rendered with an abstract style. * Reorganized filters into a separate subdirectory for each filter. * Updated Makefile.in and MANIFEST files to reflect new filters organization. * Added listing style to LiteralBlock element so listings with nested listing blocks can be rendered as a listing block. * Changed example code filter to use preferred ListingBlock syntax (the old ~ delimited filter syntax is no longer used). * Implemented enumeration and enumeration2 numbered list attributes for specifying the list numbering style (arabic, loweralpha, upperalpha, lowerroman and upperroman). * AsciiDoc now recognizes upperalpha, lowerroman and upperroman numbers in listdef-numbered2 numbered lists and sets the number style based on the style of the first numbered list item (alternative to setting enumeration2 attribute). * Updated formatlistpat definition in .vimrc example in User Guide. * You can now backslash escape system block macros. * Added Pychart FAQ. * Drop paragraph text and list text, index and label match groups from attributes — they are included in the element’s text and we don’t want them processed a second time as attributes. * Changed comment line block macro to a passthrough block macro to ensure no substitutions. * A subslist no longer has to be appended to a PassthroughBlock macro definition, if omitted no substitutions are performed. * Code tidy up: replaced deprecated <> operator with !=. * Removed unused linuxdoc code. * Code tidy ups: dropped old types module reference; replaced has_key() with preferred in operator. Bug fixes * Old syntax source highlight filter regression: special characters where not escaped in DocBook outputs. __________________________________________________________________ 24. Version 8.3.1 (2008-12-14) Additions and changes * Replaced the install.sh script with Ben Walton’s updated autoconf scripts — see [158]INSTALL for details. * Added a generalized AttributeEntry syntax to allow arbitrary configuration file entries to be set from within an AsciiDoc document (suggested by Henrik Maier). * Listing delimited blocks in DocBook outputs now support IDs; IDs of titled Listing and Literal delimited blocks have been moved to the enclosing DocBook example tag (thanks to Vijay Kumar for this patch). * Replaced vertical typewriter apostrophe with punctuation apostrophe (thanks to Noah Slater). Bug fixes * Regression: Excluding double-quotes from unquoted attribute values resulted in backward incompatibility, double-quotes in unquoted attribute values has been reinstated. * Regression: Text like &...; was sometimes mistaken for an entity reference — tightened up entity reference matching. __________________________________________________________________ 25. Version 8.3.0 (2008-11-29) Additions and changes * [159]AsciiDoc new tables is a complete redesign of the tables syntax and generation. The new syntax and features are a huge improvement over the old tables. The old tables syntax has been deprecated but is currently still processed. * [160]Lists can now be styled like other block elements. This allows a single list syntax for glossary, qanda (Question and Answer) and bibliography lists instead of having to remember a different syntax for each type. * Inline passthroughs macros have been improved and block passthrough macros added. Attribute substitution can be optionally specified when the macro is called. * The passthrough block has a fully transparent passthrough delimited block block style called pass. * The asciimath and latexmath [161]passthrough macros along with asciimath and latexmath [162]passthrough blocks provide a (backend dependent) mechanism for rendering mathematical formulas. There are [163]LaTeX Math, [164]AsciiMathML and [165]LaTeXMathML examples on the AsciiDoc website. * Reimplemented and cleaned up filter processing based on a patch submitted by Kelly Anderson. Uses the newer subprocess module instead of the deprecated popen2 module. Now works in Win32 command shell. * Addition FAQs, more documentation updates. * Arbitrary HTML/XML entities can be entered in AsciiDoc source. * Did away with the need for the shaded-literallayout.patch (thanks to Henrik Maier for this patch). * Implemented page break block macro. * Added line breaks and ruler processing instructions to DocBook outputs (thanks to Henrik Maier for this patch). * Added deg (degree) and wj (word joiner) entity attributes (thanks to Henrik Maier). * Tweaked DocBook indexterm2 macro to avoid white space preceding the term when used in table cells (thanks to Henrik Maier for this patch). * Title elements now process the options attribute like other block elements. * Added ‘single quoted’ element. * Spaces on both sides of a — em-dash are translated to thin space characters. * Improved detection and reporting of malformed attribute lists. * The list compact style is now a list option. * Added strong labeled list option which makes the labels bold (HTML outputs only). * Dropped unsupported linuxdoc backend. * Dropped deprecated xhtml-deprecated (version 6) backend. * Added breakable and unbreakable attribute options to tables to control table breaking across page boundaries (DocBook XSL/FO outputs). By and in collaboration with Henrik Maier. * Added pgwide attribute option to tables to table, block image, horizontal labeled lists. Specifies that the element should be rendered across the full text width of the page irrespective of the current indentation (DocBook XSL/FO outputs). Thanks to Henrik Maier for this patch. * Vim syntax highlighter: spaces before/after bullets no longer highlighted (which is ugly if using a theme that highlights with underlines). Thanks to Donald Chai for this patch. * Added a2x(1) --fop option. * Added a2x(1) --no-xmllint option. * Highlighted labelled list terms with the navy color in XHTML outputs. * Use w3m(1) as default a2x(1) text format generator (fallback to lynx(1)). * Changed callout formats in html4 and xhtml11 outputs to angle brackets to match source highlighter rendering. * Macros now inject user defined <optionname>-option attributes into markup. * Added IRC URLs to AsciiDoc inline macros. * Added depth attribute to include::[] system macro. * Added footnoteref inline macro. * Added stylesheet XHTML attribute to specify additional custom CSS stylesheet. * If a paragraph style is specified it will be added to the XHTML class attribute and DocBook role attribute. * Replacements can be set in a document using the reserved AttributeEntry name replacement. * The prefix for auto-generated section name IDs can be set with the idprefix attribute. Bug fixes * Escaped quote skipped over leading and trailing quote instead of just the leading quote. * Fixed bug that was causing false negative safe mode warnings (patch submitted by Julien Palmas). * Placed priority of AttributeEntry, AttributeList and BlockTitle above Title. This ensures an AttributeEntry, AttributeList or BlockTitle followed by a same length leading ListingBlock delimiter is not mistaken for a two-line title. * Vim syntax highlighter: fixed multi-line quoted text. * Contstrained quote termination after non-space character enforced. * Vim syntax highlighter: unterminated quoted text is no longer highlighted. * Vim syntax highlighter: passthroughs now exactly match AsciiDoc semantics. * Vim syntax highlighter: escaped quoted text, attribute references and inline macros are not highlighted. * Vim syntax highlighter: TODO’s highlighted in CommentBlocks (thanks to Scott Wall); non-greedy $$...$$. * Vim syntax highlighter: Comment lines mistaken for vertical list labels (thanks to Scott Wall). * Vim syntax highlighter: Single unmatched $$ mistakenly highlighted remaining text (patch contributed by Scott Wall). * Callouts now work in source highlighted listing generated by dblatex. * Fixed exception that occured if undefined attribute was present in filter command. * AttributeList block can now follow a paragraph without intervening blank line. * The include macro tabsize attribute is no longer propagated to nested includes. Omissions The following features were implemented but then but removed from this release: * pi, cdata and comment passthrough macros and passthrough block styles (creeping featurism, use pass macros instead). * Generic tag inline macro (creeping featurism, use pass macros instead). 25.1. Compatibility issues Version 8.3.0 has a number of backward incompatibilities with respect to the previous 8.2.7 release: * The old table syntax is still processed but a DEPRECATED warning is issued. * Entity references have to be escaped with a backslash. * You have to explicitly precede horizontal style labeled lists with the [horizontal] style attribute — by default all labeled lists are rendered vertically. * The list compact style has been dropped and is now a list option (use options="compact" in attribute lists). * AsciiDoc version 6 sytnax no longer supported. * Linuxdoc been removed from the distribution. * The unsupported experimental latex backend has not been tested on this release. * The introduction of single-quote quoting requires that double-quote quoting is escaped with two backslashes. __________________________________________________________________ 26. Version 8.2.7 (2008-07-04) Additions and changes * Added dvi, ps and tex output format options to a2x(1). * Added --dblatex option to a2x(1) so dblatex(1) can be used to generate PDFs. * Added custom dblatex(1) configuration files (in distribution ./dblatex directory) that are used by a2x(1). * dblatex(1) is now used to generate the distributed PDF version of the AsciiDoc User Guide. * If you don’t need a customized the link caption you can enter the http, https, ftp, file URLs and email addresses without any special macro syntax — you get the links by just cutting and pasting URLs and emails addresses. This also makes it easier to open links directly form AsciiDoc source ( most editors allow you to open URLs directly). The Vim syntax highlighter has been updated to reflect these changes. * Highlighted source code paragraphs have been implemented — it’s a much more convenient way to enter short code examples (see [166]the online docs). * The source highlighter and music filter syntax has changed — they now used the ListingBlock syntax customized with source and music style attribute values. This follows the Paragraph styling convention introduced by the source paragraph (previous item) and is easier to read. The old syntax still works but has been deprecated. * QuoteBlocks now have a verse style — you no longer have to nest a verse LiteralBlock inside a QuoteBlock for verses. The verse style on the LiteralBlock has been deprecated (still works though) and the style attribute is positional attribute 1, pushing attribution and citetitle attributes to the right (you’ll need to insert a quote attribute into your existing QuoteBlocks). * It is no up to the DocBook processor to highlight source code syntax in <programlisting> elements rather than GNU Highlighter — this is the correct way to handle it, plus dblatex(1) makes a much better job. * scaledwidth and align attributes have been added to the image macro. They apply to DocBook outputs (specifically for PDF documents). scaledwidth sets the image size as a percent of the available page width; align applies left, center or right horizontal image justification. * Added a2x(1) --fop-opts=FOP_OPTS option (patch submitted by Miklos Vajna). * Added a2x(1) --dblatex-opts=DBLATEX_OPTS option. * Added Mikhail Yakshin’s FOP 0.95 patch which fixes a long-standing fo.xsl problem and allows PDF’s to be generated with FOP 0.95 (previously had to use FOP 0.20.5). * The User Guide has been updated and outdated FOP configuration and installation sections removed. Bug fixes * Fixed stylesheets/xhtml11-manpage.css not being included when linkcss attribute was used. * Configuration file *-style attributes are now dumped correctly. * Fixed FAILED: malformed section entry LaTeX backend error. See the also the [167]AsciiDoc repository changelog. __________________________________________________________________ 27. Version 8.2.6 (2008-04-29) Additions and changes * Enhancements to the Vim AsciiDoc syntax highlighter, for example, quoted text is now highlighted in titles and macro captions. * If you define the data-uri intrinsic attribute images referenced by image macros will be embedded in XHTML using the [168]data: URI scheme. NOTE: Microsoft browser support for the data: URI scheme is currently limited to MSIE 8 beta 1. * Added toc-title attribute to allow custom table of contents titles. * Added references to Alex Efros’s AsciiDoc Cheatsheet to AsciiDoc website. * asciidoc(1) and a2x(1) man pages formatted to conform to man-pages(7) recommendations. * Old code-filter syntax (pre-8.1.0) is no longer recognized so that malformed two-line level 2 titles are no longer confused with code-filter block delimiters. * Added → ← ⇒ ⇐ arrow replacements from the Arrows block of Unicode. * Added DocBook refentry lang attribute — patch contributed by VMiklos. * AttributeEntry names can now be numeric (“named macro targets”). * Hide Table of Contents title if Table of Contents empty — patch contributed by Alex Efros. * Various XHTML CSS tweaks. * Code cleanup: + Replaced realpath() with Python 2.2 os.path.realpath() library function. + Replaced old string library functions with string methods. + Use file generators instead of readlines(). + Renamed entities that shadowed builtins. + Standardized string quoting. + Dropped readlines() function. Bug fixes * Fixed broken CSS for decimal ordered lists nested in alpha ordered list, thanks to Alex Efros. * A missing closing block delimiter now reports the opening delimiter line number instead of the end of file line number. * Fixed an error generated by the asciidoc -e option when there are no block definitions — patch contributed by Alejandro Mery. * Handle both \r\n (as well as \n) line separators that may be returned by {sys} attribute evaluation. * Numbered attribute names no longer interfere with positional attribute list values. __________________________________________________________________ 28. Version 8.2.5 (2007-11-18) Bug fixes * Fixed exception thrown by illegal command-line arguments. * Rolled back the with warning bug fix introduced in 8.2.4 — it was incompatible with Python <2.5. __________________________________________________________________ 29. Version 8.2.4 (2007-11-10) Additions and changes * You can now use the lang attribute to set the DocBook language attribute. * Attribute values can now contain attribute references. * If the lang attribute is defined then configuration files named like lang-<lang>.conf will be loaded automatically. * The help file name help-<lang>.conf is based on the AsciiDoc lang attribute, defaults to help.conf (English). * Admonition, figure and table captions have been factored into a predefined set of caption_* attributes. They only apply to directly generated (X)HTML outputs (DocBook stylesheets generate their own language specific captions based on the lang attribute). * Dropped platform dependent doc/asciidoc.chm file from distribution documentation formats. Bug fixes * The spurious warning with will become a reserved keyword in Python 2.6 has been suppressed. __________________________________________________________________ 30. Version 8.2.3 (2007-09-12) Additions and changes * Added VMiklos’s permalink patch for auto-generated section IDs (enabled by default by the sectids attribute). * Added [169]FAQ to website. * Changed format of {localdate} attribute to ISO 8601 (%Y-%m-%d). * Added abc2ly --beams=None option to make music2png.py conform to ABC’s notion of beams. * XHTML level 2 section headings are now styled with an underlining border. * XHTML links to AsciiDoc title elements are now implemented with title ID attributes (previously separate <a> element targets were generated. * Multi-word first, middle and last names can be entered in the header author line using the underscore as a word separator. * The nested inline macros restriction has now been lifted, for example you can now include links and inline images inside footnotes. * Help topic names can be shortened (so long as they are not ambiguous). For example asciidoc -hm will print the AsciiDoc man page. * Added {two_colons} and {two_semicolons} attributes for escaping labeled list ambiguity. * If quirks mode is disabled the XHTML Mime Type is set to the recommended application/xhtml+xml (rather than text/html). Bug fixes * Author information is now correctly set when using attribute entries in the header instead of an author line (previously the author attribute was not being calculated correctly and there were attribute substitution problems). __________________________________________________________________ 31. Version 8.2.2 (2007-07-22) Additions and changes * [170]LaTeXMathML capability has been added for users who are more familiar with or prefer LaTeX math formulas to the [171]ASCIIMathML notation (thanks to Arthur Sakellariou for the patch). * The source highlight and code filters now process embedded callouts. * Added an --attribute=ATTRIBUTE option to a2x(1) for passing attribute values to asciidoc(1) (a shortcut for --asciidoc-opts="-a ATTRIBUTE"). * Image block and inline macros prepend optional {imagesdir} attribute to image link targets. Bug fixes * Fixed an assertion error that occurred when a configuration file containing an include::[] macro was loaded using the --conf-file option and the configuration file name did not include an explicit directory path — patch submitted by Dmitry Potapov. * Asciidoc titles are only converted to lower case if all characters are upper case otherwise case is left unchanged — patch submitted by Dmitry Potapov. * Added a missing check that input is not stdin before loading configuration files from the document directory — patch submitted by Dmitry Potapov. * Attribute list items must evaluate to strings, numbers or None (previously it was possible to evaluate to other object types which resulted in surprising attribute values). * If an AsciiDoc document has no title an empty XHTML 1.1 title element is created — previously the title element was dropped which resulted in invalid XHTML 1.1. * The Vim syntax file no longer highlights escaped callouts. * The Vim syntax highlighter now correctly highlights Double-dollar passthroughs when they enclose dollar delimited ASCIIMathML and LaTeXMathML formulas. __________________________________________________________________ 32. Version 8.2.1 (2007-04-06) Additions and changes * A number of improvements have been made to the Vim syntax highlighter, for example the word C++ is no longer mistaken for the start of an unconstrained monospace quote. * Labeled list definitions have been tightened — a list label can no longer containing trailing spaces. The following example is no longer recognized as a valid list label: Lorum ipsum This change implements the originally intended behavior (as per the AsciiDoc documentation and examples) so there should be very few compatibility issues. __________________________________________________________________ 33. Version 8.2.0 (2007-04-04) Additions and changes * A Vim syntax file is now included in the AsciiDoc distribution (inspired by Felix Obenhuber’s asciidoc.vim script). You can find it (along with a Vim filetype detection script in the distribution ./vim/ directory (the scripts are installed automatically by the AsciiDoc installer ./install.sh). See Appendix J of the AsciiDoc User Guide for details. * Added toclevel attribute (1..4) which sets the number of title levels reported in the table of contents. Defaults to 2 and must be used with the toc attribute. Example usage: $ asciidoc -a toc -a toclevels=3 doc/asciidoc.txt * Added a listindex attribute which is the current list item index (1..). If this attribute appears outside a list its value is the number of items in the most recently closed list. * The single line titles syntax now accepts trailing suffixes — this syntax matches the title line syntax of a number of popular Wiki markups. * If a QuoteBlock has no attribution or citetitle then the DocBook <attribution> element is not generated (previously generated empty <attribution> element). * If the text of a labeled list item is blank then no texttag is written. * An end of line backslash performs line continuation for horizontal labeled list items. * The Revision line now accommodates Subversion $Id markers (in addition to CVS and RCS markers). Thanks to Tiago Sturmer Daitx for this patch. * Implemented a2x(1) option --skip-asciidoc which allows a2x(1) to convert DocBook XML files not derived from AsciiDoc sources. * If a2x(1) --doctype option is not specified it defaults to manpage if --format=manpage else defaults to article (previously --doctype always defaulted to article). * Added an External Resources section to the [172]AsciiDoc home page. __________________________________________________________________ 34. Version 8.1.0 (2006-10-22) Additions and changes * AsciiDoc generated XHTML documents now display a table of contents if the toc attribute is defined (JavaScript needs to be enabled for this to work). Thanks to Troy Hanson who contributed this feature based on a JavaScript by Mihai Bazon. I’ve simplified things somewhat to match Docbook XSL Stylesheets style, see Troy’s [173]tpl User Guide for a fancier layout. Use the -a toc -a numbered command-line options to produce a number table of contents. * A [174]music filter is included in the distribution ./filters/ directory. It translates music in [175]LilyPond or [176]ABC notation to standard classical notation in the form of a trimmed PNG image which is inserted into the AsciiDoc output document. * Incorporated Paul Melis’s Win32 filter patch. This workaround allows AsciiDoc to run filters under Windows. * Added uninstall.sh script. * Rather than proliferate a confusing number of filter block delimiters the following convention has been adopted: delimiters belonging to DelimitedBlock filters distributed with AsciiDoc will consist of a word (normally a noun identifying the block content) followed by four or more tilde characters. This has necessitated changing existing filter delimiters (the old delimiters still work but may be deprecated in future versions): + The example code filter block delimiter is now the word code followed by four or more tilde characters. + The source highlight filter block delimiter is now the word source followed by four or more tilde characters. * Conditionally redefined subscript and superscripting so they use the old replacements mechanism when asciidoc7compatible is defined rather than the asciidoc 8 default unconstrained quoting (patch for affected files attached). * Moved the source highlight filter from ./examples/ to ./filter/. * Added {verbose} intrinsic attribute (useful for passing verbose flag to filters). * Added {outdir} intrinsic attribute. * Renamed {docdir} intrinsic attribute to unambiguous {indir} ({docdir} still works but may be removed in future release). * If asciidoc(1) outputs to stdout then intrinsic attribute {docname} is extracted from the input file name. __________________________________________________________________ 35. Version 8.0.0 (2006-08-27) This is a major release because changes to quoting and index entry handling may break existing documents (see Additions and changes below and Appendix A: Migration Notes in the AsciiDoc User Guide). Please report any problems you encounter. [177]Stuart Rackham Additions and changes * Quoting can can occur within words (based on patch submitted by Benjamin Klum). See the Unconstrained Quotes sub-section in the User Guide. * The underline and plus characters can be used as alternatives to the existing apostrophe and backtick quote characters. They are arguably better choices than the apostrophe and backtick as they are not confused with punctuation. * The syntax for index entry macros have have been deprecated from +...+ and ++...++ to ((...)) and (((...))) respectively. Rationale: + Bracketing is consistent other with [[...]] and <<...>> reference macros. + To easily confused with triple plus passthroughs. + To make way for the new monospace quoting. * Superscripts and subscripts are implemented as constrained quotes so they can now be escaped with a leading backslash and prefixed with with an attribute list. * An experimental LaTeX backend has been written by Benjamin Klum (a number additions in this release are to accommodate the LaTeX backend). * include macro file names now expand environment variables and tilde expansions. * A configuration file [quotes] entry can be undefined by setting to a blank value. * Added callto inline macro for Skype callto links. * Added colnumber attribute for table data markup. * A leading comment block or comment lines are now skipped (previously a document had to start with either attribute entries or a document Title). * Experimental rows attribute (number of source lines in table) available in table markup templates (used by experimental LaTeX backend). * Included install shell script written by [178]Jacob Mandelson for installing the tarball distribution. * Added INSTALL documentation file. * Added replacements2 substitution options — a second replacements section. * Added the ability to redefine normal and verbatim substitutions with subsnormal and subsverbatim entries in configuration file [miscellaneous] section. * By default AttributeEntry values are substituted for specialcharacters and attributes, if you want a different AttributeEntry substitution set the attributeentry-subs attribute. * The name in name=value configuration file entries can now end with a backslash, just escape the trailing backslash with a backslash. For example: abc\\=xyz Results in name=abc\ and value=xyz — previously this would have escaped the = character. * A blank configuration file section deletes any preceding section with the same name (applies to non-markup template sections). * A command-line attribute value with a @ suffix does not override existing document and configuration file attributes (normally command-line attributes have precedence over document and configuration file attributes). * localtime attribute is now encoded from the native system encoding to the output encoding. Patch submitted by [179]FKtPp — here’s his description of the problem: “I am a Chinese user of AsciiDoc and I find that when I use UTF-8 (the default encoding) to write asciidoc documents in Windows platform the resulting html footer line will get screwed. It was caused by a localized tzname that was always encoded in the windows native encoding, which in my case is cp936.” * a2x(1) can generate Open Document Text files using [180]docbook2odf. Currently docbook2odf(1) only processes a subset of DocBook, unimplemented elements are skipped. * The a2x(1) format option defaults to xhtml (previously a format had to be specified explicitly). * The -d, \--doctype=DOCTYPE option has been added to a2x(1) which is a shortcut for --asciidoc-options="--doctype=DOCTYPE". * Replaced a2x(1) --no-icons and --no-copy options with their negated equivalents: --icons and --copy respectively. The default behavior has also changed: copying and use of icons is disabled by default. Rationale: + To make the default behavior more consistent since use of icons and CSS stylesheets does not apply to all formats. + To make the default behavior less surprising (the creation of icon and stylesheet output files must now be explicit). * a2x(1) has been bumped from version 0.1.1 to version 1.0.0. Bug fixes * Removed duplicate ./doc/a2x.1.txt from distribution tarball. * Documentation errata. * Attribute replacement is no longer performed twice in Titles and AttributeEntrys. * a2x(1) skipped asciidoc(1) execution when rerun with different --asciidoc-options options, it now always executes asciidoc(1). The problem was that previously asciidoc(1) was executed only if the output file was missing or older than the source file. __________________________________________________________________ 36. Version 7.1.2 (2006-03-07) Additions and changes * Support for [181]ASCIIMathML has been added. See Appendix I: ASCIIMathML Support in the User Guide and the examples at [182]http://asciidoc.org/asciimath.html. * You can now prefix quoted text with inline attributes lists. You can use this to set font size and color (XHTML and HTML outputs). * Added ##...## quoting — it does nothing — it’s purpose is to allow inline attributes to be applied to normal text. * An inline passthrough mechanism has been implemented. * Configuration file comment lines can be escaped with a backslash — this is to allows the inclusion of configuration lines that start with a hash character. * The scriptsdir attribute can be used to specify the name of the directory containing linked JavaScripts (see the [183]User Guide for details. * The BackendBlock has been renamed PassthroughBlock for consistency with the new inline passthrough naming. * a2x(1) now works with the older bash(1) version 2.05b. Patch submitted by [184]Francis Daly. * Content included by the include1::[] system macro is no longer subject to attribute substitution so that ambiguities no longer arise when used to include CSS or JavaScript files. __________________________________________________________________ 37. Version 7.1.1 (2006-02-24) Additions and changes * The caption attribute can be used to customize admonition captions as well as image, table and example block element title prefixes (xhtml11 and html4 backends). * You can now override the default icon image using the icon attribute to specify the path of the linked image (xhtml11 and html4 backends only). * The deprecated imagesdir attribute is no longer recognized (use iconsdir instead). * Added Appendix H: Using AsciiDoc with non-English Languages to the AsciiDoc User Guide. * Added Admonition Icons and Captions subsection to the User Guide explaining how to customize Admonition elements. Bug fixes * a2x(1) failed when configuration files were installed in the global /etc/asciidoc/ directory — it was only searching the directory containing the asciidoc executable (thanks to Christian Wiese for finding and submitting a patch this bug). * The html4 backend admonition caption now correctly displays the admonition caption attribute (previously displayed the style attribute). __________________________________________________________________ 38. Version 7.1.0 (2006-01-13) Additions and changes * a2x(1) toolchain wrapper utility. This overcomes the biggest hurdle for new users which seems to be assembling and using a working DocBook XML toolchain. With a2x(1) you can generate XHTML (chunked and unchunked), PDF, man page, HTML Help and text file outputs from an AsciiDoc input file with a single command. All you need to install (in addition to AsciiDoc) is xsltproc(1), DocBook XSL Stylesheets and optionally FOP (if you want PDF) or lynx(1) (if you want text). * Block titles can now start with any non-space character (previously where not allowed to start with .~-_ characters). * ./stylesheets/docbook.css renamed to ./stylesheets/docbook-xsl.css to clarify its function. * Renamed ./docbook-xsl/manpages.xsl to ./docbook-xsl/manpage.xsl for consistency. * Admonition and navigation icons moved to ./images/icons/ to clarify usage and conform with a2x(1) usage. * Renamed xhtml11 intrinsic attribute imagesdir to iconsdir to keep vocab consistent and changed default value to ./images/icons (previously ./images). imagesdir attribute still accepted but deprecated. * Unused image files have been weeded out of the distribution. * Packager notes (appendix B) have been updated to reflect the needs of a2x(1). Important The renaming of the xhtml11 backend imagesdir intrinsic attribute and it’s new default value introduces a backward compatibility issue: if you use the icons attribute you will need to either move your icons to the new default ./images/icons location or include an --attribute{nbsp}iconsdir="your_icons_path" option in your asciidoc commands. Bug fixes * Backslash line continuation is now observed in verbatim paragraphs. * Fixed errors generated by example ./examples/website/build-website.sh script. __________________________________________________________________ 39. Version 7.0.4 (2005-12-08) Additions and changes * Added ternary conditional attributes {<name>@<regexp>:<value1>[:<value2>]} and {<name>$<regexp>:<value1>[:<value2>]}. * Safety violations now generate errors (they previously generated warnings). * asciidoc(1) now defaults to safe mode, consequently the [miscellaneous] safe mode entry and --safe command-line option are no longer necessary (though for backward compatibility asciidoc(1) still accepts the --safe option). * Backend Blocks are now flagged unsafe (they could be used to include arbitrary and hence potentially unsafe output content). * Filters are no longer considered unsafe. There’s not much point in insisting on filter safety since the installation of an unsafe filter would require the introduction of new or modified configuration files — if your application configurations can be compromised you’re in all sorts of trouble (safe mode protects against unsafe input files not unsafe configuration). As with all filters, before installing, you should verify that they can’t be coerced into generating malicious output or exposing sensitive information. Bug fixes * Fixed a lot of glaring grammatical and factual errors in the User Guide. __________________________________________________________________ 40. Version 7.0.3 (2005-12-01) Additions and changes * Added --safe and --unsafe command-line options — AsciiDoc can now be executed in a safe mode which disallows the execution of arbitrary code or the inclusion of arbitrary files (see [185]Appendix C in the AsciiDoc User Guide). * Included [186]source-highlight filter in the distribution ./examples/source-highlight-filter/ directory (based on filter submitted by [187]Ryan Phillips). * Included the DocBook XSL Stylesheets 1.69.1 customizations used to generate the distributed AsciiDoc documentation (read the asciidoc-docbook-xsl.txt file in the distribution ./docbook-xsl/ directory). * AsciiDoc DocBook XSL Stylesheet drivers moved from ./doc/ to ./docbook-xsl/. * Modified ./doc/manpages.xsl so only URL content is displayed in manpages. Bug fixes * Explicitly set table CSS border style (xhtml11 backend) to solid because default border styles vary from browser to browser. __________________________________________________________________ 41. Version 7.0.2 (2005-08-28) Additions and changes * There are now long versions of all AsciiDoc options. * If the --backend is not specified it defaults to xhtml11. * Added CSS simulated frames layout to the examples website (see ./examples/website/layout2/README-website.txt). This layout does not work with IE6 and the original tables based layout is still the default. * Support page added to AsciiDoc website. Bug fixes * Invalid options are now trapped gracefully. * Documentation errata. __________________________________________________________________ 42. Version 7.0.1 (2005-06-24) Additions and changes * Reverted to use of strong, em, tt XHTML tags — they’re more obvious and no less correct than span tags, besides, the generated file sizes are smaller (the User Guide was 11% smaller). * Table title rendered with caption tag rather than a separate div. * The AsciiDoc stylesdir attribute (if specified) is now recognized when searching for embedded stylesheets (previously only searched default ./stylesheets directory). * Default charset encoding changed from ISO-8859-1 to UTF-8 — it’s less language specific and displays most common languages. * template::[] macros now expand in all configuration file sections previously only in markup template sections. * Cleaned up example website layout CSS and configuration (presentation has not been changed). * Refactored xhtml11.conf configuration file. * Set consistent and sensible permissions on distributed files. * White space is now stripped from DSV formatted table cell data. * class="tableblock" attribute added to tables generated by xhtml-deprecated-css.conf to assist CSS. Bug fixes * Illegal character set encoder (specified by the AsciiDoc encoding attribute) and character data are trapped gracefully. * AsciiDoc table format attribute in table attribute lists were not recognized. * The nested horizontal labeled list example in the AsciiDoc User Guide has been dropped — it generated invalid DocBook markup. __________________________________________________________________ 43. Version 7.0.0 (2005-06-06) This is a major release with many code and documentation changes. Please report any problems you encounter. [188]Stuart Rackham Additions and changes * A new xhtml11 backend generates XHTML 1.1 with integrated CSS2 replacing the previous xhtml, css, and css-embedded backends. * The CSS stylesheets have finally been rewritten. * The asciidoc(1) command help now includes user [189]customizable help topics. When asciidoc is invoked with the --help option the command argument is interpreted as a help topic. * The previous example website has been replaced by the actual AsciiDoc website (see ./examples/website/. * XHTML generation options now controlled by the following attributes: badges, linkcss, icons, numbered, quirks, theme, stylesdir, imagesdir (see the [190]User Guide for details. * By default HTML and XHTML are output as stand-alone documents (no embedded CSS and no linked admonition icon images). * Documents encoded with the UTF-8 Unicode character set are now processed thanks to a patch supplied by [191]Viktor Vasilev. * The -a ^name command-line syntax to undefine an attribute has been deprecated in favor of the -a name! syntax. * AttributeEntry syntax addition: :name!: to undefine name attribute. * Added template system block macro to allow the inclusion of one configuration file template section within another. * A verse style attribute can now be applied to literal paragraphs and blocks to reproduce line breaks and white space from the source document. * Replacements and Special Words can now be escaped with leading backslashes. * Replacements are now processed in configuration file order (previous ordering was indeterminate). * System macros can now be used in the base asciidoc.conf configuration file. * Deprecated features that emitted warnings in prior versions are no longer tolerated. * The eval system attribute expression evaluates to False the attribute is undefined, if it evaluates to True the result is an empty string. * The Paragraph and DelimitedBlock presubs parameter can be aliased as subs. * Added verbatim substitutions option. * Renamed List Continuation Block to List Block and renamed the listcontinuation option to list. * Deprecated default substitutions option (use normal instead). * The section-numbers section numbering attribute has be renamed numbered. * Dropped the #UNDER CONSTRUCTION# block macro. * Rewrote Paragraph and DelimitedBlock handlers adding a [192]styles configuration entry. Bug fixes * Included files are no longer read inside conditionally excluded content. * Manpage command names containing dashes (in the manpage NAME section) were misinterpreted as the spaced dash command name/purpose separator. Bug report and patch supplied by [193]David Greaves. * Unexpected error following malformed author line error. __________________________________________________________________ 44. Version 6.0.3 (2005-04-20) Additions and changes * Special characters are now substituted in AttributeEntry element values. * Spaced and unspaced em dashes are now recognized (previously only spaced em dashes were recognized). * Replaced the table noborders option with richer frame and grid attributes. * The duplicate macro warning message now only occurs when the verbose (-v) option is enabled. * Single lines starting with two forward slashes hard up against the left margin are treated as comments and are not processed. * Renamed section delimited block option to sectionbody to more accurately reflect it’s role. * Added a List Continuation block — a specialized delimited block that is functionally equivalent to the List Item Continuation feature except that the list contained within the block does not require explicit + list item continuation lines. * Dropped deprecated <u> tags from generated HTML. * Literal Block delimiters must now consist of at least four points (previously three) to avoid lone ellipsis ambiguity. Bug fixes * Some system attribute evaluation failures caused unexpected exceptions to occur. __________________________________________________________________ 45. Version 6.0.2 (2005-03-30) Additions and changes * Three new system block macros have been added — eval, sys and sys2 which are the block macro equivalents to the same named system attributes. * Intrinsic macros have been renamed system macros along with action attributes which have been renamed system attributes: + To reflect their common (though contextually different) behavior. + To avoid confusion with intrinsic attributes. Bug fixes * Asciidoc now searches in /etc/asciidoc/filters for filters. __________________________________________________________________ 46. Version 6.0.1 (2005-03-06) Additions and changes * A global configuration file location /etc/asciidoc has been added and is now processed before all other locations (patch supplied by [194]Fredrik Steen). * Recoded tempfile.mktemp() and other artifacts that are no longer necessary or desirable (patches supplied by [195]Fredrik Steen). * Added BUGS file to the distribution. Bug fixes * Illegal comment syntax in css-embedded-stylesheet.conf resulted in illegal CSS in files generated by the css-embedded backend. __________________________________________________________________ 47. Version 6.0.0 (2005-01-28) This release has had some fairly major code and documentation changes. Please report any problems you encounter. [196]Stuart Rackham A lot of new stuff. A new major version number — some regression incompatibility (hopefully mitigated by deprecated warnings). Went mad trying to rein in the current feature anarchy — established a unified notion of document attributes. Attempted to introduce a consistent vocabulary — renamed many poorly or inconsistently named entities. Actually, deprecated syntax is still processed correctly in almost all cases. One source of incompatibility that may arise if you have customized CSS stylesheets is the change of AsciiDoc CSS class names (see below). I guess the moral is if you’ve done a lot of configuration file customization and are happy with version 5 then you may want to stay put. Note This version requires Python 2.3 or better to run. Additions and changes * Glossary entries have been renamed attributes. This eliminates confusion with the accepted meaning of glossary. * An AttributeEntry block element has been added so that document attributes can be assigned from within an AsciiDoc document. * The AttributeList block element has been added which is a more general solution than the (now deprecated) DelimitedBlock arguments. * An BlockId element has been added for setting block element anchor (link target) IDs. * Quoted text can now span multiple lines (thanks to James Bowlin for this patch). * Inline macros can now span multiple lines. * ‘`double backtick / apostrophe’' quotes generate “curly quotes”. * A warning is now emitted for out of order list item (applies to explicitly enumerated numbered list items). * Added include action attribute. * A line of three or more apostrophes generates an HTML horizontal ruler (<hr/> tag). You will get a warning if processed with non-HTML backend. * An {imagesdir} attribute specifies image file location for images referenced in configuration files when generating HTML (the default location is images). * An {stylesdir} attribute specifies the location of CSS stylesheets when generating styled HTML (the default location for configured markup is .). * The use of the (often inappropriately named) {caption} attribute list entry has been deprecated, use {0} instead. * New ExampleBlock delimited block along with associated variants Note, Tip, Warning, Caution and Important. * The docbook.conf file now facilitates the optional inclusion of a DocBook revision history file. * To better reflect their purpose the following block elements have been renamed: VerbatimBlock to ListingBlock; IndentedBlock to LiteralBlock; IndentedParagraph to LiteralParagraph; CustomBlock to BackendBlock; SimpleSection to SectionBody. Any corresponding CSS class names have also been changed which could result in backward incompatibility in customized stylesheets. * Swapped plain DocBook admonition icons for Jimmac’s DocBook icons ([197]http://jimmac.musichall.cz/ikony.php3). The original plain icons have been moved to ./images/plain. * Renamed html backend to xhtml to better reflect it’s function (former html-4 backend renamed to html). * A new inline anchor macro syntax [[[<id>]]] is available, it displays [<id>] at the anchor location and is for anchoring bibliography list entries. * An optional single-line titles syntax can be used. * Tweaks to distributed CSS stylesheets and FOP fo.xsl customization file. * List Item Continuation has been implemented which allows additional block elements to be included in list items by separating them from the preceding list item element with a line containing a single plus character. * A new Horizontal Labeled List list type has been added. Generates two column list — the first column contains the list element labels, the second contains the element text. Same syntax as Vertical Labeled Lists except the double colon label suffix is followed by the start of the list item text. Bug fixes * Fixed broken backslash line continuation. * Labeled list end tags were not undergoing attribute substitution. * Documents without any author information now generate legitimate DocBook (previously if the author line was not included in the document header then an empty (illegal) DocBook author element was generated). * Multiple spaces in filter command arguments were replaced by a single space. The ./examples/asciidoc2text/asciidoc2text.sh script now indents text correctly. __________________________________________________________________ 48. Version 5.1.1 (2004-10-10) 15-December-2004: Interim update: Updated asciidoc.py to fix broken join_lines function — no other changes. * PDF documentation is now produced from DocBook XML using XSLTLib and FOP. Previously we processed DocBook SGML with jw(1) (which used Dvips to convert DVI files to PDF). FOP has come a long way in the last 12 months and produces very acceptable PDF under both Linux and Windows. * Sections detailing how to install and use the DocBook XSL Stylesheets, xsltproc, FOP toolchain and the AsciiDoc XSLT drivers have been added to the User Guide. * The PDF output from the he example article template has been included in the distribution (./doc/article.pdf). * Special characters are emitted using decimal Unicode character codes (previously used named character entities which cannot be assumed included in non-HTML documents). * Added registered trademark ® to [replacements]. * CSS stylesheet tweaks. * Admonitions (Note, Tip, Important, Warning, Caution) include icons when generating css output. __________________________________________________________________ 49. Version 5.1.0 (2004-09-18) * Callouts have been implemented (see the Callouts section of the AsciiDoc User Guide for details). * Added XSL drivers for generating XHTML, chunked XHTML and HTML Help from DocBook XML using XSL stylesheets and xsltproc(1). * Added CSS stylesheet for HTML generated from DocBook XML using XSL stylesheets. * Distribution contains HTML Help formatted User Guide (./doc/asciidoc.chm), the User Guide tells you how it’s generated. * Images referred to by distributed stylesheets are now located in the ./images subdirectory (previously located in .). * Filters path names are now handled properly under Cygwin. * The usual documentation and examples additions, updates and polishing. __________________________________________________________________ 50. Version 5.0.9 (2004-09-09) * The convention of using a .asc file extension for AsciiDoc files has been dropped in favor of the familiar .txt extension. It makes more sense in that AsciiDoc is a text presentation format and because .asc clashed with the same extension used by other applications. It’s only a naming convention — you don’t have to switch if you don’t want to. * Changed the subscript formatting character from underline to tilde since underscores in file names are reasonably common (especially in link and image macros). * An alternative syntax for the index term inline macro has been added: ++<primary>,<secondary>,<tertiary>++. * Index terms that have secondary and tertiary entries now additionally generate separate index terms for the secondary and tertiary entries. * A +<primary>+ index term inline macro has been added which displays the term in the primary text flow. * Added alternative variable list definition using double semi-colon terminator as opposed to the standard double colon terminator so variable lists can be nested to two levels. * Footnotes now appear on a separate line in HTML and Linuxdoc outputs. * Python version compatibility is checked at startup. * Preface and appendix section titles in multi-part Book documents are meant to be out of sequence — warnings are no longer emitted when outputting HTML. * Empty section warnings have been replaced by error messages and are emitted only if invalid markup would result. * Missing macro sections or invalid macro name warnings are only generated at startup if the -v (verbose) option is set. Otherwise they are deferred until a matching macro is encountered in the input file. * Missing or invalid table definition warnings are only generated at startup if the -v (verbose) option is set. Otherwise they are deferred until a matching table is encountered in the input file. * AsciiDoc now makes more of an effort to continue in the face of errors. * Fixed broken ./examples/website/main.aap script. * Converted distribution text files DOS text format as a sop to Windows users with challenged text editors. * Documentation additions and corrections. __________________________________________________________________ 51. Version 5.0.8 (2004-05-15) * Spurious out of sequence level 2 warnings no longer appear when processing book document multi-part book top level Preface and Appendix sub-sections since they are (correctly) out of sequence. * A warning is no longer emitted for empty Index sections since this is normal when generating DocBook outputs. * Fixed: [quotes] configuration file entries where not being overridden by downstream configuration file entries. * Footnote text is now output enclosed in square brackets in HTML documents. * Added superscripts and subscripts to the standard PRS configuration files. * Adjusted CSS stylesheets so list titles don’t have so much space between title and first list item (broken in IE6 due to poor CSS compliance). Lessened sidebar title top margin. __________________________________________________________________ 52. Version 5.0.7 (2004-04-22) * The version 5.0.6 README incorrectly stated that AsciiDoc would run under Python 2.0, in fact it requires Python 2.1 or better. The README has been corrected. * Documented techniques for combining and splitting AsciiDoc documents and processing the combined and split parts (see the Tips and Tricks section of the User Guide). * An example of marking up superscripts and subscripts is documented in the Tips and Tricks section of the User Guide (the example configuration file is in the AsciiDoc examples directory). * Added ellipsis to shipped [replacements]; three periods output an ellipsis entity. * Removed unused SectionClose class. * The AsciiDoc Preamble element is output as a DocBook Preface when processed as a book document type (in older AsciiDoc versions a warning was issued and processing stopped). * Fixed a quoting anomaly: quoted text can no longer begin or end with with white space. __________________________________________________________________ 53. Version 5.0.6 (2004-03-07) * New image macro implements optional image scaling and linking and works in both inline and block contexts. The image macro obsolesces the existing graphic block macro and icon inline macro. * Macro substitution section names now have -inlinemacro and -blockmacro suffixes to resolve context ambiguity, make their purpose clearer and relieve section namespace congestion. * Header derived glossary entries can now be overridden from the command-line. * Special character substitution is now performed on AuthorLine derived author names. * A macro or block argument called options can be used as a shortcut for a list named arguments with zero length string values. * Tables can be output without borders using the options="noborders" argument. * Table data lines that do not immediately follow a table section underline can now be blank. This allows CSV data with embedded blank lines to be processed correctly. * Blank DSV format table data lines are silently skipped. * Tightened up on enforcement of configuration file section names to reduce the possibility of section content being seen as a section header line. * Section titles can be optionally suffixed with title arguments enclosed in double square brackets. * A replacement has been added to asciidoc.conf to replace inline double dashes with the — entity. * Changed the .UNDER-CONSTRUCTION. macro syntax to #UNDER-CONSTRUCTION# so it is not mistaken for a BlockTitle. Similarly changed the .NEW. replacement with #NEW#. * #NEW# and #UNDER-CONSTRUCTION# macros are now included in the DocBook backend. * Replaced shipped smallnew.gif with smallnew.png. * Documentation tidy ups. __________________________________________________________________ 54. Version 5.0.5 (2004-02-25) * Fixed the disappearing paragraph titles problem that was caused by Inline macros (incorrectly) processing BlockTitles. * Tightened AuthorLine validation. Previously invalid email addresses and embedded special characters in the AuthorLine resulted in invalid output markup. __________________________________________________________________ 55. Version 5.0.4 (2004-02-09) * Reinstated missing infile, outfile, filetype and filetype-<filetype> glossary entries. * As of version 5.0.3 asciidoc(1) now requires Python 2.0 or greater, this has now been documented. __________________________________________________________________ 56. Version 5.0.3 (2004-01-23) * Fixed problem that caused any filters directory file containing .conf (not just those with the .conf extension) from being loaded. * All [miscellaneous] configuration file entries can now be referenced like glossary entries (they are now processed internally as glossary entries). * The output file line terminator (previously hardwired to \r\n is now set using the newline entry in the configuration file [miscellaneous] section. * The misspelt blocktitles configuration file entry name has been corrected (to blocktitle). * An {empty} glossary entry has been added to the default configuration which is useful for outputting trailing blank lines from configuration file substitution sections. __________________________________________________________________ 57. Version 5.0.2 (2003-12-18) * New (alternative) anchor and xref macro syntax (old syntax still valid). * DocBook mediaobject and inlinemediaobject tags are generated in place of graphic and inlinegraphic tags by the AsciiDoc graphic and icon macros. If a macro argument is specified it is the alternative text output if the target document format does not support the specified graphic file format. * Dropped the LinuxDoc left and right square bracket special character substitutions as they interfered with macro substitution. * Documentation updates and corrections. __________________________________________________________________ 58. Version 5.0.1 (2003-12-09) * Fixed problem with anchor tag when generating CSS styled HTML. __________________________________________________________________ 59. Version 5.0 (2003-12-08) This release has had some fairly major code and documentation changes. Please report any problems you encounter. [198]Stuart Rackham * AsciiDoc can now produce a full-blown multi-part DocBook book including dedication, abstract, preface, colophon, glossary, appendix, bibliography and book part elements using the new specialsections configuration file section. * All Section element children (Paragraph, DelimitedBlock, List, Table, BlockMacro) can now be titled using the BlockTitle element. A BlockTitle element is a single line containing a title and beginning with a period. * The index and backmatter macros have been dropped, superseded by specialsections. * The AsciiDoc Preface element has been renamed Preamble (to avoid confusion with the DocBook book preface element). * Out of sequence titles are now tolerated with a warning. This allows book document level 0 sections to be processed. * An anchor inline macro has been added for document link target creation. * Note, Tip, Important and Warning paragraph types have been added to support the corresponding DocBook elements. * Title substitution is now performed in SidebarBlock titles. * DocBook graphics now output as figure and informalfigure elements rather than mediaobjects. This ensures numbered figures and a lists of figures are produced by the DocBook toolchain. * You can now escape block argument lines by appending a backslash. Alternatively, if you embed arguments in the delimiter line AsciiDoc does not check for an arguments line. * The default DocBook backend file extension has been changed from .docbook to .xml (.sgml for the docbook-sgml backend). * Warnings are output by default (previously they only printed when verbose option enabled). * A Question and Answer variable list definition has been added to the shipped configuration files, primarily to create DocBook qanda DocBook elements. * Fixed broken code-filter -b linuxdoc option. The asciidoc.asc User Guide can now be processed by linuxdoc(1) (although tables are dropped because LinuxDoc does not implement tables). Compatibility issues: 1. Table titles are no longer in the arguments line, use the new BlockTitles. 2. Graphic titles are no longer in the graphic block macro caption, use the new BlockTitles. 3. The code-filter title must be placed in a preceding BlockTitle. 4. SidebarBlock titles must be placed in a preceding BlockTitle. 5. The DelimitedBlock option sidebar has been renamed to section. 6. The default DocBook backend file extension has been changed from .docbook to .xml (.sgml for the docbook-sgml backend). __________________________________________________________________ 60. Version 4.2 (2003-11-26) * The default HTML output is now XHTML 1.0 markup. To output the former HTML 4 markup specify the html-4 backend. * The default DocBook output is now DocBook XML. To output the former DocBook SGML specify the docbook-sgml backend. The associated docbook-sgml.conf file illustrates how to support minor DTD variations. Examples of using the xmlto(1) command for DocBook conversion have been added to the User Guide. * Glossary entries set using the command-line -g option can now be referenced in configuration files. * Configuration dumps (-c command-line option) no longer output redundant undefined glossary entries. * DelimitedBlock arguments can now be specified in a separate arguments line immediately following the leading delimiter line, This is in preference to the existing delimiter embedded arguments. Reasons: + The syntax is in keeping with the Tables arguments syntax. + It’s easier to enter and implements line continuation. * A new QuoteBlock DelimitedBlock definition has been added to the distribution configuration files. * The table arguments lines can be continued using the backslash line continuation character. * Added new calculated glossary reference type {<name>%<value>}. * Double-quote characters can now appear in unquoted positional arguments. __________________________________________________________________ 61. Version 4.1 (2003-11-13) * Added DSV (Delimiter Separated Values) tables format. * {eval:<expr>} glossary references drop the containing line if <expr> evaluates to None. * Block, Table and Macro arguments can now be positional (quoted or unquoted). * Vocabulary change: DelimitedBlock, Table and Macro attributes are now referred to as arguments. This makes more sense in light of the extended syntax and avoids confusion with backend markup tag attributes. * tablewidth table ruler parameter can now be expressed in percent units (0..100). If between 0 and 1 then the original fractional unit measure is applied. * The use of quoting for generating footnotes and index entries has been dropped in favor of footnote and indexterm inline macros. * backmatter inline macro included in distribution. * Fixed: CSS styled HTML tables are now fully XHTML 1.0 conformant. * Fixed: tablewidth was processed incorrectly when passed as table argument. * Fixed: Glossary references like {x=\{y}} were one character off if {x] was defined and {y} was not. __________________________________________________________________ 62. Version 4.0 (2003-11-08) This release has had some fairly major code and documentation changes. Please report any problems you encounter. Stuart Rackham * Added tables to AsciiDoc. * Added two special subs options: default specifies the default substitution options and none specifies no substitution. These options can only appear singly. * Line continuation using a trailing backslash character is available in Paragraphs, ListItems, Tables. * The left and right quotes for quoted text can now be specified separately. * Shipped configuration files implement footnotes (only useful for DocBook output) using \[[]] quoting. * Shipped configuration files implement index terms (only useful for DocBook and LinuxDoc output) using \(()) quoting. * The shipped html backend configuration now emits valid HTML 4.01 Transitional. * Added new calculated glossary reference types {<name>!<value>} and {<name>#<value>}. * The DelimitedBlock params option has been dropped in favor of the new block attributes mechanism. If you have customized block params options you may need to adjust source files to use the block attributes syntax. The example code filter has been updated to reflect these changes. * The code filter now has a -t tabsize option. * Replaced -w option with -v (verbose) option. The warnings option was just to confusing. * Named attributes can now be specified in macro calls. * The tabsize attribute is recognized in the built-in include macros. A tabsize of zero suppresses tab expansion. * The configuration file [options] section has been split into [miscellaneous] and [titles]. If you have customized any of these settings you will need to adjust the affected configuration files. * Configuration file [miscellaneous] entries can now also be set using the command-line -g option. * Fixed: error that occurred when attempting to use zero length configuration and source files. * Fixed: blocking filter halt problem. * Fixed: inline macro escape prefix problem. * Fixed: missing macros from configuration dump problem. * Fixed: named macros were dumped incorrectly. * Many documentation changes/additions/corrections. __________________________________________________________________ 63. Version 3.2.2 (2003-10-26) * Added -n option (synonym for -g section-numbers). * Dropped the processing commentary (hey, this is Unix). * Added new calculated glossary reference type {<name>?<value>}. <name> is the glossary entry name and <value> is the text substituted if the glossary entry is defined. <value> can only contain literal text (no glossary references allowed). * Added asciidoc2text to distribution examples/asciidoc2text directory (converts AsciiDoc source to text file with section numbering). * Fixed incorrect nesting of Simple lists inside Variable lists. * List definitions have been modified so that list items can be indented. This allows a more intuitive indentation of nested lists in AsciiDoc source. * Lists must be separated from preceding paragraphs by a blank line. This is to avoid paragraph lines being mistaken for list items. * Corrected asciidoc man page documentation error: the`-f` option does not search relative to source document directory for the configuration file. * Minor updates to various distribution .conf files. * Included badges.conf in examples directory. * css-embedded-stylesheet.conf now supports footer badges. * The default in-line element processing order has been changed: Glossary References are now processed before Inline Macros. This allows glossary expansions to occur inside macro references. * Glossary entries are now allowed in Author and Revision lines. * Default List subs options and Paragraph presubs options are assigned the following default value if not specified: specialcharacters,quotes,specialwords,replacements,glossary,macros * Documentation changes/additions/corrections. __________________________________________________________________ 64. Version 3.2 (2003-05-26) * Added a -s command-line option to suppress the output of [header] and [footer] sections. * Article document headers are no longer mandatory: this allows AsciiDoc to process arbitrary chunks of text. When used in conjunction with the new -s command-line option corresponding chunks of backend markup can be generated. * AsciiDoc now emits a warning message and continues when an out of sequence section title is detected (previously it failed and halted). This allows document sections to be processed separately. * Optional presubs and postsubs entries have been added to DelimitedBlock and Paragraph definitions. As a consequence substitution options are no longer legal in options entries. * presubs and postsubs substitutions are processed in the order the options are specified (rather than the fixed options order of previous versions). * ./filters subdirectories are automatically searched for filter commands. * A title-subs configuration option specifies the substitutions performed on document Header and Section titles. * A subs entry in now included in List configuration file definitions that specified substitutions performed on list entry text. * Configuration files are auto-loaded from ./filters subdirectories. * Added example code filter (see ./examples/filters). * Bug fix: if section was empty you may have got erroneous missing tag "paragraph" error. * Internal code tidy up. __________________________________________________________________ 65. Version 3.1 (2003-05-18) * In version 3.0 a [macros] section entry of the form name was equivalent to name=. An entry of the form name now undefines the entry (to bring it in line with the behavior of other special sections). * Paragraphs have now been generalized (in the same way as Lists and DelimitedBlocks). * The indentsize option has been dropped as as consequence of paragraph generalization. * Pipe | characters can be included in substituted tag and substitution section text using the {brvbar} (broken vertical bar) glossary reference. * Removed the restriction requiring substitution section text placeholders | to be on a separate line. * Added an -e asciidoc(1) command option that excludes implicit configuration files (used in conjunction with -c generated configuration files). * Version 3.0 documentation has undergone a considerable cleanup. * The dumping of quoted section entries (see -c option) now works correctly. * The format of special section entries has been made consistent: name undefines the entry; name= sets the entry value to a blank string; name=value sets the entry value to value. * As a consequence of the previous change the caret prefix is no longer used in glossary configuration file entries (although it is still used when undefining an entry using the -g command-line option). __________________________________________________________________ 66. Version 3.0 (2003-05-13) This version is the culmination of work begun in the 2.x releases whereby fixed policy has been replaced by extensible mechanisms. * Added -c command-line option to dump a composite asciidoc(1) configuration file to stdout. * Lists and Delimited Blocks are now defined by a set of configuration file parameter sections. The user can modify the default definitions or add new ones. * Block content can now be processed through external filters. * The default behavior for Custom Blocks is to perform glossary substitution (previously there was no substitution inside Custom Blocks). * The old 2.x style macros have been reimplemented; as with Lists and Delimited Blocks there syntax and behavior can be configured by the user. The default macro syntax remains the same but the semantics are now (hopefully) a bit more intelligible. * Block and Builtin macros use :: delimiter instead of the 2.x single colon delimit (to distinguish them from inline macros). The 2.x syntax is still supported for backward compatibility. * Nested lists are now supported and IndentedParagraphs can be included in list items. * Conditional source inclusion can be specified using built in ifdef, ifndef and endif macros. * The new conditional source inclusion feature has been used to reduce the number of default configuration files down to one per backend. * A change of name: 2.x Substitutions are now called Replacements and the 2.x [substitutions] configuration file section is now called [replacements] (the old name is still recognized for backward compatibility). * The line break is now implemented as a Replacements substitution. * Inline icon macro for inline images has been added to default configuration files. __________________________________________________________________ 67. Version 2.2 (2003-04-07) * The master.conf configuration file name has been deprecated in favor of asciidoc.conf. * The standard configuration files set is now loaded from the .asciidoc folder in the users home directory (if it exists) and then from the source document directory. Configuration files that don’t exist are silently skipped. * Configuration files named like the source file will be automatically loaded if they are found in the source file directory. For example if the source file is mydoc.asc and the -b html option is used then asciidoc(1) will look for mydoc.conf and mydoc-html.conf in that order. * The characters used to quote formatted text can be configured and extended by the user (see the master.conf [quotes] section). * Quoted text can now be escaped by prefixing a backslash character to the leading quote. * The double single-quote '' strong text quote has been deprecated in favor of an asterisk * character. * Added {eval:expression}, {sys:command} and {sys2:command} glossary reference actions. * Trailing brace characters } are now allowed inside glossary references provided they are escaped with a backslash character. * Glossary entries can now be escaped by prefixing a backslash character to the leading brace character (use this in preference to placing the backslash inside the brace). * The output macro has been deprecated (use the new include1 macro inside a CustomBlock). * The default document type is article (asciidoc no longer attempts to guess). * Files included within DelimitedBlocks are not searched for block termination underlines. This ensures the entire file is part of the DelimitedBlock. * include macros can now be used in configuration files. * Corrected {infile} and {outfile} glossary entry documentation. * File inclusion is now limited to a depth of 5 to catch recursion loops. * Inline tags have been deprecated, they’re not necessary and they immediately make the source document backend specific. Use CustomBlocks or Substitutions instead. __________________________________________________________________ 68. Version 2.1 (2003-03-17) * Added section auto numbering {sectnum} glossary entry (auto-numbering function contributed by Ludovico Magnocavallo). * asciidoc(1) now correctly returns non-zero exit status if an error occurs. * An AsciiDoc example website has been included in the AsciiDoc distribution examples/website directory. * NOTE: The asciidoc wrapper script included in the 2.0 distribution has been dropped, if you’ve symlinked or aliased to asciidoc you’ll need to change them to point directly to asciidoc.py instead. * An RCS $Id$ marker can be used as the document header revision line (based on a patch submitted by Ludovico Magnocavallo). * In addition to the name=value glossary entry format two new ones have been introduced: name (the default value is set to an empty string) and ^name (the glossary entry is undefined). * The -q command-line option has been deprecated and the -w level command-line option added. NOTE: By default skipped substitution warnings are now suppressed. * If a configuration file specified with the -f command-line option is not found relative to the current working directory then the search is repeated relative to the asciidoc(1) directory. This allows global configuration files to be used. * Added {infile}, {outfile} predefined glossary entries. * Added under-construction macro to HTML article configuration files. * Deprecated {asciidoc_version} glossary entry in favor of {asciidoc-version} (to it consistent with other entries). __________________________________________________________________ 69. Version 2.0 (2003-02-24) * The emphasized, strong and monospaced words options have been generalized with the introduction of macro based special words lists. * Glossary references can now appear in both the document and macro bodies. * All output files use crlf line termination (previously used UNIX lf (newline) termination). * Added [substitutions] section which implements arbitrary regular expression based substitutions. * An optional master.conf configuration file can be used for entries that are not backend or document type specific. * Special character definitions moved from the code to the new [special_characters] configuration file section. * Configuration file glossary added. * Command-line -g glossary entry added. * A new book document type has been implemented for the docbook backend. It outputs DocBook book documents. * A major internal change has been the implementation of parametrized user definable macros. Internally most document elements are now processed as macros. * Configuration file macro variables can be specified with default values (literals or other macro variables). * An attempt has been made to tighten up the vocabulary used to describe the AsciiDoc document syntax. * The term abstract has been replaced by the more general term preface and a new preface section introduced into article configuration files (replacing the synopsis sections). * Any section elements can now be put in the document preface (previous versions only allowed paragraphs). * AsciiDoc Blocks have been unified and their behavior can be user defined and parametrized. * An output inclusion allows an external file to be written directly to the backend output file. * A new CustomBlock has been added. Default behavior is to insert the enveloped AsciiDoc source lines directly into the output file. * A line break tag can be inserted by terminating a line with a + character (only really useful for HTML backends). * An fourth section level has been introduced. * The SidebarBlock delimiter line characters have been changed. The deprecated underline is still accepted. * Levels 2 and 3 title underline characters have been changed. The deprecated underlines are still accepted. * Lines with backend specific inline tags can be inserted into AsciiDoc source files. * Single words enveloped by underscores are no longer emphasized. This feature was deprecated as it is redundant (use single quotes instead) and was being applied to file names with underscores. * A -q quiet option has been added to suppress warning messages. * Badge images sourced locally. * Added author and author-mail meta tags to HTML configuration files. __________________________________________________________________ 70. Version 1.5 (2003-01-08) * Implemented sidebar document elements. * Explicit checks for user specified configuration files and input file (rather than throwing exception). __________________________________________________________________ 71. Version 1.4 (2003-01-04) * New configuration file options emphasizedwords and strongwords. These allow the definition of words that will always be emphasized or rendered in a strong font without inline formatting. * Document and section titles are no long subject to inline formatting. * Multiple configuration files can be overlaid in a single command. * Configuration file tags and options entries can now be overridden on an entry by entry basis (previously the entire section was overloaded). * Configuration file tags and options entries are now cached this has resulted in around 37% performance improvement over version 1.3. * Variable lists can now contain multiple terms per list item. * Placeholder paragraph eliminated from empty sections that contain subsections. * Added {asciidoc_version} substitution variable. * More documentation additions and tidy ups. __________________________________________________________________ 72. Version 1.3 (2003-01-01) * A new strong text formatting convention has been implemented: Word phrases enclosed in pairs of single quote characters (acute accents) are rendered in a strong font (usually bold). * Paragraphs can now be followed immediately by Simple lists and Ordered lists without an intervening blank line. * A user specified configuration file (asciidoc(1) -f option) overlays the default configuration file rather than replacing it. Custom configuration files need only contain those sections that have been customized. * Comment Block delimiters have been relaxed slightly. They must start with three forward slashes /// but the remainder can contain any characters, this allows comments to be embedded in the delimiter line. * Leading non-digit characters preceding revision number are now ignored. * Set default indentsize [option] from 2 to documented default value of zero in HTML backend html-article.conf and html-manpage.conf files. * Fixed error that occurred when taking input from stdin without explicitly specifying a document type. * Restored file name and line number error message information. * Changed deprecated -t option to -d in asciidoc --help and usage command output. * CSS styles tweaking. * Code, configuration file and documentation tidy ups. __________________________________________________________________ 73. Version 1.2 (2002-12-28) * Implemented include URL to allow file inclusion. * fileextension configuration file [option] renamed to more sensible outfilesuffix (fileextension still accepted by this version but will be dropped in future). * Improved error reporting. * CSS backends generate valid XHTML. * New css-embedded backend generates HTML with embedded stylesheets (use the css backend for linked stylesheets). The css-embedded backend output contains no linked images so the generated html files are completely self contained. * Bug fixes. __________________________________________________________________ 74. Version 1.1 (2002-12-03) * Added css (cascading style sheets) backend * Implemented IndentedBlock document element. * Tabsize command-line option has been deprecated in favor of configuration file. * Default indent width changed to zero. * Added {localdate} and {localtime} substitution variables. * Added optional [options] configuration file section with fileextension, tabsize and indentsize options. * Implemented {authorinitials} substitution variable. * Added https link type. * Corrected [graphic] substitution from {title} to {caption} in linuxdoc-article.conf configuration file. * Fixed error that occurred when == title underline was used. __________________________________________________________________ 75. Version 1.0 (2002-11-25) First AsciiDoc public release along with AsciiDoc web site ([199]http://asciidoc.org/) and SourceForge.net project registration ([200]https://sourceforge.net/projects/asciidoc/). __________________________________________________________________ Version 8.6.9 Last updated 2013-11-06 13:29:53 NZDT References 1. https://groups.google.com/group/asciidoc/browse_thread/thread/9877a316b7a47309 2. https://groups.google.com/group/asciidoc/browse_thread/thread/5145e4c0b65cde0a 3. https://groups.google.com/group/asciidoc/browse_thread/thread/5145e4c0b65cde0a 4. https://groups.google.com/group/asciidoc/browse_thread/thread/1a60eb4507a0555f/264c39c6a89fc7a0 5. http://code.google.com/p/asciidoc/issues/detail?id=14 6. https://groups.google.com/group/asciidoc/browse_thread/thread/c88457020288ce1d 7. https://groups.google.com/group/asciidoc/browse_thread/thread/268f9b46ebc192d3 8. https://groups.google.com/group/asciidoc/browse_thread/thread/753a52b2af85fcfc/04c9091b0856fc13 9. https://groups.google.com/group/asciidoc/browse_thread/thread/cd07629fa7a53fb3 10. https://groups.google.com/group/asciidoc/browse_thread/thread/2fe14a10dbf20d20/27726e7e13f7bfc7?lnk=gst&q=romanian#27726e7e13f7bfc7 11. https://groups.google.com/group/asciidoc/browse_thread/thread/b131d0155eccd73e 12. https://groups.google.com/group/asciidoc/browse_thread/thread/dbdfaf838f93e020 13. https://groups.google.com/group/asciidoc/browse_thread/thread/dbdfaf838f93e020 14. https://groups.google.com/group/asciidoc/browse_thread/thread/1b3f1a0f0a21425e 15. https://groups.google.com/group/asciidoc/browse_thread/thread/8aa340a3069ef5f1/a727a8a564eea76c 16. https://groups.google.com/group/asciidoc/browse_thread/thread/753a52b2af85fcfc/04c9091b0856fc13 17. https://groups.google.com/group/asciidoc/browse_thread/thread/7be28e9714f249c7 18. https://groups.google.com/group/asciidoc/browse_thread/thread/961a957ab5872ebf 19. https://groups.google.com/group/asciidoc/browse_thread/thread/961a957ab5872ebf 20. https://groups.google.com/group/asciidoc/browse_thread/thread/9e79d8494ef8d870 21. https://groups.google.com/group/asciidoc/browse_frm/thread/64b071bb21de9cf0 22. https://groups.google.com/group/asciidoc/browse_frm/thread/e045c9986c71d72a 23. https://groups.google.com/group/asciidoc/browse_thread/thread/f5174f450a61f14b 24. https://groups.google.com/group/asciidoc/browse_thread/thread/db3b734a6931cb74 25. https://groups.google.com/group/asciidoc/browse_thread/thread/13c9ee97930342b3 26. http://groups.google.com/group/asciidoc/browse_thread/thread/a9762e21ec0cc244/5d3a4ebf20e6847e 27. http://groups.google.com/group/asciidoc/browse_thread/thread/843d7d3d671006fb/25628e14c829db3f 28. http://groups.google.com/group/asciidoc/browse_thread/thread/b8e93740b7cd0e1d/b5e0b83fe37ae31a 29. http://groups.google.com/group/asciidoc/browse_thread/thread/3d06b0105dfbb780/8c60eb7a62f522e4 30. http://groups.google.com/group/asciidoc/browse_thread/thread/33e99b78e2472122 31. http://groups.google.com/group/asciidoc/browse_thread/thread/8200e29815c40f72 32. http://groups.google.com/group/asciidoc/browse_thread/thread/849e5ea91f43adf2 33. http://groups.google.com/group/asciidoc/browse_thread/thread/e92a75abcc382701 34. http://groups.google.com/group/asciidoc/browse_thread/thread/58d0843ae4345afd 35. http://groups.google.com/group/asciidoc/browse_thread/thread/b0e69e393b6f9f20/47a2c7586f9e40c6?lnk=gst&q=themes+tarball#47a2c7586f9e40c6 36. http://groups.google.com/group/asciidoc/browse_thread/thread/b9d705c6b6b39f59/1e120483dafca109 37. http://groups.google.com/group/asciidoc/browse_thread/thread/103445ab9d95cb0c 38. http://code.google.com/p/asciidoc/issues/detail?id=9 39. http://groups.google.com/group/asciidoc/browse_thread/thread/4608b77ec289f6c4 40. http://groups.google.com/group/asciidoc/browse_thread/thread/14e8fcb289a135b/3af3b4e57b827c78?lnk=gst&q=archlinux#3af3b4e57b827c78 41. http://groups.google.com/group/asciidoc/browse_thread/thread/5e2e6f4dd740d51a 42. http://groups.google.com/group/asciidoc/browse_thread/thread/5e2e6f4dd740d51a 43. http://groups.google.com/group/asciidoc/browse_thread/thread/a839aa01db0765d2 44. http://groups.google.com/group/asciidoc/browse_thread/thread/734ac5afed736987 45. http://groups.google.com/group/asciidoc/browse_thread/thread/6436788a10561851 46. http://groups.google.com/group/asciidoc/browse_thread/thread/c9238380a1f2507a 47. http://groups.google.com/group/asciidoc/browse_thread/thread/ec8e8481eb0e27b0/d1c035092b5bb7a4?lnk=gst&q=caption+option#d1c035092b5bb7a4 48. http://groups.google.com/group/asciidoc/browse_thread/thread/3e177b84bc133ca9/659796dfadad30ea?lnk=gst&q=a2x+format#659796dfadad30ea 49. http://groups.google.com/group/asciidoc/browse_thread/thread/16d3fb9672a408e7 50. http://groups.google.com/group/asciidoc/browse_thread/thread/bacbf8aeb8ad6a3a 51. http://code.google.com/p/asciidoc/issues/detail?id=8 52. http://groups.google.com/group/asciidoc/browse_thread/thread/6436788a10561851 53. http://groups.google.com/group/asciidoc/browse_thread/thread/e8f3938bcb4c8bb4/44d13113a35738ef 54. http://groups.google.com/group/asciidoc/browse_thread/thread/c9238380a1f2507a/9afc4559d51e1dbd 55. http://groups.google.com/group/asciidoc/browse_thread/thread/8c111f1046b33691/158a944cf4d5ff0d?lnk=gst&q=latex+escapes#158a944cf4d5ff0d 56. http://groups.google.com/group/asciidoc/browse_thread/thread/eaf25f21d1da180a 57. http://flask.pocoo.org/docs/ 58. file://localhost/tmp/lynxXXXXf1KLCf/article-html5-toc2.html 59. file://localhost/tmp/lynxXXXXf1KLCf/epub-notes.html 60. http://flask.pocoo.org/docs/ 61. http://groups.google.com/group/asciidoc/browse_thread/thread/9da9d48a6461ff14 62. http://groups.google.com/group/asciidoc/browse_thread/thread/5c792cbb395b753b 63. http://groups.google.com/group/asciidoc/browse_thread/thread/e2100b7cb29283ce 64. http://groups.google.com/group/asciidoc/browse_thread/thread/c5e30ee5555877f5 65. http://groups.google.com/group/asciidoc/browse_thread/thread/baf3218551d05a05 66. http://groups.google.com/group/asciidoc/browse_thread/thread/5a7fe64fbfd65ad 67. http://groups.google.com/group/asciidoc/browse_thread/thread/5620ba634fdb030a 68. http://groups.google.com/group/asciidoc/browse_thread/thread/f969b9ce987d7f5d 69. http://groups.google.com/group/asciidoc/browse_thread/thread/cd0f47495fd04181 70. http://code.google.com/p/asciidoc/issues/detail?id=6&q=label%3APriority-Medium 71. http://sourceforge.net/tracker/?func=detail&atid=373747&aid=2854075&group_id=21935 72. http://groups.google.com/group/asciidoc/browse_thread/thread/b24cc3362f35b801 73. http://asciidoc.org/userguide.html#X96 74. http://groups.google.com/group/asciidoc/browse_thread/thread/77f28b0dfe60d262 75. http://asciidoc.org/manpage.html 76. http://groups.google.com/group/asciidoc/browse_thread/thread/40c64cd33ee1905c 77. http://groups.google.com/group/asciidoc/browse_thread/thread/e15282f072413940 78. http://groups.google.com/group/asciidoc/browse_thread/thread/5ac8e8ea895147e9 79. http://groups.google.com/group/asciidoc/browse_thread/thread/e15282f072413940 80. http://groups.google.com/group/asciidoc/browse_thread/thread/e15282f072413940 81. http://groups.google.com/group/asciidoc/browse_thread/thread/b11066a828ab45b9 82. http://groups.google.com/group/asciidoc/browse_thread/thread/a1dd0562dee8b939 83. http://groups.google.com/group/asciidoc/browse_thread/thread/f44615dca0b834e9 84. http://groups.google.com/group/asciidoc/browse_thread/thread/1b3f88f1f8118ab3 85. http://groups.google.com/group/asciidoc/browse_thread/thread/c21c2902c29bae64 86. http://groups.google.com/group/asciidoc/browse_thread/thread/f510ea82a88aaee8 87. http://groups.google.com/group/asciidoc/browse_thread/thread/42b63ce90c2563b8 88. http://groups.google.com/group/asciidoc/browse_thread/thread/42b63ce90c2563b8 89. http://bugs.python.org/issue3932 90. http://groups.google.com/group/asciidoc/browse_thread/thread/dedc961b23e9ac56 91. https://phillordbio-asciidoc-fixes.googlecode.com/hg/ 92. http://groups.google.com/group/asciidoc/browse_thread/thread/c14a4c3b1e4f6dc5 93. http://groups.google.com/group/asciidoc/browse_thread/thread/c948697943432e24 94. http://groups.google.com/group/asciidoc/browse_thread/thread/1c415fc4540ce5e5 95. http://groups.google.com/group/asciidoc/browse_thread/thread/8712a95e95a292a7 96. http://groups.google.com/group/asciidoc/browse_thread/thread/c4427a3902d130a8 97. http://groups.google.com/group/asciidoc/browse_thread/thread/59a610068e4acb58 98. http://groups.google.com/group/asciidoc/browse_thread/thread/b22603bfb879418c 99. http://groups.google.com/group/asciidoc/browse_thread/thread/1c02d27d49221aa2 100. http://groups.google.com/group/asciidoc/browse_thread/thread/5f3e825c74ed30c 101. http://pygments.org/ 102. http://groups.google.com/group/asciidoc/browse_thread/thread/d8d042f5a3021369/8934ebbb8cb7144b 103. http://groups.google.com/group/asciidoc/browse_frm/thread/319e5cd94493e330/3fcb83fab067af42 104. http://groups.google.com/group/asciidoc/browse_frm/thread/fe9b33d8f5f1e0af 105. http://groups.google.com/group/asciidoc/browse_frm/thread/8eda3ea812968854 106. http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72 107. http://groups.google.com/group/asciidoc/browse_frm/thread/66e7b59d12cd2f91 108. http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72 109. http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72 110. http://groups.google.com/group/asciidoc/browse_frm/thread/219c86ae25b79a21 111. http://groups.google.com/group/asciidoc/browse_frm/thread/af652507caf6cec9 112. http://groups.google.com/group/asciidoc/browse_frm/thread/3f96900f7fbf5620 113. http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72 114. http://groups.google.com/group/asciidoc/browse_frm/thread/2ff802547b6a75ea 115. http://groups.google.com/group/asciidoc/browse_thread/thread/14e8fcb289a135b 116. http://groups.google.com/group/asciidoc/browse_thread/thread/faa36e9e5c7da019/d24cab3fe363e58d 117. http://groups.google.com/group/asciidoc/browse_frm/thread/ac4b9bfa2116db28 118. http://groups.google.com/group/asciidoc/browse_frm/thread/c17abd175778f5ea 119. http://groups.google.com/group/asciidoc/browse_frm/thread/c17abd175778f5ea 120. http://groups.google.com/group/asciidoc/browse_frm/thread/1b6b66adb24e710 121. http://groups.google.com/group/asciidoc/browse_frm/thread/a23fea28394c8ca9 122. http://groups.google.com/group/asciidoc/browse_frm/thread/50b28f6941de111a 123. http://groups.google.com/group/asciidoc/browse_frm/thread/dfe5204d5b2c9685 124. http://groups.google.com/group/asciidoc/browse_frm/thread/f0b6f9989f828c3 125. http://groups.google.com/group/asciidoc/browse_frm/thread/14aefc1cb6bd85f5 126. http://groups.google.com/group/asciidoc/browse_frm/thread/cb8b7694bbc82a6 127. http://groups.google.com/group/asciidoc/browse_frm/thread/cb8b7694bbc82a6 128. http://groups.google.com/group/asciidoc/browse_frm/thread/4b0f364b477ec165 129. http://groups.google.com/group/asciidoc/browse_frm/thread/e5e61823ff4203cd 130. http://groups.google.com/group/asciidoc/browse_frm/thread/2aa3e5711d243045 131. http://groups.google.com/group/asciidoc/browse_frm/thread/5215c99dcc865e7d 132. http://hg.sharesource.org/asciidoc/diff/55a5999bfd04/xhtml11.conf 133. http://groups.google.com/group/asciidoc/browse_frm/thread/b276a927fdc87995 134. http://groups.google.com/group/asciidoc/browse_frm/thread/f4df7c9eec01a9bd 135. http://groups.google.com/group/asciidoc/browse_frm/thread/f4df7c9eec01a9bd 136. http://groups.google.com/group/asciidoc/browse_frm/thread/d29924043e21cb6a 137. http://groups.google.com/group/asciidoc/browse_frm/thread/74d9a542b79ccd50 138. http://groups.google.com/group/asciidoc/browse_frm/thread/ea3a8ea399ae5d2a 139. http://groups.google.com/group/asciidoc/browse_frm/thread/69b3183fdab7c6a5 140. http://groups.google.com/group/asciidoc/browse_frm/thread/a254cf949ea7c6c5 141. http://groups.google.com/group/asciidoc/browse_frm/thread/e1dcb7ee0efc17b5 142. http://groups.google.com/group/asciidoc/browse_frm/thread/69b3183fdab7c6a5 143. http://groups.google.com/group/asciidoc/browse_frm/thread/1badad21ff9447ac 144. http://groups.google.com/group/asciidoc/browse_frm/thread/a42db6bc54c2c537 145. http://groups.google.com/group/asciidoc/browse_frm/thread/b9c63be67dd1d11c 146. http://groups.google.com/group/asciidoc/browse_frm/thread/1269dc2feb1a482c 147. http://groups.google.com/group/asciidoc/browse_frm/thread/36ff073c79cbc20a 148. http://asciidoc.org/userguide.html#X89 149. http://groups.google.com/group/asciidoc/browse_thread/thread/62278a054188a038 150. http://groups.google.com/group/asciidoc/browse_thread/thread/4bdcdfb0af773e2 151. http://groups.google.com/group/asciidoc/browse_thread/thread/c93bb4db025225d8 152. http://groups.google.com/group/asciidoc/browse_thread/thread/1d796a9c9ddb2855 153. http://groups.google.com/group/asciidoc/browse_thread/thread/6d8c716748b109e3 154. http://groups.google.com/group/asciidoc/browse_thread/thread/fd27add515597c06 155. http://asciidoc.org/testasciidoc.html 156. http://asciidoc.org/asciidocapi.html 157. file://localhost/tmp/lynxXXXXf1KLCf/L13810-8657TMP.html#X2 158. http://asciidoc.org/INSTALL.html 159. http://asciidoc.org/newtables.html 160. http://asciidoc.org/newlists.html 161. http://asciidoc.org/userguide.html#X77 162. http://asciidoc.org/userguide.html#X76 163. http://asciidoc.org/latexmath.pdf 164. http://asciidoc.org/asciimathml.html 165. http://asciidoc.org/latexmathml.html 166. http://asciidoc.org/source-highlight-filter.html 167. https://sharesource.org/hg/asciidoc/ 168. http://en.wikipedia.org/wiki/Data:_URI_scheme 169. http://asciidoc.org/faq.html 170. http://www.maths.nottingham.ac.uk/personal/drw/lm.html 171. http://asciidoc.org/asciimathml.html 172. http://asciidoc.org/index.html 173. http://tpl.sourceforge.net/userguide.html 174. http://asciidoc.org/music-filter.html 175. http://lilypond.org/ 176. http://abcnotation.org.uk/ 177. mailto:srackham@gmail.com 178. mailto:jlm@ofb.net 179. mailto:m_pupil@yahoo.com.cn 180. http://open.comsultia.com/docbook2odf/ 181. http://www1.chapman.edu/~jipsen/mathml/asciimath.html 182. http://asciidoc.org/asciimath.html 183. file://localhost/tmp/lynxXXXXf1KLCf/userguide.html#X33 184. mailto:francis@daoine.org 185. file://localhost/tmp/lynxXXXXf1KLCf/userguide.html#X39 186. file://localhost/tmp/lynxXXXXf1KLCf/source-highlight-filter.html 187. mailto:trolocsis@gmail.com 188. mailto:srackham@gmail.com 189. file://localhost/tmp/lynxXXXXf1KLCf/userguide.html#X36 190. file://localhost/tmp/lynxXXXXf1KLCf/userguide.html#X33 191. mailto:viktor@rbg.informatik.tu-darmstadt.de 192. file://localhost/tmp/lynxXXXXf1KLCf/userguide.html#X23 193. mailto:david@dgreaves.com 194. mailto:stone@debian.org 195. mailto:stone@debian.org 196. mailto:srackham@gmail.com 197. http://jimmac.musichall.cz/ikony.php3 198. mailto:srackham@gmail.com 199. http://asciidoc.org/ 200. https://sourceforge.net/projects/asciidoc/ �������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������asciidoc-8.6.9/CHANGELOG.txt������������������������������������������������������������������������0000664�0001751�0001751�00000453261�12236306601�015526� 0����������������������������������������������������������������������������������������������������ustar �srackham������������������������srackham���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������AsciiDoc ChangeLog ================== :website: http://asciidoc.org/ Version 8.6.9 (2013-11-09) -------------------------- .Additions and changes - 'html5', 'xhtml11' and 'slidy' outputs now wrap 'pre' element contents at right margin (see https://groups.google.com/group/asciidoc/browse_thread/thread/9877a316b7a47309). - Vim syntax file: highlight line breaks in lists (patch submitted by Alex Efros). See https://groups.google.com/group/asciidoc/browse_thread/thread/5145e4c0b65cde0a). - Vim syntax file: fixed highlighting of lines with spaces preceding an indented paragraph. See https://groups.google.com/group/asciidoc/browse_thread/thread/5145e4c0b65cde0a - Vim syntax file: dropped ')' from list of illegal characters following opening quote. See https://groups.google.com/group/asciidoc/browse_thread/thread/1a60eb4507a0555f/264c39c6a89fc7a0 - Added {plus} intrinsic attribute. See http://code.google.com/p/asciidoc/issues/detail?id=14 - Allow `tabsize=0 in` configuration file. See https://groups.google.com/group/asciidoc/browse_thread/thread/c88457020288ce1d - Removed 'wordpress' backend into the blogpost project (where it belongs) as an AsciiDoc backend plugin. - Added HTML5 footer badges. - Added favicon to AsciiDoc website. - Changed AsciiDoc website domain to 'asciidoc.org'. - Vim syntax file: closing quote character cannot be immediately followed by same closing quote character. - Documentation updates. - If admonition icons are embedded using the Data URI Scheme and the icons directory is undefined or does not exist then the 'iconsdir' attribute is set to the location of the icons installed in the AsciiDoc configuration directory. - Updated `./stylesheets/pygments.css` from pygments 1.4. - HTML backends: Align inline images to text-bottom. - html4 backend: Added 'hr' attribute to make the inter-section horizontal ruler element optional. - Documented 'Callout lists cannot be used within tables'. See: https://groups.google.com/group/asciidoc/browse_thread/thread/268f9b46ebc192d3 - Removed Vim related stuff from the installer makefile. See: https://groups.google.com/group/asciidoc/browse_thread/thread/753a52b2af85fcfc/04c9091b0856fc13 and https://groups.google.com/group/asciidoc/browse_thread/thread/cd07629fa7a53fb3 - Dropped `vim/ftdetect/asciidoc_filetype.vim` from distribution, the file detection was broken and the default settings satisfied noone. - Vim syntax highlighter: increase sync backtracking to catch changes to large block elements. - Added Romanian language configuration file. Contributed by Vitalie Lazu. See https://groups.google.com/group/asciidoc/browse_thread/thread/2fe14a10dbf20d20/27726e7e13f7bfc7?lnk=gst&q=romanian#27726e7e13f7bfc7 - Added ruler and line-break outputs to HTML Help outputs. Patch submitted by DonM. See https://groups.google.com/group/asciidoc/browse_thread/thread/b131d0155eccd73e - Added Czech language configuration file. Contributed by Petr Klíma. - html4 backend: allow embedded images and icons (data-uri attribute). - html4 backend: table and example block caption place at bottom for consistency. - html4 backend: dropped border around example block. - html4 backend: cellpaddings made equal to 4 for consistency. - Vim syntax highligher: Highlight closing OpenBlock delimiter when it immediately follows a list. - Updated html5 backend (previous commit was xhtml11 only). See: https://groups.google.com/group/asciidoc/browse_thread/thread/dbdfaf838f93e020 - Embedded data-uri images now figure file mimetype from file contents rather than the file extension. Patch submitted by Lex Trotman. See: https://groups.google.com/group/asciidoc/browse_thread/thread/dbdfaf838f93e020 .Bug fixes - `indexterm2:[]` macro syntax now recognized. See https://groups.google.com/group/asciidoc/browse_thread/thread/1b3f1a0f0a21425e - Synthesised `*-option` attributes for options set in table conf file style entries. See https://groups.google.com/group/asciidoc/browse_thread/thread/8aa340a3069ef5f1/a727a8a564eea76c - Makefile: Fixed sh compatibility issue. See https://groups.google.com/group/asciidoc/browse_thread/thread/753a52b2af85fcfc/04c9091b0856fc13 Version 8.6.8 (2012-07-17) -------------------------- .Release highlights Added full complement of styles to 'Open Blocks' and 'Normal Paragraphs' -- those with a minimalist bent could construct virtually any document using just Title, Normal Paragraph and Open Block syntaxes. .Other additions and changes - Increased default maximum include depth from 5 to 10. - Emit warning if maximum include depth is exceeded. - Suppress repeated console messages. - Music filter: removed '--beams=None' option from abc2ly invocation because it is broken on LilyPond 2.14 (Ubuntu 12.04). - Replaced obsolete '<tt>' tag with '<code>' in HTML backends. - Allow configuration attribute entries to create a new section (previously you could only modify existing sections). See: https://groups.google.com/group/asciidoc/browse_thread/thread/7be28e9714f249c7[discussion list]. - Documented `{wj}` (word-joiner) attribute and updated FAQ. See: https://groups.google.com/group/asciidoc/browse_thread/thread/961a957ab5872ebf[discussion list]. - FAQ: Added 'How can I place a footnote immediately following quoted text?' See https://groups.google.com/group/asciidoc/browse_thread/thread/961a957ab5872ebf[discussion list]. - Added Greek language configuration file. Contributed by Michael Dourmousoglou. See https://groups.google.com/group/asciidoc/browse_thread/thread/9e79d8494ef8d870[discussion list]. - FAQ: Added 'Using roles to select fonts for PDF'. Submitted by Lex Trotman and based on solution by Antonio Borneo. See: https://groups.google.com/group/asciidoc/browse_frm/thread/64b071bb21de9cf0[discussion list]. - Apply same monospaced font size to all monospaced text. - Changed '0' number padding to spaces in numbered GNU source-highlight outputs. - Allow 'highlight' source highlighter to use 'python' for Python `{language}` name. r1142: Update the AsciiDoc 'source' filter to allow the use of the 'highlight' source code highlighter. See https://groups.google.com/group/asciidoc/browse_frm/thread/e045c9986c71d72a[discussion list]. + NOTE: The 'pygments' attribute has been deprecated in favor of the new 'source-highlighter' attribute. - Vim syntax highlighter: Don't confuse trailing open block delimiter with section underline. - Added 'skip' option to paragraphs (c.f. Delimited Block 'skip' option). .Bug fixes - *FIXED*: latex, music and graphviz filters: When the filter output image is data-uri encoded write it to the indir (instead of the outdir) so that encoder can find it. See https://groups.google.com/group/asciidoc/browse_thread/thread/f5174f450a61f14b[discussion list]. - *FIXED*: Escape the ']' character inside inline macros. See https://groups.google.com/group/asciidoc/browse_thread/thread/db3b734a6931cb74[discussion list]. - *FIXED*: source highlighter filter: Pass 'role' attribute to HTML backends. - *FIXED*: source highlight filter: docbook backend: 'role' attribute was not passed to listings without a title. Patch submitted by Lex Trotman. See https://groups.google.com/group/asciidoc/browse_thread/thread/13c9ee97930342b3[discussion list]. - *FIXED*: music2png.py: 'FOPException: Raster ByteInterleavedRaster' error (FOP 1.0, ImageMagick 6.6.9-7). Version 8.6.7 (2012-03-17) -------------------------- .Release highlights No major enhancements but quite a few bug fixes which, among other things, fixes Jython compatibility and improves Windows compatibility. .All additions and changes - Vim syntax highlighter: highlight entity refs in macro arguments. - Added files with `.asciidoc` extension to Vim file type detection. http://groups.google.com/group/asciidoc/browse_thread/thread/a9762e21ec0cc244/5d3a4ebf20e6847e[Patch] submitted by Dag Wiers. - Added 'replacement3' substitution to enable http://groups.google.com/group/asciidoc/browse_thread/thread/843d7d3d671006fb/25628e14c829db3f[ODT whitespace processing]. - Added 'unbreakable' option to XHTML and HTML 5 backends. - Implemented toc::[] block macro and 'toc-placement' attribute for HTML backends to allow the Table of Contents placement to be set manually by the author. - Added FAQs: 'How can I control page breaks when printing HTML outputs?' and 'Is it possible to reposition the Table of Contents in HTML outputs?'. - Added `--backend` and `--backend-opts` options to the 'a2x' command to allow 'a2x' to use backend plugin code extensions. http://groups.google.com/group/asciidoc/browse_thread/thread/b8e93740b7cd0e1d/b5e0b83fe37ae31a[Patch] submitted by Lex Trotman. - Added http://groups.google.com/group/asciidoc/browse_thread/thread/3d06b0105dfbb780/8c60eb7a62f522e4[args block attribute] to source highlight blocks to allow arbitrary parameters to be passed to the source highlighters. - If the 'ascii-ids' attribute is defined then non-ascii characters in auto-generated IDs http://groups.google.com/group/asciidoc/browse_thread/thread/33e99b78e2472122[are replaced] by their nearest ascii equivalents (to work around DocBook processor limitations). - Added global 'blockname' attribute which is dynamically updated to identify the current block. See http://groups.google.com/group/asciidoc/browse_thread/thread/8200e29815c40f72[discussion list]. - 'xhtml11', 'html5' backends: Include book part TOC entries for multi-part books. Patch submitted by Loïc Paillotin. - Removed code filter example from the AsciiDoc User Guide so that backends implemented as external plugins can compile the manual. See http://groups.google.com/group/asciidoc/browse_thread/thread/849e5ea91f43adf2[discussion list]. - If the delimited block 'skip' option is set then do not consume block title and attributes. This makes it possible for the comment delimited blocks to use an attribute list (previously the comment delimited block was hardwired to skip preceding attributes and titles). See http://groups.google.com/group/asciidoc/browse_thread/thread/e92a75abcc382701[discussion list]. - Added `backend-confdir` intrinsic attribute. .Bug fixes - *FIXED*: slidy backend: broken 'stylesheet' attribute. http://groups.google.com/group/asciidoc/browse_thread/thread/58d0843ae4345afd[Patch] submitted by Micheal Hackett. - *FIXED*: Restored http://groups.google.com/group/asciidoc/browse_thread/thread/b0e69e393b6f9f20/47a2c7586f9e40c6?lnk=gst&q=themes+tarball#47a2c7586f9e40c6[missing themes] to zip file distribution archive. - *FIXED*: Grammatical error in error messages. http://groups.google.com/group/asciidoc/browse_thread/thread/b9d705c6b6b39f59/1e120483dafca109[Patch] submitted by Dag Wieers. - *FIXED*: Use configured normal substitution in preference to the default one. - *FIXED*: The 'eval' block macro would execute multiple times if it evaluated to 'None'. - *FIXED*: Duplicated entries in TOC of large document. http://groups.google.com/group/asciidoc/browse_thread/thread/103445ab9d95cb0c[Patch] submitted by Sebastien Helleu. - *FIXED*: Python 2.4 backward http://code.google.com/p/asciidoc/issues/detail?id=9[incompatibility]. - *FIXED*: 8.6.6 regression broke Jython compatibility. See http://groups.google.com/group/asciidoc/browse_thread/thread/4608b77ec289f6c4[discussion list]. - *FIXED*: Leaky file handles in a2x and music and latex filters which created incompatibility problems for Jython. - *FIXED*: All Python filters are executed with the same Python interpreter that executes the asciidoc parent (previously filters were hardwired to execute the 'python' interpreter). This prevents http://groups.google.com/group/asciidoc/browse_thread/thread/14e8fcb289a135b/3af3b4e57b827c78?lnk=gst&q=archlinux#3af3b4e57b827c78[Python mix-ups]. - *FIXED*: Microsoft Windows shelled command-line truncation that caused shelled commands to fail e.g. the 'data-uri' attribute failure. Version 8.6.6 (2011-09-04) -------------------------- .Release highlights - The AsciiDoc plugin architecture has been enhanced, unified and extended: * Plugin commands have been added to the asciidoc(1) `--backend` option. * An asciidoc(1) `--theme` option has been implemented to specify a theme and to manage theme plugins. * A plugin 'build' command (for creating plugins) added. * 'build', 'install', 'list' and 'remove' plugin commands are all recognized by asciidoc(1) `--backend`, `--filter` and `--theme` options. - A security update by Kenny MacDermid removes the use of `eval()` on untrusted input (to disallow code malicious execution). .All additions and changes - 'xhtml11', 'html5': Made verse and quote block text darker to print legibly in Google Chrome browser. - Added plugin 'build' command for plugin file creation. - Merged `--help plugins` back to `--help manpage` so it matches the asciidoc(1) manpage. - The `--filter` command-line option can specify the name of filters that will be unconditionally loaded. - If a filter directory contains a file named `__noautoload__` then the filter is not automatically loaded (you can used the `--filter` command-line option to override this behavior). - tests: Add Italian language tests. Patch submitted by Simon Ruderich. See: http://groups.google.com/group/asciidoc/browse_thread/thread/5e2e6f4dd740d51a - tests: Add tests for localized man pages. Patch submitted by Simon Ruderich. See: http://groups.google.com/group/asciidoc/browse_thread/thread/5e2e6f4dd740d51a - 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 (the default behavior is to replace the the section). - If a configuration file section named 'docinfo' is 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. - Added `{sp}` intrinsic attribute for single space character. See http://groups.google.com/group/asciidoc/browse_thread/thread/a839aa01db0765d2 - Fixed TOC and footnotes generator. Patch submitted by Will. See http://groups.google.com/group/asciidoc/browse_thread/thread/734ac5afed736987 - The `asciidoc-confdir` attribute is set to the asciidoc executable directory if it contains global configuration files i.e. a local asciidoc installation. - asciidoc now throws an error instead of just a warning of the backend configuration file is not found. - latex filter: write MD5 file after successful PNG file generation. Always delete temp files irrespective of outcome. - Added truecolor option to LaTeX filter. Patch submitted by Michel Krämer. See: http://groups.google.com/group/asciidoc/browse_thread/thread/6436788a10561851 - Unit test for table column specifiers with merged cells. Patch submitted by Simon Ruderich. See: http://groups.google.com/group/asciidoc/browse_thread/thread/c9238380a1f2507a - Added verbose message for `ifeval::[]` macro evaluation. - Added test case for `ifeval::[]` evaluation. - Security update to remove the use of `eval()` on untrusted input (to disallow code malicious execution). Patch submitted by Kenny MacDermid. - Changed web site layout from table to CSS based. See http://groups.google.com/group/asciidoc/browse_thread/thread/ec8e8481eb0e27b0/d1c035092b5bb7a4?lnk=gst&q=caption+option#d1c035092b5bb7a4 - a2x: Pass `--format` option value to asciidoc as 'a2x-format' attribute. Patch submitted by Lex Trotman (http://groups.google.com/group/asciidoc/browse_thread/thread/3e177b84bc133ca9/659796dfadad30ea?lnk=gst&q=a2x+format#659796dfadad30ea). - Added two FAQs submitted by Lex Trotman. See: http://groups.google.com/group/asciidoc/browse_thread/thread/16d3fb9672a408e7 - html5,xhtml11: Implemented themes directory structure. - html5,xhtml11: Implemented asciidoc `--theme` management option (install, list, build and remove commands). - html5,xhtml11: A theme can now optionally include a JavaScript file `<theme>.js` - html5,xhtml11: If the 'data-uri' attribute is defined then icons from the theme icons directory (if they exist) will be embedded in the generated document. - Added optional 'warnings' argument to include macros. - The asciidoc `--verbose` option now prints file inclusion messages. - xhtml11, html5: Remove necessity for separate manpage CSS files. - Added 'css-signature' attribute to tests. - Add 'css-signature' attribute to set a CSS signature for the document. Patch submitted by Peg Russell, see: http://groups.google.com/group/asciidoc/browse_thread/thread/bacbf8aeb8ad6a3a - White background for toc2 TOC viewport so that horizontally scrolled content does not obscure the the TOC. Patch submitted by Lionel Orry, see: http://code.google.com/p/asciidoc/issues/detail?id=8 .Bug fixes - *FIXED*: Plugin install command: Delete backend directory is install fails. - *FIXED*: Plugin install command: Fixed bug extracting binary files on Windows (reported by Jean-Michel Inglebert). - *FIXED*: tests: Skip blank sections in testasciidoc.conf test configuration file instead of throwing an exception (reported by Jean-Michel Inglebert). - *FIXED*: If a plugin Zip file does not contain file permissions (probably because it was created under Windows) then install it using the default permissions. - *FIXED*: Fixed missing quote in preceding LaTeX filter patch. Fix submitted by Simon Ruderich. See: http://groups.google.com/group/asciidoc/browse_thread/thread/6436788a10561851 - *FIXED*: Some path attributes were processed as escaped Python strings which could result in corrupted path names with backslash separated Windows path names. Reported by Will. See: http://groups.google.com/group/asciidoc/browse_thread/thread/e8f3938bcb4c8bb4/44d13113a35738ef - *FIXED*: Vertically spanned table cells resulted in incorrect column styles being applied to some cells. Reported by Will: http://groups.google.com/group/asciidoc/browse_thread/thread/c9238380a1f2507a/9afc4559d51e1dbd - *FIXED*: LaTeX backend: fixed bad escapes. Patch submitted by Mark McCurry: http://groups.google.com/group/asciidoc/browse_thread/thread/8c111f1046b33691/158a944cf4d5ff0d?lnk=gst&q=latex+escapes#158a944cf4d5ff0d - *FIXED*: When using slidy backend, display of characters with accents is wrong because of 'meta http-equiv' line missing. Reported by Fabrice Flore-Thebault. See: http://groups.google.com/group/asciidoc/browse_thread/thread/eaf25f21d1da180a Version 8.6.5 (2011-05-20) -------------------------- .Release highlights - The addition of an 'html5' backend to generate HTML 5 output. Apart from the inclusion of 'audio' and 'video' block macros the 'html5' backend is functionally identical to the 'xhtml11' backend. - A new 'flask' theme for 'xhtml11' and 'html5' backends inspired by the http://flask.pocoo.org/docs/[Flask website] styling (see 'toc2' example in the next item below). - The new 'toc2' attribute generates a table of contents in the left hand margin ('xhtml11' and 'html5' backends). link:article-html5-toc2.html[This example] was generated using the following command: asciidoc -b html5 -a icons -a toc2 -a theme=flask article.txt - `a2x(1)` now has a flexible mechanism for copying arbitrary resource files to HTML based outputs -- this is very handy for generating EPUB files with embedded fonts and other resources. * The `a2x(1)` `--resource` option can be used to inject any file into EPUB output documents e.g. CSS resources such as fonts and background images. * Explicitly specified resources are added to the EPUB OPF manifest automatically. * You can explicitly specify file extension MIME types. * The enhanced resource processing works around a couple of DocBook XSL bugs (see link:epub-notes.html[EPUB Notes]). .All additions and changes - A new 'flask' theme for 'xhtml11' and 'html5' backends. A shameless knock-off of the http://flask.pocoo.org/docs/[Flask website] styling. - Added HTML 5 article with 'toc2' table of contents to the example on the AsciiDoc website home page. - Added 'filters' and 'topics' help topics. Fixed documentation errors in help text. Patch submitted by Lionel Orry, see: http://groups.google.com/group/asciidoc/browse_thread/thread/9da9d48a6461ff14 - Pass parent configuration files, command-line attributes and header attributes to table asciidoc filters. Based on patch submitted by Simon Ruderich, see: http://groups.google.com/group/asciidoc/browse_thread/thread/5c792cbb395b753b - Allow a 'title' attribute entry in the document header so that HTML backends can set the 'title' element separately from the displayed document title (the 'doctitle' attribute). - Pass 'lang' attribute to 'asciidoc' table style filter. Patch submitted by Simon Ruderich, see: http://groups.google.com/group/asciidoc/browse_thread/thread/e2100b7cb29283ce - xhtml11,html5: Added 'toc2' attribute which generates a scrollable table of contents in the left hand margin. Based on customized CSS written by Suraj Kurapati, see http://groups.google.com/group/asciidoc/browse_thread/thread/c5e30ee5555877f5 - Added 'asciidoc-confdir' intrinsic attribute which expands to the global conf directory. - Documented that you can specify multiple CSS files with the a2x(1) `--stylesheet` command option. See: http://groups.google.com/group/asciidoc/browse_thread/thread/baf3218551d05a05 - Improved xhtml11 backend's table of contents generation latency. Patch submitted by Hongli Lai. See: http://groups.google.com/group/asciidoc/browse_thread/thread/5a7fe64fbfd65ad - Added html5 backend. - For consistency converted all DOS formatted configuration and text files to UNIX format. - html4: Added ability to use 'role' attribute with most block elements. Patch contributed by Simon Ruderich. See http://groups.google.com/group/asciidoc/browse_thread/thread/5620ba634fdb030a - Added Dutch language configuration file and accompanying test file (contributed by Dag Wieers, see http://groups.google.com/group/asciidoc/browse_thread/thread/f969b9ce987d7f5d). - Configuration files are loaded in two passes when the -e command-line option is used (the same behavior as when the -e option is not used). Patch submitted by haad. See http://groups.google.com/group/asciidoc/browse_thread/thread/cd0f47495fd04181 and http://code.google.com/p/asciidoc/issues/detail?id=6&q=label%3APriority-Medium - Documented how to include embedded fonts in an EPUB document. - a2x: Added `.<ext>=<mimetype>` resource specifier syntax. - a2x: Enable admonition icons in example EPUBs. - a2x: allow environment variables and tilde home directories in resource manifest files. - a2x: don't process non-existent resource directories. - a2x: assume resource option is a directory if the name ends with a directory separator. - a2x: Added a new syntax to the `--resource` option specifier which allows the destination path to be specified. - a2x: Copy resources referenced in the OPF and resources referenced by the generated HTML (in theory DocBook XSL should ensure they are identical but this is not always the case e.g. http://sourceforge.net/tracker/?func=detail&atid=373747&aid=2854075&group_id=21935). - Drop border from callout list image links. - html4: Moved manpage NAME section out of header so that the name section is rendered when the asciidoc(1) `--no-header-footer` option is specified (so that manpages processed blogpost include the NAME section). - Vim syntax highlighter: TODO markers now appear in list items and literal paragraphs and blocks. - Constrained quotes can now be bounded on the left by a } character. See: http://groups.google.com/group/asciidoc/browse_thread/thread/b24cc3362f35b801 - Added text-decoration roles (underline, overline, line-through, blink) for xhtml11 and html5 outputs. .Bug fixes - *FIXED*: epubcheck 1.1 previously issued a warning for files not registered in the manifest (epubcheck 1.0.5 did not). This resulted in a problem compiling the adventures-of-sherlock-holmes.txt example (the `underline.png` resource was not in the manifest). Version 8.6.4 (2011-02-20) -------------------------- .Additions and changes - Added text foreground and background color along with text size CSS styles for XHTML outputs, see {website}userguide.html#X96[]. - Vim syntax highlighter: highlight macros that start with an attribute reference (a common idiom). - Vim syntax highlighter: highlight attribute references in macro attribute lists. - Attribute entries can be used to set configuration markup templates. - Double-width East Asian characters in titles now correctly match the title underline widths. Submitted by Changjian Gao (see http://groups.google.com/group/asciidoc/browse_thread/thread/77f28b0dfe60d262). - Implemented {website}manpage.html[asciidoc(1)] filter commands, see: http://groups.google.com/group/asciidoc/browse_thread/thread/40c64cd33ee1905c - User's home directory now calculated in a platform independent manner. - Added double-quote characters to French language file. Patch contributed Yves-Alexis Perez, see: http://groups.google.com/group/asciidoc/browse_thread/thread/e15282f072413940 - Vim Syntax highlighter: Highlight closing OpenBlocks which immediately follow a literal paragraph. - Changed UNIX `/dev/null` to OS independent `os.devnull` in filters code. Suggested by Henrik Maier: http://groups.google.com/group/asciidoc/browse_thread/thread/5ac8e8ea895147e9 - Vim syntax highlighter: Single and double quoted text now highlights correctly when preceded by an attributes list. - Added Ukrainian language file (`lang-uk.conf`). Added double-quote characters to Russian language file.conf). Patches contributed by Lavruschenko Oleksandr, see http://groups.google.com/group/asciidoc/browse_thread/thread/e15282f072413940 - Single and double quote characters are now set using the `{lsquo}`, `{rsquo}`, `{ldquo}` and `{rdquo}` attributes. This makes is easy to customise language specific quotes. See: http://groups.google.com/group/asciidoc/browse_thread/thread/e15282f072413940 - Implemented 'conf-files' attribute to allow configuration files to be specified in the source document. Suggested by Lex Trotman, see: http://groups.google.com/group/asciidoc/browse_thread/thread/b11066a828ab45b9 .Bug fixes - *FIXED*: Auto-generated section title ids are now Unicode aware. - *FIXED*: Setting 'quotes' configuration entries using document attribute entries failed if the attribute entry was not in the document header. See: http://groups.google.com/group/asciidoc/browse_thread/thread/a1dd0562dee8b939 - *FIXED*: If the input and output file names were different then the output file name was incorrectly used to synthesize 'docinfo' file names. Reported by Christian Zuckschwerdt. - *FIXED*: An error can occur when more than one consecutive quotes are defined as a blank string. Reported by Peggy Russell. - *FIXED*: Encoding error in automatically generated author initials. Patch submitted by Xin Wang. See: http://groups.google.com/group/asciidoc/browse_thread/thread/f44615dca0b834e9 Version 8.6.3 (2010-11-14) -------------------------- .Additions and changes - Added and 'unbreakable' option to bulleted and numbered lists (thanks to Henrik Maier for this patch). - Added `ifeval::[]` system macro (thanks to Henrik Maier for suggesting this feature). - The image 'scale' attribute sets the DocBook 'imagedata' element 'scale' attribute. Patch submitted by Henrik Maier. - DocBook 'preface', 'colophon' and 'dedication' style section titles now work. Based on patch submitted by Henrik Maier. - 'a2x': Do not inject xsltproc parameters if they were specified on the command-line (parameter double-ups generate xsltproc 'Global parameter already defined' errors). - 'a2x': Refactored xsltproc parameter injection. - 'a2x': articles chunked at section level by default. - 'attributes', 'titles' and 'specialcharacters' sections are now read from the local `asciidoc.conf` file before the header is parsed. This fixes a regression problem. See http://groups.google.com/group/asciidoc/browse_thread/thread/1b3f88f1f8118ab3 - Document header attributes take precedence over configuration file attributes. - Refactored 'music', 'graphviz' and 'latex' filter configurations. - Refactored source filter configuration and added literal paragraph source style. - Separated paragraph styles from paragraph syntax -- any style can be applied to any syntax. - Added 'listing' and 'quote' paragraph styles. - Renamed paragraph 'default' style to 'normal'. - Updated `--help` option text. - 'a2x': The `asciidoc_opts`, `dblatex_opts`, `fop_opts` and `xsltproc_opts` command-line options can be specified multiple times. This makes embedding multiple 'a2x' options in document headers easier to manage and less error prone. - Added ASCIIMathML and LaTeXMathML support to slidy backend. - Pass the 'encoding' attribute to the Pygments source highlight filter command. - 'a2x': HTML Help `.hhk` file named after AsciiDoc source file. - 'a2x': Added `--xsl-file` option to allow custom XSL stylesheets to be specified. - Make builds the man pages. Patch submitted by Sebastian Pipping. See http://groups.google.com/group/asciidoc/browse_thread/thread/c21c2902c29bae64 .Bug fixes - *FIXED*: Sometimes double backquotes were misinterpreted as inline literal macros. See: http://groups.google.com/group/asciidoc/browse_thread/thread/f510ea82a88aaee8 - *FIXED*: Regression in 8.6.2: command-line attributes were not available to the global asciidoc.conf. - *FIXED*: Postponed document title substitutions until backend conf files have been loaded (8.6.2 regression). See http://groups.google.com/group/asciidoc/browse_thread/thread/42b63ce90c2563b8 - *FIXED*: The XSL Stylesheets customizations were preventing chapter and section level TOCs from being generated when using XSL Stylesheets via 'a2x'. See http://groups.google.com/group/asciidoc/browse_thread/thread/42b63ce90c2563b8 - *FIXED*: ``UnicodeDecodeError: \'ascii' codec can't decode byte'' error. This error is due to a limitation in the Python HTMLParser module, see: http://bugs.python.org/issue3932 - *FIXED*: Broken `--no-conf` option (8.6.2 regression). - *FIXED*: Regression in 8.6.2: configuration attribute entries set in the document header may cause a 'FAILED: incomplete configuration files' error. - *FIXED*: 'html4': corrected self closed meta tags. - *FIXED*: 'a2x' regression in 8.6.2: HTML Help `.hhp` file name had reverted to default name instead of the AsciiDoc source file name. See: http://groups.google.com/group/asciidoc/browse_thread/thread/dedc961b23e9ac56 - *FIXED*: Attributes in man page title caused it to be dropped resulting in invalid DocBook output. - *FIXED*: `make uninstall` now deletes the `asciidoc.1` and `a2x.1` man pages. Version 8.6.2 (2010-10-03) -------------------------- .Additions and changes - 'docbook45': Enclosed bibliographic lists in a 'bibliodiv' -- you can now include block titles with bibliographic lists. - Added optional 'keywords', 'description' and 'title' document header meta-data attributes to HTML backends for SEO. - AttributeEntry values can span multiple lines with a ' +' line continuation. - Added 'slidy' backend (based on Phillip Lord's slidy backend https://phillordbio-asciidoc-fixes.googlecode.com/hg/). - Implemented 'OpenBlock' 'partintro' style for book part introductions. - Comment lines substitute special characters only. - Backend specific global configuration files (all except `asciidoc.conf`) are loaded *after* the header has been parsed -- virtually any attribute can now be specified in the document header. - 'xhtml11': Volnitsky theme: allow bulleted lists to have intervening children. - 'xhtml11': refactored CSS font-family rules to start of file. - 'xhtml11': list bullets colored gray. - 'ifdef' and 'ifndef' system block macros accept multiple attribute names: multiple names separated by commas are 'ored'; multiple attribute names separated by pluses are 'anded'. - 'xhtml11': Volnitsky theme: set max-width on labeled lists. - Vim syntax highlighter: Entities inside quoted text are now highlighted. - Added 'role' and 'id' attributes to HTML outputs generated by 'OpenBlocks'. - Allow floating titles to generate 'h1' (level 0) titles in HTML outputs. - Added a 'start' attribute to numbered lists to set the start number. See: http://groups.google.com/group/asciidoc/browse_thread/thread/c14a4c3b1e4f6dc5 - Added two more docinfo attributes 'docinfo1' and 'docinfo2' to allow and control inclusion of a shared docinfo file. See http://groups.google.com/group/asciidoc/browse_thread/thread/c948697943432e24 - Vim syntax highlighter highlights multi-name conditional attributes. - LaTeX backend patch submitted by Andreas Hermann Braml (see http://groups.google.com/group/asciidoc/browse_thread/thread/1c415fc4540ce5e5). - Implemented 'backend aliases'; renamed `docbook.conf` to `docbook45.conf` and aliased 'docbook45' backend to 'docbook'; aliased 'xhtml11' to 'html'. .Bug fixes - *FIXED*: Filter commands located in filter directories local to the source document that where not in the search 'PATH' where not found. - *FIXED*: Volnitsky theme: Verseblock font set normal instead of monospaced. - *FIXED*: 'xhtml11': Callout icons were not rendered as Data URIs when 'icons' and 'data-uri' attributes were specified. - *FIXED*: Long standing bug: nested include macros did not restore the parent document 'infile' and 'indir' attributes. See: http://groups.google.com/group/asciidoc/browse_thread/thread/8712a95e95a292a7 - *FIXED*: 'html4': set preamble ID anchor. - *FIXED*: 'xhtml11': dropped unusable 'id' and 'role' attributes from preamble template. - *FIXED*: Bug in multi-name conditional attributes e.g. `{x,y#}` fails if x or y is undefined. - *FIXED*: latex filter not being installed by Makefile. Thanks to Grant Edwards for this patch. See http://groups.google.com/group/asciidoc/browse_thread/thread/c4427a3902d130a8 - *FIXED*: 'a2x': Long-standing bug in a2x which always passes `--string-param navig.graphics 0` to 'xsltproc', regardless of whether icons are enabled or not. Reported by Michael Wild: http://groups.google.com/group/asciidoc/browse_thread/thread/59a610068e4acb58 Version 8.6.1 (2010-08-22) -------------------------- .Additions and changes - 'a2x': `--resource-dir` option renamed to `--resource`. - 'a2x': `--resource` option accepts both file and directory names. - 'a2x': Added `-m,--resource-manifest` option. - Added Vim syntax highlighting for quote attribute lists. - Load 'asciidoc.conf' from all configuration directories before any other configuration files. This ensures that attributes used for conditional inclusion are set before backend configuration files are processed. Previously if you wanted to control global conf file inclusion your only choice was to modify the global 'asciidoc.conf' file. - AsciiDoc 'Quote element' attributes have been simplified and generalized -- positional color and size attributes and named 'role' attribute have been replaced by a single positional attribute. .Bug fixes - *FIXED*: 'testasciidoc.py': `BACKEND` command argument was being ignored. - *FIXED*: Broken 'docinfo' file functionality in 'html4' and 'xhtml11' backends (previously the docinfo file was included in the 'body' instead of the 'header'). Regression issues ~~~~~~~~~~~~~~~~~ This release breaks compatibility with quoted element positional color and size attributes (HTML backends). To revert to the deprecated quote behavior define the 'deprecated-quotes' attribute in the global `asciidoc.conf` file or on the command-line. For a more detailed explanation of the rationale behind this change see http://groups.google.com/group/asciidoc/browse_thread/thread/b22603bfb879418c. Version 8.6.0 (2010-08-16) -------------------------- .Additions and changes - The AsciiDoc distribution can now be built ``out of the box'' from the distribution tarball or the Mercurial repository (provided you have the requisite build applications installed). - The global configuration files directory is ignored by both 'asciidoc' and 'a2x' if AsciiDoc configuration files are installed in the same directory as the asciidoc executable. This change allows both a system wide copy and multiple local copies of AsciiDoc to coexist on the same host PC. - CSS 'quirks' mode is no longer the default 'xhtml11' output (http://groups.google.com/group/asciidoc/browse_thread/thread/1c02d27d49221aa2). - Relaxed anchor ID name syntax (http://groups.google.com/group/asciidoc/browse_thread/thread/5f3e825c74ed30c). - Added document files: `doc/epub-notes.txt`, `doc/publishing-ebooks-with-asciidoc.txt`. - 'a2x': If all other resource locations are exhausted then recursively search directories named 'images' and 'stylesheets' in the 'asciidoc' configuration files directory. - 'a2x': options can also be set in the AsciiDoc source file. If the source file contains a line beginning with '// a2x:' then the remainder of the line will be treated as a2x command-line options. - Added dblatex table-width processing instruction -- tables generated by dblatex now observe the AsciiDoc table width as a percentage (thanks to Gustav Broberg for suggesting this enhancement). - 'a2x': Don't exit if the `--epubcheck` option is set and 'epubcheck' is missing, issue warning and continue. - Added a global 'plaintext' attribute for dealing with large amounts of imported text. - The author name format has been relaxed, if the the author does not match the formal specification then it is assigned to the 'firstname' attribute (previously asciidoc exited with an error message). - FAQ and documentation updates. - Refactored chunked.xsl and epub.xsl files. - Exchanged article.epub for more relevant book.epub on website. - Put asciidoc.epub User Guide on website. - 'a2x': Chunking EPUB and HTML outputs set to a per chapter basis and the first chapter is separate from preceding contents. - Changed dates format in example article and books to suppress EPUB validation error. - Added 'style' and 'role' CSS classes to xhtml11 section templates. - Added the 'role' element to xhtml11 backend block templates. - Suppressed md5 module deprecation warning from music and Graphviz filters. - Pygments (http://pygments.org/) option added to source code highlight filter. Based on Pygments source code filter written by David Hajage (http://groups.google.com/group/asciidoc/browse_thread/thread/d8d042f5a3021369/8934ebbb8cb7144b). - xhtml11: Added a new theme (volnitsky). Written and contributed by Leonid V. Volnitsky. - xhtml11: Set body element class name to document type. - Added refentryinfo element and contents (including revdate) to man page DocBook output. Man pages are now dated using the revdate attribute value if it has been defined. Based on patch supplied by Rainer Muller http://groups.google.com/group/asciidoc/browse_frm/thread/319e5cd94493e330/3fcb83fab067af42. - Added `{template:...}` system attribute. - Table of contents attribute 'toc' can now be specified in the document header. - Reimplemented music and latex filter -m option functionality when the input is stdin using MD5 checksums. - Added 'latex' filter. - Added auto file name generation to image generating filters (latex,music, graphviz). - Added `counter2` and `set2` system attributes (to implement image auto file name generation). - Undefined attribute in filter command generates error but does not exit. - Attribute substitution proceeds from start line to end line (previously was in reverse order which was really confusing). - Tidied up music filter code: * Format option is optional and default to 'abc' unless Lilypond notation detected. * The -m option does not apply to stdin input. - Added paragraph styles to music and graphviz filters. - Documented dynamic template names. 753: Graphviz filter can now generate SVG format images. Patch submitted by Elmo Todurov, see: http://groups.google.com/group/asciidoc/browse_frm/thread/fe9b33d8f5f1e0af The xhtml11 SVG Graphviz template marked EXPERIMENTAL. No SVG support for other backends. - AsciiDoc template names can now contain embedded attribute references. - Added 'legalnotice' tag to `doc/article-docinfo.xml` example. - xhtml11 backend: Callouts and callout lists display callout icons when the 'icons' attribute is defined. See http://groups.google.com/group/asciidoc/browse_frm/thread/8eda3ea812968854 - Document attribute names are case insensitive everywhere, this makes using attribute entries more consistent e.g. previously :VERS: had to be refered to with {vers} ({VERS} did not work). - Hungarian translation of footer-text (submitted by Miklos Vajna). See http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72# - asciidocapi.py 0.1.2: Can now load AsciiDoc script named asciidoc. See http://groups.google.com/group/asciidoc/browse_frm/thread/66e7b59d12cd2f91 Based on patch submitted by Phillip Lord. - German translation of footer-text (submitted by Simon Ruderich). See http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72 - Pushed HTML footer text into language conf files with the introduction of a [footer-text] configuration file template section. See http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72 .Bug fixes - *FIXED*: Sometimes multiple double quoted text elements in the same paragraph were mistakenly seen as starting with an inline literal. See http://groups.google.com/group/asciidoc/browse_frm/thread/219c86ae25b79a21 - *FIXED*: 'localtime' and 'doctime' attributes calculated incorrect daylight saving / non daylight saving timezones and consequently so did HTML footers. Patch submitted by Slawomir Testowy. See http://groups.google.com/group/asciidoc/browse_frm/thread/af652507caf6cec9 - *FIXED*: Missing selector for 'List of examples' title in DocBook CSS file. Patch submitted by Laurent Laville. See http://groups.google.com/group/asciidoc/browse_frm/thread/3f96900f7fbf5620 - *FIXED*: Broken accents in lang-hu.conf. See: http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72 - *FIXED*: DocBook XSL generated HTML callout lists are properly aligned. Submitted by Lionel Orry. See http://groups.google.com/group/asciidoc/browse_frm/thread/2ff802547b6a75ea - *FIXED*: Filter execution now occurs prior to filter markup template substitution to ensure image data URI encoding happens after image generation (see http://groups.google.com/group/asciidoc/browse_thread/thread/14e8fcb289a135b). - *FIXED*: The section numbers no longer increment when the 'numbered' attribute is undefined (see http://groups.google.com/group/asciidoc/browse_thread/thread/faa36e9e5c7da019/d24cab3fe363e58d). Version 8.5.3 (2010-01-18) -------------------------- .Additions and changes - a2x: Added a2x configuration file options ASCIIDOC_OPTS, DBLATEX_OPTS, FOP_OPTS, XSLTPROC_OPTS (appended to same-named command-line options). See http://groups.google.com/group/asciidoc/browse_frm/thread/ac4b9bfa2116db28 - Dropped `.hgignore` from the repository. See http://groups.google.com/group/asciidoc/browse_frm/thread/c17abd175778f5ea - Don't pass verbose options to asciidoc table filter so that asciidocapi messages are not discarded. See: http://groups.google.com/group/asciidoc/browse_frm/thread/c17abd175778f5ea - Added `./tests/data/lang-pt-BR-test.txt` file to the repository. - xhtml11: Verse block and verse paragraph content enveloped in a 'pre' tag (instead of a 'div') so it renders better in text-only browsers. See: http://groups.google.com/group/asciidoc/browse_frm/thread/1b6b66adb24e710 - User Guide: Clarified Passthrough Blocks (suggested by Simon Ruderich). - FAQ: 'How can I include lines of dashes inside a listing block?' - FAQ errata and updates (submitted by Simon Ruderich). - User Guide errata. - Simplified 'asciidoc-toc' processing instruction and included lists of figures, tables, examples and equations in books (i.e. revert to pre-8.5.0 behavior). - Attempted to have dblatex recognise the 'asciidoc-toc' processing instruction but couldn't get it to work. - Added 'notitle' attribute to allow the document title to be hidden. .Bug fixes - *FIXED*: Regression: system attribute escaping did not work. - *FIXED*: Website: broken image links in chunked User Guide. Version 8.5.2 (2009-12-07) -------------------------- .Additions and changes - Updated example article and book documents with the recommended explicit section name syntax (see the 'Special section titles vs. explicit template names' sidebar in the AsciiDoc 'User Guide'). - Added Italian language configuration file (contributed by Fabio Inguaggiato). - Added 'header' table style. See: http://groups.google.com/group/asciidoc/browse_frm/thread/a23fea28394c8ca9 - Pass 'icons', 'data-uri', 'imagesdir', 'iconsdir' attributes to 'asciidoc' table style filter so that images are rendered in table cells. - Pass 'trace' and 'verbose' attributes to 'asciidoc' table style filter so diagnostic information is printed from table cell source. - The 'eval' system attribute can be nested inside other system attributes. - HTML outputs: Table and figure caption punctuation set to more usual syntax. - docbook backend: footnotes can now contain embedded images. See http://groups.google.com/group/asciidoc/browse_frm/thread/50b28f6941de111a - CSS tweaks so that tables processed by DocBook XSL Stylesheets have the default asciidoc xhtml11 backend styling. See http://groups.google.com/group/asciidoc/browse_frm/thread/dfe5204d5b2c9685 - Block titles take precedence over section titles to avoid titled delimited blocks being mistaken for two line section titles (see http://groups.google.com/group/asciidoc/browse_frm/thread/f0b6f9989f828c3). - Section title trace displays level and title text. - FAQ additions. - Added `{zwsp}` (zero width space) attribute. - Undefined paragraph styles are reported (previously threw a runtime error). - Eliminated empty preamble generation. - Floating titles now processed in all contexts. - Implemented auto-lettered appendix names and updated example documents. - Section numbering can be disabled in HTML outputs with a ':numbered!:' AttributeEntry. - xhtml11: Nicer default quote block styling. - Exclude floating titles from xhtml11 table of contents. Patch submitted by Mark Burton (see http://groups.google.com/group/asciidoc/browse_frm/thread/14aefc1cb6bd85f5). - Enhanced `doc/article-docinfo.xml` example docinfo file. - Vim syntax highlighter improvements. .Bug fixes - *FIXED*: Absolute 'imagesdir' and 'iconsdir' attribute path names do not work with the xhtml11 data-uri encoding. See http://groups.google.com/group/asciidoc/browse_frm/thread/cb8b7694bbc82a6 - *FIXED*: Regression issue with inline data-uri images. See http://groups.google.com/group/asciidoc/browse_frm/thread/cb8b7694bbc82a6 - *FIXED*: An unexpected error occurred when processing a table containing CSV data if the 'cols' attribute was not explicitly specified. See http://groups.google.com/group/asciidoc/browse_frm/thread/4b0f364b477ec165 Version 8.5.1 (2009-10-31) -------------------------- .Additions and changes - If an AsciiDoc document file begins with a UTF-8 BOM (byte order mark) then it is passed transparently through to the output file. The BOM is stripped from included files. See http://groups.google.com/group/asciidoc/browse_frm/thread/e5e61823ff4203cd - Added AsciiDoc 'role' attribute to quoted text. Sets 'class' attribute in HTML outputs; 'role' attribute in DocBook outputs. See: http://groups.google.com/group/asciidoc/browse_frm/thread/2aa3e5711d243045 - Conditional attribute syntax extended: they now accept multiple ORed or ANDed attribute names. - The 'xhtml11' backend dynamically processes footnotes using JavaScript. - Tidied up and namespaced 'xhtml11' JavaScript. - Superceded `javascripts/toc.js` with `javascripts/asciidoc-xhtml11.js`. - Added 'disable-javascript' attribute ('xhtml11' backend). - Styled HTML footnotes. - Added links to HTML footnote refs. - Added title attribute to inline image macros to display popup ``tooltip'' (HTML outputs only). - Single-quoted attribute values are substituted in block macros (just like the AttributeList element). - For consistency changed underscores to dashes in attribute names. Public attributes with underscores retained for compatibility. - Added Brazilian Portuguese language configuration file (contributed by Thiago Farina). - Added 'leveloffset' attribute to make it easier to combine documents. .Bug fixes - *FIXED:* a2x: `--dblatex-opts` is now processed last so `asciidoc-dblatex.xsl` params can be overridden. Patch submitted by Mark Fernandes (see http://groups.google.com/group/asciidoc/browse_frm/thread/5215c99dcc865e7d). - *FIXED:* An error occurred if a directory in current path with same name as executable. Regression issues ~~~~~~~~~~~~~~~~~ There's been quite a bit of tiding up to the xhtml11 JavaScript. The most obvious change is that the toc.js script has been superceded by asciidoc-xhtml11.js so if you're linking you'll need get a copy of the new file from the distribution javascripts directory. If you use customised xhtml11 configuration file `[header]` and `[footer]` sections and you want them to use the new footnotes feature then you've got a bit more work to do: . The onload event expression changed. . The new `<div id="content">...</div>` div envelopes document content. . You need to add `<div id="footnotes">...</div>` div to the `[footnotes]` section for footnotes to work. . Drop the `ifdef::toc[]` macro that surround JavaScript inclusion. Take a look at the [header] and [footer] changes in the xhtml11.conf diff to see what's going on: http://hg.sharesource.org/asciidoc/diff/55a5999bfd04/xhtml11.conf Version 8.5.0 (2009-10-04) -------------------------- .Additions and changes - Implemented a 'float' attribute for tables and block images (HTML outputs only). - Added `unfloat::[]` block macro to cancel floating. - Added table 'align' attribute to (HTML outputs only). - The image 'align' attribute now works with HTML backends. - Renamed table cell 'align' attribute to 'halign' so it doesn't clash with the new table 'align' attribute. - Added 'breakable' and 'unbreakable' options to AsciiDoc example and block image elements. - `[miscellaneous]` section entries now update properly when set from a document 'AttributeEntry'. - `[miscellaneous]` section `pagewidth` entry accepts fractional values. - Fractional column widths are now calculated correctly when using fractional 'pageunits' (DocBook tables). - Use DocBook XSL table width processing instructions. - asciidoc 'KeyboardInterrupt' exits with error code 1. - Added 'set' system attribute to allow attributes to be set from configuration file templates. - Allow constrained quotes to be bounded on the left by a colons and semicolons, see http://groups.google.com/group/asciidoc/browse_frm/thread/b276a927fdc87995 - Titled listing and literal blocks (DocBook outputs) no longer default to examples. See http://groups.google.com/group/asciidoc/browse_frm/thread/f4df7c9eec01a9bd - Updated language file table, figure and example captions to accommodate new auto-numbering in html4 and xhtml11 backends. - Titled source highlight filter listings generated by docbook backend are now rendered as examples. See http://groups.google.com/group/asciidoc/browse_frm/thread/f4df7c9eec01a9bd - Implemented 'counter' system attribute. - Use 'counter' system attributes to number titled tables and block images in HTML backends. - Added program name suffix to console messages. - Added substitution to the 'AttributeEntry' passthrough syntax, this replaces the now unnecessary 'attributeentry-subs' attribute. - Allow passthrough inline macro syntax to be used in 'AttributeEntrys'. - Reinstated 8.4.4 default 'lang' attribute behavior. See http://groups.google.com/group/asciidoc/browse_frm/thread/d29924043e21cb6a. - Added 'max-width' attribute to the 'xhtml11' backend to set maximum display width. See http://groups.google.com/group/asciidoc/browse_frm/thread/74d9a542b79ccd50. - Added 'a2x.py', a rewritten and much enhanced version of the old 'a2x' bash script. - The new 'a2x' can output EPUB formatted documents. - Added `--safe` option and deprecated `--unsafe` option. Patch submitted by Todd Zullinger. See http://groups.google.com/group/asciidoc/browse_frm/thread/ea3a8ea399ae5d2a and http://groups.google.com/group/asciidoc/browse_frm/thread/69b3183fdab7c6a5 - Added 'CHECK' and 'TEST' todo highlight words to Vim syntax highlighter. - Line breaks, page breaks, and horizontal rulers are now processed by dblatex, thanks to a patch submitted by Mark Fernandes (http://groups.google.com/group/asciidoc/browse_frm/thread/a254cf949ea7c6c5). - Allow footnote macros hard up against the preceding word so the rendered footnote mark can be placed against the noted text without an intervening space (patch submitted by Stas Bushuev, http://groups.google.com/group/asciidoc/browse_frm/thread/e1dcb7ee0efc17b5). - Normalized path in `safe_filename` function (submitted by Todd Zullinger, http://groups.google.com/group/asciidoc/browse_frm/thread/69b3183fdab7c6a5). - The Asciidoc 'numbered' and 'toc' attributes cause DocBook outputs to include `asciidoc-numbered` and `asciidoc-toc` processing instructions, these are used by DocBook XSL to include section numbering and table of contents (like Asciidoc HTML backends). For backward compatibility both 'numbered' and 'toc' attributes are defined by default when the 'docbook' backend is used. See http://groups.google.com/group/asciidoc/browse_frm/thread/1badad21ff9447ac. - 'data-uri' attribute is now evaluated dynamically and can be set in document body (previously could only be set from command-line). - Added 'sys3' and 'eval3' system attributes to passthrough generated output, this fixes the data-uri inline image problem: http://groups.google.com/group/asciidoc/browse_frm/thread/a42db6bc54c2c537. - Missing language file generates a warning instead of an error. - Updated Spanish language file (updates contributed by Gustavo Andrés Gómez Farhat). .Bug fixes - *FIXED:* Options in an 'AttributeList' option attribute are merged with (rather than replace) configuration file options. - *FIXED:* Comment blocks and comment block macros no longer consume preceding block titles and attribute lists. - *FIXED:* `examples/website/layout1.conf` and `examples/website/layout2.conf` TOC problem. Submitted by Mark (burtoogle). See http://groups.google.com/group/asciidoc/browse_frm/thread/b9c63be67dd1d11c - *FIXED:* Only the first occurrence of passthrough macro was substituted. Patch submitted by Peter Johnson. See http://groups.google.com/group/asciidoc/browse_frm/thread/1269dc2feb1a482c - *FIXED:* asciidoc now runs on Jython 2.5.0. - *FIXED:* Wordpress margins and pads in a number of block elements (http://groups.google.com/group/asciidoc/browse_frm/thread/36ff073c79cbc20a). Regression issues ~~~~~~~~~~~~~~~~~ - Tables generated by 'dblatex' occupy 100% of the available space regardless of the 'width' attribute setting. To restore width behavior change the 'pageunits' miscellaneous parameter to 'pt'. You can do this from the command-line with the `-a pageunits=pt` option. See {website}userguide.html#X89[DocBook table widths]. Version 8.4.5 (2009-05-24) -------------------------- .Additions and changes - Added manpage 'Name' and 'Synopsis' section title customization to languages configuration files. - Synopsis manpage section no longer mandatory. - Section markup templates can be specified by setting the title's first positional attribute or 'template' attribute. - The article and book document header can now include a revision remark. - A 'role' attribute can now be applied to block elements. This adds the 'role' attribute to DocBook elements. Patch submitted by http://groups.google.com/group/asciidoc/browse_thread/thread/62278a054188a038[Noah Slater]). - Renamed 'revision' and 'date' attributes to more sensible and consistent 'revnumber' and 'revdate' (old names deprecated but still recognized). - Moved backend specific attributes to Appendix H in User Guide. - Renamed and generalized the docbook backend revision history inclusion mechanism to 'docinfo' to reflect the use of all article or book information elements. The old revision history names still work but have been deprecated. - Refactored docbook.conf headers. - Moved line break replacement from `[replacements]` to `[replacements2]` so the replacement occurs after the mailto macro. This fixes bug http://groups.google.com/group/asciidoc/browse_thread/thread/4bdcdfb0af773e2 - The typewriter to punctuation apostrophe replacement can be escaped with a backslash. - Graphviz filter outputs images to 'imagesdir' if it is defined. - Made the block image macro generic so that it can be used for filter outputs. As a result Music and Graphviz filters: * Have been greatly simplified. * Honor the 'data-uri' attribute. * 'html4' outputs no longer generate W3C validation warning. - The 'iconsdir' attribute no longer requires a trailing directory separator character. - Removed borders around linked html4 images. - Added 'html4' specific HTML output for music filter. - 'a2x': Added `--unsafe` option (shortcut for `--asciidoc-opts=--unsafe`). - 'a2x': The FOP executable can now be named `fop` (this is the default name in some distributions). - Attributes are now substituted in the system macro attribute list. - If the output is set to stdout (i.e. no output directory is defined) then Music and Graphviz filters will output included images to the source file directory. - Added 'name' directive to 'testasciidoc'. - Added lots of 'testasciidoc' new tests. - Moved language specific configuration parameters into `lang-en.conf` file. - 'lang' attribute entry can be specified in the AsciiDoc source file (preceding the header). - Removed cruft from A-A-P scripts and documented them. - Added German language config file (`lang-de.conf`) contributed by Michael Wild. - Added French language config file (`lang-fr.conf`) contributed by Yves-Alexis Perez. - Added Russian language config file (`lang-ru.conf`) contributed by Artem Zolochevskiy. - Added Hungarian language config file (`lang-hu.conf`) contributed by Miklos Vajna. .Bug fixes - *FIXED:* Multiple manpage names are now handled correctly when generating DocBook output, each name now generates a separate DocBook `<refname>` element. See http://groups.google.com/group/asciidoc/browse_thread/thread/c93bb4db025225d8 - *FIXED:* A problem that caused AttributeEntries preceding the header to be overwritten when the language conf file loaded. - *FIXED:* Possible inline macro name ambiguity e.g. link matches olink. - *FIXED:* The documented macro definition deletion behavior had been broken for a long time. - *FIXED:* Email addresses not recognized when followed by a period character. - *FIXED:* Hyphens in mailto macros can delimit nested addresses e.g. \bloggs@mail was processed inside \mailto:joe-bloggs@mail-server.com[Mail]. - *FIXED:* User name in FTP URI generated incorrect FTP link. See http://groups.google.com/group/asciidoc/browse_thread/thread/1d796a9c9ddb2855 - *FIXED:* Source highlighter now works with Wordpress backend (see http://groups.google.com/group/asciidoc/browse_thread/thread/6d8c716748b109e3). [[X2]] Regression issues ~~~~~~~~~~~~~~~~~ . A colon following the date in the AsciiDoc header is treated as a revision remark delimiter -- this could be an issue if you have used a colon in the header date. Version 8.4.4 (2009-04-26) -------------------------- .Additions and changes - Added table column and row spanning. - Table styles can now be applied per cell. - Vertical cell alignment can be applied to columns and individual cells. - Added table 'align' attribute to set horizontal alignment for entire table. - Included Geoff Eddy's update of the experimental LaTeX backend. - A new attribute named 'trace' controls the output of diagnostic information. If the 'trace' attribute is defined then element-by-element diagnostic messages detailing output markup generation are printed to stderr. - Added 'literal' paragraph style (allows 'literal' style to be applied to normal paragraphs). - Deleted unused `replacements2` from `xhtml11.conf`. - Added `replacements2` to default substitutions. - 'testasciidoc.py': messages to 'stdout', only diffs to 'stderr'. - Added transparency to `smallnew.png` image. .Bug fixes - All combinations of leading comments and attribute entries at the start of a document are now skipped correctly. - *FIXED:* `./configure` doesn't support `--docdir` as expected (patch submitted by Artem Zolochevskiy) - *FIXED:* Constrained quotes were incorrectly matched across line boundaries e.g. the string `+\nabc+` incorrectly matched a monospace quote. Version 8.4.3 (2009-04-13) -------------------------- .Additions and changes - DocBook outputs default to DocBook version 4.5 doctype (previously 4.2). - Configuration file `[specialsections]` definitions can be undefined by setting their configuration entry values blank. - The Makefile 'install' target depends on the 'all' target to ensure pre-install patches are applied. - 'testasciidoc.py' now emits user friendly messages if: . the configuration file is missing. . an illegal backend is specified. . an illegal test number is specified. .Bug fixes - Fixed http://groups.google.com/group/asciidoc/browse_thread/thread/fd27add515597c06[missing template section] error. - The 'testasciidoc.py' `--force` option no longer deletes test data files that were not specified. - Dropped second quotes substitution in table cells -- it had effectively disabled quote escaping in table cells. Version 8.4.2 (2009-03-19) -------------------------- .Additions and changes - Added {website}testasciidoc.html[testasciidoc], a tool to verify AsciiDoc conformance. - A warning is issued if nested inline passthroughs are encountered. - 'asciidocapi': setting an attribute value to `None` will undefine (delete) the attribute (this in addition to the `name!` attribute name format that the `asciidoc(1)` command uses). .Bug fixes Version 8.4.1 (2009-03-10) -------------------------- .Additions and changes - AsciiDoc now has a {website}asciidocapi.html[Python API]. The following minimal example compiles `mydoc.txt` to `mydoc.html`: + [source,python] ------------------------------------------------------------------------------- from asciidocapi import AsciiDocAPI asciidoc = AsciiDocAPI() asciidoc.execute('mydoc.txt') ------------------------------------------------------------------------------- - Backtick quoting for monospaced text is now implemented as an 'inline literal' passthrough. This makes more sense since monospace text is usually intended to be rendered literally. See <<X2,Regression issues>> below for the impact this may have on existing documents. Here are some examples that would previously have had to be escaped: The `++i` and `++j` auto-increments. Paths `~/.vim` and `~/docs`. The `__init__` method. The `{id}` attribute. - Added `--doctest` option to `asciidoc(1)` command. - Added an optional second argument to 'BlockId' element, this sets the `{reftext}` attribute which in turn is used to set the `xreflabel` attribute in DocBook elements. - Added lists to `--help` syntax summary. - `{infile}` and `{indir}` attributes reflect the current input file (previously always referred to the root document). - `{docfile}` (new) and `{docdir}` (previously deprecated) attributes refer to the root document specified on the `asciidoc(1)` command-line. - Vim syntax highlighter improvements. - Syntax summary command (`asciidoc -h syntax`) additions. - Admonition icons now have transparent backgrounds. - Changed yellow W3C badges to blue ones in page footers. .Bug fixes - Dropped `asciidoc(1)` broken undocumented `--profile` option. - Em dash replacement now recognized at start of block. Regression issues ~~~~~~~~~~~~~~~~~ Replacing backtick quoting with the 'inline literal' passthrough raises two regression scenarios for existing documents: 1. You have escaped the expansion of enclosed inline elements, for example: `\{id}`. You would need to delete the backslashes: `{id}` (if you don't the backslashes will be printed). Mostly it's just a case of interactively finding and replacing of all occurrences of `\. 2. There are enclosed inline elements, for example: `some *bold* monospaced`. You would need to switch to plus character monospace quoting: `+some *bold* monospaced+` (if you don't the enclosed elements won't be expanded). If your existing documents include these cases and you don't want to upgrade then use the `-a no-inline-literal` command-line option, alternatively put this in `~/.asciidoc/asciidoc.conf`: [attributes] no-inline-literal= Version 8.3.5 (2009-02-02) -------------------------- .Additions and changes - Cached compiled regular expression delimiters (speed up 'User Manual' compilation by 250%). - Created distinct list definitions for each numbered list style to allow nesting of all styles. - Roman numbers in numbered lists are followed by a closing parenthesis instead of a period to eliminate 'i', 'v', 'x' item ambiguity with respect to alpha numbered list items. - Added `**`, `***`, `****`, `*****` bulleted lists. - Added `...`, `....`, `.....` implicit numbered lists. - Added `:::`, `::::` labeled lists. - Updated User Guide for new list syntaxes. - Optimized paragraph and list termination detection with separate precompiled regular expressions for performance and to prevent reaching Python 100 named group limit. - Updated Vim syntax highlighter for new list syntaxes. - Allow `template::[]` macros in conf file entries sections (not just in template sections). - Dropped unused `[listdef-numbered2]` conf file sections. - Renamed 'ListBlock' to more appropriate 'OpenBlock'. - Implemented single-line versions of `ifdef::[]` and `ifndef::[]` macros. - 'html4' backend styling: * Underlined admonition captions. * Added side border to Example Blocks. - 'xhtml11' backend styling: * Dropped right hand margin from all but quote and verse blocks. * html4 backend: corrected over-sized width of caption in admonition block. .Bug fixes - Fixed broken numbered list nesting. Compatibility issues ~~~~~~~~~~~~~~~~~~~~ The roman numbered list parenthesis syntax is incompatible with the potentially ambiguous roman period syntax introduced in 8.3.2. Version 8.3.4 (2009-01-20) -------------------------- .Additions and changes - Implemented a title 'float' style. A floating title (or bridgehead) is rendered just like a normal section 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. - Implemented inline comment macro so comment lines can now appear inside block elements. - Comment lines are sent to the output if the 'showcomments' attribute is defined (comment blocks are never sent to the output). - Single quoting attribute values in 'AttributeList' elements causes them to be substituted like normal inline text (without single quoting only attribute substitution is performed). - Rewrote list item processing (was very crufty). List continuation and list blocks now work as expected. Updated and clarified list documentation in User Guide. - The 'revision' attribute now recognizes the RCS $Id$ marker format. - An RCS $Id$ marker formatted revision line in the header does not need to be preceded by an author line. - If an RCS $Id$ formatted revision is specified and the author name has not already been set then the author name in the $Id$ marker will be used. - Updated Gouichi Iisaka's Graphviz filter to version 1.1.3. - Added 'autowidth' table attribute option for (X)HTML outputs. - DocBook backend now puts 'orgname' optional attribute in DocBook header. - Deprecated undocumented 'companyname' attribute in favor of DocBook's 'corpname'. - Removed explicit closing backslash from HTML4 self-closing tags to comply with WC3 recommendation. .Bug fixes - Fixed 8.3.3 regression whereby adjacent lists with the same syntax but different list styles were incorrectly treated as a single list. Version 8.3.3 (2009-01-02) -------------------------- This release supersedes 8.3.2. .Bug fixes - The broken and confusing numeration and numeration2 numbered list attributes have been dropped, use the style attribute instead. Version 8.3.2 (2009-01-01) -------------------------- .Additions and changes - Added Gouichi Iisaka's Graphviz filter to distribution. - The 'SidebarBlock' element can now be rendered with an 'abstract' style. - Reorganized filters into a separate subdirectory for each filter. - Updated `Makefile.in` and `MANIFEST` files to reflect new filters organization. - Added 'listing' style to 'LiteralBlock' element so listings with nested listing blocks can be rendered as a listing block. - Changed example 'code' filter to use preferred 'ListingBlock' syntax (the old `~` delimited filter syntax is no longer used). - Implemented 'enumeration' and 'enumeration2' numbered list attributes for specifying the list numbering style ('arabic', 'loweralpha', 'upperalpha', 'lowerroman' and 'upperroman'). - AsciiDoc now recognizes 'upperalpha', 'lowerroman' and 'upperroman' numbers in `listdef-numbered2` numbered lists and sets the number style based on the style of the first numbered list item (alternative to setting 'enumeration2' attribute). - Updated `formatlistpat` definition in `.vimrc` example in User Guide. - You can now backslash escape system block macros. - Added 'Pychart' FAQ. - Drop paragraph 'text' and list 'text', 'index' and 'label' match groups from attributes -- they are included in the element's text and we don't want them processed a second time as attributes. - Changed comment line block macro to a passthrough block macro to ensure no substitutions. - A 'subslist' no longer has to be appended to a 'PassthroughBlock' macro definition, if omitted no substitutions are performed. - Code tidy up: replaced deprecated `<>` operator with `!=`. - Removed unused linuxdoc code. - Code tidy ups: dropped old types module reference; replaced `has_key()` with preferred `in` operator. .Bug fixes - Old syntax source highlight filter regression: special characters where not escaped in DocBook outputs. Version 8.3.1 (2008-12-14) -------------------------- .Additions and changes - Replaced the `install.sh` script with Ben Walton's updated autoconf scripts -- see {website}INSTALL.html[INSTALL] for details. - Added a generalized 'AttributeEntry' syntax to allow arbitrary configuration file entries to be set from within an AsciiDoc document (suggested by Henrik Maier). - Listing delimited blocks in DocBook outputs now support IDs; IDs of titled Listing and Literal delimited blocks have been moved to the enclosing DocBook example tag (thanks to Vijay Kumar for this patch). - Replaced vertical typewriter apostrophe with punctuation apostrophe (thanks to Noah Slater). .Bug fixes - Regression: Excluding double-quotes from unquoted attribute values resulted in backward incompatibility, double-quotes in unquoted attribute values has been reinstated. - Regression: Text like `&...;` was sometimes mistaken for an entity reference -- tightened up entity reference matching. Version 8.3.0 (2008-11-29) -------------------------- .Additions and changes - {website}newtables.html[AsciiDoc new tables] is a complete redesign of the tables syntax and generation. The new syntax and features are a huge improvement over the old tables. The old tables syntax has been deprecated but is currently still processed. - {website}newlists.html[Lists can now be styled] like other block elements. This allows a single list syntax for 'glossary', 'qanda' (Question and Answer) and 'bibliography' lists instead of having to remember a different syntax for each type. - Inline passthroughs macros have been improved and block passthrough macros added. Attribute substitution can be optionally specified when the macro is called. - The passthrough block has a fully transparent passthrough delimited block block style called 'pass'. - The 'asciimath' and 'latexmath' {website}userguide.html#X77[passthrough macros] along with 'asciimath' and 'latexmath' {website}userguide.html#X76[passthrough blocks] provide a (backend dependent) mechanism for rendering mathematical formulas. There are {website}latexmath.pdf[LaTeX Math], {website}asciimathml.html[AsciiMathML] and {website}latexmathml.html[LaTeXMathML] examples on the AsciiDoc website. - Reimplemented and cleaned up filter processing based on a patch submitted by Kelly Anderson. Uses the newer subprocess module instead of the deprecated popen2 module. Now works in Win32 command shell. - Addition FAQs, more documentation updates. - Arbitrary HTML/XML entities can be entered in AsciiDoc source. - Did away with the need for the `shaded-literallayout.patch` (thanks to Henrik Maier for this patch). - Implemented 'page break' block macro. - Added 'line breaks' and 'ruler' processing instructions to DocBook outputs (thanks to Henrik Maier for this patch). - Added 'deg' (degree) and 'wj' (word joiner) entity attributes (thanks to Henrik Maier). - Tweaked DocBook 'indexterm2' macro to avoid white space preceding the term when used in table cells (thanks to Henrik Maier for this patch). - Title elements now process the 'options' attribute like other block elements. - Added `single quoted' element. - Spaces on both sides of a -- em-dash are translated to thin space characters. - Improved detection and reporting of malformed attribute lists. - The list 'compact' style is now a list option. - Added 'strong' labeled list option which makes the labels bold (HTML outputs only). - Dropped unsupported 'linuxdoc' backend. - Dropped deprecated 'xhtml-deprecated' (version 6) backend. - Added 'breakable' and 'unbreakable' attribute options to tables to control table breaking across page boundaries (DocBook XSL/FO outputs). By and in collaboration with Henrik Maier. - Added 'pgwide' attribute option to tables to table, block image, horizontal labeled lists. Specifies that the element should be rendered across the full text width of the page irrespective of the current indentation (DocBook XSL/FO outputs). Thanks to Henrik Maier for this patch. - Vim syntax highlighter: spaces before/after bullets no longer highlighted (which is ugly if using a theme that highlights with underlines). Thanks to Donald Chai for this patch. - Added `a2x(1)` `--fop` option. - Added `a2x(1)` `--no-xmllint` option. - Highlighted labelled list terms with the navy color in XHTML outputs. - Use `w3m(1)` as default `a2x(1)` text format generator (fallback to `lynx(1)`). - Changed callout formats in html4 and xhtml11 outputs to angle brackets to match source highlighter rendering. - Macros now inject user defined `<optionname>-option` attributes into markup. - Added IRC URLs to AsciiDoc inline macros. - Added `depth` attribute to `include::[]` system macro. - Added 'footnoteref' inline macro. - Added 'stylesheet' XHTML attribute to specify additional custom CSS stylesheet. - If a paragraph style is specified it will be added to the XHTML 'class' attribute and DocBook 'role' attribute. - Replacements can be set in a document using the reserved AttributeEntry name 'replacement'. - The prefix for auto-generated section name IDs can be set with the 'idprefix' attribute. .Bug fixes - Escaped quote skipped over leading and trailing quote instead of just the leading quote. - Fixed bug that was causing false negative safe mode warnings (patch submitted by Julien Palmas). - Placed priority of AttributeEntry, AttributeList and BlockTitle above Title. This ensures an AttributeEntry, AttributeList or BlockTitle followed by a same length leading ListingBlock delimiter is not mistaken for a two-line title. - Vim syntax highlighter: fixed multi-line quoted text. - Contstrained quote termination after non-space character enforced. - Vim syntax highlighter: unterminated quoted text is no longer highlighted. - Vim syntax highlighter: passthroughs now exactly match AsciiDoc semantics. - Vim syntax highlighter: escaped quoted text, attribute references and inline macros are not highlighted. - Vim syntax highlighter: TODO's highlighted in CommentBlocks (thanks to Scott Wall); non-greedy pass:[$$...$$]. - Vim syntax highlighter: Comment lines mistaken for vertical list labels (thanks to Scott Wall). - Vim syntax highlighter: Single unmatched $$ mistakenly highlighted remaining text (patch contributed by Scott Wall). - Callouts now work in source highlighted listing generated by dblatex. - Fixed exception that occured if undefined attribute was present in filter command. - AttributeList block can now follow a paragraph without intervening blank line. - The include macro tabsize attribute is no longer propagated to nested includes. .Omissions The following features were implemented but then but removed from this release: - 'pi', 'cdata' and 'comment' passthrough macros and passthrough block styles (creeping featurism, use 'pass' macros instead). - Generic 'tag' inline macro (creeping featurism, use 'pass' macros instead). [[X1]] Compatibility issues ~~~~~~~~~~~~~~~~~~~~ Version 8.3.0 has a number of backward incompatibilities with respect to the previous 8.2.7 release: - The old table syntax is still processed but a 'DEPRECATED' warning is issued. - Entity references have to be escaped with a backslash. - You have to explicitly precede horizontal style labeled lists with the `[horizontal]` style attribute -- by default all labeled lists are rendered vertically. - The list 'compact' style has been dropped and is now a list option (use `options="compact"` in attribute lists). - AsciiDoc version 6 sytnax no longer supported. - Linuxdoc been removed from the distribution. - The unsupported experimental 'latex' backend has not been tested on this release. - The introduction of single-quote quoting requires that double-quote quoting is escaped with two backslashes. Version 8.2.7 (2008-07-04) -------------------------- .Additions and changes - Added `dvi`, `ps` and `tex` output format options to a2x(1). - Added `--dblatex` option to a2x(1) so `dblatex(1)` can be used to generate PDFs. - Added custom `dblatex(1)` configuration files (in distribution `./dblatex` directory) that are used by a2x(1). - `dblatex(1)` is now used to generate the distributed PDF version of the AsciiDoc User Guide. - If you don't need a customized the link caption you can enter the 'http', 'https', 'ftp', 'file' URLs and email addresses without any special macro syntax -- you get the links by just cutting and pasting URLs and emails addresses. This also makes it easier to open links directly form AsciiDoc source ( most editors allow you to open URLs directly). The Vim syntax highlighter has been updated to reflect these changes. - Highlighted source code paragraphs have been implemented -- it's a much more convenient way to enter short code examples (see http://asciidoc.org/source-highlight-filter.html[the online docs]). - The source highlighter and music filter syntax has changed -- they now used the ListingBlock syntax customized with 'source' and 'music' style attribute values. This follows the Paragraph styling convention introduced by the source paragraph (previous item) and is easier to read. The old syntax still works but has been deprecated. - QuoteBlocks now have a 'verse' style -- you no longer have to nest a 'verse' LiteralBlock inside a QuoteBlock for verses. The 'verse' style on the LiteralBlock has been deprecated (still works though) and the 'style' attribute is positional attribute 1, pushing 'attribution' and 'citetitle' attributes to the right (you'll need to insert a 'quote' attribute into your existing QuoteBlocks). - It is no up to the DocBook processor to highlight source code syntax in `<programlisting>` elements rather than GNU Highlighter -- this is the correct way to handle it, plus `dblatex(1)` makes a much better job. - 'scaledwidth' and 'align' attributes have been added to the 'image' macro. They apply to DocBook outputs (specifically for PDF documents). 'scaledwidth' sets the image size as a percent of the available page width; 'align' applies 'left', 'center' or 'right' horizontal image justification. - Added a2x(1) `--fop-opts=FOP_OPTS` option (patch submitted by Miklos Vajna). - Added a2x(1) `--dblatex-opts=DBLATEX_OPTS` option. - Added Mikhail Yakshin's FOP 0.95 patch which fixes a long-standing `fo.xsl` problem and allows PDF's to be generated with FOP 0.95 (previously had to use FOP 0.20.5). - The User Guide has been updated and outdated FOP configuration and installation sections removed. .Bug fixes - Fixed `stylesheets/xhtml11-manpage.css` not being included when 'linkcss' attribute was used. - Configuration file `*-style` attributes are now dumped correctly. - Fixed 'FAILED: malformed section entry' LaTeX backend error. See the also the https://sharesource.org/hg/asciidoc/[AsciiDoc repository changelog]. Version 8.2.6 (2008-04-29) -------------------------- .Additions and changes - Enhancements to the Vim AsciiDoc syntax highlighter, for example, quoted text is now highlighted in titles and macro captions. - If you define the `data-uri` intrinsic attribute images referenced by 'image' macros will be embedded in XHTML using the http://en.wikipedia.org/wiki/Data:_URI_scheme[data: URI scheme]. *NOTE*: Microsoft browser support for the 'data: URI scheme' is currently limited to MSIE 8 beta 1. - Added `toc-title` attribute to allow custom table of contents titles. - Added references to Alex Efros's AsciiDoc Cheatsheet to AsciiDoc website. - `asciidoc(1)` and `a2x(1)` man pages formatted to conform to `man-pages(7)` recommendations. - Old code-filter syntax (pre-8.1.0) is no longer recognized so that malformed two-line level 2 titles are no longer confused with 'code-filter' block delimiters. - Added -> <- => <= arrow replacements from the Arrows block of Unicode. - Added DocBook refentry lang attribute -- patch contributed by VMiklos. - AttributeEntry names can now be numeric (``named macro targets''). - Hide Table of Contents title if Table of Contents empty -- patch contributed by Alex Efros. - Various XHTML CSS tweaks. - Code cleanup: * Replaced `realpath()` with Python 2.2 `os.path.realpath()` library function. * Replaced old string library functions with string methods. * Use file generators instead of `readlines()`. * Renamed entities that shadowed builtins. * Standardized string quoting. * Dropped `readlines()` function. .Bug fixes - Fixed broken CSS for decimal ordered lists nested in alpha ordered list, thanks to Alex Efros. - A missing closing block delimiter now reports the opening delimiter line number instead of the end of file line number. - Fixed an error generated by the asciidoc `-e` option when there are no block definitions -- patch contributed by Alejandro Mery. - Handle both `\r\n` (as well as `\n`) line separators that may be returned by `{sys}` attribute evaluation. - Numbered attribute names no longer interfere with positional attribute list values. Version 8.2.5 (2007-11-18) -------------------------- .Additions and changes .Bug fixes - Fixed exception thrown by illegal command-line arguments. - Rolled back the 'with' warning bug fix introduced in 8.2.4 -- it was incompatible with Python <2.5. Version 8.2.4 (2007-11-10) -------------------------- .Additions and changes - You can now use the `lang` attribute to set the DocBook language attribute. - Attribute values can now contain attribute references. - If the `lang` attribute is defined then configuration files named like `lang-<lang>.conf` will be loaded automatically. - The help file name `help-<lang>.conf` is based on the AsciiDoc `lang` attribute, defaults to `help.conf` (English). - Admonition, figure and table captions have been factored into a predefined set of `caption_*` attributes. They only apply to directly generated (X)HTML outputs (DocBook stylesheets generate their own language specific captions based on the `lang` attribute). - Dropped platform dependent `doc/asciidoc.chm` file from distribution documentation formats. .Bug fixes - The spurious warning 'with will become a reserved keyword in Python 2.6' has been suppressed. Version 8.2.3 (2007-09-12) -------------------------- .Additions and changes - Added VMiklos's 'permalink' patch for auto-generated section IDs (enabled by default by the `sectids` attribute). - Added http://asciidoc.org/faq.html[FAQ] to website. - Changed format of \{localdate} attribute to ISO 8601 (`%Y-%m-%d`). - Added `abc2ly --beams=None` option to make `music2png.py` conform to ABC's notion of beams. - XHTML level 2 section headings are now styled with an underlining border. - XHTML links to AsciiDoc title elements are now implemented with title ID attributes (previously separate `<a>` element targets were generated. - Multi-word first, middle and last names can be entered in the header author line using the underscore as a word separator. - The nested inline macros restriction has now been lifted, for example you can now include links and inline images inside footnotes. - Help topic names can be shortened (so long as they are not ambiguous). For example `asciidoc -hm` will print the AsciiDoc man page. - Added `{two_colons}` and `{two_semicolons}` attributes for escaping labeled list ambiguity. - If quirks mode is disabled the XHTML Mime Type is set to the recommended `application/xhtml+xml` (rather than `text/html`). .Bug fixes - Author information is now correctly set when using attribute entries in the header instead of an author line (previously the 'author' attribute was not being calculated correctly and there were attribute substitution problems). Version 8.2.2 (2007-07-22) -------------------------- .Additions and changes - http://www.maths.nottingham.ac.uk/personal/drw/lm.html[LaTeXMathML] capability has been added for users who are more familiar with or prefer LaTeX math formulas to the http://asciidoc.org/asciimathml.html[ASCIIMathML] notation (thanks to Arthur Sakellariou for the patch). - The 'source highlight' and 'code' filters now process embedded callouts. - Added an `--attribute=ATTRIBUTE` option to `a2x(1)` for passing attribute values to asciidoc(1) (a shortcut for `--asciidoc-opts="-a ATTRIBUTE"`). - Image block and inline macros prepend optional `{imagesdir}` attribute to image link targets. .Bug fixes - Fixed an assertion error that occurred when a configuration file containing an `include::[]` macro was loaded using the `--conf-file` option and the configuration file name did not include an explicit directory path -- patch submitted by Dmitry Potapov. - Asciidoc titles are only converted to lower case if all characters are upper case otherwise case is left unchanged -- patch submitted by Dmitry Potapov. - Added a missing check that input is not stdin before loading configuration files from the document directory -- patch submitted by Dmitry Potapov. - Attribute list items must evaluate to strings, numbers or None (previously it was possible to evaluate to other object types which resulted in surprising attribute values). - If an AsciiDoc document has no title an empty XHTML 1.1 'title' element is created -- previously the 'title' element was dropped which resulted in invalid XHTML 1.1. - The Vim syntax file no longer highlights escaped callouts. - The Vim syntax highlighter now correctly highlights Double-dollar passthroughs when they enclose dollar delimited ASCIIMathML and LaTeXMathML formulas. Version 8.2.1 (2007-04-06) -------------------------- .Additions and changes - A number of improvements have been made to the Vim syntax highlighter, for example the word C++ is no longer mistaken for the start of an unconstrained monospace quote. - Labeled list definitions have been tightened -- a list label can no longer containing trailing spaces. The following example is no longer recognized as a valid list label: Lorum ipsum :: + This change implements the originally intended behavior (as per the AsciiDoc documentation and examples) so there should be very few compatibility issues. .Bug fixes Version 8.2.0 (2007-04-04) -------------------------- .Additions and changes - A Vim syntax file is now included in the AsciiDoc distribution (inspired by Felix Obenhuber's `asciidoc.vim` script). You can find it (along with a Vim filetype detection script in the distribution `./vim/` directory (the scripts are installed automatically by the AsciiDoc installer `./install.sh`). See 'Appendix J' of the 'AsciiDoc User Guide' for details. - Added 'toclevel' attribute (1..4) which sets the number of title levels reported in the table of contents. Defaults to 2 and must be used with the 'toc' attribute. Example usage: $ asciidoc -a toc -a toclevels=3 doc/asciidoc.txt - Added a `listindex` attribute which is the current list item index (1..). If this attribute appears outside a list its value is the number of items in the most recently closed list. - The single line titles syntax now accepts trailing suffixes -- this syntax matches the title line syntax of a number of popular Wiki markups. - If a QuoteBlock has no attribution or citetitle then the DocBook `<attribution>` element is not generated (previously generated empty `<attribution>` element). - If the text of a labeled list item is blank then no `texttag` is written. - An end of line backslash performs line continuation for horizontal labeled list items. - The Revision line now accommodates Subversion `$Id` markers (in addition to CVS and RCS markers). Thanks to Tiago Sturmer Daitx for this patch. - Implemented `a2x(1)` option `--skip-asciidoc` which allows `a2x(1)` to convert DocBook XML files not derived from AsciiDoc sources. - If `a2x(1) --doctype` option is not specified it defaults to `manpage` if `--format=manpage` else defaults to `article` (previously `--doctype` always defaulted to `article`). - Added an 'External Resources' section to the http://asciidoc.org/index.html[AsciiDoc home page]. .Bug fixes Version 8.1.0 (2006-10-22) -------------------------- .Additions and changes - AsciiDoc generated XHTML documents now display a table of contents if the 'toc' attribute is defined (JavaScript needs to be enabled for this to work). Thanks to Troy Hanson who contributed this feature based on a JavaScript by Mihai Bazon. I've simplified things somewhat to match Docbook XSL Stylesheets style, see Troy's http://tpl.sourceforge.net/userguide.html[tpl User Guide] for a fancier layout. Use the `-a toc -a numbered` command-line options to produce a number table of contents. - A http://asciidoc.org/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 in the form of a trimmed PNG image which is inserted into the AsciiDoc output document. - Incorporated Paul Melis's Win32 filter patch. This workaround allows AsciiDoc to run filters under Windows. - Added `uninstall.sh` script. - Rather than proliferate a confusing number of filter block delimiters the following convention has been adopted: delimiters belonging to DelimitedBlock filters distributed with AsciiDoc will consist of a word (normally a noun identifying the block content) followed by four or more tilde characters. This has necessitated changing existing filter delimiters (the old delimiters still work but may be deprecated in future versions): * The example code filter block delimiter is now the word `code` followed by four or more tilde characters. * The source highlight filter block delimiter is now the word `source` followed by four or more tilde characters. - Conditionally redefined subscript and superscripting so they use the old replacements mechanism when asciidoc7compatible is defined rather than the asciidoc 8 default unconstrained quoting (patch for affected files attached). - Moved the source highlight filter from `./examples/` to `./filter/`. - Added `{verbose}` intrinsic attribute (useful for passing verbose flag to filters). - Added `{outdir}` intrinsic attribute. - Renamed `{docdir}` intrinsic attribute to unambiguous `{indir}` (`{docdir}` still works but may be removed in future release). - If `asciidoc(1)` outputs to stdout then intrinsic attribute `{docname}` is extracted from the input file name. Version 8.0.0 (2006-08-27) -------------------------- ********************************************************************* This is a major release because changes to quoting and index entry handling may break existing documents (see 'Additions and changes' below and 'Appendix A: Migration Notes' in the AsciiDoc User Guide). Please report any problems you encounter. mailto:srackham@gmail.com['Stuart Rackham'] ********************************************************************* .Additions and changes - Quoting can can occur within words (based on patch submitted by Benjamin Klum). See the 'Unconstrained Quotes' sub-section in the User Guide. - The underline and plus characters can be used as alternatives to the existing apostrophe and backtick quote characters. They are arguably better choices than the apostrophe and backtick as they are not confused with punctuation. - The syntax for index entry macros have have been deprecated from `+...+` and `++...++` to `((...))` and `(((...)))` respectively. Rationale: * Bracketing is consistent other with `[[...]]` and `<<...>>` reference macros. * To easily confused with triple plus passthroughs. * To make way for the new monospace quoting. - Superscripts and subscripts are implemented as constrained quotes so they can now be escaped with a leading backslash and prefixed with with an attribute list. - An experimental LaTeX backend has been written by Benjamin Klum (a number additions in this release are to accommodate the LaTeX backend). - `include` macro file names now expand environment variables and tilde expansions. - A configuration file `[quotes]` entry can be undefined by setting to a blank value. - Added `callto` inline macro for Skype 'callto' links. - Added `colnumber` attribute for table data markup. - A leading comment block or comment lines are now skipped (previously a document had to start with either attribute entries or a document Title). - Experimental `rows` attribute (number of source lines in table) available in table markup templates (used by experimental LaTeX backend). - Included install shell script written by mailto:jlm@ofb.net[Jacob Mandelson] for installing the tarball distribution. - Added INSTALL documentation file. - Added 'replacements2' substitution options -- a second replacements section. - Added the ability to redefine 'normal' and 'verbatim' substitutions with `subsnormal` and `subsverbatim` entries in configuration file `[miscellaneous]` section. - By default `AttributeEntry` values are substituted for `specialcharacters` and `attributes`, if you want a different AttributeEntry substitution set the `attributeentry-subs` attribute. - The `name` in `name=value` configuration file entries can now end with a backslash, just escape the trailing backslash with a backslash. For example: abc\\=xyz + Results in `name=abc\` and `value=xyz` -- previously this would have escaped the `=` character. - A blank configuration file section deletes any preceding section with the same name (applies to non-markup template sections). - A command-line attribute value with a `@` suffix does not override existing document and configuration file attributes (normally command-line attributes have precedence over document and configuration file attributes). - `localtime` attribute is now encoded from the native system encoding to the output encoding. Patch submitted by mailto:m_pupil@yahoo.com.cn[FKtPp] -- here's his description of the problem: + ``I am a Chinese user of AsciiDoc and I find that when I use UTF-8 (the default encoding) to write asciidoc documents in Windows platform the resulting html footer line will get screwed. It was caused by a localized tzname that was always encoded in the windows native encoding, which in my case is 'cp936'.'' - a2x(1) can generate Open Document Text files using http://open.comsultia.com/docbook2odf/[docbook2odf]. Currently `docbook2odf(1)` only processes a subset of DocBook, unimplemented elements are skipped. - The a2x(1) format option defaults to `xhtml` (previously a format had to be specified explicitly). - The `-d, \--doctype=DOCTYPE` option has been added to a2x(1) which is a shortcut for `--asciidoc-options="--doctype=DOCTYPE"`. - Replaced a2x(1) `--no-icons` and `--no-copy` options with their negated equivalents: `--icons` and `--copy` respectively. The default behavior has also changed: copying and use of icons is disabled by default. Rationale: * To make the default behavior more consistent since use of icons and CSS stylesheets does not apply to all formats. * To make the default behavior less surprising (the creation of icon and stylesheet output files must now be explicit). - a2x(1) has been bumped from version 0.1.1 to version 1.0.0. .Bug fixes - Removed duplicate `./doc/a2x.1.txt` from distribution tarball. - Documentation errata. - Attribute replacement is no longer performed twice in Titles and AttributeEntrys. - a2x(1) skipped asciidoc(1) execution when rerun with different `--asciidoc-options` options, it now always executes asciidoc(1). The problem was that previously asciidoc(1) was executed only if the output file was missing or older than the source file. Version 7.1.2 (2006-03-07) -------------------------- .Additions and changes - Support for http://www1.chapman.edu/~jipsen/mathml/asciimath.html[ASCIIMathML] has been added. See 'Appendix I: ASCIIMathML Support' in the User Guide and the examples at http://asciidoc.org/asciimath.html. - You can now prefix quoted text with inline attributes lists. You can use this to set font size and color (XHTML and HTML outputs). - Added `##...##` quoting -- it does nothing -- it's purpose is to allow inline attributes to be applied to normal text. - An 'inline passthrough' mechanism has been implemented. - Configuration file comment lines can be escaped with a backslash -- this is to allows the inclusion of configuration lines that start with a hash character. - The `scriptsdir` attribute can be used to specify the name of the directory containing linked JavaScripts (see the link:userguide.html#X33[User Guide] for details. - The BackendBlock has been renamed PassthroughBlock for consistency with the new inline passthrough naming. - `a2x(1)` now works with the older `bash(1)` version 2.05b. Patch submitted by mailto:francis@daoine.org[Francis Daly]. - Content included by the `include1::[]` system macro is no longer subject to attribute substitution so that ambiguities no longer arise when used to include CSS or JavaScript files. Version 7.1.1 (2006-02-24) -------------------------- .Additions and changes - The `caption` attribute can be used to customize admonition captions as well as image, table and example block element title prefixes (`xhtml11` and `html4` backends). - You can now override the default icon image using the `icon` attribute to specify the path of the linked image (xhtml11 and html4 backends only). - The deprecated `imagesdir` attribute is no longer recognized (use `iconsdir` instead). - Added 'Appendix H: Using AsciiDoc with non-English Languages' to the AsciiDoc User Guide. - Added 'Admonition Icons and Captions' subsection to the User Guide explaining how to customize Admonition elements. .Bug fixes - `a2x(1)` failed when configuration files were installed in the global `/etc/asciidoc/` directory -- it was only searching the directory containing the asciidoc executable (thanks to Christian Wiese for finding and submitting a patch this bug). - The html4 backend admonition caption now correctly displays the admonition `caption` attribute (previously displayed the `style` attribute). Version 7.1.0 (2006-01-13) -------------------------- .Additions and changes - `a2x(1)` toolchain wrapper utility. This overcomes the biggest hurdle for new users which seems to be assembling and using a working DocBook XML toolchain. With `a2x(1)` you can generate XHTML (chunked and unchunked), PDF, man page, HTML Help and text file outputs from an AsciiDoc input file with a single command. All you need to install (in addition to AsciiDoc) is xsltproc(1), DocBook XSL Stylesheets and optionally FOP (if you want PDF) or lynx(1) (if you want text). - Block titles can now start with any non-space character (previously where not allowed to start with `.~-_` characters). - `./stylesheets/docbook.css` renamed to `./stylesheets/docbook-xsl.css` to clarify its function. - Renamed `./docbook-xsl/manpages.xsl` to `./docbook-xsl/manpage.xsl` for consistency. - Admonition and navigation icons moved to `./images/icons/` to clarify usage and conform with a2x(1) usage. - Renamed xhtml11 intrinsic attribute `imagesdir` to `iconsdir` to keep vocab consistent and changed default value to `./images/icons` (previously `./images`). `imagesdir` attribute still accepted but deprecated. - Unused image files have been weeded out of the distribution. - Packager notes (appendix B) have been updated to reflect the needs of `a2x(1)`. IMPORTANT: The renaming of the xhtml11 backend `imagesdir` intrinsic attribute and it's new default value introduces a backward compatibility issue: if you use the `icons` attribute you will need to either move your icons to the new default `./images/icons` location or include an `--attribute{nbsp}iconsdir="your_icons_path"` option in your asciidoc commands. .Bug fixes - Backslash line continuation is now observed in verbatim paragraphs. - Fixed errors generated by example `./examples/website/build-website.sh` script. Version 7.0.4 (2005-12-08) -------------------------- .Additions and changes - Added ternary conditional attributes `{<name>@<regexp>:<value1>[:<value2>]}` and `{<name>$<regexp>:<value1>[:<value2>]}`. - Safety violations now generate errors (they previously generated warnings). - asciidoc(1) now defaults to safe mode, consequently the `[miscellaneous]` safe mode entry and `--safe` command-line option are no longer necessary (though for backward compatibility asciidoc(1) still accepts the `--safe` option). - Backend Blocks are now flagged unsafe (they could be used to include arbitrary and hence potentially unsafe output content). - Filters are no longer considered unsafe. There's not much point in insisting on filter safety since the installation of an unsafe filter would require the introduction of new or modified configuration files -- if your application configurations can be compromised you're in all sorts of trouble (safe mode protects against unsafe input files not unsafe configuration). As with all filters, before installing, you should verify that they can't be coerced into generating malicious output or exposing sensitive information. .Bug fixes - Fixed a lot of glaring grammatical and factual errors in the User Guide. Version 7.0.3 (2005-12-01) -------------------------- .Additions and changes - Added `--safe` and `--unsafe` command-line options -- AsciiDoc can now be executed in a 'safe mode' which disallows the execution of arbitrary code or the inclusion of arbitrary files (see link:userguide.html#X39[Appendix C in the AsciiDoc User Guide]). - Included link:source-highlight-filter.html[source-highlight filter] in the distribution `./examples/source-highlight-filter/` directory (based on filter submitted by mailto:trolocsis@gmail.com[Ryan Phillips]). - Included the DocBook XSL Stylesheets 1.69.1 customizations used to generate the distributed AsciiDoc documentation (read the `asciidoc-docbook-xsl.txt` file in the distribution `./docbook-xsl/` directory). - AsciiDoc DocBook XSL Stylesheet drivers moved from `./doc/` to `./docbook-xsl/`. - Modified `./doc/manpages.xsl` so only URL content is displayed in manpages. .Bug fixes - Explicitly set table CSS border style (`xhtml11` backend) to `solid` because default border styles vary from browser to browser. Version 7.0.2 (2005-08-28) -------------------------- .Additions and changes - There are now long versions of all AsciiDoc options. - If the `--backend` is not specified it defaults to `xhtml11`. - Added CSS simulated frames layout to the examples website (see `./examples/website/layout2/README-website.txt`). This layout does not work with IE6 and the original tables based layout is still the default. - Support page added to AsciiDoc website. .Bug fixes - Invalid options are now trapped gracefully. - Documentation errata. Version 7.0.1 (2005-06-24) -------------------------- .Additions and changes - Reverted to use of `strong`, `em`, `tt` XHTML tags -- they're more obvious and no less correct than `span` tags, besides, the generated file sizes are smaller (the 'User Guide' was 11% smaller). - Table title rendered with `caption` tag rather than a separate `div`. - The AsciiDoc 'stylesdir' attribute (if specified) is now recognized when searching for embedded stylesheets (previously only searched default `./stylesheets` directory). - Default charset encoding changed from ISO-8859-1 to UTF-8 -- it's less language specific and displays most common languages. - `template::[]` macros now expand in all configuration file sections previously only in markup template sections. - Cleaned up example website layout CSS and configuration (presentation has not been changed). - Refactored `xhtml11.conf` configuration file. - Set consistent and sensible permissions on distributed files. - White space is now stripped from DSV formatted table cell data. - `class="tableblock"` attribute added to tables generated by `xhtml-deprecated-css.conf` to assist CSS. .Bug fixes - Illegal character set encoder (specified by the AsciiDoc `encoding` attribute) and character data are trapped gracefully. - AsciiDoc table 'format' attribute in table attribute lists were not recognized. - The nested horizontal labeled list example in the 'AsciiDoc User Guide' has been dropped -- it generated invalid DocBook markup. Version 7.0.0 (2005-06-06) -------------------------- *************************************************** This is a major release with many code and documentation changes. Please report any problems you encounter. mailto:srackham@gmail.com['Stuart Rackham'] *************************************************** .Additions and changes - A new 'xhtml11' backend generates XHTML 1.1 with integrated CSS2 replacing the previous 'xhtml', 'css', and 'css-embedded' backends. - The CSS stylesheets have finally been rewritten. - The asciidoc(1) command help now includes user link:userguide.html#X36[customizable help] topics. When asciidoc is invoked with the `--help` option the command argument is interpreted as a help topic. - The previous example website has been replaced by the actual AsciiDoc website (see `./examples/website/`. - XHTML generation options now controlled by the following attributes: 'badges', 'linkcss', 'icons', 'numbered', 'quirks', 'theme', 'stylesdir', 'imagesdir' (see the link:userguide.html#X33[User Guide] for details. - By default HTML and XHTML are output as stand-alone documents (no embedded CSS and no linked admonition icon images). - Documents encoded with the UTF-8 Unicode character set are now processed thanks to a patch supplied by mailto:viktor@rbg.informatik.tu-darmstadt.de[Viktor Vasilev]. - The `-a ^name` command-line syntax to undefine an attribute has been deprecated in favor of the `-a name!` syntax. - AttributeEntry syntax addition: `:name!:` to undefine `name` attribute. - Added `template` system block macro to allow the inclusion of one configuration file template section within another. - A 'verse' style attribute can now be applied to literal paragraphs and blocks to reproduce line breaks and white space from the source document. - Replacements and Special Words can now be escaped with leading backslashes. - Replacements are now processed in configuration file order (previous ordering was indeterminate). - System macros can now be used in the base `asciidoc.conf` configuration file. - Deprecated features that emitted warnings in prior versions are no longer tolerated. - The `eval` system attribute expression evaluates to `False` the attribute is undefined, if it evaluates to `True` the result is an empty string. - The Paragraph and DelimitedBlock 'presubs' parameter can be aliased as 'subs'. - Added 'verbatim' substitutions option. - Renamed 'List Continuation Block' to 'List Block' and renamed the 'listcontinuation' option to 'list'. - Deprecated 'default' substitutions option (use 'normal' instead). - The 'section-numbers' section numbering attribute has be renamed 'numbered'. - Dropped the '\#UNDER CONSTRUCTION#' block macro. - Rewrote Paragraph and DelimitedBlock handlers adding a link:userguide.html#X23[styles] configuration entry. .Bug fixes - Included files are no longer read inside conditionally excluded content. - Manpage command names containing dashes (in the manpage NAME section) were misinterpreted as the spaced dash command name/purpose separator. Bug report and patch supplied by mailto:david@dgreaves.com[David Greaves]. - Unexpected error following malformed author line error. Version 6.0.3 (2005-04-20) -------------------------- .Additions and changes - Special characters are now substituted in AttributeEntry element values. - Spaced and unspaced em dashes are now recognized (previously only spaced em dashes were recognized). - Replaced the table 'noborders' option with richer 'frame' and 'grid' attributes. - The `duplicate macro` warning message now only occurs when the verbose (`-v`) option is enabled. - Single lines starting with two forward slashes hard up against the left margin are treated as comments and are not processed. - Renamed 'section' delimited block option to 'sectionbody' to more accurately reflect it's role. - Added a List Continuation block -- a specialized delimited block that is functionally equivalent to the List Item Continuation feature except that the list contained within the block does not require explicit '+' list item continuation lines. - Dropped deprecated `<u>` tags from generated HTML. - Literal Block delimiters must now consist of at least four points (previously three) to avoid lone ellipsis ambiguity. .Bug fixes - Some system attribute evaluation failures caused unexpected exceptions to occur. Version 6.0.2 (2005-03-30) -------------------------- .Additions and changes - Three new 'system' block macros have been added -- `eval`, `sys` and `sys2` which are the block macro equivalents to the same named system attributes. - 'Intrinsic' macros have been renamed 'system' macros along with 'action' attributes which have been renamed 'system' attributes: * To reflect their common (though contextually different) behavior. * To avoid confusion with 'intrinsic attributes'. .Bug fixes - Asciidoc now searches in `/etc/asciidoc/filters` for filters. Version 6.0.1 (2005-03-06) -------------------------- .Additions and changes - A global configuration file location `/etc/asciidoc` has been added and is now processed before all other locations (patch supplied by mailto:stone@debian.org[Fredrik Steen]). - Recoded `tempfile.mktemp()` and other artifacts that are no longer necessary or desirable (patches supplied by mailto:stone@debian.org[Fredrik Steen]). - Added BUGS file to the distribution. .Bug fixes - Illegal comment syntax in `css-embedded-stylesheet.conf` resulted in illegal CSS in files generated by the `css-embedded` backend. Version 6.0.0 (2005-01-28) -------------------------- *************************************************** This release has had some fairly major code and documentation changes. Please report any problems you encounter. mailto:srackham@gmail.com['Stuart Rackham'] *************************************************** A lot of new stuff. A new major version number -- some regression incompatibility (hopefully mitigated by 'deprecated' warnings). Went mad trying to rein in the current feature anarchy -- established a unified notion of document attributes. Attempted to introduce a consistent vocabulary -- renamed many poorly or inconsistently named entities. Actually, deprecated syntax is still processed correctly in almost all cases. One source of incompatibility that may arise if you have customized CSS stylesheets is the change of AsciiDoc CSS class names (see below). I guess the moral is if you've done a lot of configuration file customization and are happy with version 5 then you may want to stay put. NOTE: This version requires Python 2.3 or better to run. .Additions and changes - 'Glossary entries' have been renamed 'attributes'. This eliminates confusion with the accepted meaning of glossary. - An `AttributeEntry` block element has been added so that document attributes can be assigned from within an AsciiDoc document. - The `AttributeList` block element has been added which is a more general solution than the (now deprecated) DelimitedBlock arguments. - An BlockId element has been added for setting block element anchor (link target) IDs. - Quoted text can now span multiple lines (thanks to James Bowlin for this patch). - Inline macros can now span multiple lines. - \``double backtick / apostrophe'' quotes generate ``curly quotes''. - A warning is now emitted for out of order list item (applies to explicitly enumerated numbered list items). - Added `include` action attribute. - A line of three or more apostrophes generates an HTML horizontal ruler (`<hr/>` tag). You will get a warning if processed with non-HTML backend. - An `{imagesdir}` attribute specifies image file location for images referenced in configuration files when generating HTML (the default location is `images`). - An `{stylesdir}` attribute specifies the location of CSS stylesheets when generating styled HTML (the default location for configured markup is `.`). - The use of the (often inappropriately named) `{caption}` attribute list entry has been deprecated, use `{0}` instead. - New 'ExampleBlock' delimited block along with associated variants Note, Tip, Warning, Caution and Important. - The `docbook.conf` file now facilitates the optional inclusion of a DocBook revision history file. - To better reflect their purpose the following block elements have been renamed: `VerbatimBlock` to `ListingBlock`; `IndentedBlock` to `LiteralBlock`; `IndentedParagraph` to `LiteralParagraph`; `CustomBlock` to `BackendBlock`; `SimpleSection` to `SectionBody`. Any corresponding CSS class names have also been changed which could result in backward incompatibility in customized stylesheets. - Swapped plain DocBook admonition icons for Jimmac's DocBook icons (http://jimmac.musichall.cz/ikony.php3). The original plain icons have been moved to `./images/plain`. - Renamed `html` backend to `xhtml` to better reflect it's function (former `html-4` backend renamed to `html`). - A new inline anchor macro syntax `[[[<id>]]]` is available, it displays `[<id>]` at the anchor location and is for anchoring bibliography list entries. - An optional 'single-line titles' syntax can be used. - Tweaks to distributed CSS stylesheets and FOP `fo.xsl` customization file. - 'List Item Continuation' has been implemented which allows additional block elements to be included in list items by separating them from the preceding list item element with a line containing a single plus character. - A new 'Horizontal Labeled List' list type has been added. Generates two column list -- the first column contains the list element labels, the second contains the element text. Same syntax as `Vertical Labeled Lists` except the double colon label suffix is followed by the start of the list item text. .Bug fixes - Fixed broken backslash line continuation. - Labeled list end tags were not undergoing attribute substitution. - Documents without any author information now generate legitimate DocBook (previously if the author line was not included in the document header then an empty (illegal) DocBook `author` element was generated). - Multiple spaces in filter command arguments were replaced by a single space. The `./examples/asciidoc2text/asciidoc2text.sh` script now indents text correctly. Version 5.1.1 (2004-10-10) -------------------------- *15-December-2004: Interim update:* Updated `asciidoc.py` to fix broken `join_lines` function -- no other changes. - PDF documentation is now produced from DocBook XML using XSLTLib and FOP. Previously we processed DocBook SGML with `jw(1)` (which used Dvips to convert DVI files to PDF). FOP has come a long way in the last 12 months and produces very acceptable PDF under both Linux and Windows. - Sections detailing how to install and use the DocBook XSL Stylesheets, xsltproc, FOP toolchain and the AsciiDoc XSLT drivers have been added to the User Guide. - The PDF output from the he example article template has been included in the distribution (`./doc/article.pdf`). - Special characters are emitted using decimal Unicode character codes (previously used named character entities which cannot be assumed included in non-HTML documents). - Added registered trademark (R) to `[replacements]`. - CSS stylesheet tweaks. - Admonitions (Note, Tip, Important, Warning, Caution) include icons when generating css output. Version 5.1.0 (2004-09-18) -------------------------- - Callouts have been implemented (see the 'Callouts' section of the AsciiDoc User Guide for details). - Added XSL drivers for generating XHTML, chunked XHTML and HTML Help from DocBook XML using XSL stylesheets and xsltproc(1). - Added CSS stylesheet for HTML generated from DocBook XML using XSL stylesheets. - Distribution contains HTML Help formatted User Guide (`./doc/asciidoc.chm`), the User Guide tells you how it's generated. - Images referred to by distributed stylesheets are now located in the `./images` subdirectory (previously located in `.`). - Filters path names are now handled properly under Cygwin. - The usual documentation and examples additions, updates and polishing. Version 5.0.9 (2004-09-09) -------------------------- - The convention of using a `.asc` file extension for AsciiDoc files has been dropped in favor of the familiar `.txt` extension. It makes more sense in that AsciiDoc is a text presentation format and because `.asc` clashed with the same extension used by other applications. It's only a naming convention -- you don't have to switch if you don't want to. - Changed the subscript formatting character from underline to tilde since underscores in file names are reasonably common (especially in link and image macros). - An alternative syntax for the index term inline macro has been added: `++<primary>,<secondary>,<tertiary>++`. - Index terms that have secondary and tertiary entries now additionally generate separate index terms for the secondary and tertiary entries. - A `+<primary>+` index term inline macro has been added which displays the term in the primary text flow. - Added alternative variable list definition using double semi-colon terminator as opposed to the standard double colon terminator so variable lists can be nested to two levels. - Footnotes now appear on a separate line in HTML and Linuxdoc outputs. - Python version compatibility is checked at startup. - Preface and appendix section titles in multi-part Book documents are meant to be out of sequence -- warnings are no longer emitted when outputting HTML. - Empty section warnings have been replaced by error messages and are emitted only if invalid markup would result. - Missing macro sections or invalid macro name warnings are only generated at startup if the `-v` (verbose) option is set. Otherwise they are deferred until a matching macro is encountered in the input file. - Missing or invalid table definition warnings are only generated at startup if the `-v` (verbose) option is set. Otherwise they are deferred until a matching table is encountered in the input file. - AsciiDoc now makes more of an effort to continue in the face of errors. - Fixed broken `./examples/website/main.aap` script. - Converted distribution text files DOS text format as a sop to Windows users with challenged text editors. - Documentation additions and corrections. Version 5.0.8 (2004-05-15) -------------------------- - Spurious 'out of sequence' level 2 warnings no longer appear when processing 'book' document multi-part book top level Preface and Appendix sub-sections since they are (correctly) out of sequence. - A warning is no longer emitted for empty Index sections since this is normal when generating DocBook outputs. - Fixed: `[quotes]` configuration file entries where not being overridden by downstream configuration file entries. - Footnote text is now output enclosed in square brackets in HTML documents. - Added superscripts and subscripts to the standard PRS configuration files. - Adjusted CSS stylesheets so list titles don't have so much space between title and first list item (broken in IE6 due to poor CSS compliance). Lessened sidebar title top margin. Version 5.0.7 (2004-04-22) -------------------------- - The version 5.0.6 README incorrectly stated that AsciiDoc would run under Python 2.0, in fact it requires Python 2.1 or better. The README has been corrected. - Documented techniques for combining and splitting AsciiDoc documents and processing the combined and split parts (see the 'Tips and Tricks' section of the User Guide). - An example of marking up superscripts and subscripts is documented in the 'Tips and Tricks' section of the User Guide (the example configuration file is in the AsciiDoc `examples` directory). - Added ellipsis to shipped `[replacements]`; three periods output an ellipsis entity. - Removed unused 'SectionClose' class. - The AsciiDoc 'Preamble' element is output as a DocBook 'Preface' when processed as a 'book' document type (in older AsciiDoc versions a warning was issued and processing stopped). - Fixed a quoting anomaly: quoted text can no longer begin or end with with white space. Version 5.0.6 (2004-03-07) -------------------------- - New 'image' macro implements optional image scaling and linking and works in both inline and block contexts. The 'image' macro obsolesces the existing 'graphic' block macro and 'icon' inline macro. - Macro substitution section names now have `-inlinemacro` and `-blockmacro` suffixes to resolve context ambiguity, make their purpose clearer and relieve section namespace congestion. - Header derived glossary entries can now be overridden from the command-line. - Special character substitution is now performed on AuthorLine derived author names. - A macro or block argument called 'options' can be used as a shortcut for a list named arguments with zero length string values. - Tables can be output without borders using the `options="noborders"` argument. - Table data lines that do not immediately follow a table section underline can now be blank. This allows CSV data with embedded blank lines to be processed correctly. - Blank DSV format table data lines are silently skipped. - Tightened up on enforcement of configuration file section names to reduce the possibility of section content being seen as a section header line. - Section titles can be optionally suffixed with title arguments enclosed in double square brackets. - A replacement has been added to `asciidoc.conf` to replace inline double dashes with the `—` entity. - Changed the `.UNDER-CONSTRUCTION.` macro syntax to `#UNDER-CONSTRUCTION#` so it is not mistaken for a BlockTitle. Similarly changed the `.NEW.` replacement with `#NEW#`. - `#NEW#` and `#UNDER-CONSTRUCTION#` macros are now included in the DocBook backend. - Replaced shipped `smallnew.gif` with `smallnew.png`. - Documentation tidy ups. Version 5.0.5 (2004-02-25) -------------------------- - Fixed the disappearing paragraph titles problem that was caused by Inline macros (incorrectly) processing BlockTitles. - Tightened AuthorLine validation. Previously invalid email addresses and embedded special characters in the AuthorLine resulted in invalid output markup. Version 5.0.4 (2004-02-09) -------------------------- - Reinstated missing `infile`, `outfile`, `filetype` and `filetype-<filetype>` glossary entries. - As of version 5.0.3 asciidoc(1) now requires Python 2.0 or greater, this has now been documented. Version 5.0.3 (2004-01-23) -------------------------- - Fixed problem that caused any filters directory file containing `.conf` (not just those with the `.conf` extension) from being loaded. - All `[miscellaneous]` configuration file entries can now be referenced like glossary entries (they are now processed internally as glossary entries). - The output file line terminator (previously hardwired to `\r\n` is now set using the `newline` entry in the configuration file `[miscellaneous]` section. - The misspelt `blocktitles` configuration file entry name has been corrected (to `blocktitle`). - An `{empty}` glossary entry has been added to the default configuration which is useful for outputting trailing blank lines from configuration file substitution sections. Version 5.0.2 (2003-12-18) -------------------------- - New (alternative) 'anchor' and 'xref' macro syntax (old syntax still valid). - DocBook `mediaobject` and `inlinemediaobject` tags are generated in place of `graphic` and `inlinegraphic` tags by the AsciiDoc `graphic` and `icon` macros. If a macro argument is specified it is the alternative text output if the target document format does not support the specified graphic file format. - Dropped the LinuxDoc left and right square bracket special character substitutions as they interfered with macro substitution. - Documentation updates and corrections. Version 5.0.1 (2003-12-09) -------------------------- - Fixed problem with anchor tag when generating CSS styled HTML. Version 5.0 (2003-12-08) ------------------------ *************************************************** This release has had some fairly major code and documentation changes. Please report any problems you encounter. mailto:srackham@gmail.com['Stuart Rackham'] *************************************************** - AsciiDoc can now produce a full-blown multi-part DocBook book including dedication, abstract, preface, colophon, glossary, appendix, bibliography and book part elements using the new `specialsections` configuration file section. - All Section element children (Paragraph, DelimitedBlock, List, Table, BlockMacro) can now be titled using the BlockTitle element. A BlockTitle element is a single line containing a title and beginning with a period. - The `index` and `backmatter` macros have been dropped, superseded by `specialsections`. - The AsciiDoc 'Preface' element has been renamed 'Preamble' (to avoid confusion with the DocBook book preface element). - Out of sequence titles are now tolerated with a warning. This allows book document level 0 sections to be processed. - An 'anchor' inline macro has been added for document link target creation. - 'Note', 'Tip', 'Important' and 'Warning' paragraph types have been added to support the corresponding DocBook elements. - Title substitution is now performed in SidebarBlock titles. - DocBook graphics now output as `figure` and `informalfigure` elements rather than `mediaobjects`. This ensures numbered figures and a lists of figures are produced by the DocBook toolchain. - You can now escape block argument lines by appending a backslash. Alternatively, if you embed arguments in the delimiter line AsciiDoc does not check for an arguments line. - The default DocBook backend file extension has been changed from `.docbook` to `.xml` (`.sgml` for the 'docbook-sgml' backend). - Warnings are output by default (previously they only printed when verbose option enabled). - A Question and Answer variable list definition has been added to the shipped configuration files, primarily to create DocBook `qanda` DocBook elements. - Fixed broken code-filter `-b linuxdoc` option. The asciidoc.asc User Guide can now be processed by linuxdoc(1) (although tables are dropped because LinuxDoc does not implement tables). .Compatibility issues: 1. Table titles are no longer in the arguments line, use the new BlockTitles. 2. Graphic titles are no longer in the 'graphic' block macro caption, use the new BlockTitles. 3. The code-filter title must be placed in a preceding BlockTitle. 4. SidebarBlock titles must be placed in a preceding BlockTitle. 5. The DelimitedBlock option 'sidebar' has been renamed to 'section'. 6. The default DocBook backend file extension has been changed from `.docbook` to `.xml` (`.sgml` for the 'docbook-sgml' backend). Version 4.2 (2003-11-26) ------------------------ - The default HTML output is now XHTML 1.0 markup. To output the former HTML 4 markup specify the `html-4` backend. - The default DocBook output is now DocBook XML. To output the former DocBook SGML specify the `docbook-sgml` backend. The associated `docbook-sgml.conf` file illustrates how to support minor DTD variations. Examples of using the `xmlto(1)` command for DocBook conversion have been added to the User Guide. - Glossary entries set using the command-line -g option can now be referenced in configuration files. - Configuration dumps (`-c` command-line option) no longer output redundant undefined glossary entries. - DelimitedBlock arguments can now be specified in a separate arguments line immediately following the leading delimiter line, This is in preference to the existing delimiter embedded arguments. Reasons: * The syntax is in keeping with the Tables arguments syntax. * It's easier to enter and implements line continuation. - A new QuoteBlock DelimitedBlock definition has been added to the distribution configuration files. - The table arguments lines can be continued using the backslash line continuation character. - Added new calculated glossary reference type `{<name>%<value>}`. - Double-quote characters can now appear in unquoted positional arguments. Version 4.1 (2003-11-13) ------------------------ - Added DSV (Delimiter Separated Values) tables format. - `{eval:<expr>}` glossary references drop the containing line if `<expr>` evaluates to `None`. - Block, Table and Macro arguments can now be positional (quoted or unquoted). - Vocabulary change: DelimitedBlock, Table and Macro 'attributes' are now referred to as 'arguments'. This makes more sense in light of the extended syntax and avoids confusion with backend markup tag attributes. - 'tablewidth' table ruler parameter can now be expressed in percent units (0..100). If between 0 and 1 then the original fractional unit measure is applied. - The use of quoting for generating footnotes and index entries has been dropped in favor of 'footnote' and 'indexterm' inline macros. - 'backmatter' inline macro included in distribution. - Fixed: CSS styled HTML tables are now fully XHTML 1.0 conformant. - Fixed: 'tablewidth' was processed incorrectly when passed as table argument. - Fixed: Glossary references like `{x=\{y}}` were one character off if \{x] was defined and `{y}` was not. Version 4.0 (2003-11-08) ------------------------ *************************************************** This release has had some fairly major code and documentation changes. Please report any problems you encounter. 'Stuart Rackham' *************************************************** - Added tables to AsciiDoc. - Added two special 'subs' options: 'default' specifies the default substitution options and 'none' specifies no substitution. These options can only appear singly. - Line continuation using a trailing backslash character is available in Paragraphs, ListItems, Tables. - The left and right quotes for quoted text can now be specified separately. - Shipped configuration files implement footnotes (only useful for DocBook output) using \[[]] quoting. - Shipped configuration files implement index terms (only useful for DocBook and LinuxDoc output) using \(()) quoting. - The shipped 'html' backend configuration now emits valid 'HTML 4.01 Transitional'. - Added new calculated glossary reference types `{<name>!<value>}` and `{<name>#<value>}`. - The DelimitedBlock 'params' option has been dropped in favor of the new 'block attributes' mechanism. If you have customized block params options you may need to adjust source files to use the 'block attributes' syntax. The example code filter has been updated to reflect these changes. - The code filter now has a `-t tabsize` option. - Replaced `-w` option with `-v` (verbose) option. The warnings option was just to confusing. - Named attributes can now be specified in macro calls. - The 'tabsize' attribute is recognized in the built-in `include` macros. A tabsize of zero suppresses tab expansion. - The configuration file `[options]` section has been split into `[miscellaneous]` and `[titles]`. If you have customized any of these settings you will need to adjust the affected configuration files. - Configuration file `[miscellaneous]` entries can now also be set using the command-line `-g` option. - Fixed: error that occurred when attempting to use zero length configuration and source files. - Fixed: blocking filter halt problem. - Fixed: inline macro escape prefix problem. - Fixed: missing macros from configuration dump problem. - Fixed: named macros were dumped incorrectly. - Many documentation changes/additions/corrections. Version 3.2.2 (2003-10-26) -------------------------- - Added `-n` option (synonym for `-g section-numbers`). - Dropped the processing commentary (hey, this is Unix). - Added new calculated glossary reference type `{<name>?<value>}`. `<name>` is the glossary entry name and `<value>` is the text substituted if the glossary entry is defined. `<value>` can only contain literal text (no glossary references allowed). - Added `asciidoc2text` to distribution `examples/asciidoc2text` directory (converts AsciiDoc source to text file with section numbering). - Fixed incorrect nesting of Simple lists inside Variable lists. - List definitions have been modified so that list items can be indented. This allows a more intuitive indentation of nested lists in AsciiDoc source. - Lists must be separated from preceding paragraphs by a blank line. This is to avoid paragraph lines being mistaken for list items. - Corrected asciidoc man page documentation error: the`-f` option does *not* search relative to source document directory for the configuration file. - Minor updates to various distribution `.conf` files. - Included `badges.conf` in `examples` directory. - `css-embedded-stylesheet.conf` now supports footer badges. - The default in-line element processing order has been changed: Glossary References are now processed before Inline Macros. This allows glossary expansions to occur inside macro references. - Glossary entries are now allowed in Author and Revision lines. - Default List `subs` options and Paragraph `presubs` options are assigned the following default value if not specified: specialcharacters,quotes,specialwords,replacements,glossary,macros - Documentation changes/additions/corrections. Version 3.2 (2003-05-26) ------------------------ - Added a `-s` command-line option to suppress the output of `[header]` and `[footer]` sections. - Article document headers are no longer mandatory: this allows AsciiDoc to process arbitrary chunks of text. When used in conjunction with the new `-s` command-line option corresponding chunks of backend markup can be generated. - AsciiDoc now emits a warning message and continues when an out of sequence section title is detected (previously it failed and halted). This allows document sections to be processed separately. - Optional 'presubs' and 'postsubs' entries have been added to 'DelimitedBlock' and 'Paragraph' definitions. As a consequence substitution options are no longer legal in 'options' entries. - 'presubs' and 'postsubs' substitutions are processed in the order the options are specified (rather than the fixed 'options' order of previous versions). - ./filters subdirectories are automatically searched for filter commands. - A 'title-subs' configuration option specifies the substitutions performed on document Header and Section titles. - A 'subs' entry in now included in List configuration file definitions that specified substitutions performed on list entry text. - Configuration files are auto-loaded from ./filters subdirectories. - Added example code filter (see ./examples/filters). - Bug fix: if section was empty you may have got erroneous 'missing tag "paragraph"' error. - Internal code tidy up. Version 3.1 (2003-05-18) ------------------------ - In version 3.0 a `[macros]` section entry of the form 'name' was equivalent to 'name='. An entry of the form 'name' now undefines the entry (to bring it in line with the behavior of other special sections). - Paragraphs have now been generalized (in the same way as Lists and DelimitedBlocks). - The 'indentsize' option has been dropped as as consequence of paragraph generalization. - Pipe | characters can be included in substituted tag and substitution section text using the \{brvbar} (broken vertical bar) glossary reference. - Removed the restriction requiring substitution section text placeholders | to be on a separate line. - Added an `-e` asciidoc(1) command option that excludes implicit configuration files (used in conjunction with `-c` generated configuration files). - Version 3.0 documentation has undergone a considerable cleanup. - The dumping of quoted section entries (see `-c` option) now works correctly. - The format of special section entries has been made consistent: `name` undefines the entry; `name=` sets the entry value to a blank string; `name=value` sets the entry value to `value`. - As a consequence of the previous change the caret prefix is no longer used in glossary configuration file entries (although it is still used when undefining an entry using the `-g` command-line option). Version 3.0 (2003-05-13) ------------------------ This version is the culmination of work begun in the 2.x releases whereby fixed policy has been replaced by extensible mechanisms. - Added `-c` command-line option to dump a composite asciidoc(1) configuration file to stdout. - Lists and Delimited Blocks are now defined by a set of configuration file parameter sections. The user can modify the default definitions or add new ones. - Block content can now be processed through external filters. - The default behavior for Custom Blocks is to perform glossary substitution (previously there was no substitution inside Custom Blocks). - The old 2.x style macros have been reimplemented; as with Lists and Delimited Blocks there syntax and behavior can be configured by the user. The default macro syntax remains the same but the semantics are now (hopefully) a bit more intelligible. - Block and Builtin macros use :: delimiter instead of the 2.x single colon delimit (to distinguish them from inline macros). The 2.x syntax is still supported for backward compatibility. - Nested lists are now supported and IndentedParagraphs can be included in list items. - Conditional source inclusion can be specified using built in `ifdef`, `ifndef` and `endif` macros. - The new conditional source inclusion feature has been used to reduce the number of default configuration files down to one per backend. - A change of name: 2.x 'Substitutions' are now called 'Replacements' and the 2.x `[substitutions]` configuration file section is now called `[replacements]` (the old name is still recognized for backward compatibility). - The line break is now implemented as a 'Replacements' substitution. - Inline 'icon' macro for inline images has been added to default configuration files. Version 2.2 (2003-04-07) ------------------------ - The `master.conf` configuration file name has been deprecated in favor of `asciidoc.conf`. - The standard configuration files set is now loaded from the `.asciidoc` folder in the users home directory (if it exists) and then from the source document directory. Configuration files that don't exist are silently skipped. - Configuration files named like the source file will be automatically loaded if they are found in the source file directory. For example if the source file is `mydoc.asc` and the `-b html` option is used then asciidoc(1) will look for `mydoc.conf` and `mydoc-html.conf` in that order. - The characters used to quote formatted text can be configured and extended by the user (see the master.conf [quotes] section). - Quoted text can now be escaped by prefixing a backslash character to the leading quote. - The double single-quote '' strong text quote has been deprecated in favor of an asterisk * character. - Added \{eval:expression}, \{sys:command} and \{sys2:command} glossary reference actions. - Trailing brace characters `}` are now allowed inside glossary references provided they are escaped with a backslash character. - Glossary entries can now be escaped by prefixing a backslash character to the leading brace character (use this in preference to placing the backslash inside the brace). - The output macro has been deprecated (use the new include1 macro inside a CustomBlock). - The default document type is `article` (asciidoc no longer attempts to guess). - Files included within DelimitedBlocks are not searched for block termination underlines. This ensures the entire file is part of the DelimitedBlock. - `include` macros can now be used in configuration files. - Corrected \{infile} and \{outfile} glossary entry documentation. - File inclusion is now limited to a depth of 5 to catch recursion loops. - Inline tags have been deprecated, they're not necessary and they immediately make the source document backend specific. Use CustomBlocks or Substitutions instead. Version 2.1 (2003-03-17) ------------------------ - Added section auto numbering `{sectnum}` glossary entry (auto-numbering function contributed by Ludovico Magnocavallo). - asciidoc(1) now correctly returns non-zero exit status if an error occurs. - An AsciiDoc example website has been included in the AsciiDoc distribution `examples/website` directory. - NOTE: The `asciidoc` wrapper script included in the 2.0 distribution has been dropped, if you've symlinked or aliased to `asciidoc` you'll need to change them to point directly to `asciidoc.py` instead. - An RCS $Id$ marker can be used as the document header revision line (based on a patch submitted by Ludovico Magnocavallo). - In addition to the `name=value` glossary entry format two new ones have been introduced: `name` (the default value is set to an empty string) and `^name` (the glossary entry is undefined). - The `-q` command-line option has been deprecated and the `-w level` command-line option added. + NOTE: By default skipped substitution warnings are now suppressed. - If a configuration file specified with the `-f` command-line option is not found relative to the current working directory then the search is repeated relative to the asciidoc(1) directory. This allows global configuration files to be used. - Added `{infile}`, `{outfile}` predefined glossary entries. - Added `under-construction` macro to HTML article configuration files. - Deprecated `{asciidoc_version}` glossary entry in favor of `{asciidoc-version}` (to it consistent with other entries). Version 2.0 (2003-02-24) ------------------------ - The emphasized, strong and monospaced words options have been generalized with the introduction of macro based 'special words' lists. - Glossary references can now appear in both the document and macro bodies. - All output files use `crlf` line termination (previously used UNIX `lf` (newline) termination). - Added [substitutions] section which implements arbitrary regular expression based substitutions. - An optional `master.conf` configuration file can be used for entries that are not backend or document type specific. - Special character definitions moved from the code to the new [special_characters] configuration file section. - Configuration file glossary added. - Command-line -g glossary entry added. - A new 'book' document type has been implemented for the 'docbook' backend. It outputs DocBook 'book' documents. - A major internal change has been the implementation of parametrized user definable 'macros'. Internally most document elements are now processed as macros. - Configuration file macro variables can be specified with default values (literals or other macro variables). - An attempt has been made to tighten up the vocabulary used to describe the AsciiDoc document syntax. - The term abstract has been replaced by the more general term 'preface' and a new preface section introduced into article configuration files (replacing the synopsis sections). - Any section elements can now be put in the document preface (previous versions only allowed paragraphs). - AsciiDoc Blocks have been unified and their behavior can be user defined and parametrized. - An 'output' inclusion allows an external file to be written directly to the backend output file. - A new CustomBlock has been added. Default behavior is to insert the enveloped AsciiDoc source lines directly into the output file. - A 'line break' tag can be inserted by terminating a line with a '+' character (only really useful for HTML backends). - An fourth section level has been introduced. - The SidebarBlock delimiter line characters have been changed. The deprecated underline is still accepted. - Levels 2 and 3 title underline characters have been changed. The deprecated underlines are still accepted. - Lines with backend specific inline tags can be inserted into AsciiDoc source files. - Single words enveloped by underscores are no longer emphasized. This feature was deprecated as it is redundant (use single quotes instead) and was being applied to file names with underscores. - A `-q` quiet option has been added to suppress warning messages. - Badge images sourced locally. - Added 'author' and 'author-mail' meta tags to HTML configuration files. Version 1.5 (2003-01-08) ------------------------ - Implemented sidebar document elements. - Explicit checks for user specified configuration files and input file (rather than throwing exception). Version 1.4 (2003-01-04) ------------------------ - New configuration file options 'emphasizedwords' and 'strongwords'. These allow the definition of words that will always be emphasized or rendered in a strong font without inline formatting. - Document and section titles are no long subject to inline formatting. - Multiple configuration files can be overlaid in a single command. - Configuration file tags and options entries can now be overridden on an entry by entry basis (previously the entire section was overloaded). - Configuration file tags and options entries are now cached this has resulted in around 37% performance improvement over version 1.3. - Variable lists can now contain multiple terms per list item. - Placeholder paragraph eliminated from empty sections that contain subsections. - Added \{asciidoc_version} substitution variable. - More documentation additions and tidy ups. Version 1.3 (2003-01-01) ------------------------ - A new 'strong' text formatting convention has been implemented: Word phrases enclosed in pairs of single quote characters (acute accents) are rendered in a strong font (usually bold). - Paragraphs can now be followed immediately by Simple lists and Ordered lists without an intervening blank line. - A user specified configuration file (`asciidoc(1)` -f option) overlays the default configuration file rather than replacing it. Custom configuration files need only contain those sections that have been customized. - Comment Block delimiters have been relaxed slightly. They must start with three forward slashes /// but the remainder can contain any characters, this allows comments to be embedded in the delimiter line. - Leading non-digit characters preceding revision number are now ignored. - Set default indentsize [option] from 2 to documented default value of zero in HTML backend html-article.conf and html-manpage.conf files. - Fixed error that occurred when taking input from stdin without explicitly specifying a document type. - Restored file name and line number error message information. - Changed deprecated -t option to -d in asciidoc --help and usage command output. - CSS styles tweaking. - Code, configuration file and documentation tidy ups. Version 1.2 (2002-12-28) ------------------------ - Implemented 'include' URL to allow file inclusion. - `fileextension` configuration file [option] renamed to more sensible `outfilesuffix` (`fileextension` still accepted by this version but will be dropped in future). - Improved error reporting. - CSS backends generate valid XHTML. - New `css-embedded` backend generates HTML with embedded stylesheets (use the `css` backend for linked stylesheets). The css-embedded backend output contains no linked images so the generated html files are completely self contained. - Bug fixes. Version 1.1 (2002-12-03) ------------------------ - Added css (cascading style sheets) backend - Implemented IndentedBlock document element. - Tabsize command-line option has been deprecated in favor of configuration file. - Default indent width changed to zero. - Added \{localdate} and \{localtime} substitution variables. - Added optional [options] configuration file section with fileextension, tabsize and indentsize options. - Implemented \{authorinitials} substitution variable. - Added https link type. - Corrected [graphic] substitution from \{title} to \{caption} in linuxdoc-article.conf configuration file. - Fixed error that occurred when '==' title underline was used. Version 1.0 (2002-11-25) ------------------------ First AsciiDoc public release along with AsciiDoc web site (http://asciidoc.org/) and SourceForge.net project registration (https://sourceforge.net/projects/asciidoc/[]). // vim: set syntax=asciidoc: �����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������asciidoc-8.6.9/asciidoc.conf������������������������������������������������������������������������0000664�0001751�0001751�00000042535�12070213051�016111� 0����������������������������������������������������������������������������������������������������ustar �srackham������������������������srackham���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������# # asciidoc.conf # # Asciidoc global configuration file. # Contains backend independent configuration settings that are applied to all # AsciiDoc documents. # [miscellaneous] tabsize=8 textwidth=70 newline=\r\n [attributes] backend-alias-html=xhtml11 backend-alias-docbook=docbook45 toclevels=2 toc-placement=auto sectids= iconsdir=./images/icons encoding=UTF-8 # Uncomment to use xhtml11 quirks mode CSS. #quirks= # HTML source code highlighter (source-highlight, pygments or highlight). source-highlighter=source-highlight # Uncomment to use deprecated quote attributes. #deprecated-quotes= empty= sp=" " # Attribute and AttributeList element patterns. attributeentry-pattern=^:(?P<attrname>\w[^.]*?)(\.(?P<attrname2>.*?))?:(\s+(?P<attrvalue>.*))?$ attributelist-pattern=(?u)(^\[\[(?P<id>[\w_:][\w_:.-]*)(,(?P<reftext>.*?))?\]\]$)|(^\[(?P<attrlist>.*)\]$) # Substitution attributes for escaping AsciiDoc processing. amp=& lt=< gt=> brvbar=| nbsp=  zwsp=​ wj=⁠ deg=° backslash=\ two-colons=:: two-semicolons=;; plus=+ # DEPRECATED: underscore attribute names. two_colons=:: two_semicolons=;; # Left and right single and double quote characters. # See http://en.wikipedia.org/wiki/Non-English_usage_of_quotation_marks lsquo=‘ rsquo=’ ldquo=“ rdquo=” [titles] subs=specialcharacters,quotes,replacements,macros,attributes,replacements2 # Double-line title pattern and underlines. sectiontitle=^(?P<title>.*?)$ underlines="==","--","~~","^^","++" # Single-line title patterns. sect0=^= +(?P<title>[\S].*?)( +=)?$ sect1=^== +(?P<title>[\S].*?)( +==)?$ sect2=^=== +(?P<title>[\S].*?)( +===)?$ sect3=^==== +(?P<title>[\S].*?)( +====)?$ sect4=^===== +(?P<title>[\S].*?)( +=====)?$ blocktitle=^\.(?P<title>([^.\s].*)|(\.[^.\s].*))$ [specialcharacters] &=& <=< >=> [quotes] # The order is important, quotes are processed in conf file order. **=#strong *=strong ``|''=doublequoted '=emphasis `|'=singlequoted ifdef::no-inline-literal[] `=monospaced endif::no-inline-literal[] # +++ and $$ quoting is applied to the +++ and $$ inline passthrough # macros to allow quoted attributes to be used. # This trick only works with inline passthrough macros. +++=#unquoted $$=#unquoted ++=#monospaced +=monospaced __=#emphasis _=emphasis \##=#unquoted \#=unquoted ^=#superscript ~=#subscript [specialwords] emphasizedwords= strongwords= monospacedwords= [replacements] # Replacements performed in order of configuration file entry. The first entry # of each replacement pair performs the (non-escaped) replacement, the second # strips the backslash from the escaped replacement. # (C) Copyright (entity reference ©) (?<!\\)\(C\)=© \\\(C\)=(C) # (R) registered trade mark (entity reference ® (?<!\\)\(R\)=® \\\(R\)=(R) # (TM) Trademark (entity reference ™) (?<!\\)\(TM\)=™ \\\(TM\)=(TM) # -- Spaced and unspaced em dashes (entity reference —). # Space on both sides is translated to thin space characters. (^-- )=—  (\n-- )|( -- )|( --\n)= —  (\w)--(\w)=\1—\2 \\--(?!-)=-- # Replace vertical typewriter apostrophe with punctuation apostrophe. (\w)'(\w)=\1’\2 (\w)\\'(\w)=\1'\2 # ... Ellipsis (entity reference …) (?<!\\)\.\.\.=… \\\.\.\.=... # Arrows from the Arrows block of Unicode. # -> right arrow (?<!\\)->=→ \\->=-> # => right double arrow (?<!\\)\=>=⇒ \\\=>==> # <- left arrow (?<!\\)<-=← \\<-=<- # <= left double arrow (?<!\\)<\==⇐ \\<\==<= # Arbitrary entity references. (?<!\\)&([:_#a-zA-Z][:_.\-\w]*?;)=&\1 \\(&[:_#a-zA-Z][:_.\-\w]*?;)=\1 #----------- # Paragraphs #----------- [paradef-default] delimiter=(?s)(?P<text>\S.*) posattrs=style style=normal template::[paragraph-styles] [paradef-literal] delimiter=(?s)(?P<text>\s+.*) options=listelement posattrs=style style=literal template::[paragraph-styles] [paradef-admonition] delimiter=(?s)^\s*(?P<style>NOTE|TIP|IMPORTANT|WARNING|CAUTION):\s+(?P<text>.+) template::[paragraph-styles] [paragraph-styles] normal-style=template="paragraph" comment-style=template="paragraph",options=('skip',) verse-style=template="verseparagraph",posattrs=("style","attribution","citetitle") quote-style=template="quoteparagraph",posattrs=("style","attribution","citetitle") literal-style=template="literalparagraph",subs=("verbatim",) listing-style=template="listingparagraph",subs=("verbatim",) example-style=template="exampleparagraph" sidebar-style=template="sidebarparagraph" abstract-style=template="abstractparagraph" partintro-style=template="partintroparagraph" NOTE-style=template="admonitionparagraph",name="note",caption="{note-caption}" TIP-style=template="admonitionparagraph",name="tip",caption="{tip-caption}" IMPORTANT-style=template="admonitionparagraph",name="important",caption="{important-caption}" WARNING-style=template="admonitionparagraph",name="warning",caption="{warning-caption}" CAUTION-style=template="admonitionparagraph",name="caution",caption="{caution-caption}" [literalparagraph] template::[literalblock] [verseparagraph] template::[verseblock] [quoteparagraph] template::[quoteblock] [listingparagraph] template::[listingblock] [exampleparagraph] template::[exampleblock] [sidebarparagraph] template::[sidebarblock] [abstractparagraph] template::[abstractblock] [partintroparagraph] template::[partintroblock] [macros] #-------------- # Inline macros #-------------- # Backslash prefix required for escape processing. # (?s) re flag for line spanning. # Macros using default syntax. (?su)(?<!\w)[\\]?(?P<name>http|https|ftp|file|irc|mailto|callto|image|link|anchor|xref|indexterm|indexterm2):(?P<target>\S*?)\[(?P<attrlist>.*?)(?<!\\)\]= # These URL types don't require any special attribute list formatting. (?su)(?<!\S)[\\]?(?P<name>http|https|ftp|file|irc):(?P<target>//[^\s<>]*[\w/])= # Allow a leading parenthesis and square bracket. (?su)(?<\=[([])[\\]?(?P<name>http|https|ftp|file|irc):(?P<target>//[^\s<>]*[\w/])= # Allow <> brackets. (?su)[\\]?<(?P<name>http|https|ftp|file|irc):(?P<target>//[^\s<>]*[\w/])>= # Email addresses don't require special attribute list formatting. # The before ">: and after "< character exclusions stop multiple substitution. (?su)(?<![">:\w._/-])[\\]?(?P<target>\w[\w._-]*@[\w._-]*\w)(?!["<\w_-])=mailto # Allow footnote macros hard up against the preceding word so the footnote mark # can be placed against the noted text without an intervening space # (http://groups.google.com/group/asciidoc/browse_frm/thread/e1dcb7ee0efc17b5). (?su)[\\]?(?P<name>footnote|footnoteref):(?P<target>\S*?)\[(?P<attrlist>.*?)(?<!\\)\]= # Anchor: [[[id]]]. Bibliographic anchor. (?su)[\\]?\[\[\[(?P<attrlist>[\w_:][\w_:.-]*?)\]\]\]=anchor3 # Anchor: [[id,xreflabel]] (?su)[\\]?\[\[(?P<attrlist>[\w"_:].*?)\]\]=anchor2 # Link: <<id,text>> (?su)[\\]?<<(?P<attrlist>[\w"_:].*?)>>=xref2 ifdef::asciidoc7compatible[] # Index term: ++primary,secondary,tertiary++ (?su)(?<!\S)[\\]?\+\+(?P<attrlist>[^+].*?)\+\+(?!\+)=indexterm # Index term: +primary+ # Follows ++...++ macro otherwise it will match them. (?<!\S)[\\]?\+(?P<attrlist>[^\s\+][^+].*?)\+(?!\+)=indexterm2 endif::asciidoc7compatible[] ifndef::asciidoc7compatible[] # Index term: (((primary,secondary,tertiary))) (?su)(?<!\()[\\]?\(\(\((?P<attrlist>[^(].*?)\)\)\)(?!\))=indexterm # Index term: ((primary)) # Follows (((...))) macro otherwise it will match them. (?<!\()[\\]?\(\((?P<attrlist>[^\s\(][^(].*?)\)\)(?!\))=indexterm2 endif::asciidoc7compatible[] # Callout [\\]?<(?P<index>\d+)>=callout # Passthrough macros. (?su)[\\]?(?P<name>pass):(?P<subslist>\S*?)\[(?P<passtext>.*?)(?<!\\)\]=[] # Triple-plus and double-dollar inline passthroughs. (?su)[\\]?\+\+\+(?P<passtext>.*?)\+\+\+=pass[] (?su)[\\]?\$\$(?P<passtext>.*?)\$\$=pass[specialcharacters] # Inline literal. ifndef::no-inline-literal[] (?su)(?<![`\w])([\\]?`(?P<passtext>[^`\s]|[^`\s].*?\S)`)(?![`\w])=literal[specialcharacters] endif::no-inline-literal[] # Inline comment. (?mu)^[\\]?//(?P<passtext>[^/].*|)$=comment[specialcharacters] # Default (catchall) inline macro is not implemented so there is no ambiguity # with previous definition that could result in double substitution of escaped # references. #(?su)[\\]?(?P<name>\w(\w|-)*?):(?P<target>\S*?)\[(?P<passtext>.*?)(?<!\\)\]= #------------- # Block macros #------------- # Macros using default syntax. (?u)^(?P<name>image|unfloat|toc)::(?P<target>\S*?)(\[(?P<attrlist>.*?)\])$=# # Passthrough macros. (?u)^(?P<name>pass)::(?P<subslist>\S*?)(\[(?P<passtext>.*?)\])$=# ^'{3,}$=#ruler ^<{3,}$=#pagebreak ^//(?P<passtext>[^/].*|)$=#comment[specialcharacters] # Implemented in HTML backends. [unfloat-blockmacro] [toc-blockmacro] #----------------- # Delimited blocks #----------------- [blockdef-comment] delimiter=^/{4,}$ options=skip posattrs=style [blockdef-sidebar] delimiter=^\*{4,}$ template=sidebarblock options=sectionbody posattrs=style # DEPRECATED: Use Openblock instead. abstract-style=template="abstractblock" [blockdef-open] # A block without opening or closing tags. delimiter=^--$ posattrs=style style=default default-style=template="openblock",options=("sectionbody",) comment-style=template="openblock",options=("skip",) abstract-style=template="abstractblock",options=("sectionbody",) partintro-style=template="partintroblock",options=("sectionbody",) example-style=template="exampleblock",options=("sectionbody",) sidebar-style=template="sidebarblock",options=("sectionbody",) verse-style=template="verseblock",posattrs=("style","attribution","citetitle") quote-style=template="quoteblock",posattrs=("style","attribution","citetitle"),options=("sectionbody",) literal-style=template="literalparagraph",subs=("verbatim",) listing-style=template="listingparagraph",subs=("verbatim",) NOTE-style=template="admonitionblock",name="note",caption="{note-caption}",options=("sectionbody",) TIP-style=template="admonitionblock",name="tip",caption="{tip-caption}",options=("sectionbody",) IMPORTANT-style=template="admonitionblock",name="important",caption="{important-caption}",options=("sectionbody",) WARNING-style=template="admonitionblock",name="warning",caption="{warning-caption}",options=("sectionbody",) CAUTION-style=template="admonitionblock",name="caution",caption="{caution-caption}",options=("sectionbody",) [blockdef-pass] delimiter=^\+{4,}$ template=passblock # Default subs choosen for backward compatibility. subs=attributes,macros posattrs=style pass-style=template="passblock",subs=() [blockdef-listing] delimiter=^-{4,}$ template=listingblock subs=verbatim posattrs=style [blockdef-literal] delimiter=^\.{4,}$ template=literalblock subs=verbatim posattrs=style listing-style=template="listingblock" # DEPRECATED: Use verse style on quote blocks instead. verse-style=template="verseblock",subs="normal" [blockdef-quote] delimiter=^_{4,}$ subs=normal style=quote posattrs=style,attribution,citetitle quote-style=template="quoteblock",options=("sectionbody",) verse-style=template="verseblock" [blockdef-example] delimiter=^={4,}$ template=exampleblock options=sectionbody posattrs=style NOTE-style=template="admonitionblock",name="note",caption="{note-caption}" TIP-style=template="admonitionblock",name="tip",caption="{tip-caption}" IMPORTANT-style=template="admonitionblock",name="important",caption="{important-caption}" WARNING-style=template="admonitionblock",name="warning",caption="{warning-caption}" CAUTION-style=template="admonitionblock",name="caution",caption="{caution-caption}" # For use by custom filters. # DEPRECATED: No longer used, a styled listing block (blockdef-listing) is preferable. [blockdef-filter] delimiter=^~{4,}$ template=listingblock subs=none posattrs=style #------- # Lists #------- [listdef-bulleted] # - bullets. delimiter=^\s*- +(?P<text>.+)$ posattrs=style type=bulleted tags=bulleted callout-style=tags="callout" bibliography-style=tags="bibliography" [listdef-bulleted1] # * bullets. template::[listdef-bulleted] delimiter=^\s*\* +(?P<text>.+)$ [listdef-bulleted2] # ** bullets. template::[listdef-bulleted] delimiter=^\s*\*{2} +(?P<text>.+)$ [listdef-bulleted3] # *** bullets. template::[listdef-bulleted] delimiter=^\s*\*{3} +(?P<text>.+)$ [listdef-bulleted4] # **** bullets. template::[listdef-bulleted] delimiter=^\s*\*{4} +(?P<text>.+)$ [listdef-bulleted5] # ***** bullets. template::[listdef-bulleted] delimiter=^\s*\*{5} +(?P<text>.+)$ [listdef-arabic] # Arabic numbering. delimiter=^\s*(?P<index>\d+\.) +(?P<text>.+)$ posattrs=style type=numbered tags=numbered style=arabic [listdef-loweralpha] # Lower alpha numbering. template::[listdef-arabic] delimiter=^\s*(?P<index>[a-z]\.) +(?P<text>.+)$ style=loweralpha [listdef-upperalpha] # Upper alpha numbering. template::[listdef-arabic] delimiter=^\s*(?P<index>[A-Z]\.) +(?P<text>.+)$ style=upperalpha [listdef-lowerroman] # Lower roman numbering. template::[listdef-arabic] delimiter=^\s*(?P<index>[ivx]+\)) +(?P<text>.+)$ style=lowerroman [listdef-upperroman] # Upper roman numbering. template::[listdef-arabic] delimiter=^\s*(?P<index>[IVX]+\)) +(?P<text>.+)$ style=upperroman [listdef-numbered1] # . numbering. template::[listdef-arabic] delimiter=^\s*\. +(?P<text>.+)$ [listdef-numbered2] # .. numbering. template::[listdef-loweralpha] delimiter=^\s*\.{2} +(?P<text>.+)$ [listdef-numbered3] # ... numbering. template::[listdef-lowerroman] delimiter=^\s*\.{3} +(?P<text>.+)$ [listdef-numbered4] # .... numbering. template::[listdef-upperalpha] delimiter=^\s*\.{4} +(?P<text>.+)$ [listdef-numbered5] # ..... numbering. template::[listdef-upperroman] delimiter=^\s*\.{5} +(?P<text>.+)$ [listdef-labeled] # label:: item. delimiter=^\s*(?P<label>.*[^:])::(\s+(?P<text>.+))?$ posattrs=style type=labeled tags=labeled vertical-style=tags="labeled" horizontal-style=tags="horizontal" glossary-style=tags="glossary" qanda-style=tags="qanda" [listdef-labeled2] # label;; item. template::[listdef-labeled] delimiter=^\s*(?P<label>.*[^;]);;(\s+(?P<text>.+))?$ [listdef-labeled3] # label::: item. template::[listdef-labeled] delimiter=^\s*(?P<label>.*[^:]):{3}(\s+(?P<text>.+))?$ [listdef-labeled4] # label:::: item. template::[listdef-labeled] delimiter=^\s*(?P<label>.*[^:]):{4}(\s+(?P<text>.+))?$ [listdef-callout] posattrs=style delimiter=^<?(?P<index>\d*>) +(?P<text>.+)$ type=callout tags=callout style=arabic # DEPRECATED: Old list syntax. [listdef-qanda] posattrs=style delimiter=^\s*(?P<label>.*\S)\?\?$ type=labeled tags=qanda # DEPRECATED: Old list syntax. [listdef-bibliography] posattrs=style delimiter=^\+ +(?P<text>.+)$ type=bulleted tags=bibliography # DEPRECATED: Old list syntax. [listdef-glossary] delimiter=^(?P<label>.*\S):-$ posattrs=style type=labeled tags=glossary #------- # Tables #------- [tabledef-default] delimiter=^\|={3,}$ posattrs=style template=table default-style=tags="default" verse-style=tags="verse" literal-style=tags="literal",subs=("specialcharacters",) emphasis-style=tags="emphasis" strong-style=tags="strong" monospaced-style=tags="monospaced" header-style=tags="header" asciidoc-style=tags="asciidoc",subs=(),filter='"{python}" "{asciidoc-file}" -b {backend} {asciidoc-args}{lang? -a "lang={lang}@"}{icons? -a icons -a "iconsdir={iconsdir}"}{imagesdir? -a "imagesdir={imagesdir}"}{data-uri? -a data-uri} -a "indir={indir}"{trace? -a "trace={trace}"}{blockname? -a "blockname={blockname}"} -s -' [tabledef-nested] # Same as [tabledef-default] but with different delimiter and separator. delimiter=^!={3,}$ separator=((?<!\S)((?P<span>[\d.]+)(?P<op>[*+]))?(?P<align>[<\^>.]{,3})?(?P<style>[a-z])?)?! posattrs=style template=table verse-style=tags="verse" literal-style=tags="literal",subs=("specialcharacters",) emphasis-style=tags="emphasis" strong-style=tags="strong" monospaced-style=tags="monospaced" header-style=tags="header" asciidoc-style=tags="asciidoc",subs=(),filter='"{python}" "{asciidoc-file}" -b {backend} {asciidoc-args}{lang? -a "lang={lang}@"}{icons? -a icons -a "iconsdir={iconsdir}"}{imagesdir? -a "imagesdir={imagesdir}"}{data-uri? -a data-uri} -a "indir={indir}"{trace? -a "trace={trace}"}{blockname? -a "blockname={blockname}"} -s -' #---------------------------------------- # Common block and macro markup templates #---------------------------------------- [comment-inlinemacro] # Outputs nothing. [comment-blockmacro] # Outputs nothing. [pass-blockmacro] {passtext} [pass-inlinemacro] template::[pass-blockmacro] [passblock] | [filter-image-blockmacro] # Synthesize missing target attribute for filter generated file names. # The tag split | ensures missing target file names are auto-generated # before the filter is executed, the remainder (the [image-blockmacro]) # is excuted after the filter to ensure data URI encoding comes after # the image is created. {target%}{counter2:target-number} {target%}{set2:target:{docname}__{target-number}.png} | template::[image-blockmacro] [+docinfo] # Blank section to suppress missing template warning. #---------------------------------- # Default special section templates #---------------------------------- [abstract] template::[sect1] [colophon] template::[sect1] [dedication] template::[sect1] [preface] template::[sect1] [appendix] template::[sect1] [glossary] template::[sect1] [bibliography] template::[sect1] [index] template::[sect1] [synopsis] template::[sect1] #-------------------------------------------------------------------- # Deprecated old table definitions. # [old_tabledef-default] fillchar=- format=fixed [old_tabledef-csv] fillchar=~ format=csv [old_tabledef-dsv] fillchar=_ format=dsv # End of deprecated old table definitions. #-------------------------------------------------------------------- �������������������������������������������������������������������������������������������������������������������������������������������������������������������asciidoc-8.6.9/docbook45.conf�����������������������������������������������������������������������0000664�0001751�0001751�00000055623�12031161246�016133� 0����������������������������������������������������������������������������������������������������ustar �srackham������������������������srackham���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������# # docbook45.conf # # Asciidoc DocBook 4.5 configuration file. # [miscellaneous] outfilesuffix=.xml # Printable page width and units. # Used to calculate DocBook CALS tables absolute column and table widths. pagewidth=425 pageunits=* [attributes] basebackend=docbook basebackend-docbook= basebackend-docbook45= # For backward compatibility (docbook backend was renamed to docbook45 at 8.6.2) backend-docbook= # toc and numbered are set to maintain original default behavior. toc= numbered= [replacements2] # Line break markup. Custom processing instruction in fo.xsl. (?m)^(.*)\s\+$=\1<?asciidoc-br?> [replacements] ifdef::asciidoc7compatible[] # Superscripts. \^(.+?)\^=<superscript>\1</superscript> # Subscripts. ~(.+?)~=<subscript>\1</subscript> endif::asciidoc7compatible[] [ruler-blockmacro] # Uses custom processing instructions in fo.xsl and asciidoc-dblatex.xsl. <simpara><?asciidoc-hr?></simpara> [pagebreak-blockmacro] # Uses custom processing instructions in fo.xsl and asciidoc-dblatex.xsl. <simpara><?asciidoc-pagebreak?></simpara> [blockdef-pass] latexmath-style=template="latexmathblock",subs=() [macros] # math macros. (?su)[\\]?(?P<name>latexmath):(?P<subslist>\S*?)\[(?P<passtext>.*?)(?<!\\)\]=[] (?u)^(?P<name>latexmath)::(?P<subslist>\S*?)(\[(?P<passtext>.*?)\])$=#[] [latexmath-inlinemacro] <inlineequation> <alt><![CDATA[{passtext}]]></alt> <inlinemediaobject><textobject><phrase></phrase></textobject></inlinemediaobject> </inlineequation> [latexmath-blockmacro] <informalequation> <alt><![CDATA[{passtext}]]></alt> <mediaobject><textobject><phrase></phrase></textobject></mediaobject> </informalequation> [latexmathblock] <equation{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}><title>{title} {title%} {title#} {title%} [image-inlinemacro] {alt={target}} [image-blockmacro] {title} {title%}{pgwide-option?} # DocBook XSL Stylesheets custom processing instructions. {alt={target}} {title#} {title%} [indexterm-inlinemacro] # Index term. # Generate separate index entries for primary, secondary and tertiary # descriptions. # Primary only. {2%} {2%} {1} {2%} # Primary and secondary. {2#}{3%} {2#}{3%} {1}{2} {2#}{3%} {2#}{3%} {2#}{3%} {2} {2#}{3%} # Primary, secondary and tertiary. {3#} {1}{2}{3} {3#} {3#} {2}{3} {3#} {3#} {3} {3#} [indexterm2-inlinemacro] # Index term. # Single entry index term that is visible in the primary text flow. {1}{1} [footnote-inlinemacro] # Footnote. {0} [footnoteref-inlinemacro] # Footnote reference. {2#}{2} {2%} [callout-inlinemacro] # Callout. # List tags. [listtags-bulleted] list={unbreakable-option? }{title?{title}}| item=| text=| [listtags-numbered] list={unbreakable-option? }{title?{title}}{start?}| item=| text=| [listtags-labeled] list={title?{title}}| entry=| label= term=| item=| text=| [listtags-horizontal] # Horizontal labeled list (implemented with two column table). # Hardwired column widths to 30%,70% because the current crop of PDF # generators do not auto calculate column widths. list=<{title?table}{title!informaltable}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}{style? tabstyle="{style}"}{pgwide-option? pgwide="1"} frame="none" colsep="0" rowsep="0">{title?{title}}|<{title?/table}{title!/informaltable}> entry=| label=| term=| item=| text=| [listtags-callout] list={title?{title}}| item=| text=| [listtags-qanda] list={title?{title}}| entry=| label=| term=| item=| text=| [listtags-bibliography] list={title?{title}}| item=| text=| [listtags-glossary] list= entry=| label= term=| item=| text=| [tags] # Quoted text emphasis={1?}|{1?} strong={1?}|{1?} monospaced={1?}|{1?} singlequoted={lsquo}{1?}|{1?}{rsquo} doublequoted={ldquo}{1?}|{1?}{rdquo} unquoted={1?}|{1?} subscript={1?}|{1?} superscript={1?}|{1?} ifdef::deprecated-quotes[] # Override with deprecated quote attributes. emphasis={role?}|{role?} strong={role?}|{role?} monospaced={role?}|{role?} singlequoted={role?}{amp}#8216;|{amp}#8217;{role?} doublequoted={role?}{amp}#8220;|{amp}#8221;{role?} unquoted={role?}|{role?} subscript={role?}|{role?} superscript={role?}|{role?} endif::deprecated-quotes[] # Inline macros [http-inlinemacro] {0={name}:{target}} [https-inlinemacro] {0={name}:{target}} [ftp-inlinemacro] {0={name}:{target}} [file-inlinemacro] {0={name}:{target}} [irc-inlinemacro] {0={name}:{target}} [mailto-inlinemacro] {0={target}} [callto-inlinemacro] {0={target}} [link-inlinemacro] {0={target}} # anchor:id[text] [anchor-inlinemacro] # [[id,text]] [anchor2-inlinemacro] # [[[id]]] [anchor3-inlinemacro] [{1}] # xref:id[text] [xref-inlinemacro] {0} {2%} # <> [xref2-inlinemacro] {2} {2%} # // comment line [comment-inlinemacro] {showcomments#}{passtext} [comment-blockmacro] {showcomments#}{passtext} [literal-inlinemacro] # Inline literal. {passtext} # Special word macros [emphasizedwords] {words} [monospacedwords] {words} [strongwords] {words} # Paragraph substitution. [paragraph] {title} {title%} | {title%} {title#} {empty} [admonitionparagraph] <{name}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>| # Delimited blocks. [literalblock] {title} {title#} {title%} | {title#} [listingblock] {title} {title#} {title%} | {title#} [sidebarblock-open] {title} [sidebarblock-close] [sidebarblock] template::[sidebarblock-open] | template::[sidebarblock-close] [sidebarparagraph] template::[sidebarblock-open] | template::[sidebarblock-close] [abstractblock-open] {title} [abstractblock-close] [abstractblock] template::[abstractblock-open] | template::[abstractblock-close] [abstractparagraph] template::[abstractblock-open] | template::[abstractblock-close] [openblock] | [partintroblock-open] {title} [partintroblock-close] [partintroblock] template::[partintroblock-open] | template::[partintroblock-close] [partintroparagraph] template::[partintroblock-open] | template::[partintroblock-close] [quote-open] # Common quote and verse element template. {title} # Include attribution only if either {attribution} or {citetitle} is defined. {attribution#} {attribution%}{citetitle#} {attribution} {citetitle} {attribution#} {attribution%}{citetitle#} [quote-close] [quoteblock] template::[quote-open] | template::[quote-close] [verseblock] template::[quote-open] | template::[quote-close] [quoteparagraph] template::[quote-open] | template::[quote-close] [exampleblock-open] <{title?example}{title!informalexample}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> # DocBook XSL Stylesheets custom processing instructions. {title} [exampleblock-close] [exampleblock] template::[exampleblock-open] | template::[exampleblock-close] [exampleparagraph] template::[exampleblock-open] | template::[exampleblock-close] [admonitionblock] <{name}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> {title} | # Tables. [tabletags-default] colspec= bodyrow=| headdata=| bodydata=| paragraph=| [tabletags-emphasis] paragraph=| [tabletags-header] paragraph=| [tabletags-strong] paragraph=| [tabletags-monospaced] paragraph=| [tabletags-verse] bodydata=| paragraph= [tabletags-literal] bodydata=| paragraph= [tabletags-asciidoc] paragraph= [table] <{title?table}{title!informaltable}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}{pgwide-option? pgwide="1"} frame="{frame=all}" {grid%rowsep="1" colsep="1"} rowsep="{grid@none|cols:0:1}" colsep="{grid@none|rows:0:1}" > {title} # DocBook XSL Stylesheets custom processing instructions. {colspecs} {headrows#} {headrows} {headrows#} {footrows#} {footrows} {footrows#} {bodyrows} #-------------------------------------------------------------------- # Deprecated old table definitions. # [old_tabledef-default] template=old_table colspec= bodyrow=| bodydata=| [old_table] <{title?table}{title!informaltable}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"} pgwide="0" frame="{frame=topbot}" {grid%rowsep="0" colsep="0"} rowsep="{grid@none|cols:0:1}" colsep="{grid@none|rows:0:1}" > {title} {colspecs} {headrows#} {headrows} {headrows#} {footrows#} {footrows} {footrows#} {bodyrows} # End of deprecated old table definitions. #-------------------------------------------------------------------- # Special sections. [preface] {title=} | [index] {title} | [bibliography] {title} | [glossary] {title} | [appendix] {title} | [floatingtitle] {title} [header-declarations] {toc#} {numbered#} [+docinfo] {notitle%} {doctitle} {revdate} # To ensure valid articleinfo/bookinfo when there is no AsciiDoc header. {doctitle%}{revdate%}{docdate} {authored#} {firstname} {middlename} {lastname} {email} {authored#} {authorinitials} {revnumber?{revnumber}}{revdate}{authorinitials?{authorinitials}}{revremark?{revremark}} {docinfo1,docinfo2#}{include:{docdir}/docinfo.xml} {docinfo,docinfo2#}{include:{docdir}/{docname}-docinfo.xml} # DEPRECATED: Use docinfo. {revisionhistory#}{include:{docdir}/{docname}-revhistory.xml} # DEPRECATED: Use orgname in preference to companyname. {companyname} # DEPRECATED: Use orgname in preference to corpname. {corpname} {orgname} #------------------------- # article document type #------------------------- ifdef::doctype-article[] [header] template::[header-declarations]
template::[docinfo] [footer]
[preamble] # Untitled elements between header and first section title. | [abstract] | [sect1] {title} | [sect2] {title} | [sect3] {title} | [sect4] {title} | endif::doctype-article[] #------------------------- # manpage document type #------------------------- ifdef::doctype-manpage[] [replacements] # The roff format does not substitute special characters so just print them as # text. \(C\)=(C) \(TM\)=(TM) [header] template::[header-declarations] template::[docinfo] {mantitle} {manvolnum} # Default source and manual to suppress DocBook XSL warnings. {mansource= } {manmanual= } {manversion={revnumber}} {manname1} {manname2} {manname3} {manname4} {manname5} {manname6} {manname7} {manname8} {manname9} {manpurpose} [footer] # Section macros [synopsis] | [sect1] {title} | [sect2] {title} | [sect3] {title} | endif::doctype-manpage[] #------------------------- # book document type #------------------------- ifdef::doctype-book[] [header] template::[header-declarations] template::[docinfo] [footer] [preamble] # Preamble is not allowed in DocBook book so wrap it in a preface. {title=} | [dedication] {title} | [colophon] {title} | [sect0] {title} | [sect1] {title} | [sect2] {title} | [sect3] {title} | [sect4] {title} | endif::doctype-book[] ifdef::sgml[] # # Optional DocBook SGML. # # Most of the differences between DocBook XML and DocBook SGML boils # down to the empty element syntax: SGML does not like the XML empty # element <.../> syntax, use <...> instead. # [miscellaneous] outfilesuffix=.sgml [header-declarations] [tabledef-default] colspec= [image-inlinemacro] {alt={target}} [image-blockmacro]
{title} {title%} {alt={target}} {title#}
{title%} # Inline macros [xref-inlinemacro] {0} {2%} [xref2-inlinemacro] # <> {2} {2%} [anchor-inlinemacro] [anchor2-inlinemacro] # [[id,text]] endif::sgml[] asciidoc-8.6.9/help.conf0000644000175100017510000002505412067401103015261 0ustar srackhamsrackham# AsciiDoc help file. # # INI section format, each section contains a topic. # Displayed with 'asciidoc --help sectionname' command. # # # Default help topic. # [default] Man page: asciidoc --help manpage Syntax: asciidoc --help syntax [manpage] NAME asciidoc - converts an AsciiDoc text file to HTML or DocBook SYNOPSIS asciidoc [OPTIONS] FILE DESCRIPTION The asciidoc(1) command translates the AsciiDoc text file FILE to DocBook or HTML. If FILE is - then the standard input is used. OPTIONS -a, --attribute=ATTRIBUTE Define or delete document attribute. ATTRIBUTE is formatted like NAME=VALUE. Command-line attributes take precedence over document and configuration file attributes. Alternate acceptable forms are NAME (the VALUE defaults to an empty string); NAME! (delete the NAME attribute); NAME=VALUE@ (do not override document or configuration file attributes). Values containing spaces should be enclosed in double-quote characters. This option may be specified more than once. A special attribute named trace controls the output of diagnostic information. -b, --backend=BACKEND Backend output file format: docbook45, xhtml11, html4, html5, slidy, wordpress or latex (the latex backend is experimental). You can also use the backend alias names html (aliased to xhtml11) or docbook (aliased to docbook45). Defaults to html. The --backend option is also used to manage backend plugins (see [1]PLUGIN COMMANDS). -f, --conf-file=CONF_FILE Use configuration file CONF_FILE.Configuration files processed in command-line order (after implicit configuration files). This option may be specified more than once. --doctest Run Python doctests in asciidoc module. -d, --doctype=DOCTYPE Document type: article, manpage or book. The book document type is only supported by the docbook backend. Default document type is article. -c, --dump-conf Dump configuration to stdout. --filter=FILTER Specify the name of a filter to be loaded (used to load filters that are not auto-loaded). This option may be specified more than once. The --filter option is also used to manage filter plugins (see [2]PLUGIN COMMANDS). -h, --help [TOPIC] Print help TOPIC. --help topics will print a list of help topics, --help syntax summarizes AsciiDoc syntax, --help manpage prints the AsciiDoc manpage. -e, --no-conf Exclude implicitly loaded configuration files except for those named like the input file (infile.conf and infile-backend.conf). -s, --no-header-footer Suppress document header and footer output. -o, --out-file=OUT_FILE Write output to file OUT_FILE. Defaults to the base name of input file with backend extension. If the input is stdin then the outfile defaults to stdout. If OUT_FILE is - then the standard output is used. -n, --section-numbers Auto-number HTML article section titles. Synonym for --attribute numbered. --safe Enable safe mode. Safe mode is disabled by default. AsciiDoc safe mode skips potentially dangerous scripted sections in AsciiDoc source files. --theme=THEME Specify a theme name. Synonym for --attribute theme=THEME. The --theme option is also used to manage theme plugins (see [3]PLUGIN COMMANDS). -v, --verbose Verbosely print processing information and configuration file checks to stderr. --version Print program version number. PLUGIN COMMANDS The asciidoc(1) --filter, --backend and --theme options are used to install, remove and list AsciiDoc filter, backend and theme plugins. Syntax: asciidoc OPTION install ZIP_FILE [PLUGINS_DIR] asciidoc OPTION remove PLUGIN_NAME [PLUGINS_DIR] asciidoc OPTION list asciidoc OPTION build ZIP_FILE PLUGIN_SOURCE Where: OPTION asciidoc(1) --filter, --backend or --theme option specifying the type of plugin. PLUGIN_NAME A unique plugin name containing only alphanumeric or underscore characters. ZIP_FILE A Zip file containing plugin resources, the name must start with the plugin name e.g. my_filter-1.0.zip packages filter my_filter. PLUGINS_DIR The directory containing installed plugins. Each plugin is contained in its own separate subdirectory which has the same name as the plugin. PLUGINS_DIR defaults to the $HOME/.asciidoc/filters (for filter plugins) or $HOME/.asciidoc/backends (for backend plugins) or $HOME/.asciidoc/themes (for theme plugins). PLUGIN_SOURCE The name of a directory containing the plugin source files or the name of a single source file. The plugin commands perform as follows: install Create a subdirectory in PLUGINS_DIR with the same name as the plugin then extract the ZIP_FILE into it. remove Delete the PLUGIN_NAME plugin subdirectory and all its contents from the PLUGINS_DIR. list List the names and locations of all installed filter or theme plugins (including standard plugins installed in the global configuration directory). build Create a plugin file named ZIP_FILE containing the files and subdirectories specified by PLUGIN_SOURCE. File and directory names starting with a period are skipped. EXIT STATUS 0 Success 1 Failure (syntax or usage error; configuration error; document processing failure; unexpected error). BUGS See the AsciiDoc distribution BUGS file. AUTHOR AsciiDoc was originally written by Stuart Rackham. Many people have contributed to it. RESOURCES SourceForge: [4]http://sourceforge.net/projects/asciidoc/ Main web site: [5]http://asciidoc.org/ COPYING Copyright (C) 2002-2011 Stuart Rackham. Free use of this software is granted under the terms of the GNU General Public License (GPL). [syntax] AsciiDoc Markup Syntax Summary ============================== A summary of the most commonly used markup. For a complete reference see the 'AsciiDoc User Guide'. Text formatting --------------- *bold text* (boldface font) _emphasized text_ (normally italics) 'emphasized text' +monospaced text+ (proportional font) `monospaced text` (inline literal passthrough) Document links -------------- [[id]] (define link target) <> (link to target id) link:filename#id[caption] (link to external HTML file) URLs ---- Use normal URL and email addess syntax or: http:address[caption] (link to web page) mailto:address[caption] (link to mail recipient) Images ------ image:filename[caption] (inline image) image::filename[caption] (block image) Document header --------------- The Document Title ================== author revision, date author, email, revision and date are optional. Section title underlines ------------------------ Underlined: Level 0 (document title) ======= Level 1 ------- Level 2 ~~~~~~~ Level 3 ^^^^^^^ Level 4 (bottom level) +++++++ Single line: = Level 0 = (document title) == Level 1 == === Level 2 === ==== Level 3 ==== ===== Level 4 ===== (bottom level) Paragraphs ---------- A normal paragraph. (styles: literal,verse,quote,listing, NOTE,TIP,WARNING,IMPORTANT,CAUTION) An indented literal paragraph. Delimited blocks ---------------- Delimiters must begin at left margin. ------------------- (styles: source,music,graphviz) listing block ------------------- ................... (styles: listing,verse) literal block ................... ******************* sidebar block ******************* [style, author, cite] ___________________ (styles: quote,verse) quote block ___________________ =================== (styles: NOTE,TIP,WARNING, example block IMPORTANT,CAUTION) =================== /////////////////// comment block /////////////////// +++++++++++++++++++ (styles: pass,asciimath,latexmath) passthrough block +++++++++++++++++++ [style] (styles: abstract,partintro) -- open block -- More block elements ------------------- [attributes list] .Block title // Comment line include::filename[] Tables ------ .An example table [width="40%",cols="^,2m",frame="topbot",options="header,footer"] |====================== |Column 1 |Column 2 |1 |Item 1 |2 |Item 2 |3 |Item 3 |6 |Three items |====================== Common attributes: grid: none,cols,rows,all frame: topbot,none,sides,all options: header,footer format: psv,csv,dsv valign: top,bottom,middle width: 1%..100% cols: colspec[,colspec,...] colspec: [multiplier*][align][width][style] multiplier: 1... width: 1... or 1%...100% align: [horiz][.vert] horiz: < (left), ^ (center), > (right) vert: < (top), ^ (middle), > (bottom) style: d[efault], e[mphasis], m[onospaced], a[sciidoc], s[trong], l[iteral], v[erse], h[eader] cell: [cellspec]|data cellspec: [span*|+][align][style] span: [colspan][.rowspan] colspan: 1... rowspan: 1... Bulleted lists -------------- - item text * item text ** item text *** item text **** item text ***** item text (styles: callout,bibliography) Numbered lists -------------- 1. arabic (decimal) numbering a. loweralpha numbering F. upperalpha numbering iii) lowerroman numbering IX) upperroman numbering . arabic (decimal) numbering .. loweralpha numbering ... lowerroman numbering .... upperalpha numbering ..... upperroman numbering (styles: arabic,loweralpha,upperalpha,lowerroman,upperroman) Labeled lists ------------- label:: item text label;; item text label::: item text label:::: item text (styles: horizontal,vertical,glossary,qanda,bibliograpy) More inline elements -------------------- footnote:[footnote text] (document footnote) asciidoc-8.6.9/html4.conf0000664000175100017510000003531612021466157015377 0ustar srackhamsrackham# # html4.conf # # Asciidoc HTML 4.01 configuration file. # [miscellaneous] outfilesuffix=.html [attributes] basebackend=html basebackend-html= basebackend-html4= hr=
[replacements2] # Line break. (?m)^(.*)\s\+$=\1
[replacements] ifdef::asciidoc7compatible[] # Superscripts. \^(.+?)\^=\1 # Subscripts. ~(.+?)~=\1 endif::asciidoc7compatible[] [ruler-blockmacro]
[pagebreak-blockmacro]
[pi-blockmacro] [pi-inlinemacro] template::[pi-blockmacro] [image-inlinemacro] # src attribute must be first attribute for blogpost compatibility. {data-uri%}{alt={target}} {data-uri#}{alt={target}} {link#} [image-blockmacro] {data-uri%}{alt={target}} {data-uri#}{alt={target}} {link#}

{caption={figure-caption} {counter:figure-number}. }{title}

[unfloat-blockmacro]
[indexterm-inlinemacro] # Index term. {empty} [indexterm2-inlinemacro] # Index term. # Single entry index term that is visible in the primary text flow. {1} [footnote-inlinemacro] # footnote:[].
[{0}]
[footnoteref-inlinemacro] # footnoteref:[], create reference to footnote. {2%}
[{1}]
# footnoteref:[,], create footnote with ID. {2#}
[{2}]
[callout-inlinemacro] # Callout. <{index}> # Comment line macros. [comment-inlinemacro] {showcomments#}
{passtext}
[comment-blockmacro] {showcomments#}

{passtext}

[literal-inlinemacro] # Inline literal. {passtext} # List tags. [listtags-bulleted] list={id?}{title?

{title}

}| item=
  • |
    • text=

    |

    [listtags-numbered] list={id?}{title?

    {title}

    }
      |
    item=
  • |
    • text=

    |

    [listtags-labeled] list={id?}{title?

    {title}

    }| entry= label= term=
    {strong-option?}|{strong-option?}
    item=
    |
    text=

    |

    [listtags-horizontal] list={id?}{title?

    {title}

    }|
    entry=| label={strong-option?}|{strong-option?} term=|
    item=| text=

    |

    [listtags-callout] list={id?}{title?

    {title}

    }| item=
  • |
    • text=

    |

    [listtags-qanda] list={id?}{title?

    {title}

    }| entry=
  • |
    • label= term=

    |

    item= text=

    |

    [listtags-glossary] list={id?}{title?

    {title}

    }| entry= label= term=
    |
    item=
    |
    text=

    |

    [listtags-bibliography] list={id?}{title?

    {title}

    }| item=
  • |
    • text=

    |

    [tags] # Quoted text. emphasis={1?}|{1?} strong={1?}|{1?} monospaced={1?}|{1?} singlequoted={lsquo}{1?}|{1?}{rsquo} doublequoted={ldquo}{1?}|{1?}{rdquo} unquoted={1?}|{1?} superscript={1?}|{1?} subscript={1?}|{1?} ifdef::deprecated-quotes[] # Override with deprecated quote attributes. emphasis={role?}|{role?} strong={role?}|{role?} monospaced={role?}|{role?} singlequoted={role?}{1,2,3?}{amp}#8216;|{amp}#8217;{1,2,3?}{role?} doublequoted={role?}{1,2,3?}{amp}#8220;|{amp}#8221;{1,2,3?}{role?} unquoted={role?}{1,2,3?}|{1,2,3?}{role?} superscript={role?}|{role?} subscript={role?}|{role?} endif::deprecated-quotes[] # Inline macros [http-inlinemacro] {0={name}:{target}} [https-inlinemacro] {0={name}:{target}} [ftp-inlinemacro] {0={name}:{target}} [file-inlinemacro] {0={name}:{target}} [irc-inlinemacro] {0={name}:{target}} [mailto-inlinemacro] {0={target}} [callto-inlinemacro] {0={target}} [link-inlinemacro] {0={target}} # anchor:id[text] [anchor-inlinemacro] # [[id,text]] [anchor2-inlinemacro] # [[[id]]] [anchor3-inlinemacro] [{1}] # xref:id[text] [xref-inlinemacro] {0=[{target}]} # <> [xref2-inlinemacro] {2=[{1}]} # Special word substitution. [emphasizedwords] {words} [monospacedwords] {words} [strongwords] {words} # Paragraph substitution. [paragraph] {id?}{title?{title}
    } |

    [admonitionparagraph] template::[admonitionblock] # Delimited blocks. [passthroughblock] | [listingblock]

    {title}

    
|
    [literalblock]

    {title}

    | [sidebarblock]

    {title}

    |
    [openblock]

    {title}

    | [partintroblock] template::[openblock] [abstractblock] template::[quoteblock] [quoteblock]

    {title}

    |

    {citetitle}{attribution?
    } — {attribution}

    [verseblock]

    {title}

    # Font inheritance broken in IE6. 
    |

    {citetitle}{attribution?
    } — {attribution}

    [exampleblock]
    |

    {caption={example-caption} {counter:example-number}. }{title}

    [admonitionblock]
    {data-uri%}{icons#}{caption} {data-uri#}{icons#}{caption} {icons%}

    {caption}

    {title}

    |
    [mathblock] # Here to suppress missing block warning (html4 does not include math # JavaScripts).

    {title}

    | # Tables. [tabletags-default] bodyrow=| headdata=| footdata=| bodydata=| paragraph=

    |

    [tabletags-header] paragraph=

    |

    [tabletags-emphasis] paragraph=

    |

    [tabletags-strong] paragraph=

    |

    [tabletags-monospaced] paragraph=

    |

    [tabletags-verse] bodydata=
    |
    paragraph= [tabletags-literal] bodydata=
    |
    paragraph= [tabletags-asciidoc] bodydata=
    |
    paragraph= [table] {headrows#} {headrows} {headrows#} {footrows#} {footrows} {footrows#} {bodyrows}

    {caption={table-caption} {counter:table-number}. }{title}

    #-------------------------------------------------------------------- # Deprecated old table definitions. # [miscellaneous] # Screen width in pixels. pagewidth=800 pageunits= [old_tabledef-default] template=old_table bodyrow=| headdata=| footdata=| bodydata=| [old_table]

    {caption={table-caption}}{title}

    {headrows#} {headrows} {headrows#} {footrows#} {footrows} {footrows#} {bodyrows}
    # End of deprecated old table definitions. #-------------------------------------------------------------------- [floatingtitle] {id?}{title} [preamble] # Untitled elements between header and first section title. | [sect0] {doctype-manpage%}{hr}

    {id?}{title}

    | [sect1] {doctype-manpage%}{hr} {id?}{numbered?{sectnum} }{title} | [sect2] {id?}{numbered?{sectnum} }{title} | [sect3] {id?}{numbered?{sectnum} }{title} | [sect4] {id?}{title} | [appendix] {hr} {id?}{numbered?{sectnum} }{appendix-caption} {counter:appendix-number:A}: {title} | [footer]

    template::[footer-text]

    [header-declarations] {title} {title%}{doctitle=} {docinfo1,docinfo2#}{include:{docdir}/docinfo.html} {docinfo,docinfo2#}{include:{docdir}/{docname}-docinfo.html} template::[docinfo] #-------------------------------- # article and book document types #-------------------------------- ifndef::doctype-manpage[] [header] template::[header-declarations] {notitle%}

    {doctitle}

    {doctitle#}

    {doctitle#}{author}
    {doctitle#}<{email}>
    {doctitle#}version {revnumber}{revdate?,} {doctitle#}{revdate} {doctitle#}
    {revremark} {doctitle#}

    endif::doctype-manpage[] #------------------------- # manpage document type #------------------------- ifdef::doctype-manpage[] [tags] # This is more inline with man page convention. emphasis=| vlistterm=
    |
    [header] template::[header-declarations] {hr}

    {doctitle} Manual Page

    {hr} [name]

    {manname-title}

    {manname} - {manpurpose}

    [synopsis] template::[sect1] endif::doctype-manpage[] asciidoc-8.6.9/html5.conf0000644000175100017510000005272712070136402015372 0ustar srackhamsrackham# # html5.conf # # Asciidoc configuration file. # html5 backend. # [miscellaneous] outfilesuffix=.html [attributes] basebackend=html basebackend-html= basebackend-html5= [replacements2] # Line break. (?m)^(.*)\s\+$=\1
    [replacements] ifdef::asciidoc7compatible[] # Superscripts. \^(.+?)\^=\1 # Subscripts. ~(.+?)~=\1 endif::asciidoc7compatible[] [ruler-blockmacro]
    [pagebreak-blockmacro]
    [blockdef-pass] asciimath-style=template="asciimathblock",subs=() latexmath-style=template="latexmathblock",subs=() [macros] (?u)^(?Paudio|video)::(?P\S*?)(\[(?P.*?)\])$=# # math macros. # Special characters are escaped in HTML math markup. (?su)[\\]?(?Pasciimath|latexmath):(?P\S*?)\[(?P.*?)(?asciimath|latexmath)::(?P\S*?)(\[(?P.*?)\])$=#[specialcharacters] [asciimath-inlinemacro] `{passtext}` [asciimath-blockmacro]
    {title}
    `{passtext}`
    [asciimathblock]
    {title}
    `|`
    [latexmath-inlinemacro] {passtext} [latexmath-blockmacro]
    {title}
    {passtext}
    [latexmathblock]
    {title}
    |
    [image-inlinemacro] {data-uri%}{alt={target}} {data-uri#}{alt={target}} {link#} [image-blockmacro]
    {data-uri%}{alt={target}} {data-uri#}{alt={target}} {link#}
    {caption={figure-caption} {counter:figure-number}. }{title}
    [audio-blockmacro]
    {caption=}{title}
    [video-blockmacro]
    {caption=}{title}
    [unfloat-blockmacro]
    [toc-blockmacro] template::[toc] [indexterm-inlinemacro] # Index term. {empty} [indexterm2-inlinemacro] # Index term. # Single entry index term that is visible in the primary text flow. {1} [footnote-inlinemacro] # footnote:[].
    [{0}]
     [footnoteref-inlinemacro] # footnoteref:[], create reference to footnote. {2%}
    [{1}]
     # footnoteref:[,], create footnote with ID. {2#}
    [{2}]
     [callout-inlinemacro] ifndef::icons[] <{index}> endif::icons[] ifdef::icons[] ifndef::data-uri[] {index} endif::data-uri[] ifdef::data-uri[] {index} endif::data-uri[] endif::icons[] # Comment line macros. [comment-inlinemacro] {showcomments#}
    {passtext}
    [comment-blockmacro] {showcomments#}

    {passtext}

    [literal-inlinemacro] # Inline literal. {passtext} # List tags. [listtags-bulleted] list=
    {title?
    {title}
    }
      |
    item=
  • |
    • text=

    |

    [listtags-numbered] # The start attribute is not valid XHTML 1.1 but all browsers support it. list=
    {title?
    {title}
    }
      |
    item=
  • |
    • text=

    |

    [listtags-labeled] list=
    {title?
    {title}
    }
    |
    entry= label= term=
    |
    item=
    |
    text=

    |

    [listtags-horizontal] list=
    {title?
    {title}
    }{labelwidth?}{itemwidth?}|
    label=| term=|
    entry=| item=| text=

    |

    [listtags-qanda] list=
    {title?
    {title}
    }
      |
    entry=
  • |
    • label= term=

    |

    item= text=

    |

    [listtags-callout] ifndef::icons[] list=
    {title?
    {title}
    }
      |
    item=
  • |
    • text=

    |

    endif::icons[] ifdef::icons[] list=
    {title?
    {title}
    }|
    ifndef::data-uri[] item={listindex}| endif::data-uri[] ifdef::data-uri[] item={listindex}| endif::data-uri[] text=| endif::icons[] [listtags-glossary] list=
    {title?
    {title}
    }
    |
    label= entry= term=
    |
    item=
    |
    text=

    |

    [listtags-bibliography] list=
    {title?
    {title}
    }
      |
    item=
  • |
    • text=

    |

    [tags] # Quoted text. emphasis={1?}|{1?} strong={1?}|{1?} monospaced=| singlequoted={lsquo}{1?}|{1?}{rsquo} doublequoted={ldquo}{1?}|{1?}{rdquo} unquoted={1?}|{1?} superscript={1?}|{1?} subscript={1?}|{1?} ifdef::deprecated-quotes[] # Override with deprecated quote attributes. emphasis={role?}|{role?} strong={role?}|{role?} monospaced=| singlequoted={role?}{1,2,3?}{amp}#8216;|{amp}#8217;{1,2,3?}{role?} doublequoted={role?}{1,2,3?}{amp}#8220;|{amp}#8221;{1,2,3?}{role?} unquoted={role?}{1,2,3?}|{1,2,3?}{role?} superscript={role?}|{role?} subscript={role?}|{role?} endif::deprecated-quotes[] # Inline macros [http-inlinemacro] {0={name}:{target}} [https-inlinemacro] {0={name}:{target}} [ftp-inlinemacro] {0={name}:{target}} [file-inlinemacro] {0={name}:{target}} [irc-inlinemacro] {0={name}:{target}} [mailto-inlinemacro] {0={target}} [link-inlinemacro] {0={target}} [callto-inlinemacro] {0={target}} # anchor:id[text] [anchor-inlinemacro] # [[id,text]] [anchor2-inlinemacro] # [[[id]]] [anchor3-inlinemacro] [{1}] # xref:id[text] [xref-inlinemacro] {0=[{target}]} # <> [xref2-inlinemacro] {2=[{1}]} # Special word substitution. [emphasizedwords] {words} [monospacedwords] {words} [strongwords] {words} # Paragraph substitution. [paragraph]
    {title?
    {title}
    }

    |

    [admonitionparagraph] template::[admonitionblock] # Delimited blocks. [listingblock]
    {caption=}{title}
    |
    [literalblock]
    {title}
    |
    [sidebarblock]
    {title}
    |
    [openblock]
    {title}
    |
    [partintroblock] template::[openblock] [abstractblock] template::[quoteblock] [quoteblock]
    {title}
    |
    {citetitle}{attribution?
    } — {attribution}
    [verseblock]
    {title}
    |
    {citetitle}{attribution?
    } — {attribution}
    [exampleblock]
    {caption={example-caption} {counter:example-number}. }{title}
    |
    [admonitionblock]
    {data-uri%}{icons#}{caption} {data-uri#}{icons#}{caption} {icons%}
    {caption}
    {title}
    |
    # Tables. [tabletags-default] colspec= bodyrow=| headdata=| bodydata=| paragraph=

    |

    [tabletags-header] paragraph=

    |

    [tabletags-emphasis] paragraph=

    |

    [tabletags-strong] paragraph=

    |

    [tabletags-monospaced] paragraph=

    |

    [tabletags-verse] bodydata=
    |
    paragraph= [tabletags-literal] bodydata=
    |
    paragraph= [tabletags-asciidoc] bodydata=
    |
    paragraph= [table] {colspecs} {headrows#} {headrows} {headrows#} {footrows#} {footrows} {footrows#} {bodyrows}
    {caption={table-caption} {counter:table-number}. }{title}
    #-------------------------------------------------------------------- # Deprecated old table definitions. # [miscellaneous] # Screen width in pixels. pagewidth=800 pageunits=px [old_tabledef-default] template=old_table colspec= bodyrow=| headdata=| footdata=| bodydata=| [old_table] {colspecs} {headrows#} {headrows} {headrows#} {footrows#} {footrows} {footrows#} {bodyrows}
    {caption={table-caption}}{title}
    # End of deprecated old table definitions. #-------------------------------------------------------------------- [floatingtitle] {title} [preamble] # Untitled elements between header and first section title.
    |
    # Document sections. [sect0] {title} | [sect1]
    {numbered?{sectnum} }{title}
    |
    [sect2]
    {numbered?{sectnum} }{title} |
    [sect3]
    {numbered?{sectnum} }{title} |
    [sect4]
    {title} |
    [appendix]
    {numbered?{sectnum} }{appendix-caption} {counter:appendix-number:A}: {title}
    |
    [toc]
    {toc-title}
    [header] {title} {title%}{doctitle=} ifdef::linkcss[] ifeval::["{source-highlighter}"=="pygments"] endif::[] # DEPRECATED: 'pygments' attribute. ifdef::pygments[] ifdef::toc2[] endif::linkcss[] ifndef::linkcss[] endif::linkcss[] ifndef::disable-javascript[] ifdef::linkcss[] endif::linkcss[] ifndef::linkcss[] endif::linkcss[] endif::disable-javascript[] ifdef::asciimath[] ifdef::linkcss[] endif::linkcss[] ifndef::linkcss[] endif::linkcss[] endif::asciimath[] ifdef::latexmath[] ifdef::linkcss[] endif::linkcss[] ifndef::linkcss[] endif::linkcss[] endif::latexmath[] {docinfo1,docinfo2#}{include:{docdir}/docinfo.html} {docinfo,docinfo2#}{include:{docdir}/{docname}-docinfo.html} template::[docinfo] # Article, book header. ifndef::doctype-manpage[] endif::doctype-manpage[] # Man page header. ifdef::doctype-manpage[] endif::doctype-manpage[]
    [footer]
    {disable-javascript%
    } ifdef::doctype-manpage[] [synopsis] template::[sect1] endif::doctype-manpage[] asciidoc-8.6.9/lang-cs.conf0000664000175100017510000000240412016016142015650 0ustar srackhamsrackham# # AsciiDoc Czech language configuration file. # (C) 2012 Petr Klíma # License: GNU Free Documentation License, ver. 1.3 or later version, see http://fsf.org/ [attributes] # Captions, used by (X)HTML backends. # Captions on RHS are displayed in outputs. ifdef::basebackend-html[] caution-caption=Pozor important-caption=Důležité note-caption=Poznámka tip-caption=Tip warning-caption=Varování figure-caption=Obrázek table-caption=Tabulka example-caption=Příklad toc-title=Obsah appendix-caption=Příloha # Man page NAME section title. manname-title=NAME [footer-text] Verze {revnumber}{basebackend-xhtml11?
    }{basebackend-xhtml11=
    } Poslední úprava {docdate} {doctime} endif::basebackend-html[] [specialsections] # DocBook special sections. # The regular expression on LHS is matched against source titles. ifdef::basebackend-docbook[] ifdef::doctype-article[] ^Abstrakt$=abstract endif::doctype-article[] ifdef::doctype-book[] ^Tiráž$=colophon ^Věnování$=dedication ^Předmluva$=preface endif::doctype-book[] ^Index$=index ^(Bibliografie|Reference)$=bibliography ^Glosář$=glossary ^Příloha [A-Z][:.](?P.*)$=appendix endif::basebackend-docbook[] ifdef::doctype-manpage[] (?i)^Přehled$=synopsis endif::doctype-manpage[] ������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������asciidoc-8.6.9/lang-de.conf�������������������������������������������������������������������������0000644�0001751�0001751�00000002451�11626510035�015641� 0����������������������������������������������������������������������������������������������������ustar �srackham������������������������srackham���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������# # AsciiDoc German language configuration file. # Originally written by Michael Wild # [attributes] # Left and right single and double quote characters. lsquo=‚ rsquo=‘ ldquo=„ rdquo=“ # Captions, used by (X)HTML backends. # Captions on RHS are displayed in outputs. ifdef::basebackend-html[] caution-caption=Achtung important-caption=Wichtig note-caption=Anmerkung tip-caption=Tipp warning-caption=Warnung figure-caption=Abbildung table-caption=Tabelle example-caption=Beispiel toc-title=Inhaltsverzeichnis appendix-caption=Anhang # Man page NAME section title. manname-title=NAME [footer-text] Version {revnumber}{basebackend-xhtml11?<br />}{basebackend-xhtml11=<br>} Letzte Änderung {docdate} {doctime} endif::basebackend-html[] [specialsections] # DocBook special sections. # The regular expression on LHS is matched against source titles. ifdef::basebackend-docbook[] ifdef::doctype-article[] ^Zusammenfassung$=abstract endif::doctype-article[] ifdef::doctype-book[] ^Kolophon$=colophon ^Widmung$=dedication ^Vorwort$=preface endif::doctype-book[] ^Stichwortverzeichnis$=index ^Literaturverzeichnis$=bibliography ^Glossar$=glossary ^Anhang [A-Z][:.](?P<title>.*)$=appendix endif::basebackend-docbook[] ifdef::doctype-manpage[] (?i)^ÜBERSICHT$=synopsis endif::doctype-manpage[] �����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������asciidoc-8.6.9/lang-el.conf�������������������������������������������������������������������������0000664�0001751�0001751�00000002637�11765237661�015700� 0����������������������������������������������������������������������������������������������������ustar �srackham������������������������srackham���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������# # AsciiDoc Greek language configuration file. # Originally written by Michael Dourmousoglou # [attributes] # Captions, used by (X)HTML backends. # Captions on RHS are displayed in outputs. ifdef::basebackend-html[] caution-caption=Προσοχή important-caption=Σημαντικό note-caption=Σημείωση tip-caption=Υπόδειξη warning-caption=Προειδοποίηση figure-caption=Σχήμα table-caption=Πίνακας example-caption=Παράδειγμα toc-title=Πίνακας περιεχομένων appendix-caption=Παράρτημα # Man page NAME section title. manname-title=ΌΝΟΜΑ [footer-text] Έκδοση {revnumber}{basebackend-xhtml11?<br />}{basebackend-xhtml11=<br>} Τελευταία αναθεώρηση {docdate} {doctime} endif::basebackend-html[] [specialsections] # DocBook special sections. # The regular expression on LHS is matched against source titles. ifdef::basebackend-docbook[] ifdef::doctype-article[] ^Περίληψη$=abstract endif::doctype-article[] ifdef::doctype-book[] ^Κολοφώνας$=colophon ^Αφιέρωση$=dedication ^Πρόλογος$=preface endif::doctype-book[] ^Ευρετήριο$=index ^(Βιβλιογραφία|Αναφορές)$=bibliography ^Γλωσσάρι÷$=glossary ^Παράρτημα [Α-Ω][:.](?P<title>.*)$=appendix endif::basebackend-docbook[] ifdef::doctype-manpage[] (?i)^Σύνοψη$=synopsis endif::doctype-manpage[] �������������������������������������������������������������������������������������������������asciidoc-8.6.9/lang-en.conf�������������������������������������������������������������������������0000644�0001751�0001751�00000002175�11520077352�015661� 0����������������������������������������������������������������������������������������������������ustar �srackham������������������������srackham���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������# # AsciiDoc English language configuration file. # [attributes] # Captions, used by (X)HTML backends. # Captions on RHS are displayed in outputs. ifdef::basebackend-html[] caution-caption=Caution important-caption=Important note-caption=Note tip-caption=Tip warning-caption=Warning figure-caption=Figure table-caption=Table example-caption=Example toc-title=Table of Contents appendix-caption=Appendix # Man page NAME section title. manname-title=NAME [footer-text] Version {revnumber}{basebackend-xhtml11?<br />}{basebackend-xhtml11=<br>} Last updated {docdate} {doctime} endif::basebackend-html[] [specialsections] # DocBook special sections. # The regular expression on LHS is matched against source titles. ifdef::basebackend-docbook[] ifdef::doctype-article[] ^Abstract$=abstract endif::doctype-article[] ifdef::doctype-book[] ^Colophon$=colophon ^Dedication$=dedication ^Preface$=preface endif::doctype-book[] ^Index$=index ^(Bibliography|References)$=bibliography ^Glossary$=glossary ^Appendix [A-Z][:.](?P<title>.*)$=appendix endif::basebackend-docbook[] ifdef::doctype-manpage[] (?i)^SYNOPSIS$=synopsis endif::doctype-manpage[] ���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������asciidoc-8.6.9/lang-es.conf�������������������������������������������������������������������������0000644�0001751�0001751�00000002415�11626510035�015660� 0����������������������������������������������������������������������������������������������������ustar �srackham������������������������srackham���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������# # AsciiDoc Spanish language configuration file. # [attributes] #TODO: Left and right single and double quote characters. # Captions, used by (X)HTML backends. # Captions on RHS are displayed in outputs. ifdef::basebackend-html[] caution-caption=Atención important-caption=Importante note-caption=Nota tip-caption=Sugerencia warning-caption=Aviso figure-caption=Figura table-caption=Tabla example-caption=Ejemplo toc-title=Tabla de contenidos appendix-caption=Apéndice # Man page NAME section title. manname-title=NOMBRE DE REFERENCIA [footer-text] #TODO: Translation of 'Version' and 'Last updated'. Version {revnumber}{basebackend-xhtml11?<br />}{basebackend-xhtml11=<br>} Last updated {docdate} {doctime} endif::basebackend-html[] [specialsections] # DocBook special sections. # The regular expression on LHS is matched against source titles. ifdef::basebackend-docbook[] ifdef::doctype-article[] ^Resumen$=abstract endif::doctype-article[] ifdef::doctype-book[] ^Colofón$=colophon ^Dedicación$=dedication ^Prefacio$=preface endif::doctype-book[] ^Índice$=index ^(Bibliografía|Referencias)$=bibliography ^Glosario$=glossary ^Apéndice [A-Z][:.](?P<title>.*)$=appendix endif::basebackend-docbook[] ifdef::doctype-manpage[] (?i)^SINOPSIS$=synopsis endif::doctype-manpage[] ���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������asciidoc-8.6.9/lang-fr.conf�������������������������������������������������������������������������0000644�0001751�0001751�00000002426�11626510035�015662� 0����������������������������������������������������������������������������������������������������ustar �srackham������������������������srackham���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������# # AsciiDoc French language configuration file. # Originally written by Yves-Alexis Perez # [attributes] # Left and right single and double quote characters. ldquo=« rdquo=» # Captions, used by (X)HTML backends. # Captions on RHS are displayed in outputs. ifdef::basebackend-html[] caution-caption=Avertissement important-caption=Important note-caption=Note tip-caption=Astuce warning-caption=Attention figure-caption=Figure table-caption=Tableau example-caption=Exemple toc-title=Table des matières appendix-caption=Appendice # Man page NAME section title. manname-title=NOM [footer-text] Version {revnumber}{basebackend-xhtml11?<br />}{basebackend-xhtml11=<br>} Dernière mise à jour {docdate} {doctime} endif::basebackend-html[] [specialsections] # DocBook special sections. # The regular expression on LHS is matched against source titles. ifdef::basebackend-docbook[] ifdef::doctype-article[] ^Résumé$=abstract endif::doctype-article[] ifdef::doctype-book[] ^Colophon$=colophon ^Dédicace$=dedication ^Préface$=preface endif::doctype-book[] ^Index$=index ^(Bibliographie|Références)$=bibliography ^Glossaire$=glossary ^Appendice [A-Z][:.](?P<title>.*)$=appendix endif::basebackend-docbook[] ifdef::doctype-manpage[] (?i)^SYNOPSIS$=synopsis endif::doctype-manpage[] ������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������asciidoc-8.6.9/lang-hu.conf�������������������������������������������������������������������������0000644�0001751�0001751�00000002406�11626510035�015665� 0����������������������������������������������������������������������������������������������������ustar �srackham������������������������srackham���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������# # AsciiDoc Hungarian language configuration file. # Originally written by Miklos Vajna # [attributes] #TODO: Left and right single and double quote characters. # Captions, used by (X)HTML backends. # Captions on RHS are displayed in outputs. ifdef::basebackend-html[] caution-caption=Figyelmeztetés important-caption=Fontos note-caption=Megjegyzés tip-caption=Tipp warning-caption=Figyelem figure-caption=Ábra table-caption=Táblázat example-caption=Példa toc-title=Tartalomjegyzék appendix-caption=függelék # Man page NAME section title. manname-title=NÉV [footer-text] Verzió {revnumber}{basebackend-xhtml11?<br />}{basebackend-xhtml11=<br>} Utolsó frissítés: {docdate} {doctime} endif::basebackend-html[] [specialsections] # DocBook special sections. # The regular expression on LHS is matched against source titles. ifdef::basebackend-docbook[] ifdef::doctype-article[] ^Kivonat$=abstract endif::doctype-article[] ifdef::doctype-book[] ^Utószó$=colophon ^Ajánlás$=dedication ^Előszó$=preface endif::doctype-book[] ^Index$=index ^(Bibliográfia|Hivatkozások)$=bibliography ^Szójegyzék$=glossary ^[A-Z] függelék[:.](?P<title>.*)$=appendix endif::basebackend-docbook[] ifdef::doctype-manpage[] (?i)^ÁTTEKINTÉS$=synopsis endif::doctype-manpage[] ����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������asciidoc-8.6.9/lang-it.conf�������������������������������������������������������������������������0000644�0001751�0001751�00000002367�11626510035�015673� 0����������������������������������������������������������������������������������������������������ustar �srackham������������������������srackham���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������# # AsciiDoc Italian language configuration file. # [attributes] #TODO: Left and right single and double quote characters. # Captions, used by (X)HTML backends. # Captions on RHS are displayed in outputs. ifdef::basebackend-html[] caution-caption=Attenzione important-caption=Importante note-caption=Nota tip-caption=Suggerimento warning-caption=Avvertenza figure-caption=Figura table-caption=Tabella example-caption=Esempio toc-title=Sommario appendix-caption=Appendice # Man page NAME section title. manname-title=NOME [footer-text] #TODO: Translation of 'Version' and 'Last updated'. Version {revnumber}{basebackend-xhtml11?<br />}{basebackend-xhtml11=<br>} Last updated {docdate} {doctime} endif::basebackend-html[] [specialsections] # DocBook special sections. # The regular expression on LHS is matched against source titles. ifdef::basebackend-docbook[] ifdef::doctype-article[] ^Abstract$=abstract endif::doctype-article[] ifdef::doctype-book[] ^Colofone$=colophon ^Dedica$=dedication ^Prefazione$=preface endif::doctype-book[] ^Index$=index ^(Bibliografia|Riferimenti)$=bibliography ^Glossario$=glossary ^Appendice [A-Z][:.](?P<title>.*)$=appendix endif::basebackend-docbook[] ifdef::doctype-manpage[] (?i)^SINOSSI$=synopsis endif::doctype-manpage[] �������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������asciidoc-8.6.9/lang-nl.conf�������������������������������������������������������������������������0000644�0001751�0001751�00000002471�11626510035�015664� 0����������������������������������������������������������������������������������������������������ustar �srackham������������������������srackham���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������# # AsciiDoc Dutch language configuration file. # Originally written by Dag Wieërs # [attributes] # Left and right single and double quote characters. lsquo=‚ rsquo=‘ ldquo=„ rdquo=“ # Captions, used by (X)HTML backends. # Captions on RHS are displayed in outputs. ifdef::basebackend-html[] caution-caption=Let op important-caption=Belangrijk note-caption=Opmerking tip-caption=Tip warning-caption=Waarschuwing figure-caption=Figuur table-caption=Tabel example-caption=Voorbeeld toc-title=Inhoudsopgave appendix-caption=Bijlage # Man page NAME section title. manname-title=NAME [footer-text] Versie {revnumber}{basebackend-xhtml11?<br />}{basebackend-xhtml11=<br>} Laatst bijgewerkt {docdate} {doctime} endif::basebackend-html[] [specialsections] # DocBook special sections. # The regular expression on LHS is matched against source titles. ifdef::basebackend-docbook[] ifdef::doctype-article[] ^Samenvatting$=abstract endif::doctype-article[] ifdef::doctype-book[] ^Colofon$=colophon ^Opdracht$=dedication ^Voorwoord$=preface endif::doctype-book[] ^Register$=index ^Literatuurlijst$=bibliography ^Woordenlijst$=glossary ^Bijlage [A-Z][:.](?P<title>.*)$=appendix endif::basebackend-docbook[] ifdef::doctype-manpage[] #TODO: Translation of 'SYNOPSIS'. (?i)^SYNOPSIS$=synopsis endif::doctype-manpage[] �������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������asciidoc-8.6.9/lang-pt-BR.conf����������������������������������������������������������������������0000644�0001751�0001751�00000002451�11626510035�016175� 0����������������������������������������������������������������������������������������������������ustar �srackham������������������������srackham���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������# # AsciiDoc Portugues language configuration file. # Originally written by Thiago Farina # [attributes] #TODO: Left and right single and double quote characters. # Captions, used by (X)HTML backends. # Captions on RHS are displayed in outputs. ifdef::basebackend-html[] caution-caption=Atenção important-caption=Importante note-caption=Nota tip-caption=Sugestão warning-caption=Aviso figure-caption=Figura table-caption=Tabela example-caption=Exemplo toc-title=Tabela de conteúdos appendix-caption=Appêndice # Man page NAME section title. manname-title=NOME [footer-text] #TODO: Translation of 'Version' and 'Last updated'. Version {revnumber}{basebackend-xhtml11?<br />}{basebackend-xhtml11=<br>} Last updated {docdate} {doctime} endif::basebackend-html[] [specialsections] # DocBook special sections. # The regular expression on LHS is matched against source titles. ifdef::basebackend-docbook[] ifdef::doctype-article[] ^Resumo$=abstract endif::doctype-article[] ifdef::doctype-book[] ^Cólofon$=colophon ^Dedicação$=dedication ^Prefácio$=preface endif::doctype-book[] ^Índice$=index ^(Bibliografia|Referências)$=bibliography ^Glossário$=glossary ^Appêndice [A-Z][:.](?P<title>.*)$=appendix endif::basebackend-docbook[] ifdef::doctype-manpage[] (?i)^SINOPSE$=synopsis endif::doctype-manpage[] �����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������asciidoc-8.6.9/lang-ro.conf�������������������������������������������������������������������������0000664�0001751�0001751�00000002340�12016047631�015671� 0����������������������������������������������������������������������������������������������������ustar �srackham������������������������srackham���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������# # AsciiDoc Romanian language configuration file. # Originally written by Vitalie Lazu # [attributes] # Left and right single and double quote characters. ldquo=„ rdquo=” # Captions, used by (X)HTML backends. # Captions on RHS are displayed in outputs. ifdef::basebackend-html[] caution-caption=Precauție important-caption=Important note-caption=Notă tip-caption=Sfat warning-caption=Anteție figure-caption=Figură table-caption=Tabela example-caption=Exemplu toc-title=Cuprins appendix-caption=Apendix # Man page NAME section title. manname-title=NUME [footer-text] Versiunea {revnumber}{basebackend-xhtml11?<br />}{basebackend-xhtml11=<br>} Ultima actualizare {docdate} {doctime} endif::basebackend-html[] [specialsections] # DocBook special sections. # The regular expression on LHS is matched against source titles. ifdef::basebackend-docbook[] ifdef::doctype-article[] ^Adnotație$=abstract endif::doctype-article[] ifdef::doctype-book[] ^Casetă$=colophon ^Dedicare$=dedication ^Prefață$=preface endif::doctype-book[] ^Index$=index ^Bibliografia$=bibliography ^Glosar$=glossary ^Anexa [A-Z][:.](?P<title>.*)$=appendix endif::basebackend-docbook[] ifdef::doctype-manpage[] (?i)^REZUMAT$=synopsis endif::doctype-manpage[] ������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������asciidoc-8.6.9/lang-ru.conf�������������������������������������������������������������������������0000644�0001751�0001751�00000002754�11723015156�015707� 0����������������������������������������������������������������������������������������������������ustar �srackham������������������������srackham���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������# # AsciiDoc Russian language configuration file. # Originally written by Artem Zolochevskiy # [attributes] # Left and right single and double quote characters. ldquo=« rdquo=» # Captions, used by (X)HTML backends. # Captions on RHS are displayed in outputs. ifdef::basebackend-html[] caution-caption=Предостережение important-caption=Важно note-caption=Замечание tip-caption=Подсказка warning-caption=Внимание figure-caption=Рисунок table-caption=Таблица example-caption=Пример toc-title=Содержание appendix-caption=Приложение # Man page NAME section title. manname-title=ИМЯ [footer-text] Редакция {revnumber}{basebackend-xhtml11?<br />}{basebackend-xhtml11=<br>} Последнее обновление {docdate} {doctime} endif::basebackend-html[] [specialsections] # DocBook special sections. # The regular expression on LHS is matched against source titles. ifdef::basebackend-docbook[] ifdef::doctype-article[] ^Аннотация$=abstract endif::doctype-article[] ifdef::doctype-book[] ^Колофон$=colophon ^Посвящение$=dedication ^Введение$=preface endif::doctype-book[] ^Предметный указатель$=index ^Библиография$=bibliography ^Словарь терминов$=glossary ^Приложение [A-Z][:.](?P<title>.*)$=appendix endif::basebackend-docbook[] ifdef::doctype-manpage[] (?i)^ОБЗОР$=synopsis endif::doctype-manpage[] ��������������������asciidoc-8.6.9/lang-uk.conf�������������������������������������������������������������������������0000644�0001751�0001751�00000002745�11523047565�015707� 0����������������������������������������������������������������������������������������������������ustar �srackham������������������������srackham���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������# # AsciiDoc Ukrainian language configuration file. # Originally written by Oleksandr Lavrushchenko # [attributes] # Left and right single and double quote characters. ldquo=« rdquo=» # Captions, used by (X)HTML backends. # Captions on RHS are displayed in outputs. ifdef::basebackend-html[] caution-caption=Попередження important-caption=Важливо note-caption=Зауваження tip-caption=Підказка warning-caption=Увага figure-caption=Рисунок table-caption=Таблиця example-caption=Приклад toc-title=Зміст appendix-caption=Додаток # Man page NAME section title. manname-title=НАЗВА [footer-text] #TODO: Translation of 'Version' and 'Last updated'. Version {revnumber}{basebackend-xhtml11?<br />}{basebackend-xhtml11=<br>} Last updated {docdate} {doctime} endif::basebackend-html[] [specialsections] # DocBook special sections. # The regular expression on LHS is matched against source titles. ifdef::basebackend-docbook[] ifdef::doctype-article[] ^Анотація$=abstract endif::doctype-article[] ifdef::doctype-book[] ^Колофон$=colophon ^Присвячення$=dedication ^Вступ$=preface endif::doctype-book[] ^Предметний покажчик$=index ^Бібліографія$=bibliography ^Словник термінів$=glossary ^Додаток [А-Я][:.](?P<title>.*)$=appendix endif::basebackend-docbook[] ifdef::doctype-manpage[] (?i)^ОГЛЯД$=synopsis endif::doctype-manpage[] ���������������������������asciidoc-8.6.9/latex.conf���������������������������������������������������������������������������0000644�0001751�0001751�00000047574�11660032741�015467� 0����������������������������������������������������������������������������������������������������ustar �srackham������������������������srackham���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������# # latex.conf # # Asciidoc configuration file. # latex backend, generates LaTeX conformant markup. # # Originally created by Benjamin Klum, later modified by Geoff Eddy. [titles] subs=quotes,replacements,attributes,macros,specialcharacters,replacements2 # The listing block uses a LaTeX verbatim environment where special characters don't need to be escaped. # Hence only "callouts" substitution should be applied. [blockdef-listing] subs=callouts [attributes] basebackend=latex basebackend-latex= latex-table-rowlimit=20 latex-use-bibliography-environment! latex-indent-paragraphs! latex-recognize-escaped-unicode! latex-use-custom-list-items! latex-use-colored-tables! latex-use-running-title-headings! latex-use-colored-sidebar-blocks! [miscellaneous] subsnormal=quotes,specialwords,replacements,attributes,macros,specialcharacters,replacements2 #subsnormal=quotes,specialwords,replacements,attributes,macros,passthroughs,specialcharacters,replacements2 subsverbatim=callouts,specialcharacters outfilesuffix=.tex # Screen width in pixels. pagewidth=418 pageunits=pt [specialcharacters] {=\{{} }=\}{} \=\textbackslash{} $=\${} <=\textless{} >=\textgreater{} &=\&{} _=\_{} %=\%{} \#=\#{} ^=\textasciicircum{} ~=\textasciitilde{} |=\textbar{} "=\textquotedbl{} [macros] # I needed to rewrite some regular expressions because '<' and '>' have not been escaped to '<' and '>' # Callout [\\]?<(?P<index>\d+)>=callout # Link: <<id,text>> (?su)[\\]?<<(?P<attrlist>[\w"].*?)>>=xref2 [replacements] # Line break. (?m)^(.*)\s\+$=\1 !..backslash..!newline!..braceleft..!!..braceright..! # -- Spaced em dashes (entity reference —) (^|[^-\\])--($|[^-])=\1--\2 # (C) Copyright (entity reference ©) (?<!\\)\(C\)=!..backslash..!textcopyright!..braceleft..!!..braceright..! \\\(C\)=(C) # (R) registered trade mark (entity reference ® (?<!\\)\(R\)=!..backslash..!textregistered!..braceleft..!!..braceright..! \\\(R\)=(R) # (TM) Trademark (entity reference ™) (?<!\\)\(TM\)=!..backslash..!texttrademark!..braceleft..!!..braceright..! \\\(TM\)=(TM) # ... Ellipsis (entity reference …) (?<!\\)\.\.\.=!..backslash..!dots!..braceleft..!!..braceright..! \\\.\.\.=... # Recognize escaped unicode characters # FIXME: these should be uncommented, but then there are encoding # problems. #&#([0-9]*);=!..backslash..!unichar!..braceleft..!\1!..braceright..! #&#x([0123456789abcdefABCDEF]*);=!..backslash..!unichar!..braceleft..!{eval:0x\1}!..braceright..! # -> right arrow ->=!..backslash..!textrightarrow!..braceleft..!!..braceright..! # => right double arrow (have to enter math mode) =>=!..dollar..!!..backslash..!Rightarrow!..braceleft..!!..braceright..!!..dollar..! # <- left arrow <-=!..backslash..!textleftarrow!..braceleft..!!..braceright..! # <= left double arrow (have to enter math mode) <\==!..dollar..!!..backslash..!Leftarrow!..braceleft..!!..braceright..!!..dollar..! # --> long right arrow (have to enter math mode) -->=!..backslash..!textrightarrow!..braceleft..!!..braceright..! # ==> long right double arrow (have to enter math mode) =\=>=!..dollar..!!..backslash..!Rightarrow!..braceleft..!!..braceright..!!..dollar..! # <-- long left arrow (have to enter math mode) <--=!..backslash..!textleftarrow!..braceleft..!!..braceright..! # <== long left double arrow (have to enter math mode) <\=\==!..dollar..!!..backslash..!Leftarrow!..braceleft..!!..braceright..!!..dollar..! # apostrophe (\w)'(\w)=\1'\2 [quotes] #``|''= #`|'= `=monospaced [replacements2] !..braceleft..!={ !..braceright..!=} !..backslash..!=\\ !..dollar..!=$ !..lessthan..!=< !..greaterthan..!=> !..amp..!=& !..underline..!=_ !..percent..!=% !..sharp..!=# !..circum..!=^ !..tilde..!=~ !..bar..!=| !..doublequote..!=" # Ruler is interpreted as a page break. [ruler-blockmacro] \clearpage [image-inlinemacro] !..backslash..!href!..braceleft..!{link}!..braceright..!!..braceleft..!!..percent..! !..backslash..!includegraphics[{scale?scale={scale},}{width?width={width}pt,}{height? height={height}pt}]!..braceleft..!{target}!..braceright..! {link#}!..braceright..! [image-blockmacro] \begin\{figure\} \hypertarget\{{id}\}\{\} \caption\{{title}\} \href\{{link}\}\{% \includegraphics[{scale?scale={scale},}{width?width={width}pt,}{height? height={height}pt}]\{{target}\}% \label\{{id}\} {link#}\} \end\{figure\} [indexterm-inlinemacro] # Inline index term. !..backslash..!index!..braceleft..!{1}{2?!{2}}{3?!{3}}!..braceright..! [indexterm2-inlinemacro] # Inline index term. # Single entry index term that is visible in the primary text flow. !..backslash..!index!..braceleft..!{1}!..braceright..!{1} [footnote-inlinemacro] # Inline footnote. !..backslash..!footnote!..braceleft..!{0}!..braceright..! [footnoteref-inlinemacro] [callout-inlinemacro] # Inline callout. <{index}> [literal-inlinemacro] [listtags-bulleted] list={title?\minisec\{{title}\}} {id?\label\{{id}\}\hypertarget\{{id}\}\{\}} \begin\{itemize\}|\end\{itemize\} item=\item%| text=| [listtags-numbered] list={title?\minisec\{{title}\}} {id?\label\{{id}\}\hypertarget\{{id}\}\{\}} \begin\{enumerate\}|\end\{enumerate\} item=\item%| text=| [listtags-labeled] list={title?\minisec\{{title}\}} \par{id?\label\{{id}\}\hypertarget\{{id}\}\{\}} | item=\begin\{quote\}|\end\{quote\} text=| term=\noindent\textbf\{%|\} entry= label= [listtags-horizontal] list={title?\minisec\{{title}\}} {id?\label\{{id}\}\hypertarget\{{id}\}\{\}} \begin\{description\}|\end\{description\} item= text=| term=\item[%|] entry= label= [listtags-callout] list={title?\minisec\{{title}\}} {id?\label\{{id}\}\hypertarget\{{id}\}\{\}} \begin\{enumerate\}|\end\{enumerate\} item=\item%| text=| [listtags-qanda] list={title?\minisec\{{title}\}} {id?\label\{{id}\}\hypertarget\{{id}\}\{\}} \begin\{enumerate\}|\end\{enumerate\} item=\begin\{quotation\}|\end\{quotation\} text=| term=| entry=\item%| label= [listtags-glossary] list={title?\minisec\{{title}\}} {id?\label\{{id}\}\hypertarget\{{id}\}\{\}} \begin\{enumerate\}|\end\{enumerate\} item=\item%| text=| term=\item%| entry= label= [listtags-bibliography] list=biblist={title?\minisec\{{title}\}} {id?\label\{{id}\}\hypertarget\{{id}\}\{\}} \begin\{description\} | \end\{description\} item=| text=| [tags] superscript=!..backslash..!textsuperscript!..braceleft..!|!..braceright..! subscript=!..backslash..!textsubscript!..braceleft..!|!..braceright..! singlequoted=``|'' doublequoted=`|' # Quoted text. emphasis=!..backslash..!emph!..braceleft..!|!..braceright..! strong=!..backslash..!textbf!..braceleft..!|!..braceright..! monospaced=!..backslash..!texttt!..braceleft..!|!..braceright..! doublequoted=!..backslash..!{language!textquotedblleft}{language?{language@.german:glqq}}{language?{language@english:textquotedblleft}}!..braceleft..!!..braceright..!|!..backslash..!{language?{language@.german:grqq}}{language?{language@english:textquotedblright}}{language!textquotedblright}!..braceleft..!!..braceright..! unquoted=| # $$ inline passthrough. $$passthrough=| # Inline macros [http-inlinemacro] !..backslash..!href!..braceleft..!{name}:{target}!..braceright..!!..braceleft..!{0={name}:{target}}!..braceright..! [https-inlinemacro] !..backslash..!href!..braceleft..!{name}:{target}!..braceright..!!..braceleft..!{0={name}:{target}}!..braceright..! [ftp-inlinemacro] !..backslash..!href!..braceleft..!{name}:{target}!..braceright..!!..braceleft..!{0={name}:{target}}!..braceright..! [file-inlinemacro] !..backslash..!href!..braceleft..!{name}:{target}!..braceright..!!..braceleft..!{0={name}:{target}}!..braceright..! [mailto-inlinemacro] !..backslash..!href!..braceleft..!{name}:{target}!..braceright..!!..braceleft..!{0={target}}!..braceright..! [callto-inlinemacro] !..backslash..!href!..braceleft..!{name}:{target}!..braceright..!!..braceleft..!{0={target}}!..braceright..! [link-inlinemacro] !..backslash..!href!..braceleft..!{target}!..braceright..!!..braceleft..!{0={target}}!..braceright..! # anchor:id[text] [anchor-inlinemacro] !..backslash..!label!..braceleft..!{target}!..braceright..!!..backslash..!hypertarget!..braceleft..!{target}!..braceright..!!..braceleft..!{0={target}}!..braceright..! # [[id,text]] [anchor2-inlinemacro] !..backslash..!label!..braceleft..!{1}!..braceright..!!..backslash..!hypertarget!..braceleft..!{1}!..braceright..!!..braceleft..!{2={1}}!..braceright..! # [[[id]]] [anchor3-inlinemacro] {latex-use-bibliography-environment?!..backslash..!bibitem!..braceleft..!{1}!..braceright..!} {latex-use-bibliography-environment!!..backslash..!item[{1}]} !..backslash..!label!..braceleft..!{1}!..braceright..!!..backslash..!hypertarget!..braceleft..!{1}!..braceright..!!..braceleft..!!..braceright..! # xref:id[text] [xref-inlinemacro] {style#}{style$page:!..backslash..!pageref!..braceleft..!{target}!..braceright..!} {style#}{style$autoref:!..backslash..!autoref!..braceleft..!{target}!..braceright..!} {style#}{style$ref:!..backslash..!ref!..braceleft..!{target}!..braceright..!} {style#}{latex-use-bibliography-environment#}{style$cite:!..backslash..!cite!..braceleft..!{target}!..braceright..!} {style#}{latex-use-bibliography-environment%}{style$cite:!..backslash..!hyperlink!..braceleft..!{target}!..braceright..!!..braceleft..!{0=[{target}]}!..braceright..!} {style%}!..backslash..!hyperlink!..braceleft..!{target}!..braceright..!!..braceleft..!{0=[{target}]}!..braceright..! # <<id,text>> [xref2-inlinemacro] {3#}{3$page:!..backslash..!pageref!..braceleft..!{1}!..braceright..!} {3#}{3$autoref:!..backslash..!autoref!..braceleft..!{1}!..braceright..!} {3#}{3$ref:!..backslash..!ref!..braceleft..!{1}!..braceright..!} {3#}{latex-use-bibliography-environment#}{3$cite:!..backslash..!cite!..braceleft..!{1}!..braceright..!} {3#}{latex-use-bibliography-environment%}{3$cite:!..backslash..!hyperlink!..braceleft..!{1}!..braceright..!!..braceleft..!{2=[{1}]}!..braceright..!} {3%}!..backslash..!hyperlink!..braceleft..!{1}!..braceright..!!..braceleft..!{2=[{1}]}!..braceright..! # Special word substitution. [emphasizedwords] !..backslash..!emph!..braceleft..!{words}!..braceright..! [monospacedwords] !..backslash..!texttt!..braceleft..!{words}!..braceright..! [strongwords] !..backslash..!textbf!..braceleft..!{words}!..braceright..! # Paragraph substitution. [paragraph] {title%} \par{latex-indent-paragraphs!\noindent{}} {title#} \paragraph\{{title}\} \label\{{id}\}\hypertarget\{{id}\}\{\} | [literalparagraph] # The literal block employs the same markup. template::[literalblock] [verseparagraph] # The verse block employs the same markup. template::[verseblock] [admonitionparagraph] # The admonition block employs the same markup. template::[admonitionblock] # Delimited blocks. [passthroughblock] | # FIXME: we get SPURIOUS TEXT at the beginning, but can't delete it. # Putting "[]" after the \begin{lstlisting} in the LaTeX output works, # but inserting the same "[]" below doesn't. [listingblock] \\minisec\{{caption=Listing: }{title}\} \label\{{id}\}\hypertarget\{{id}\}\{\} \begin\{verbatim\}|\end\{verbatim\} % FIXXME: dirty hack to circumvent missing \n after verbatim [literalblock] \minisec\{{title}\} \label\{{id}\}\hypertarget\{{id}\}\{\} \begin\{alltt\} | \end\{alltt\} [verseblock] \minisec\{{title}\} \label\{{id}\}\hypertarget\{{id}\}\{\} \begin\{alltt\} \normalfont\{\} | \end\{alltt\} [sidebarblock] \label\{{id}\}\hypertarget\{{id}\}\{\} \par\noindent{} ifndef::latex-use-colored-sidebar-blocks[] \setlength\{\tabcolsep\}\{0pt\} \rowcolors\{1\}\{\}\{\} \begin\{tabular\}\{l>\{\columncolor[gray]\{.75\}\}rcl\} \hspace*\{0pt\} & \hspace*\{8pt\} & \hspace*\{16pt\} & \begin\{minipage\}\{4in\} endif::latex-use-colored-sidebar-blocks[] ifdef::latex-use-colored-sidebar-blocks[] \fcolorbox\{SidebarBorderColor\}\{SidebarBackgroundColor\}\{\parbox\{\textwidth\}\{ endif::latex-use-colored-sidebar-blocks[] \minisec\{{title}\} | ifdef::latex-use-colored-sidebar-blocks[] \} \} endif::latex-use-colored-sidebar-blocks[] ifndef::latex-use-colored-sidebar-blocks[] \end\{minipage\} \end\{tabular\} endif::latex-use-colored-sidebar-blocks[] \bigskip [quoteblock] \minisec\{{title}\} \label\{{id}\}\hypertarget\{{id}\}\{\} \begin\{quote\} | \end\{quote\} \begin\{flushright\} {citetitle} \\ -- {attribution} \end\{flushright\} [exampleblock] \minisec\{{caption=}{title}\} \label\{{id}\}\hypertarget\{{id}\}\{\} \begin\{quotation\} | \end\{quotation\} [admonitionblock] \begin\{addmargin*\}[0em]\{0em\} \label\{{id}\}\hypertarget\{{id}\}\{\} \begin\{minipage\}\{\linewidth\} {icons#} \includegraphics\{{icon={iconsdir}/{name}.png}\} {icons%} \minisec\{{caption}\} \rule\{\linewidth\}\{2pt\} \par\{\}\noindent\{\}|\par\{\}\noindent\{\}% \rule[.25\baselineskip]\{\linewidth\}\{2pt\} \end\{minipage\} \end\{addmargin*\} # Bibliography list. # Same as numbered list. [listdef-bibliography] listtag=biblist itemtag=biblistitem texttag=biblisttext # Glossary list. # Same as labeled list. [listdef-glossary] listtag=vlist itemtag=vlistitem texttag=vlisttext entrytag=vlistentry labeltag=vlistterm # Tables. # FIXME: no lines! [tabletags-monospaced] [tabletags-strong] [tabletags-verse] [tabletags-literal] [tabletags-emphasis] [tabletags-asciidoc] #[tabledef-default] [tabletags-default] #template=table colspec=>\{{colalign@left:\\raggedright}{colalign@center:\\centering}{colalign@right:\\raggedleft}\}p\{ {colwidth}pt \} bodyrow=| \tabularnewline headdata=\{\bfseries\{\}|\} {colnumber@{colcount}::&} footdata=\{\bfseries\{\}|\} {colnumber@{colcount}::&} bodydata=| {colnumber@{colcount}:%:&} paragraph= [tabletags-header] [table] ifdef::latex-use-colored-tables[] \rowcolors\{1\}\{TableEvenColor\}\{TableOddColor\} \setlength\arrayrulewidth\{1.5pt\} \arrayrulecolor\{TableBorderColor\} endif::latex-use-colored-tables[] {eval:{rowcount}{gt}{latex-table-rowlimit}} \begin\{longtable\}\{ {eval:{rowcount}{gt}{latex-table-rowlimit}} {frame$all|sides:|} {eval:{rowcount}{gt}{latex-table-rowlimit}} {colspecs} {eval:{rowcount}{gt}{latex-table-rowlimit}} {frame$all|sides:|} {eval:{rowcount}{gt}{latex-table-rowlimit}} \} {eval:{rowcount}{gt}{latex-table-rowlimit}} \hypertarget\{{id}\}\{\} {eval:{rowcount}{gt}{latex-table-rowlimit}} \caption\{{title}\} {eval:{rowcount}{gt}{latex-table-rowlimit}} {frame$all|topbot:\hline} {eval:{rowcount}{gt}{latex-table-rowlimit}} {headrows} {eval:{rowcount}{gt}{latex-table-rowlimit}} {headrows#} \endhead {eval:{rowcount}{gt}{latex-table-rowlimit}} {footrows} {eval:{rowcount}{gt}{latex-table-rowlimit}} {footrows#} \endlastfoot {eval:{rowcount}{gt}{latex-table-rowlimit}} {eval:{rowcount}{gt}{latex-table-rowlimit}} {bodyrows} {eval:{rowcount}{gt}{latex-table-rowlimit}} {frame$all|topbot:\hline} {eval:{rowcount}{gt}{latex-table-rowlimit}} \label\{{id}\} {eval:{rowcount}{gt}{latex-table-rowlimit}} \end\{longtable\} {eval:{rowcount}{lt}={latex-table-rowlimit}} {title%} \par{latex-indent-paragraphs!\noindent} {eval:{rowcount}{lt}={latex-table-rowlimit}} {title#} \begin\{table\} {eval:{rowcount}{lt}={latex-table-rowlimit}} {title#} \begin\{center\} {eval:{rowcount}{lt}={latex-table-rowlimit}} \hypertarget\{{id}\}\{\} {eval:{rowcount}{lt}={latex-table-rowlimit}} \caption\{{title}\} {eval:{rowcount}{lt}={latex-table-rowlimit}} \begin\{tabular\}\{lllllllllllllll {eval:{rowcount}{lt}={latex-table-rowlimit}} {frame$all|sides:|} {eval:{rowcount}{lt}={latex-table-rowlimit}} {colspecs} {eval:{rowcount}{lt}={latex-table-rowlimit}} {frame$all|sides:|} {eval:{rowcount}{lt}={latex-table-rowlimit}} \} {eval:{rowcount}{lt}={latex-table-rowlimit}} {frame$all|topbot:\hline} {eval:{rowcount}{lt}={latex-table-rowlimit}} {headrows} {eval:{rowcount}{lt}={latex-table-rowlimit}} {bodyrows} {eval:{rowcount}{lt}={latex-table-rowlimit}} {footrows} {eval:{rowcount}{lt}={latex-table-rowlimit}} {frame$all|topbot:\hline} {eval:{rowcount}{lt}={latex-table-rowlimit}} \end\{tabular\} {eval:{rowcount}{lt}={latex-table-rowlimit}} {title#} \end\{center\} {eval:{rowcount}{lt}={latex-table-rowlimit}} \label\{{id}\} {eval:{rowcount}{lt}={latex-table-rowlimit}} {title#} \end\{table\} [specialsections] ifdef::doctype-article[] ^Abstract$=abstract endif::doctype-article[] ifdef::doctype-book[] ^Dedication$=dedication endif::doctype-book[] ^Index$=index ifdef::latex-use-bibliography-environment[] ^(Bibliography|References)$=bibliography endif::latex-use-bibliography-environment[] ^Appendix.*$=appendix ^(TOC|Contents)$=toc ^Figures$=list-of-figures # Special sections. [list-of-figures] \listoffigures [toc] \label\{{id}\}\hypertarget\{{id}\}\{\} \tableofcontents [index] \setindexpreamble\{ | \} \label\{{id}\}\hypertarget\{{id}\}\{\} \printindex ifdef::latex-use-bibliography-environment[] [bibliography] \label\{{id}\}\hypertarget\{{id}\}\{\} \begin\{thebibliography\}\{99\} | \end\{thebibliography\} endif::latex-use-bibliography-environment[] [appendix] \appendix \label\{{id}\}\hypertarget\{{id}\}\{\} | [abstract] \label\{{id}\}\hypertarget\{{id}\}\{\} \begin\{abstract\} | \end\{abstract\} [abstractblock] [dedication] \label\{{id}\}\hypertarget\{{id}\}\{\} \dedication\{ | \} [preamble] # Untitled elements between header and first section title. ifdef::doctype-book[] \frontmatter \chapter*\{Preface\} \label\{preamble\}\hypertarget\{preamble\}\{\} endif::doctype-book[] | ifdef::doctype-book[] \mainmatter endif::doctype-book[] # Document sections. [sect0] \hypertarget\{{id}\}\{\} \chapter\{{title}\} \label\{{id}\} | [sect1] \hypertarget\{{id}\}\{\} \section\{{title}\} \label\{{id}\} [sect2] \hypertarget\{{id}\}\{\} \subsection\{{title}\} \label\{{id}\} | [sect3] \hypertarget\{{id}\}\{\} \subsubsection\{{title}\} \label\{{id}\} | [sect4] \hypertarget\{{id}\}\{\} \minisec\{{title}\} \label\{{id}\} | # FIXME: if the "backgroundcolor" entry is present as below, the # background comes out black and is unreadable in PDF, although it is # OK in DVI. # \lstset\{basicstyle=\footnotesize\ttfamily,showstringspaces=false,breaklines,frame=single, rulecolor=\color\{ListingBorderColor\}, backgroundcolor=\color\{ListingBackgroundColor\}, xleftmargin=0cm, linewidth=0.95\textwidth\} [header] {encoding$UTF-8:}% coding: utf-8 \documentclass [a4paper,abstracton,titlepage]\{{doctype@article:scrartcl:scrbook}\} \pagestyle\{{latex-use-running-title-headings?headings}{latex-use-running-title-headings!plain}\} \usepackage\{makeidx\} \usepackage[table]\{xcolor\} \usepackage\{color\} \definecolor\{LinkColor\}\{rgb\}\{0.33,0.42,0.18\} \definecolor\{TableEvenColor\}\{rgb\}\{0.93,1,0.8\} \definecolor\{TableOddColor\}\{rgb\}\{0.93,1,1\} \definecolor\{TableBorderColor\}\{rgb\}\{0.55,0.67,0.73\} \definecolor\{ListingBorderColor\}\{rgb\}\{0.55,0.55,0.55\} \definecolor\{ListingBackgroundColor\}\{rgb\}\{0.95,0.95,0.95\} \definecolor\{SidebarBorderColor\}\{rgb\}\{0.95,0.95,0.95\} \definecolor\{SidebarBackgroundColor\}\{rgb\}\{1,1,0.93\} \usepackage\{type1ec\} \usepackage[{language=english}]\{babel\} \usepackage[ pdftex, pdftitle=\{{doctitle}\}, pdfauthor=\{{author}\}, backref, pagebackref, breaklinks=true, unicode ] \{hyperref\} \usepackage\{enumerate\} \usepackage\{graphicx\} \usepackage\{longtable\} \usepackage[T1]\{fontenc\} \usepackage\{ucs\} \usepackage[{encoding@ISO-8859-1:latin1}{encoding@UTF-8:utf8x}{encoding!utf8x}]\{inputenc\} \usepackage\{textcomp\} \usepackage\{alltt\} %\usepackage\{listings\} \usepackage\{verbatim\} \usepackage\{moreverb\} \usepackage\{upquote\} %\lstset\{basicstyle=\footnotesize\ttfamily,showstringspaces=false,breaklines,frame=single, rulecolor=\color\{ListingBorderColor\}, xleftmargin=0cm, linewidth=0.95\textwidth\} {latex-indent-paragraphs%} \setlength\{\parskip\}\{1ex plus 0.5ex minus 0.2ex\} \makeatletter \DeclareRobustCommand*\textsubscript[1]\{% \@textsubscript\{\selectfont#1\}\} \def\@textsubscript#1\{% \{\m@th\ensuremath\{_\{\mbox\{\fontsize\sf@size\z@#1\}\}\}\}\} \makeatother \subject\{{subject}\} \title\{{doctitle}\} \author\{{author}{email?, \href\{mailto:{email}\}\{{email}\}}\} \date\{{revdate}\} \publishers\{\begin\{tabular\}\{ll\} {revision?\textbf\{Revision:\} & {revision} \\ } {keywords?\textbf\{Keywords:\} & {keywords} \\ } \end\{tabular\}\} \makeindex \begin\{document\} %\newcommand{\texttesh}{\textteshlig\/} \label\{header\}\hypertarget\{header\}\{\} {doctitle#\maketitle} [footer] \label\{footer\}\hypertarget\{footer\}\{\} \end\{document\} ������������������������������������������������������������������������������������������������������������������������������������asciidoc-8.6.9/slidy.conf���������������������������������������������������������������������������0000644�0001751�0001751�00000011402�11767207127�015465� 0����������������������������������������������������������������������������������������������������ustar �srackham������������������������srackham���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������# # Asciidoc Configuration file for slidy HTML generation. # include::xhtml11.conf[] [literalparagraph] template::[listingblock] [openblock] <div class="openblock{incremental? incremental}{role? {role}}"{id? id="{id}"}> <div class="title">{title}</div> <div class="content"> | </div></div> [listtags-bulleted] list={title?<div class="title">{title}</div>}<ul{id? id="{id}"} class="{incremental? incremental}{role? {role}}">|</ul> item=<li>|</li> text=<span>|</span> [listtags-numbered] # The start attribute is not valid XHTML 1.1 but all browsers support it. list={title?<div class="title">{title}</div>}<ol{id? id="{id}"} class="{style}{incremental? incremental}{role? {role}}"{start? start="{start}"}>|</ol> item=<li>|</li> text=<span>|</span> [listtags-labeled] list=<div class="dlist{compact-option? compact}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<dl class="{incremental? incremental}{role? {role}}">|</dl></div> entry= label= term=<dt class="hdlist1{strong-option? strong}">|</dt> item=<dd>|</dd> text=<p>|</p> [preamble] # Untitled elements between header and first section title. <div id="preamble" class="slide"> <div class="sectionbody"{max-width? style="max-width:{max-width}"}> | </div> </div> [sect1] <div class="sect1 slide{style? {style}}{role? {role}}"> <h1{id? id="{id}"}>{numbered?{sectnum} }{title}</h1> # Set max-width here because Slidy ignores max-width on body. <div class="sectionbody"{max-width? style="max-width:{max-width}"}> | </div> </div> [appendix] <div class="sect1 slide{style? {style}}{role? {role}}"> <h1{id? id="{id}"}>{numbered?{sectnum} }{appendix-caption} {counter:appendix-number:A}: {title}</h1> # Set max-width here because Slidy ignores max-width on body. <div class="sectionbody"{max-width? style="max-width:{max-width}"}> | </div> </div> [header] <?xml version="1.0" encoding="{encoding}"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" lang="{lang=en}" xml:lang="{lang=en}"> <head> <title>{doctitle=} ifndef::copyright[] ifdef::linkcss[] ifeval::["{source-highlighter}"=="pygments"] endif::[] # DEPRECATED: 'pygments' attribute. ifdef::pygments[] endif::linkcss[] ifndef::linkcss[] endif::linkcss[] ifdef::asciimath[] ifdef::linkcss[] endif::linkcss[] ifndef::linkcss[] endif::linkcss[] endif::asciimath[] ifdef::latexmath[] ifdef::linkcss[] endif::linkcss[] ifndef::linkcss[] endif::linkcss[] endif::latexmath[] [footer] asciidoc-8.6.9/text.conf0000644000175100017510000000066611552142257015331 0ustar srackhamsrackham# text.conf # Used by the AsciiDoc a2x(1) toolchain wrapper utility. # Filters to add leading blank line and margin indent to verbatim # block elements so lynx(1) generated text output looks nicer. [paradef-default] verse-style=template="verseparagraph",filter="echo; echo; sed 's/^/ /'" [paradef-literal] filter=echo; echo; sed 's/^/ /' [blockdef-listing] filter=echo; sed 's/^/ /' [blockdef-literal] filter=echo; sed 's/^/ /' asciidoc-8.6.9/xhtml11.conf0000664000175100017510000005221612236303460015636 0ustar srackhamsrackham# # xhtml11.conf # # Asciidoc configuration file. # xhtml11 backend, generates XHTML 1.1 conformant markup. # [miscellaneous] outfilesuffix=.html [attributes] basebackend=html basebackend-html= basebackend-xhtml11= [replacements2] # Line break. (?m)^(.*)\s\+$=\1
    [replacements] ifdef::asciidoc7compatible[] # Superscripts. \^(.+?)\^=\1 # Subscripts. ~(.+?)~=\1 endif::asciidoc7compatible[] [ruler-blockmacro]
    [pagebreak-blockmacro]
    [blockdef-pass] asciimath-style=template="asciimathblock",subs=() latexmath-style=template="latexmathblock",subs=() [macros] # math macros. # Special characters are escaped in HTML math markup. (?su)[\\]?(?Pasciimath|latexmath):(?P\S*?)\[(?P.*?)(?asciimath|latexmath)::(?P\S*?)(\[(?P.*?)\])$=#[specialcharacters] [asciimath-inlinemacro] `{passtext}` [asciimath-blockmacro]
    {title}
    `{passtext}`
    [asciimathblock]
    {title}
    `|`
    [latexmath-inlinemacro] {passtext} [latexmath-blockmacro]
    {title}
    {passtext}
    [latexmathblock]
    {title}
    |
    [image-inlinemacro] {data-uri%}{alt={target}} {data-uri#}{alt={target}} {link#} [image-blockmacro]
    {data-uri%}{alt={target}} {data-uri#}{alt={target}} {link#}
    {caption={figure-caption} {counter:figure-number}. }{title}
    [unfloat-blockmacro]
    [toc-blockmacro] template::[toc] [indexterm-inlinemacro] # Index term. {empty} [indexterm2-inlinemacro] # Index term. # Single entry index term that is visible in the primary text flow. {1} [footnote-inlinemacro] # footnote:[].
    [{0}]
     [footnoteref-inlinemacro] # footnoteref:[], create reference to footnote. {2%}
    [{1}]
     # footnoteref:[,], create footnote with ID. {2#}
    [{2}]
     [callout-inlinemacro] ifndef::icons[] <{index}> endif::icons[] ifdef::icons[] ifndef::data-uri[] {index} endif::data-uri[] ifdef::data-uri[] {index} endif::data-uri[] endif::icons[] # Comment line macros. [comment-inlinemacro] {showcomments#}
    {passtext}
    [comment-blockmacro] {showcomments#}

    {passtext}

    [literal-inlinemacro] # Inline literal. {passtext} # List tags. [listtags-bulleted] list=
    {title?
    {title}
    }
      |
    item=
  • |
    • text=

    |

    [listtags-numbered] # The start attribute is not valid XHTML 1.1 but all browsers support it. list=
    {title?
    {title}
    }
      |
    item=
  • |
    • text=

    |

    [listtags-labeled] list=
    {title?
    {title}
    }
    |
    entry= label= term=
    |
    item=
    |
    text=

    |

    [listtags-horizontal] list=
    {title?
    {title}
    }{labelwidth?}{itemwidth?}|
    label=| term=|
    entry=| item=| text=

    |

    [listtags-qanda] list=
    {title?
    {title}
    }
      |
    entry=
  • |
    • label= term=

    |

    item= text=

    |

    [listtags-callout] ifndef::icons[] list=
    {title?
    {title}
    }
      |
    item=
  • |
    • text=

    |

    endif::icons[] ifdef::icons[] list=
    {title?
    {title}
    }|
    ifndef::data-uri[] item={listindex}| endif::data-uri[] ifdef::data-uri[] item={listindex}| endif::data-uri[] text=| endif::icons[] [listtags-glossary] list=
    {title?
    {title}
    }
    |
    label= entry= term=
    |
    item=
    |
    text=

    |

    [listtags-bibliography] list=
    {title?
    {title}
    }
      |
    item=
  • |
    • text=

    |

    [tags] # Quoted text. emphasis={1?}|{1?} strong={1?}|{1?} monospaced={1?}|{1?} singlequoted={lsquo}{1?}|{1?}{rsquo} doublequoted={ldquo}{1?}|{1?}{rdquo} unquoted={1?}|{1?} superscript={1?}|{1?} subscript={1?}|{1?} ifdef::deprecated-quotes[] # Override with deprecated quote attributes. emphasis={role?}|{role?} strong={role?}|{role?} monospaced={role?}|{role?} singlequoted={role?}{1,2,3?}{amp}#8216;|{amp}#8217;{1,2,3?}{role?} doublequoted={role?}{1,2,3?}{amp}#8220;|{amp}#8221;{1,2,3?}{role?} unquoted={role?}{1,2,3?}|{1,2,3?}{role?} superscript={role?}|{role?} subscript={role?}|{role?} endif::deprecated-quotes[] # Inline macros [http-inlinemacro] {0={name}:{target}} [https-inlinemacro] {0={name}:{target}} [ftp-inlinemacro] {0={name}:{target}} [file-inlinemacro] {0={name}:{target}} [irc-inlinemacro] {0={name}:{target}} [mailto-inlinemacro] {0={target}} [link-inlinemacro] {0={target}} [callto-inlinemacro] {0={target}} # anchor:id[text] [anchor-inlinemacro] # [[id,text]] [anchor2-inlinemacro] # [[[id]]] [anchor3-inlinemacro] [{1}] # xref:id[text] [xref-inlinemacro] {0=[{target}]} # <> [xref2-inlinemacro] {2=[{1}]} # Special word substitution. [emphasizedwords] {words} [monospacedwords] {words} [strongwords] {words} # Paragraph substitution. [paragraph]
    {title?
    {title}
    }

    |

    [admonitionparagraph] template::[admonitionblock] # Delimited blocks. [listingblock]
    {caption=}{title}
    
|
    [literalblock]
    {title}
    
|
    [sidebarblock]
    {title}
    |
    [openblock]
    {title}
    |
    [partintroblock] template::[openblock] [abstractblock] template::[quoteblock] [quoteblock]
    {title}
    |
    {citetitle}{attribution?
    } — {attribution}
    [verseblock]
    {title}
    |
    {citetitle}{attribution?
    } — {attribution}
    [exampleblock]
    {caption={example-caption} {counter:example-number}. }{title}
    |
    [admonitionblock]
    {data-uri%}{icons#}{caption} {data-uri#}{icons#}{caption} {icons%}
    {caption}
    {title}
    |
    # Tables. [tabletags-default] colspec= bodyrow=| headdata=| bodydata=| paragraph=

    |

    [tabletags-header] paragraph=

    |

    [tabletags-emphasis] paragraph=

    |

    [tabletags-strong] paragraph=

    |

    [tabletags-monospaced] paragraph=

    |

    [tabletags-verse] bodydata=
    |
    paragraph= [tabletags-literal] bodydata=
    |
    paragraph= [tabletags-asciidoc] bodydata=
    |
    paragraph= [table]
    {colspecs} {headrows#} {headrows} {headrows#} {footrows#} {footrows} {footrows#} {bodyrows}
    {caption={table-caption} {counter:table-number}. }{title}
    #-------------------------------------------------------------------- # Deprecated old table definitions. # [miscellaneous] # Screen width in pixels. pagewidth=800 pageunits= [old_tabledef-default] template=old_table colspec= bodyrow=| headdata=| footdata=| bodydata=| [old_table]
    {colspecs} {headrows#} {headrows} {headrows#} {footrows#} {footrows} {footrows#} {bodyrows}
    {caption={table-caption}}{title}
    # End of deprecated old table definitions. #-------------------------------------------------------------------- [floatingtitle] {title} [preamble] # Untitled elements between header and first section title.
    |
    # Document sections. [sect0] {title} | [sect1]
    {numbered?{sectnum} }{title}
    |
    [sect2]
    {numbered?{sectnum} }{title} |
    [sect3]
    {numbered?{sectnum} }{title} |
    [sect4]
    {title} |
    [appendix]
    {numbered?{sectnum} }{appendix-caption} {counter:appendix-number:A}: {title}
    |
    [toc]
    {toc-title}
    [header] {title} {title%}{doctitle=} ifdef::linkcss[] ifdef::quirks[] endif::quirks[] ifeval::["{source-highlighter}"=="pygments"] endif::[] # DEPRECATED: 'pygments' attribute. ifdef::pygments[] ifdef::toc2[] endif::linkcss[] ifndef::linkcss[] endif::linkcss[] ifndef::disable-javascript[] ifdef::linkcss[] endif::linkcss[] ifndef::linkcss[] endif::linkcss[] endif::disable-javascript[] ifdef::asciimath[] ifdef::linkcss[] endif::linkcss[] ifndef::linkcss[] endif::linkcss[] endif::asciimath[] ifdef::latexmath[] ifdef::linkcss[] endif::linkcss[] ifndef::linkcss[] endif::linkcss[] endif::latexmath[] {docinfo1,docinfo2#}{include:{docdir}/docinfo.html} {docinfo,docinfo2#}{include:{docdir}/{docname}-docinfo.html} template::[docinfo] # Article, book header. ifndef::doctype-manpage[] endif::doctype-manpage[] # Man page header. ifdef::doctype-manpage[] endif::doctype-manpage[]
    [footer]
    {disable-javascript%
    } ifdef::doctype-manpage[] [synopsis] template::[sect1] endif::doctype-manpage[] ifdef::quirks[] include::xhtml11-quirks.conf[] endif::quirks[] asciidoc-8.6.9/xhtml11-quirks.conf0000644000175100017510000000362411723065626017160 0ustar srackhamsrackham# # xhtml11-quirks.conf # # Workarounds for IE6's broken # and incomplete CSS2. # [image-blockmacro]
    {data-uri%}{alt={target}} {data-uri#}{alt={target}} {link#}
    {caption={figure-caption} {counter:figure-number}: }{title}
    [sidebarblock]
    {title}
    |
    [quoteblock]
    {title}
    |
    {citetitle}
    — {attribution}
    [verseblock]
    {title}
    |
    {citetitle}
    — {attribution}
    [exampleblock]
    {caption={example-caption} {counter:example-number}: }{title}
    |
    [sect2]
    # The
    is because the IE6 adjacent-sibling CSS selector is broken. {numbered?{sectnum} }{title}
    |
    asciidoc-8.6.9/COPYING0000664000175100017510000004307612031161152014521 0ustar srackhamsrackham GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc. 675 Mass Ave, Cambridge, MA 02139, USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS Appendix: How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) 19yy This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program 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 for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) 19yy name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License. asciidoc-8.6.9/COPYRIGHT0000664000175100017510000000135112031161152014747 0ustar srackhamsrackhamCopyright (C) 2000-2007 Stuart Rackham Email: srackham@gmail.com This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program 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 for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. asciidoc-8.6.9/dblatex/asciidoc-dblatex.sty0000664000175100017510000000116212031161152021037 0ustar srackhamsrackham%% %% This style is derived from the docbook one. %% \NeedsTeXFormat{LaTeX2e} \ProvidesPackage{asciidoc}[2008/06/05 AsciiDoc DocBook Style] %% Just use the original package and pass the options. \RequirePackageWithOptions{docbook} % Sidebar is a boxed minipage that can contain verbatim. % Changed shadow box to double box. \renewenvironment{sidebar}[1][0.95\textwidth]{ \hspace{0mm}\newline% \noindent\begin{Sbox}\begin{minipage}{#1}% \setlength\parskip{\medskipamount}% }{ \end{minipage}\end{Sbox}\doublebox{\TheSbox}% } % For DocBook literallayout elements, see `./dblatex/dblatex-readme.txt`. \usepackage{alltt} asciidoc-8.6.9/dblatex/asciidoc-dblatex.xsl0000664000175100017510000000443712031161152021036 0ustar srackhamsrackham colorlinks,linkcolor=blue,pdfstartview=FitH 1 1 0 3 0 0 1 1 \begin{alltt} \normalfont{} \end{alltt} \pagebreak[4] \newline \begin{center} \line(1,0){444} \end{center} asciidoc-8.6.9/dblatex/dblatex-readme.txt0000664000175100017510000000252012031161152020515 0ustar srackhamsrackhamAsciiDoc dblatex README ======================= Customization ------------- The `./dblatex` directory contains: `./dblatex/asciidoc-dblatex.xsl`:: Optional dblatex XSL parameter customization. `./dblatex/asciidoc-dblatex.sty`:: Optional customized LaTeX styles. Use these files with dblatex(1) `-p` and `-s` options, for example: dblatex -p ../dblatex/asciidoc-dblatex.xsl \ -s ../dblatex/asciidoc-dblatex.sty article.xml Limitations ----------- Observed in dblatex 0.2.8. - dblatex doesn't seem to process the DocBook 'literallayout' element correctly: it is rendered in a monospaced font and no inline elements are processed. By default the normal font should be used and almost all DocBook inline elements should be processed (http://www.docbook.org/tdg/en/html/literallayout.html). I almost fixed this by overriding the default dblatex literallayout template (in `./dblatex/asciidoc-dblatex.xsl`) and using the LaTeX 'alltt' package, but there are remaining problems: * Blank lines are replaced by a single space. * The 'literallayout' element incorrectly wraps text when rendered inside a table. - Callouts do not work inside DocBook 'literallayout' elements which means callouts are not displayed inside AsciiDoc literal blocks. A workaround is to change the AsciiDoc literal block to a listing block. asciidoc-8.6.9/doc/a2x.10000644000175100017510000003717612236330763015026 0ustar srackhamsrackham'\" t .\" Title: a2x .\" Author: [see the "AUTHOR" section] .\" Generator: DocBook XSL Stylesheets v1.76.1 .\" Date: 9 November 2013 .\" Manual: \ \& .\" Source: \ \& 8.6.9 .\" Language: English .\" .TH "A2X" "1" "9 November 2013" "\ \& 8\&.6\&.9" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .\" http://bugs.debian.org/507673 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" a2x \- A toolchain manager for AsciiDoc (converts Asciidoc text files to other file formats) .SH "SYNOPSIS" .sp \fBa2x\fR [\fIOPTIONS\fR] \fISOURCE_FILE\fR .SH "DESCRIPTION" .sp A DocBook toolchain manager that translates an AsciiDoc text file \fISOURCE_FILE\fR to PDF, EPUB, DVI, PS, LaTeX, XHTML (single page or chunked), man page, HTML Help or plain text formats using \fIasciidoc(1)\fR and other applications (see REQUISITES section)\&. \fISOURCE_FILE\fR can also be a DocBook file with an \&.xml extension\&. .SH "OPTIONS" .PP \fB\-a, \-\-attribute\fR=\fIATTRIBUTE\fR .RS 4 Set asciidoc(1) attribute value (shortcut for \fB\-\-asciidoc\-opts\fR=\fI"\-a ATTRIBUTE"\fR option)\&. This option may be specified more than once\&. .RE .PP \fB\-\-asciidoc\-opts\fR=\fIASCIIDOC_OPTS\fR .RS 4 Additional \fIasciidoc(1)\fR options\&. This option may be specified more than once\&. .RE .PP \fB\-\-conf\-file\fR=\fICONF_FILE\fR .RS 4 Load configuration file\&. See CONF FILES section\&. .RE .PP \fB\-D, \-\-destination\-dir\fR=\fIDESTINATION_DIR\fR .RS 4 Output directory\&. Defaults to \fISOURCE_FILE\fR directory\&. This option is only applicable to HTML based output formats (\fIchunked\fR, \fIepub\fR, \fIhtmlhelp\fR, \fIxhtml\fR)\&. .RE .PP \fB\-d, \-\-doctype\fR=\fIDOCTYPE\fR .RS 4 DocBook document type: \fIarticle\fR, \fImanpage\fR or \fIbook\fR\&. Default document type is \fIarticle\fR unless the format is \fImanpage\fR (in which case it defaults to \fImanpage\fR)\&. .RE .PP \fB\-b, \-\-backend\fR=\fIBACKEND\fR .RS 4 \fIBACKEND\fR is the name of an installed backend plugin\&. When this option is specified \fIa2x\fR attempts load a file name \fIa2x\-backend\&.py\fR from the \fIBACKEND\fR plugin directory It then converts the \fISOURCE_FILE\fR to a \fIBACKEND\fR formatted output file using a global function defined in \fIa2x\-backend\&.py\fR called \fIto_BACKEND\fR\&. .RE .PP \fB\-f, \-\-format\fR=\fIFORMAT\fR .RS 4 Output formats: \fIchunked\fR, \fIdocbook\fR, \fIdvi\fR, \fIepub\fR, \fIhtmlhelp\fR, \fImanpage\fR, \fIpdf\fR (default), \fIps\fR, \fItex\fR, \fItext\fR, \fIxhtml\fR\&. The AsciiDoc \fIa2x\-format\fR attribute value is set to \fIFORMAT\fR\&. .RE .PP \fB\-h, \-\-help\fR .RS 4 Print command\-line syntax and program options to stdout\&. .RE .PP \fB\-\-icons\fR .RS 4 Use admonition or navigation icon images in output documents\&. The default behavior is to use text in place of icons\&. .RE .PP \fB\-\-icons\-dir\fR=\fIPATH\fR .RS 4 A path (relative to output files) containing admonition and navigation icons\&. Defaults to images/icons\&. The \fI\-\-icons\fR option is implicit if this option is used\&. .RE .PP \fB\-k, \-\-keep\-artifacts\fR .RS 4 Do not delete temporary build files\&. .RE .PP \fB\-\-lynx\fR .RS 4 Use \fIlynx(1)\fR to generate text formatted output\&. The default behavior is to use \fIw3m(1)\fR\&. .RE .PP \fB\-L, \-\-no\-xmllint\fR .RS 4 Do not check asciidoc output with \fIxmllint(1)\fR\&. .RE .PP \fB\-\-\-epubcheck\fR .RS 4 Check EPUB output with \fIepubcheck(1)\fR\&. .RE .PP \fB\-n, \-\-dry\-run\fR .RS 4 Do not do anything just print what would have been done\&. .RE .PP \fB\-r, \-\-resource\fR=\fIRESOURCE_SPEC\fR .RS 4 Specify a resource\&. This option may be specified more than once\&. See the \fBRESOURCES\fR section for more details\&. .RE .PP \fB\-m, \-\-resource\-manifest\fR=\fIFILE\fR .RS 4 \fIFILE\fR contains a list resources (one per line)\&. Manifest \fIFILE\fR entries are formatted just like \fB\-\-resource\fR option arguments\&. Environment variables and tilde home directories are allowed\&. .RE .PP \fB\-\-stylesheet\fR=\fISTYLESHEET\fR .RS 4 A space delimited list of one or more CSS stylesheet file names that are used to style HTML output generated by DocBook XSL Stylesheets\&. Defaults to \fIdocbook\-xsl\&.css\fR\&. The stylesheets are processed in list order\&. The stylesheets must reside in a valid resource file location\&. Applies to HTML formats: \fIxhtml\fR, \fIepub\fR, \fIchunked\fR, \fIhtmlhelp\fR formats\&. .RE .PP \fB\-v, \-\-verbose\fR .RS 4 Print operational details to stderr\&. A second \fB\-v\fR option applies the verbose option to toolchain commands\&. .RE .PP \fB\-\-version\fR .RS 4 Print program version to stdout\&. .RE .PP \fB\-\-xsltproc\-opts\fR=\fIXSLTPROC_OPTS\fR .RS 4 Additional \fIxsltproc(1)\fR options\&. This option may be specified more than once\&. .RE .PP \fB\-\-xsl\-file\fR=\fIXSL_FILE\fR .RS 4 Override the built\-in XSL stylesheet with the custom XSL stylesheet \fIXSL_FILE\fR\&. .RE .PP \fB\-\-fop\fR .RS 4 Use FOP to generate PDFs\&. The default behavior is to use \fIdblatex(1)\fR\&. The \fI\-\-fop\fR option is implicit if this option is used\&. .RE .PP \fB\-\-fop\-opts\fR=\fIFOP_OPTS\fR .RS 4 Additional \fIfop(1)\fR options\&. If this option is specified FOP is used to generate PDFs\&. This option may be specified more than once\&. .RE .PP \fB\-\-dblatex\-opts\fR=\fIDBLATEX_OPTS\fR .RS 4 Additional \fIdblatex(1)\fR options\&. This option may be specified more than once\&. .RE .PP \fB\-\-backend\-opts\fR=\fIBACKEND_OPTS\fR .RS 4 Options for the backend plugin specified by the \fI\-\-backend\fR option\&. This option may be specified more than once\&. .RE .sp Options can also be set in the AsciiDoc source file\&. If \fISOURCE_FILE\fR contains a comment line beginning with \fB// a2x:\fR then the remainder of the line will be treated as \fIa2x\fR command\-line options\&. For example: .sp .if n \{\ .RS 4 .\} .nf // a2x default options\&. // a2x: \-dbook \-\-epubcheck // Suppress revision history in dblatex outputs\&. // a2x: \-\-dblatex\-opts "\-P latex\&.output\&.revhistory=0" .fi .if n \{\ .RE .\} .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Options spanning multiple such comment lines will be concatenated\&. .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Zero or more white space characters can appear between the leading \fB//\fR and \fBa2x:\fR\&. .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Command\-line options take precedence over options set in the source file\&. .RE .SH "OUTPUT FILES" .sp Output files are written to the directory specified by the \fB\-\-destination\-dir\fR option\&. If no \fB\-\-destination\-dir\fR option is set output files are written to the \fISOURCE_FILE\fR directory\&. .sp Output files have the same name as the \fISOURCE_FILE\fR but with an appropriate file name extension: \&.html for \fIxhtml\fR; \&.epub for \fIepub\fR; \&.hhp for \fIhtmlhelp\fR; \&.pdf for \fIpdf\fR; \&.text for \fItext\fR, \&.xml for \fIdocbook\fR\&. By convention manpages have no \&.man extension (man page section number only)\&. Chunked HTML directory names have a \&.chunked extension; chunked HTML Help directory names have a \&.htmlhelp extension\&. .sp Same named existing files are overwritten\&. .sp In addition to generating HTML files the \fIxhtml\fR, \fIepub\fR, \fIchunked\fR and \fIhtmlhelp\fR formats ensure resource files are copied to their correct destination directory locations\&. .SH "RESOURCES" .sp Resources are files (typically CSS and images) that are required by HTML based outputs (\fIxhtml\fR, \fIepub\fR, \fIchunked\fR, \fIhtmlhelp\fR formats)\&. \fIa2x\fR scans the generated HTML files and builds a list of required CSS and image files\&. Additional resource files can be specified explicitly using the \fB\-\-resource\fR option\&. .sp \fIa2x\fR searches for resource files in the following locations in the following order: .sp .RS 4 .ie n \{\ \h'-04' 1.\h'+01'\c .\} .el \{\ .sp -1 .IP " 1." 4.2 .\} The \fISOURCE_FILE\fR directory\&. .RE .sp .RS 4 .ie n \{\ \h'-04' 2.\h'+01'\c .\} .el \{\ .sp -1 .IP " 2." 4.2 .\} Resource directories specified by the \fB\-\-resource\fR option (searched recursively)\&. .RE .sp .RS 4 .ie n \{\ \h'-04' 3.\h'+01'\c .\} .el \{\ .sp -1 .IP " 3." 4.2 .\} Resource directories specified by the \fB\-\-resource\-manifest\fR option (searched recursively in the order they appear in the manifest file)\&. .RE .sp .RS 4 .ie n \{\ \h'-04' 4.\h'+01'\c .\} .el \{\ .sp -1 .IP " 4." 4.2 .\} The stock images and stylesheets directories in the \fIasciidoc(1)\fR configuration files directories (searched recursively)\&. .RE .sp .RS 4 .ie n \{\ \h'-04' 5.\h'+01'\c .\} .el \{\ .sp -1 .IP " 5." 4.2 .\} The destination directory\&. .RE .sp When a resource file is found it is copied to the correct relative destination directory\&. Missing destination sub\-directories are created automatically\&. .sp There are two distinct mechanisms for specifying additional resources: .sp .RS 4 .ie n \{\ \h'-04' 1.\h'+01'\c .\} .el \{\ .sp -1 .IP " 1." 4.2 .\} A resource directory which will be searched recursively for missing resource files\&. .RE .sp .RS 4 .ie n \{\ \h'-04' 2.\h'+01'\c .\} .el \{\ .sp -1 .IP " 2." 4.2 .\} A resource file which will be copied to the output destination directory\&. .RE .sp Resources are specified with \fB\-\-resource\fR option values which can be one of the following formats: .sp .if n \{\ .RS 4 .\} .nf [=] \&.= .fi .if n \{\ .RE .\} .sp Where: .PP .RS 4 Specifies a directory (absolute or relative to the \fISOURCE_FILE\fR) which is searched recursively for missing resource files\&. To eliminate ambiguity the name should end with a directory separator character\&. .RE .PP .RS 4 Specifies a resource file (absolute or relative to the \fISOURCE_FILE\fR) which will be copied to \&. If is not specified then it is the same as the \&. .RE .PP .RS 4 Specifies the destination of the copied source file\&. The path is relative to the destination directory (absolute paths are not allowed)\&. The location of the destination directory depends on the output \fIFORMAT\fR (see the \fBOUTPUT FILES\fR section for details): .PP chunked, htmlhelp .RS 4 The chunked output directory\&. .RE .PP epub .RS 4 The archived OEBPS directory\&. .RE .PP xhtml .RS 4 The output \fBDESTINATION_DIR\fR\&. .RE .RE .PP \&.= .RS 4 When adding resources to EPUB files the mimetype is inferred from the extension, if the mimetype cannot be guessed an error occurs\&. The \&.= resource syntax can be used to explicitly set mimetypes\&. is the file name extension, is the corresponding MIME type\&. .RE .sp Resource option examples: .sp .if n \{\ .RS 4 .\} .nf \-\-resource \&.\&./images/ \-\-resource doc/README\&.txt=README\&.txt \-\-resource ~/images/tiger\&.png=images/tiger\&.png \-\-resource \&.ttf=application/x\-font\-ttf .fi .if n \{\ .RE .\} .SH "EXAMPLES" .PP a2x \-f pdf doc/source\-highlight\-filter\&.txt .RS 4 Generates doc/source\-highlight\-filter\&.pdf file\&. .RE .PP a2x \-f xhtml \-D \&.\&./doc \-\-icons \-r \&.\&./images/ team\&.txt .RS 4 Creates HTML file \&.\&./doc/team\&.html, uses admonition icons and recursively searches the \&.\&./images/ directory for any missing resources\&. .RE .PP a2x \-f manpage doc/asciidoc\&.1\&.txt .RS 4 Generate doc/asciidoc\&.1 manpage\&. .RE .SH "REQUISITES" .sp \fIa2x\fR uses the following programs: .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} \fBAsciidoc\fR: http://asciidoc\&.org/ .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} \fBxsltproc\fR: (all formats except text): http://xmlsoft\&.org/XSLT/ .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} \fBDocBook XSL Stylesheets\fR (all formats except text): http://docbook\&.sourceforge\&.net/projects/xsl/ .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} \fBdblatex\fR (pdf, dvi, ps, tex formats): http://dblatex\&.sourceforge\&.net/ .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} \fBFOP\fR (pdf format \(em alternative PDF file generator): http://xmlgraphics\&.apache\&.org/fop/ .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} \fBw3m\fR (text format): http://w3m\&.sourceforge\&.net/index\&.en\&.html .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} \fBLynx\fR (text format \(em alternative text file generator): http://lynx\&.isc\&.org/ .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} \fBepubcheck\fR (epub format \(em EPUB file validator): http://code\&.google\&.com/p/epubcheck/ .RE .sp See also the latest README file\&. .SH "CONF FILES" .sp A configuration file contains executable Python code that overrides the global configuration parameters in a2x\&.py\&. Optional configuration files are loaded in the following order: .sp .RS 4 .ie n \{\ \h'-04' 1.\h'+01'\c .\} .el \{\ .sp -1 .IP " 1." 4.2 .\} a2x\&.conf from the directory containing the \fIa2x\&.py\fR executable\&. .RE .sp .RS 4 .ie n \{\ \h'-04' 2.\h'+01'\c .\} .el \{\ .sp -1 .IP " 2." 4.2 .\} a2x\&.conf from the AsciiDoc global configuration directory\&. Skip this step if we are executing a locally installed (non system wide) copy\&. .RE .sp .RS 4 .ie n \{\ \h'-04' 3.\h'+01'\c .\} .el \{\ .sp -1 .IP " 3." 4.2 .\} a2x\&.conf from the AsciiDoc $HOME/\&.asciidoc configuration directory\&. .RE .sp .RS 4 .ie n \{\ \h'-04' 4.\h'+01'\c .\} .el \{\ .sp -1 .IP " 4." 4.2 .\} The \fICONF_FILE\fR specified in the \fI\-\-conf\-file\fR option\&. .RE .sp Here are the default configuration file option values: .sp .if n \{\ .RS 4 .\} .nf # Optional environment variable dictionary passed to # executing programs\&. If set to None the existing # environment is used\&. ENV = None # External executables\&. ASCIIDOC = \*(Aqasciidoc\*(Aq XSLTPROC = \*(Aqxsltproc\*(Aq DBLATEX = \*(Aqdblatex\*(Aq # pdf generation\&. FOP = \*(Aqfop\*(Aq # pdf generation (\-\-fop option)\&. W3M = \*(Aqw3m\*(Aq # text generation\&. LYNX = \*(Aqlynx\*(Aq # text generation (if no w3m)\&. XMLLINT = \*(Aqxmllint\*(Aq # Set to \*(Aq\*(Aq to disable\&. EPUBCHECK = \*(Aqepubcheck\*(Aq # Set to \*(Aq\*(Aq to disable\&. # External executable default options\&. ASCIIDOC_OPTS = \*(Aq\*(Aq DBLATEX_OPTS = \*(Aq\*(Aq FOP_OPTS = \*(Aq\*(Aq XSLTPROC_OPTS = \*(Aq\*(Aq .fi .if n \{\ .RE .\} .SH "BUGS" .sp See the AsciiDoc distribution BUGS file\&. .SH "AUTHOR" .sp a2x was originally written by Stuart Rackham\&. Many people have contributed to it\&. .SH "RESOURCES" .sp SourceForge: http://sourceforge\&.net/projects/asciidoc/ .sp Main web site: http://asciidoc\&.org/ .SH "COPYING" .sp Copyright (C) 2002\-2011 Stuart Rackham\&. Free use of this software is granted under the terms of the MIT license\&. asciidoc-8.6.9/doc/book.epub0000664000175100017510000004233612236331060016044 0ustar srackhamsrackhamPK̀fCoa,mimetypeapplication/epub+zipPKˀfCK ŰMETA-INF/container.xmlU;0D{NamCV$$j8lٵ c(tS{3>Ds1V%b/]sLV05vV{a4s.Ց`1z'? 5GCbꥁn{8^d I=>Ry)Q R.el[hgOPKˀfCKBOEBPS/content.opfϓ0W0xPIۅv(;zѓ'N6yIj7ݕ/-{3=UHD1 @q-*dac Hi?d5/y+GGk9>D)0&<'%  =k"ʳ ,̲<|7YavSS(c(r`H1l M3XiKrw_O(ut}ZzL)f}d !s*|<٣nOA'.J8 y9WLgB凧xk5GABڱ.%g֭nCa{ Cp}-scм[5e$FGżY'ޠl7R*N$](~\$&1+Yl*V QPo?['۷ + hJ K #tCZJJWWf5[٬&γ\>mL*rPHӑtOHxzZ*U} uzx-6ܳYq9enh~f~A%?Yt w|PKˀfC7OEBPS/ch03.htmlRn0 }Wp|4! 4Vn=EFɰ\/lE ۃ9~^㌿>[~N1Kp%1vb7[R{R=.,[,.$f#‘e {*δLT<>TrMg.U&CG^c⃧mȴgY:zdӲ,65 )E2np̟F(z,lڛ֣Ь~vfMczU5xǎlwOCT>оm9=$0a% ڄa? ~&j_.Bd6dPKˀfC{5\OEBPS/bi01.htmlo0W~ɺv-$uʘЄX8vkƿ_SŲ|w_}xQJRTBMSr=~gR+L8k%φNǟ/Π.dH@Mxގߏ cJ %wC#S&Uɒ+lJ"zZX&teKPߠFcMh e 47@Q]J'Z FfIbšY]ȵlJ:?qjW>Q7]:|%\C.qNu lS8VlR;vgc xJJmdEm* 0hɅp8`2-)LhjwPg|GKueݸ4{$K@F^Vb*~7[VY4[8E-Kx;*XV3WeCmP[ZE =:,hܠ 9DAÃ~vn5Dpi39J=s]Ns7V`ZSj N(a=›K?.QH\50FY4!N?:(8ڋ'r0GtM(jI (ρw ):ب/PKˀfC&!yDOEBPS/co01.htmlmAO1ܳԒ6IV -'ؓ ^xYPq{XO6E@%Ɲ !ކIcLxnNԧEj p&Ӆz w?5J sMPND}-.hxW=^p1r>O4!`] X&E% m|@!b>vi`rFhzjmRz 9TcY'wz"Sd.np?Y}Rɱbn?'p^0cR#M) xO`43u {H[0bvSV[JjI mu}稔 D ^ B7'PKˀfCp߶SOEBPS/go01.htmlMo0 N!Ҍ2.$Xݭ;Beɐ&b7hw |_>T{vd9m㔶mnO IqKf;Ǣsrul&ﳅz _oky.; v|wƝoES<ϓ)+# |> VJU`~0 AC!h{M aMI4!0#*duqcM^kbuTo@V[xv4I7HӸ7;V_PKˀfCg޺OEBPS/pr01.htmlRAn0۽, b;h1jIO-m,!4)L,&oJYR);3;CR7[T{@6syi7 ^>hk,%hnz5I.fP_\_̿LGߜN8S~`7,B>qziBcpOc\PCjme5$Ҕj2 7 U <s5ް͕R`67dlHp겋Ȁ~ጉVw..+c3F+Jov_ q43 e:հ{=*/k6sՑOYx-د^0~?WWlz=оC=o?: PK̀fCHxkjOEBPS/docbook-xsl.cssXr6+v#),9uivNrIPD  V=.@I@4F6v],~s ju)U _~Hg|Ut&bUeTˌoW*䑑EM%S%" TKWE#޿Z-+PU({ʎX԰91Fv-RVo8$g%]V|b,EE*8;mi(E ؿ<:E);D׭-~7&& y o8=L]d/~DKϤq TZ&9Lsc-3vl$/Qe} EX bvf)&@ i8W[G|3 j[gZBT ԂjHGvT~=6Nu@w/99Ai[B)Jz7WN;Z(_n ϓɧLU9DIN9%/`23Z˹g5֚eZ-{--Zw#`!dXQ%&iʏप18ݓ{n Ւϯo4K_xAizL)}09[COA#U9+}wlje8ymlnڲataBEh8%ܟWD>|ձ{! i"L9 JI7a%j8o eHW2%6 $ڗOE"ha%,S+ wB }z71NAЪYPm7SfLs9!Úm _}LASFDٔ/=#ծ)U#sWB8Dzۖ33n'_lQ;|q\W k}qWH964fPkheMj'z6n#2M܀9+5ГB8= ٓ {j~vR7?h궶sͰ~@۱`.6nO:n;%v8QzQ:p=H*Z#S4EX#6NX6 %rN:R!\iML[c^@*!֭p륯ahn-ƿ &5VELӸBA{rjɇ>gS-fї eNc!!Wd$3!xqx,yy;8HlZ}|[J6 ױ C/..LXq㰮v,jۖF%_z@ZEY@Ν>T{ /f&XKOI* Gڤӵݡk^v8Nҷdd^r:gMtUySjY=,iӠ=PKˀfCuOEBPS/apa.htmlRn0+{7Y"@Svnʣ'DƖ&ߒ/+eYi $͡ݙYntVԸҚ@&4y3((0fP>8=p>Mp5>Xx_|ٰ1MӟBt͔W:숃8Wb<LJ"_zMY]QexƞgjM0D#WE4А&WyEOsECcT6[Y{?jf]'QE^UP#m2k<fw9,v򉉎WVmHkȴt+ b:1wZԇG!!'T1.'[>AY'6P&ܵ$5 PPI.֤ÂD>0A P?qKZaov{">tP369PKˀfCn OEBPS/toc.ncx[o0+,SںIVyr ֈri Ӟs&L\9DS&"sí~&䚊R9W PF|vӘm*c͈k`trOk?a4 )fc")4zCghqe:eY;)x,ߘbQ>Ҭ}\h9)BAfL9r EiMu"]n4yf0߮ctUڧqٖLHS\& |*>fjH1J$Ķf=>nI: %r< rln>ۯPJݮQc %]Bynj#F+mJ>}tVfs̺ Aapu5ƀXW ]cfeLļM"5;Lžk%S'!=F۠!͙{W)kEmp"M>3ywHzFBiB|LlMa['!yN`C=Ť5^2KFx$#GPFn]VG, PKˀfC?.K%OEBPS/index.htmlTmo0_qXB*CIXC ؖ{MZ!s/swհD5%˳!4Kc-B[%3ų+h"%S.9Oz,kbt8_VjY?o|<93<⛟w**$]܃G]7Cč"#C`xLzJX렳$Ub`DKs4EAmMDK6gy wNTT˔;-RMVdbso5tbދdɔt0?{K/VS@{LbJGOD Δ1U[PdP]XނG;Qx\6*P7DŔZ/S2X) ϩsm+dpRÞ՜:_ZaEQF)譙W8)ǚtX?ф|jq6NʋNۜkԝ{EKTTWk:Q-;{LzʱZ\ Y]RMŀqҐݩ}.BIp#6MPVL™ 16lRFN$ e$i FHtr06]PipHz@$B(~P/\`Ѯ5pTVvk6'06jY:h?%jF5<.l]# LVadĽ:xnC`?PKˀfCˍwOEBPS/ch02.htmln0*wzC@Qik@`!T9[[K>[ӻٵp>:6 ?Id=Hrl+S>gS阀nRr'PX)*gUJ#QjuQu}><2bɔY>rr. nX9oo*Q3p6d+Hh%dJeS-jT>ZBJև%7UJ}kD +C ZDpfԄ,K Xe< Ŕ\y\a;R:pr%AYk-{҂䅂3qFCgN)YV٭iЕeMQ} =Z׺M O't$Oj;1' P#*˳z)SAx1U[cٺ\m7L>fr^imi' ob|)Yovp0V>c,SgfՏZ=ru&b3"|Q$oq8mUψ,|2(lKX4ɘ5CnN,l.&Q<+ Y6 ôg :*f /fvbg b47>ՍGк|lF4z΢+:3[l@[܌\j 9(ڤAd$?ًcn?PK̀fC/jsOEBPS/images/tiger.png]W<Տ^LH2l!H*Te8{ϒQll>-!##>9x]o^W; /5y ]P1wQYY&ѣ\P4(N+Y|QmmsCDXbn.qv xs-ZGk%^k)TJ[.#e f:856/~ht o2l-|.ɹ!DfK4q5Kر [DDL{h8QKMv@]TwckwPf w/mT~A&(q5[N & Nm( nS@Qi--~T@;m_)0e^ضLؼQdhayw }!/eY*;myVIOngB֝{tΗZOZYK  BX·9hM&hZVg룑HÃK~=be$ᨪ1{' <1|Cs%vI2ȍ,(}ZkTQfǕoLQ* հF%Tx8|f4=7(&#[ǖ%x^Jۃ)Zwo.io~~i_lXcCWP$E}Jkpx[LӢWmP)eEHb*0O6q5tr3TcFZ1 `:[6 X5Z>z, azjiAF!/miưK R5)OBC\@͉ Y&?`>WSfg䷓Uڏ@g"rxCnAێŽ%oCP 6ȷt4Y/VB%M}n3:P2jվ2~K;=w򯖾^޽M|Q=C$aȔFH|[c qfq;D=q (ࢧ@!(ȋ#Gt )- %+!ţ$[%AAW''B.+t)Ixzg-gPwaʺ 6 )$WW]]DvVr. P2eiJ̑@oTOwH5ݣ+h04Q0╕^bzmXd=uAU;EU,@XEd$j\;cy:::N-l_Λ*wl-氃* aVD T;_YaoMr}w>Gg!`s0(U?( Nȏtl<{*DwƖ@vOs`Ē ˤrIg"KЧxKo`L#ꀪF[o)]n7M[$ @nmVi5,lQjAc#ŋFewvvT9рRvTE&/1h6*gi /Aw_߼C@(%wPǟBXh-G5DOWG4h7ēC!R9ۆJ|t f{myw<K_ꑀ\D2fAm>EፉU("J7Ǜ">: eKМڼn R6 CMг# %cIPh{&N)7ԫҫVAjj:pEU8cITeIIo3RpeK`L EK<"9$3lHkSЀ%w]~ʅm9FN܅i> 0%2LlX"hCe7u ǹ =3C6"MΒ6%–jː66*ʛ{!H%OD FI +h*k֨3VF8b3HGM %uz.i"8 ۆf4`JAs=Cg"tm~d9u Clx}HgH32gfVȩ %Q*EDD{ [H:9iruDheuՀ(L=|zʱH %7-<u](nm("rggn@w.|~&nM4_G\Ǒ zXh"߸Nx!F?VYI,IG=ђR:;jI(ƪY`?u:CYJQ})ukdN4Oȴm ΅uϽ*Ak'=e-TX'%II_&4Z/[`[45qe@ -B1%qOܘ `DKfP++}/u\k"^uخꈃr3gG4?˙ym9{ lBwelha;Pสa xHS\mCp?-.ŧ18* qWFU &P]nxv g5A~}5nʤתHl ׇ4ډ|}oWAa*,)}ॽSOq$:>֨Zq!tI;7(0IHJ%@At;scjV;_Ѳ`G9INׂ~<T͞}ԋS:>^ )C.|)W?g,+T}91+=Y$4Jw*&F) m9)F>OiH9Z@d,F?Q_Ğ72)įgR.bOy+>H:~sqKQ8 ";vd%hGg yJD"dXr!](y`|=oԑ2V.g֠oUZ& Ġzr& g&E)K?M)}E}Ŷ ƙ.Mڱ|_iatfkw1o~MɲJõ~ƻjBgM++ݯwVHpڿLLj8;wiɈ]Ϳd%?kY0=gFQJr_X&aIp mje2Dp%Z fT5&%`vOg% =.뽷 'Oh4 -P,Doq |٣0;lJ>C{gSyYKR vŻ#V//ѶС7GKC/{N_+ǁ03']49nݙW9Ly꨾9 7~t&;"Ou-jpiՎR%m>[<17XDe~g9$+Dc˽&4l:L=' ^f8ũxA? ygWMUmtH1 bmGwfAg,QğiYwqwʟNd9dx}fZXyG-V k8BK/qJ H.tk[yO~BbnMSS*oM1vJLQ%9ُ DI5}0J p-3 fG:\?i1ҿ hu43m{ALE'͏C4`dWKsvVkqʜUVeO06Ne<>{pinn +0!؃ow:Gcw})U'yKG 綝mS[FP|.PrVlvI=tٔ}Wrg;557R h$!DqmylWJ1CAC };&e5 )5.Ȋ%gPLbft{.S /KְMINW&8tu^@E~TlYoܩ ЮgXm >|Ctm31쿌5Z,w0"KiDALSؗ:uRֲ,!._=:A`걟~!rgMbtrʕྫྷLbo׸?Q۴+?ʁw斉{\Ji'[,NooٯWl}UV&nǟ|qm/н ~.PK̀fCoa,mimetypePKˀfCK Ű:META-INF/container.xmlPKˀfCKBOEBPS/content.opfPKˀfC7OEBPS/ch03.htmlPKˀfC{5\GOEBPS/bi01.htmlPKˀfC&!yDIOEBPS/co01.htmlPKˀfCp߶S OEBPS/go01.htmlPKˀfCg޺ OEBPS/pr01.htmlPK̀fCHxkj OEBPS/docbook-xsl.cssPKˀfCHOEBPS/ix01.htmlPKˀfCuOEBPS/apa.htmlPKˀfCn OEBPS/toc.ncxPKˀfC?.K%OEBPS/index.htmlPKˀfCˍwOEBPS/ch02.htmlPKˀfCaOEBPS/ch01.htmlPK̀fC/js%OEBPS/images/tiger.pngPK̀fC$ $M?OEBPS/images/smallnew.pngPK$@asciidoc-8.6.9/doc/asciidoc.10000644000175100017510000001710412236330762016076 0ustar srackhamsrackham'\" t .\" Title: asciidoc .\" Author: [see the "AUTHOR" section] .\" Generator: DocBook XSL Stylesheets v1.76.1 .\" Date: 9 November 2013 .\" Manual: \ \& .\" Source: \ \& 8.6.9 .\" Language: English .\" .TH "ASCIIDOC" "1" "9 November 2013" "\ \& 8\&.6\&.9" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .\" http://bugs.debian.org/507673 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" asciidoc \- converts an AsciiDoc text file to HTML or DocBook .SH "SYNOPSIS" .sp \fBasciidoc\fR [\fIOPTIONS\fR] \fIFILE\fR .SH "DESCRIPTION" .sp The asciidoc(1) command translates the AsciiDoc text file \fIFILE\fR to DocBook or HTML\&. If \fIFILE\fR is \fI\-\fR then the standard input is used\&. .SH "OPTIONS" .PP \fB\-a, \-\-attribute\fR=\fIATTRIBUTE\fR .RS 4 Define or delete document attribute\&. \fIATTRIBUTE\fR is formatted like \fINAME=VALUE\fR\&. Command\-line attributes take precedence over document and configuration file attributes\&. Alternate acceptable forms are \fINAME\fR (the \fIVALUE\fR defaults to an empty string); \fINAME!\fR (delete the \fINAME\fR attribute); \fINAME=VALUE@\fR (do not override document or configuration file attributes)\&. Values containing spaces should be enclosed in double\-quote characters\&. This option may be specified more than once\&. A special attribute named \fItrace\fR controls the output of diagnostic information\&. .RE .PP \fB\-b, \-\-backend\fR=\fIBACKEND\fR .RS 4 Backend output file format: \fIdocbook45\fR, \fIxhtml11\fR, \fIhtml4\fR, \fIhtml5\fR, \fIslidy\fR, \fIwordpress\fR or \fIlatex\fR (the \fIlatex\fR backend is experimental)\&. You can also use the backend alias names \fIhtml\fR (aliased to \fIxhtml11\fR) or \fIdocbook\fR (aliased to \fIdocbook45\fR)\&. Defaults to \fIhtml\fR\&. The \fB\-\-backend\fR option is also used to manage backend plugins (see \fBPLUGIN COMMANDS\fR)\&. .RE .PP \fB\-f, \-\-conf\-file\fR=\fICONF_FILE\fR .RS 4 Use configuration file \fICONF_FILE\fR\&.Configuration files processed in command\-line order (after implicit configuration files)\&. This option may be specified more than once\&. .RE .PP \fB\-\-doctest\fR .RS 4 Run Python doctests in \fIasciidoc\fR module\&. .RE .PP \fB\-d, \-\-doctype\fR=\fIDOCTYPE\fR .RS 4 Document type: \fIarticle\fR, \fImanpage\fR or \fIbook\fR\&. The \fIbook\fR document type is only supported by the \fIdocbook\fR backend\&. Default document type is \fIarticle\fR\&. .RE .PP \fB\-c, \-\-dump\-conf\fR .RS 4 Dump configuration to stdout\&. .RE .PP \fB\-\-filter\fR=\fIFILTER\fR .RS 4 Specify the name of a filter to be loaded (used to load filters that are not auto\-loaded)\&. This option may be specified more than once\&. The \fB\-\-filter\fR option is also used to manage filter plugins (see \fBPLUGIN COMMANDS\fR)\&. .RE .PP \fB\-h, \-\-help\fR [\fITOPIC\fR] .RS 4 Print help TOPIC\&. \fB\-\-help\fR \fItopics\fR will print a list of help topics, \fB\-\-help\fR \fIsyntax\fR summarizes AsciiDoc syntax, \fB\-\-help\fR \fImanpage\fR prints the AsciiDoc manpage\&. .RE .PP \fB\-e, \-\-no\-conf\fR .RS 4 Exclude implicitly loaded configuration files except for those named like the input file (\fIinfile\&.conf\fR and \fIinfile\-backend\&.conf\fR)\&. .RE .PP \fB\-s, \-\-no\-header\-footer\fR .RS 4 Suppress document header and footer output\&. .RE .PP \fB\-o, \-\-out\-file\fR=\fIOUT_FILE\fR .RS 4 Write output to file \fIOUT_FILE\fR\&. Defaults to the base name of input file with \fIbackend\fR extension\&. If the input is stdin then the outfile defaults to stdout\&. If \fIOUT_FILE\fR is \fI\-\fR then the standard output is used\&. .RE .PP \fB\-n, \-\-section\-numbers\fR .RS 4 Auto\-number HTML article section titles\&. Synonym for \fB\-\-attribute numbered\fR\&. .RE .PP \fB\-\-safe\fR .RS 4 Enable safe mode\&. Safe mode is disabled by default\&. AsciiDoc \fIsafe mode\fR skips potentially dangerous scripted sections in AsciiDoc source files\&. .RE .PP \fB\-\-theme\fR=\fITHEME\fR .RS 4 Specify a theme name\&. Synonym for \fB\-\-attribute theme\fR=\fITHEME\fR\&. The \fB\-\-theme\fR option is also used to manage theme plugins (see \fBPLUGIN COMMANDS\fR)\&. .RE .PP \fB\-v, \-\-verbose\fR .RS 4 Verbosely print processing information and configuration file checks to stderr\&. .RE .PP \fB\-\-version\fR .RS 4 Print program version number\&. .RE .SH "PLUGIN COMMANDS" .sp The asciidoc(1) \fB\-\-filter\fR, \fB\-\-backend\fR and \fB\-\-theme\fR options are used to install, remove and list AsciiDoc filter, backend and theme plugins\&. Syntax: .sp .if n \{\ .RS 4 .\} .nf asciidoc OPTION install ZIP_FILE [PLUGINS_DIR] asciidoc OPTION remove PLUGIN_NAME [PLUGINS_DIR] asciidoc OPTION list asciidoc OPTION build ZIP_FILE PLUGIN_SOURCE .fi .if n \{\ .RE .\} .sp Where: .PP \fBOPTION\fR .RS 4 asciidoc(1) \fB\-\-filter\fR, \fB\-\-backend\fR or \fB\-\-theme\fR option specifying the type of plugin\&. .RE .PP \fBPLUGIN_NAME\fR .RS 4 A unique plugin name containing only alphanumeric or underscore characters\&. .RE .PP \fBZIP_FILE\fR .RS 4 A Zip file containing plugin resources, the name must start with the plugin name e\&.g\&. my_filter\-1\&.0\&.zip packages filter my_filter\&. .RE .PP \fBPLUGINS_DIR\fR .RS 4 The directory containing installed plugins\&. Each plugin is contained in its own separate subdirectory which has the same name as the plugin\&. \fBPLUGINS_DIR\fR defaults to the $HOME/\&.asciidoc/filters (for filter plugins) or $HOME/\&.asciidoc/backends (for backend plugins) or $HOME/\&.asciidoc/themes (for theme plugins)\&. .RE .PP \fBPLUGIN_SOURCE\fR .RS 4 The name of a directory containing the plugin source files or the name of a single source file\&. .RE .sp The plugin commands perform as follows: .PP \fBinstall\fR .RS 4 Create a subdirectory in \fBPLUGINS_DIR\fR with the same name as the plugin then extract the \fBZIP_FILE\fR into it\&. .RE .PP \fBremove\fR .RS 4 Delete the \fBPLUGIN_NAME\fR plugin subdirectory and all its contents from the \fBPLUGINS_DIR\fR\&. .RE .PP \fBlist\fR .RS 4 List the names and locations of all installed filter or theme plugins (including standard plugins installed in the global configuration directory)\&. .RE .PP \fBbuild\fR .RS 4 Create a plugin file named \fBZIP_FILE\fR containing the files and subdirectories specified by \fBPLUGIN_SOURCE\fR\&. File and directory names starting with a period are skipped\&. .RE .SH "EXIT STATUS" .PP \fB0\fR .RS 4 Success .RE .PP \fB1\fR .RS 4 Failure (syntax or usage error; configuration error; document processing failure; unexpected error)\&. .RE .SH "BUGS" .sp See the AsciiDoc distribution BUGS file\&. .SH "AUTHOR" .sp AsciiDoc was originally written by Stuart Rackham\&. Many people have contributed to it\&. .SH "RESOURCES" .sp SourceForge: http://sourceforge\&.net/projects/asciidoc/ .sp Main web site: http://asciidoc\&.org/ .SH "COPYING" .sp Copyright (C) 2002\-2011 Stuart Rackham\&. Free use of this software is granted under the terms of the GNU General Public License (GPL)\&. asciidoc-8.6.9/doc/asciidoc.conf0000664000175100017510000000025312031161153016647 0ustar srackhamsrackham# # Customization for AsciiDoc documentation. # [specialwords] ifndef::doctype-manpage[] monospacedwords=(?u)\\?\basciidoc\(1\) (?u)\\?\ba2x\(1\) endif::doctype-manpage[] asciidoc-8.6.9/doc/article-docinfo.xml0000664000175100017510000000456612031161152020020 0ustar srackhamsrackham Dr Lois Common-Demoninator Director, M. Behn School of Coop. Eng. Director of Cooperative Efforts The Marguerite Behn International School of Cooperative Engineering Mr Steven Norman T ATI Senior Application Analyst Foobar, Inc. Application Development Peter Pan Sr. Spiderman Peter's a super hero in his spare time. 2009 Behn International This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program 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 for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 1.1 May 2009 PP Updates. 1.0 October 2003 PP First release. asciidoc-8.6.9/doc/customers.csv0000664000175100017510000000146312031161153016767 0ustar srackhamsrackham"AROUT","Around the Horn","Thomas Hardy","120 Hanover Sq. London","(171) 555-7788" "BERGS","Berglunds snabbkop","Christina Berglund","Berguvsvagen 8 Lulea","0921-12 34 65" "BLAUS","Blauer See Delikatessen","Hanna Moos","Forsterstr. 57 Mannheim","0621-08460" "BLONP","Blondel pere et fils","Frederique Citeaux","24, place Kleber Strasbourg","88.60.15.31" "BOLID","Bolido Comidas preparadas","Martin Sommer","C/ Araquil, 67 Madrid","(91) 555 22 82" "BONAP","Bon app'","Laurence Lebihan","12, rue des Bouchers Marseille","91.24.45.40" "BOTTM","Bottom-Dollar Markets","Elizabeth Lincoln","23 Tsawassen Blvd. Tsawassen","(604) 555-4729" "BSBEV","B's Beverages","Victoria Ashworth","Fauntleroy Circus London","(171) 555-1212" "CACTU","Cactus Comidas para llevar","Patricio Simpson","Cerrito 333 Buenos Aires","(1) 135-5555" asciidoc-8.6.9/doc/images0000777000175100017510000000000012031161153017010 2../imagesustar srackhamsrackhamasciidoc-8.6.9/doc/main.aap0000664000175100017510000002017212031161153015633 0ustar srackhamsrackham##################################################################### # # A-A-P file for making AsciiDoc distribution documentation. # (you can obtain A-A-P from http://www.a-a-p.org) # # Stuart Rackham ##################################################################### :execute ../common.aap ASCIIDOC = python ../asciidoc.py -a revnumber=$(VERS)@ -a revdate="$(DATE)@" A2X = python ../a2x.py :syseval which fop | :assign FOP @if not _no.FOP: :syseval which fop.sh | :assign FOP :syseval which lynx | :assign LYNX # Converts HTML to text. :syseval which xmllint | :assign XMLLINT # Validates XML. :syseval which dblatex | :assign DBLATEX # Converts DocBook XML to PDF. :syseval which aspell | :assign ASPELL :syseval which xsltproc | :assign XSLTPROC ROOT = asciidoc asciidoc.1 INFILES = $*(ROOT).txt CHUNK_DIR = ./asciidoc.chunked HTMLHELP_DIR = ./asciidoc.htmlhelp HTMLHELP_FILE = asciidoc OUTFILES = $*(ROOT).html $*(ROOT).css.html $*(ROOT).css-embedded.html \ asciidoc.pdf asciidoc.1.man a2x.1.man \ article.html book.html book-multi.html asciidoc.xml asciidoc.1.xml \ ../BUGS ../CHANGELOG ../README ../INSTALL \ latex-backend.html \ $HTMLHELP_DIR/index.html \ $CHUNK_DIR/index.html \ article.pdf \ latexmath.pdf \ latex-filter.pdf \ source-highlight-filter.pdf \ music-filter.pdf \ book.epub \ article-standalone.html \ article-html5-toc2.html TEST_FILES = $*(ROOT).css-embedded.html article.css-embedded.html book.css-embedded.html \ article.xml book.xml book-multi.xml asciidoc.xml asciidoc.1.xml \ asciidoc.1.html a2x.1.xml music-filter.xml \ book.epub asciidoc.epub \ ##################################################################### # Filetype build rules. ##################################################################### :rule %.epub : %.txt :sys $A2X -f epub -d book --epubcheck --icons $source :rule %.text : %.txt # Convert AsciiDoc to HTML then use lynx(1) to convert HTML to text. @if not _no.LYNX: :print WARNING: lynx(1) unavailable: skipping $target file generation @else: opt = -f ../text.conf @if source_list[0] == 'asciidoc.1.txt': opt += -d manpage @else: opt += -n :sys $ASCIIDOC $opt -b html4 -o - $source | \ lynx -dump -stdin > $target :rule %.css.html : %.txt opt = @if source_list[0] == 'asciidoc.1.txt': opt += -d manpage @else: opt += -n opt += -a toc -a toclevels=2 -a scriptsdir=../javascripts :sys $ASCIIDOC $opt -b xhtml11 -a linkcss -a icons -a stylesdir=../stylesheets -o $target $(source[0]) @if _no.XMLLINT: :sys $XMLLINT --nonet --noout --valid $target @else: :print WARNING: xmllint(1) unavailable: skipping validation :rule %.css-embedded.html : %.txt opt = @if source_list[0] == 'asciidoc.1.txt': opt += -d manpage @else: opt += -n opt += -a toc -a toclevels=2 :sys $ASCIIDOC -b xhtml11 $opt -o $target $(source[0]) @if _no.XMLLINT: :sys $XMLLINT --nonet --noout --valid $target @else: :print WARNING: xmllint(1) unavailable: skipping validation :rule %.xml : %.txt opt = @if source_list[0] in ('asciidoc.1.txt','a2x.1.txt'): opt += -d manpage @else: opt += -n @if source_list[0] == 'asciidoc.txt' or source_list[0].startswith('book'): opt += -d book :sys $ASCIIDOC $opt -b docbook $(source[0]) @if _no.XMLLINT: :sys $XMLLINT --nonet --noout --valid $target @else: :print WARNING: xmllint(1) unavailable: skipping validation :rule %.sgml : %.txt opt = @if source_list[0] in ('asciidoc.1.txt','a2x.1.txt'): opt += -d manpage @if source_list[0] == 'asciidoc.txt' or source_list[0].startswith('book'): opt += -d book :sys $ASCIIDOC $opt -b docbook-sgml $(source[0]) :rule %.html: %.xml :sys $XSLTPROC --nonet --stringparam admon.textlabel 0 --stringparam html.stylesheet ./docbook-xsl.css ../docbook-xsl/xhtml.xsl $source >$target :rule %.man : %.xml :sys $XSLTPROC --nonet ../docbook-xsl/manpage.xsl $source :sys touch $target # Dummy target. :rule %.fo: %.xml :sys $XSLTPROC --nonet --stringparam admon.textlabel 0 ../docbook-xsl/fo.xsl $source >$target # This kludge forces the User Guide and LaTeX related PDFs to be generated # using dblatex so we include a dblatex example in the distribution. @if _no.DBLATEX: asciidoc.pdf: asciidoc.txt :sys $ASCIIDOC -b docbook $(source[0]) :sys $DBLATEX -p ../dblatex/asciidoc-dblatex.xsl -s ../dblatex/asciidoc-dblatex.sty -o $target asciidoc.xml latexmath.pdf: latexmath.xml :sys $DBLATEX -p ../dblatex/asciidoc-dblatex.xsl -s ../dblatex/asciidoc-dblatex.sty -o $target $source latex-filter.pdf: latex-filter.xml :sys $DBLATEX -p ../dblatex/asciidoc-dblatex.xsl -s ../dblatex/asciidoc-dblatex.sty -o $target $source # Force the Source Highlighter PDF to be generated using dblatex # because dblatex has builtin source code highlighting. @if _no.DBLATEX: source-highlight-filter.pdf: source-highlight-filter.xml :sys $DBLATEX -p ../dblatex/asciidoc-dblatex.xsl -s ../dblatex/asciidoc-dblatex.sty -o $target $source @if _no.FOP: :rule %.pdf: %.fo :sys $FOP $source $target @elif _no.DBLATEX: # Fall back to dblatex if no FOP. :rule %.pdf: %.xml :sys $DBLATEX -p ../dblatex/asciidoc-dblatex.xsl -s ../dblatex/asciidoc-dblatex.sty -o $target $source @else: :rule %.pdf: :print WARNING: PDF processor unavailable: skipping $target file generation ##################################################################### # Explicit file generation (cases that don't fit the rules). ##################################################################### article-standalone.html: article.txt :sys $ASCIIDOC -a data-uri -a icons -a toc -a max-width=55em -o $target $source article-html5-toc2.html: article.txt :sys $ASCIIDOC -b html5 -a icons -a toc2 -a theme=flask -o $target $source asciidoc.1.html: asciidoc.1.txt :sys $ASCIIDOC -d manpage -b html4 $source @if _no.XMLLINT: :sys $XMLLINT --nonet --noout --valid --html $target @else: :print WARNING: xmllint(1) unavailable: skipping validation # User Guide 'chunked' into linked HTML pages. $CHUNK_DIR/index.html: asciidoc.txt :sys $A2X -fchunked -dbook --icons -D ./ asciidoc.txt # HTML Help formatted User Guide. $HTMLHELP_DIR/index.html: asciidoc.xml :sys $A2X -fhtmlhelp -dbook --icons -D ./ asciidoc.txt ../BUGS: ../BUGS.text # Make BUGS.text and copy to BUGS. :copy ../BUGS.text ../BUGS ../CHANGELOG: ../CHANGELOG.text # Make CHANGELOG.text and copy to CHANGELOG. :copy ../CHANGELOG.text ../CHANGELOG ../README: ../README.text # Make README.text and copy to README. :copy ../README.text ../README ../INSTALL: ../INSTALL.text # Make INSTALL.text and copy to INSTALL. :copy ../INSTALL.text ../INSTALL asciimathml.html: asciimathml.txt :sys $ASCIIDOC -a asciimath $source # No xmllint(1) checking -- fails on embedded JavaScript. latexmathml.html: latexmathml.txt :sys $ASCIIDOC -a latexmath $source # No xmllint(1) checking -- fails on embedded JavaScript. ##################################################################### # Build commands. ##################################################################### all: $OUTFILES clean: :del {f} $OUTFILES $TEST_FILES :del {f} *.bak # Remove aspell backups. spell: $INFILES ../CHANGELOG.txt ../README.txt ../BUGS.txt ../INSTALL.txt \ a2x.1.txt faq.txt asciidocapi.txt testasciidoc.txt \ epub-notes.txt publishing-ebooks-with-asciidoc.txt \ source-highlight-filter.txt \ slidy.txt slidy-example.txt # Interactively spell check all files. @for s in source_list: :sys {i} $ASPELL check -p ./asciidoc.dict $s clean_testfiles: :del {f} $TEST_FILES :del {f} music*.png # Force Lilypond to run. test: clean_testfiles $TEST_FILES # Force generation and validation of .html and Docbook (.xml) files. asciidoc-8.6.9/doc/article.pdf0000664000175100017510000011207712236331045016356 0ustar srackhamsrackham%PDF-1.4 % 4 0 obj << /Title (The Article Title) /Author (Author's Name) /Creator (DocBook XSL Stylesheets with Apache FOP) /Producer (Apache FOP Version 1.0) /CreationDate (D:20131106160612+13'00') >> endobj 5 0 obj << /N 3 /Length 11 0 R /Filter /FlateDecode >> stream xwTSϽ7PkhRH H.*1 J"6DTpDQ2(C"QDqpId߼y͛~kg}ֺLX Xňg` lpBF|،l *?Y"1P\8=W%Oɘ4M0J"Y2Vs,[|e92<se'9`2&ctI@o|N6(.sSdl-c(2-yH_/XZ.$&\SM07#1ؙYrfYym";8980m-m(]v^DW~ emi]P`/u}q|^R,g+\Kk)/C_|Rax8t1C^7nfzDp 柇u$/ED˦L L[B@ٹЖX!@~(* {d+} G͋љς}WL$cGD2QZ4 E@@A(q`1D `'u46ptc48.`R0) @Rt CXCP%CBH@Rf[(t CQhz#0 Zl`O828.p|O×X ?:0FBx$ !i@ڐH[EE1PL ⢖V6QP>U(j MFkt,:.FW8c1L&ӎ9ƌaX: rbl1 {{{;}#tp8_\8"Ey.,X%%Gщ1-9ҀKl.oo/O$&'=JvMޞxǥ{=Vs\x ‰N柜>ucKz=s/ol|ϝ?y ^d]ps~:;/;]7|WpQoH!ɻVsnYs}ҽ~4] =>=:`;cܱ'?e~!ańD#G&}'/?^xI֓?+\wx20;5\ӯ_etWf^Qs-mw3+?~O~ endstream endobj 6 0 obj [/ICCBased 5 0 R] endobj 7 0 obj << /Type /Metadata /Subtype /XML /Length 12 0 R >> stream The Article Title Author's Name 2013-11-06T16:06:12+13:00 1.4 Apache FOP Version 1.0 2013-11-06T16:06:12+13:00 DocBook XSL Stylesheets with Apache FOP 2013-11-06T16:06:12+13:00 endstream endobj 10 0 obj << /Name /Im1 /Type /XObject /Length 13 0 R /Filter /FlateDecode /Subtype /Image /Width 254 /Height 259 /BitsPerComponent 8 /ColorSpace [/Indexed /DeviceRGB 255 <00000030303048000060646060980098240098989898CC30A01820A02448B03058B06460B0B0B0C83C48C87020C8CCC8E06488E09898E0E4B0E87C38E88C48E88C50E89458E89860E8A470E8A878F0B088F0B890F0BC98F0C4A8F0CCB0F87078F8D8C0F8DCC8F8E0D0F8E4D0F8F0E8F8FCC8F8FCF8000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000>] >> stream x 8u .!Pn!ѼJhsoٖFz.w]r.w]rwbq%4ĩ6Z ,_c770>#/M;v%)8S4x% 2\}=DS4T7Us4=M?bEgv> 2s(ZN*b=<ȯ@OT "O- Clq`=GMߜ"bߩ1ijORm靜fdkՉZS%=Nu@/oEO.}F¼~QN6;M1c uCB3{Aoނy/U^kZ0}&2jv'I[ UI>s z}) oaO[R<}z=_7}BG][Ts 2%M?TMnCӷ؝th^ߚ7jr??ny*^עǀoON~(ė9yc[b o6}[VP|t%퍭'n 0LBf{UE FlmzqZN^.MS(E k_HV5Kϓ(4W>ٺ <^ZV 6n /4TЯ*iq> =]5*Wk*M/N{jG&ު5| {yyyQ-;E7B6נGLX+FX[G_#"`AQ“.ƿ] k96:_OUW_Gc{ԯ }ƼAk.aV,0\E7w g^_NwpB9N=ss>ޣ5&O_KỼ`o4ѓL:aCwXB|p"akڳOLY"t@J}%#_(O8O|+zDmny_^=o9 ov#-s|/V{aW­S/"o@9 .=f"NӋ^>~]N.E ?=HOAz.jZ?zAJOq*Ú\iVB@(I$I<34/I*?x0zŽvs _MqђGU1m|wy'W~E5;%ӻibFH/]x9'Eo mϦΏ0>=x{d zkY.\3'rlT)/&ЯW Bo^'_'#a]1zD@۝sz&9fgWMZ{+43~wH#=Nhl\ͅ znwA;~P'8$F-,Am/#'%f' RPN0fǦ/:($cpDsRz/X_?I>@($*|weƯ"%kkREV/G~:|uzӃTXС'`A/سGw?W{/)%dcMۗ:w@=f HR3"@'{SH1( 8ˬh<"ߤ?r)ڙ.io΍E]cV)ؓ\zGKG-L/4'_āH@d8c?*zbg0^CIdz .<؝_ޭUIe?o[sD0dzKz91!-V͡3e |%Ϳt< Ҍ*2l4~ݡ˓Q/m4#o>>g{ $q@o5%%)׊p3ѫqϳC_>/hmbG)ьDxѻLꜯ5d34uex$ÙS<۔ u|j;ySMcM*gyBh N2/xwKW/ zHTzѭ?^YfOy+>?%'Z 7q.kVuG<Z^>?E#/i2k5ҊUB-Cb3V=*U|T~*>ԑm#މ=n+dlZv'Xzðێwih/O''uxG w~8q]rȆaC'Ww[I3Px<) >nd~옂]ZԥDtMk-*:~Z><(IV+~EñwCI|}eHV[/x=n΅0]?֚C N3q؀K/CM;sM#~ ]?zN`{w|{3W-ܵ(׮B tWy30!W˲Ka`.D/)%wymzsO1Jvȿ.2gf'CHW;Qy>e. ӆwFJ#6l? }N.Ԕ0 wIf)p3 3oG|<j> "%&}d7J z;ow4ĽԊiфW['Zހ|rs鋷gwqtZ MEK/f[zS p$9֗Z7; ^x4۴ymbоu8]0:&Sٿ'i/{b]*|ÊP8 XHO`|D%1 N\ǹ=*7Lw˶j!1q'"q§y2;UwpZuc=dEYE-fQzTCꃍ2oWV͑|ݰ ^\|CǏM[客 {({KZ§OIm(>6W5m ̄W|>+b}͜wUԼBvLʋNFpq<_RBFr:NG Xmفñ6^ij<3dm!}:!aQ]x $7D;Mq-o/U>?hW|PӚOeҥK(OUrqp*,.+tOH'џ1ߵV`[<ua@,~3z<DZOj? h39qeqfTM?n"e!Ӕ2d"RM *}'Cl 4 ?ۛ/?0^u|0ǵdru,Qf&5>"c?R>d]>xc=r_VB.4=-oAb#Lo*>bᓳ], ~U.?*ci>|#.U\6zKRrl] eÞ!dz0Hr XM2c6>=O!?cId7ϟ)֋q?+H?X,z?}wgw)3뗀KYxD{h}В)BOl@LnO5z0z;64 &b{\ㆋп^,;XT|{n\?;}6~sןLᯁ}-cEu %u##ݕbawfcÈ&{='zyRBOߪ}6|J}*7w&&MaU39 |QO׵iOC=WF^|ޝO׽-GoB_اF|NU^֦7& _"qݏNMk 7~sB>={6p?7=_ׯt9M+HS ؼhOպćWY|b%j xt {wJw{z{(d8J ĉ~/pEU O=5 Lz<$MϪ'X໲U^lĪplh^(ۋ^5 +ޡsz=EosUgX_vC8|Oo5HᑮGll3Wl ̩$oU fMDg %*7, }_ȅ"0ej~mvFO)' |_CpԲXov!"3݈<UDS k_X0Wsբǐ(Aq'8MJz $EƍoN8s=à;,DcPmgo啅*ouODNi*>!8ҷ&3qj>[~kiRO2e:mG aO456!8l7sz"þcQ xb%9{I b :VkӚިա,PqCNH!kutP{2`gDOxQx[ӳӕ oǠ;|o>`: J>NzH{;# p0pMɆ4eX;rEEٶ<׺yڤx3z}RR\hSuծC]tK 1ߪlM4X0cqszt ~ PpJN6͝mT8_\!CRᑣ21QOvJS>E%xB {&7_Z{5l-ѫ ʟ֧Ժʾ69RA?X@ғ7 V:qב&9EwiuI;鸝L¿&l>+_\ ha6cofE>}< 0%KtJ ǻw燑 ^L_ \0mH)B(zdqI\Kz)= NB!V9B*=D@u=12~uL2>[,w]?-C endstream endobj 11 0 obj 2596 endobj 12 0 obj 884 endobj 13 0 obj 6133 endobj 14 0 obj << /Length 15 0 R /Filter /FlateDecode >> stream xYKs6W=@oɴiKN'AhSQ%N}$(HG51"owAaĀ}Ɉ13PS$ZA񔅥[<K{sQx7@QPm7}y|~m)܍~޼U8Lo)eʂ%#9|azŦYL _GWj!41L$ObmR ~gw;?EPC'֚?{![MZp.p2pƬMF8ć8jR;\{  e6mvۤ]e1|vwHM8nMB43/96IT+.1]W 2טfT3BHMh>*gEk=Mdt3㊚־, U кĘN̓ ;yh$Gа~+f~  tc]}Pk 4o:i*画ځ8+"_Y:Z@;18zE?P3N7>ƼG!13pWU Eg`~~0Q ;v8P(8[ƞ=wNG6pFv=VjTD/1> >"$\cXqܜ5Ƈ8:X93sxMO(,tw5~>zPЩEn3Z n6< e>Fw/~ZsAZCfeGr鮄׉o ;Z]dѱC:5LCƎ%}E]xв%*IwOYB;A6jY[WrZ+h%j=#yxЗS#c.c ltoȜ:_la6`շfiyr?Q@?p$eBWW&`pDðk*v~+6.Sլ*Ud"7*TY+3&6x{5/6C@Zi=f%,%prZ/emL rݹ)Mm.B\CX4esdL;Lp֘ěWZlUV!RH Q(򤹳϶?ٗ,xoCݭŦ/ "ۖf.,,0/VFsV8`!hLj(2!: {YVjEA+?w8qC+ &<Hb2 _{AZL҆@bgmQ4Lt endstream endobj 8 0 obj << /Resources 3 0 R /Type /Page /MediaBox [0 0 595.275 841.889] /CropBox [0 0 595.275 841.889] /BleedBox [0 0 595.275 841.889] /TrimBox [0 0 595.275 841.889] /Parent 1 0 R /Contents 14 0 R >> endobj 15 0 obj 1368 endobj 17 0 obj << /Type /Action /S /GoTo /D [16 0 R /XYZ 54.0 434.153 null] >> endobj 18 0 obj << /Type /Action /S /GoTo /D [8 0 R /XYZ 54.0 289.671 null] >> endobj 19 0 obj << /Type /Annot /Subtype /Link /Rect [ 262.968 689.158 339.96 699.958 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 18 0 R /H /I >> endobj 21 0 obj << /Type /Annot /Subtype /Link /Rect [ 261.648 662.822 296.304 673.622 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 17 0 R /H /I >> endobj 23 0 obj << /Type /Annot /Subtype /Link /Rect [ 122.988 171.403 128.988 182.203 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 22 0 R /H /I >> endobj 25 0 obj << /Type /Annot /Subtype /Link /Rect [ 99.336 142.603 105.336 153.403 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 24 0 R /H /I >> endobj 27 0 obj << /Type /Annot /Subtype /Link /Rect [ 146.988 113.803 152.988 124.603 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 26 0 R /H /I >> endobj 29 0 obj << /Type /Annot /Subtype /Link /Rect [ 152.988 99.403 158.988 110.203 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 28 0 R /H /I >> endobj 31 0 obj << /Type /Annot /Subtype /Link /Rect [ 159.984 55.787 165.984 66.587 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 30 0 R /H /I >> endobj 32 0 obj << /Length 33 0 R /Filter /FlateDecode >> stream xWKs6W)T(ޏ5q3i%TH*}IECŷ~ 03V2bj^g$]/iK$W `h+8]rFT?I|8Wp;> p(Q4gxq77[Ha1Mq<y֔2rܽ,=\U&J>D-&-}sc"-*^£ q[ke,ոқw^BΘs9` Ky3u#}:C< ĺYGlGBwb8yhJٖ Rc䐠YP%!r3f6krx7̽_c%kl sZiȾG$-"]VIQAũ%N[Lz} EY#lBZc> a3MAc"4LӐ/d܂ϪbۅmYJm"9Tbli|N-G7 \k%0$LR$A9 c>CtN9l0/B4>MPM\dRsn+ #q8Xc(18e戴(.E#{`VX?{\Z4*-r{89Eh8eҋ&# ^%8'*6M+sDiL'=c!>ݤ%7뜂؟쩶3Wgߒ 9/2i}UΐͿ} lI"ǰv]bvP֗<}:db$w ]OFjt9\m|fxyy|yspAݓ0<× ?,TᧇO0gy5vo>޵"Jcnx3A2ڬjPiPY:4w+)1L4רSeR\TTgfں uױm7CGAL}ZA3洛 4,/Vm{lbbgyQr!#T?v> endobj 33 0 obj 1299 endobj 35 0 obj << /Name /Im2 /Type /XObject /Length 37 0 R /Filter /FlateDecode /Subtype /Image /Width 48 /Height 48 /BitsPerComponent 8 /ColorSpace /DeviceGray >> stream x1 P8 t~5k;PTƏxѣ>~I>< endstream endobj 36 0 obj << /Name /Im3 /Type /XObject /Length 38 0 R /Filter /FlateDecode /Subtype /Image /Width 48 /Height 48 /BitsPerComponent 8 /ColorSpace [/ICCBased 5 0 R] /SMask 35 0 R >> stream x{PSWZݪժUq}2l;Ӈmei-ڑj]A"KAy( *C3 ^&$! IMnnm_ˆvfvw=gw~瞜{'?-Wܹt_S7\_Ro|ҍ G6<ش@bb~y5}VT/,R[@׷nM2eʔSΚ5KձWt?l[f6j[n}iӦ=fϞ ݂`Μ9Ýv[^}s9MÇ.z…0n:8=.}|Rw{IumřPo_v#3&SEOk$'S"RRM_c96Lk󼼼`=ygZ'n_ી${N='x3{#lh!q2TMdFA]b_ܹsmZVϋYss͙ ~gՒ܍Z^\yW]I!aI єISL `8'ZƠ%>>>wgѢE}-:)'d1c:0.C0}Р-ekBTHpL&)*RL2c`9 l'gٲe$dg=]茸6,yzOMUQ~EY,eמ\YN⎓NZjVW\<$J ?S", UWyy)qi6W^1φko;$Kٴ/?Vv8(rPXI$‹ 9QU%I8i W )\@D4T Ixlj(O =ldt>Ox<`hkrßeE"#\ < a!;&xΥ|yCiWeq'xYűs :æ5j9? 28tˇO((=e>< '\QqK+QH\ri\cxf;o>N ;VDum~Ю;ȁŞw䐸h@cF!I\+S&bΛ7ao¼ gOmv(8II I.?wLrr|鸏w%wmvOU%*\%J7?L?|{/>|N:p]`A@@@^^^MM B  9s&"׭0TÇT*Uw> endobj 30 0 obj << /Type /Action /S /GoTo /D [34 0 R /XYZ 420.096 274.351 null] >> endobj 24 0 obj << /Type /Action /S /GoTo /D [34 0 R /XYZ 239.304 231.151 null] >> endobj 26 0 obj << /Type /Action /S /GoTo /D [34 0 R /XYZ 245.304 231.151 null] >> endobj 22 0 obj << /Type /Action /S /GoTo /D [34 0 R /XYZ 251.304 231.151 null] >> endobj 28 0 obj << /Type /Action /S /GoTo /D [34 0 R /XYZ 254.304 231.151 null] >> endobj 40 0 obj << /Name /Im4 /Type /XObject /Length 42 0 R /Filter /FlateDecode /Subtype /Image /Width 27 /Height 17 /BitsPerComponent 8 /ColorSpace /DeviceGray >> stream xc``&0c)@HDM\A0z9< UD~0 endstream endobj 41 0 obj << /Name /Im5 /Type /XObject /Length 43 0 R /Filter /FlateDecode /Subtype /Image /Width 27 /Height 17 /BitsPerComponent 8 /ColorSpace [/ICCBased 5 0 R] /SMask 40 0 R >> stream x 0C//@5q0a*i1~Lʼc&!2;#]H}7VAPC7*^ƞ!FV6a8pcY}'z. endstream endobj 42 0 obj 58 endobj 43 0 obj 113 endobj 44 0 obj << /Type /Annot /Subtype /Link /Rect [ 66.0 604.214 164.043 615.014 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 39 0 R /H /I >> endobj 46 0 obj << /Type /Annot /Subtype /Link /Rect [ 553.02 604.214 559.02 615.014 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 39 0 R /H /I >> endobj 47 0 obj << /Type /Annot /Subtype /Link /Rect [ 90.0 589.814 233.829 600.614 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 18 0 R /H /I >> endobj 48 0 obj << /Type /Annot /Subtype /Link /Rect [ 553.007 589.814 559.007 600.614 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 18 0 R /H /I >> endobj 49 0 obj << /Type /Action /S /GoTo /D [16 0 R /XYZ 54.0 769.889 null] >> endobj 50 0 obj << /Type /Annot /Subtype /Link /Rect [ 66.0 575.414 177.234 586.214 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 49 0 R /H /I >> endobj 51 0 obj << /Type /Annot /Subtype /Link /Rect [ 553.02 575.414 559.02 586.214 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 49 0 R /H /I >> endobj 52 0 obj << /Type /Action /S /GoTo /D [16 0 R /XYZ 54.0 661.022 null] >> endobj 53 0 obj << /Type /Annot /Subtype /Link /Rect [ 66.0 561.014 175.825 571.814 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 52 0 R /H /I >> endobj 54 0 obj << /Type /Annot /Subtype /Link /Rect [ 553.104 561.014 559.104 571.814 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 52 0 R /H /I >> endobj 55 0 obj << /Type /Action /S /GoTo /D [16 0 R /XYZ 54.0 580.078 null] >> endobj 56 0 obj << /Type /Annot /Subtype /Link /Rect [ 90.0 546.614 222.627 557.414 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 55 0 R /H /I >> endobj 57 0 obj << /Type /Annot /Subtype /Link /Rect [ 553.093 546.614 559.093 557.414 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 55 0 R /H /I >> endobj 58 0 obj << /Type /Action /S /GoTo /D [16 0 R /XYZ 54.0 499.084 null] >> endobj 59 0 obj << /Type /Annot /Subtype /Link /Rect [ 66.0 532.214 176.081 543.014 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 58 0 R /H /I >> endobj 60 0 obj << /Type /Annot /Subtype /Link /Rect [ 553.186 532.214 559.186 543.014 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 58 0 R /H /I >> endobj 61 0 obj << /Type /Action /S /GoTo /D [16 0 R /XYZ 54.0 375.817 null] >> endobj 62 0 obj << /Type /Annot /Subtype /Link /Rect [ 66.0 517.814 155.472 528.614 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 61 0 R /H /I >> endobj 63 0 obj << /Type /Annot /Subtype /Link /Rect [ 553.186 517.814 559.186 528.614 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 61 0 R /H /I >> endobj 64 0 obj << /Type /Action /S /GoTo /D [16 0 R /XYZ 54.0 255.014 null] >> endobj 65 0 obj << /Type /Annot /Subtype /Link /Rect [ 66.0 503.414 140.186 514.214 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 64 0 R /H /I >> endobj 66 0 obj << /Type /Annot /Subtype /Link /Rect [ 553.186 503.414 559.186 514.214 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 64 0 R /H /I >> endobj 67 0 obj << /Length 68 0 R /Filter /FlateDecode >> stream xMs㶖?vөJ[jjj:sӹwʴfd!۴,9Nb[.77mQ!M~ጭ|&9spugb֊q:<㗂6e.p5sclm~mW.~z5}4#O=dZ}ecOG9qWvkC[`5w]^}_;*wTqv%Zk}17__|ynmVn KG}x}t?l>ܬ?y^#lekNŽ-_r)Fvgc-柳ftvXtWZ.|ay'ZNKR>S̏?aUWɗ&_-'I>W]隆Ku>'sY8iӫ:ǖ濖Ͱجsdfmc&M:1_h$Ƙv~Zo_0\o*nA/5'>Yqmδ Žeqa H6ųx`+'Ņ#3T#SL51TSL53T3S-L0ՂTg#UowH;RzTG3UaT*SULUj`jd&jbfjfZX*Eb8*C⑪x* S*LU2UeTS L50T#SL52TSML53T3S-L0T RUT"UHURUT!UHU=RUTՖՖՖՖՖՖՖՖՖՖՖՖՖՖՖՖՖՖՖՖՖds\u;{Jź3m[dw`͇oֻ^8ܿ~$\pf9)֨;\ 3R+'wőj+8Rm>GGT SULU2TS MUG œeqaųgL0T Rm>GԇHPR{J}(T S*LU2UejdFjb&jfZjaR#V#qT[őj+8Rm>gT SULUj`jdFjbfjf֣\=*qm|6iOL޸vܒ3"_=ްYj? K.n9D5qF-Ӥ~dpUb(]H~#&ҙaVFYFdeD Y&deFYfdYeAYb-XI;bXzO,'K KA,Y*Tde@Yc>b.$=J$J+J'eFYdYXbYH4G,KqRO,KR KA,Y*Tde@YFdeD Y&deBYfdeAYbX%jZbX#ꈥzbXG,Y dR"ˀ, 2"ˈ,#2!˄,2#ˌ, l`m!UKZO[ʸorxnJ|xy㰸9.ׅt~.LJ u\Qͪ~-.&X\YCI; ыn1GIl70LG~Rka`ŕ׃K,^H]H]KqQn$T(T SLU2TS{/(^.Q: &.Z 6r(% O{9n~Ҳ~28my%"G. G"I$J+J'g!iBβ KA,Y*Tde@YdeDY&deBYfdeFYdYIJL!ibN4l'RHX($M,Id)R"KE,YdehgWu::VN$,J JG.$=JFYdYe;YBIJ*!ibN4lI@v KA,Y*Td2 ˀ,2"ˈ,#L2!˄,32#˂, ,ȲKR-TK,KuRTO,KR=d)R"KE, 2 ˀ,#2"˄,L2#ˌ,3Ȳ=ձݛT83 ;N;Q$&[vo|l7j>\˛<-6|1;Qͧ_]Oss\f3>9 #myðجr=֟LGn_^~!qaXW=&-9뇋zO]^}Ze1nr.O֛zu[zL7\n)f1vvylLWɚŶ_j-fbS7tAV8\ϦևnFknA-4ğ馚n)X˖z(MVǾ\Wat5n/_ejw[/0ڴz6nM߆Ζthj5ncL7u̶y_oպTNIi?Su ;c]z~\n҆Cu{vO 8ߎnbڦ|?[7{&FD͇1;l=Yo&2Ӎ s㶣S\ f1Vyz4ej[{'e#o u,u2:Wwou;>;Ih!W~ݽA_/f7:oOkv~Ù߆O|VwMڇհMu? =DͰZL7?̧:A<:ʷ?q8p{|XI8S3AXH8~!c}oϵ~xxof4O<ݰVu?Qڤ?K7PhSr;LQb^;_=T_b endstream endobj 45 0 obj [ 44 0 R 46 0 R 47 0 R 48 0 R 50 0 R 51 0 R 53 0 R 54 0 R 56 0 R 57 0 R 59 0 R 60 0 R 62 0 R 63 0 R 65 0 R 66 0 R ] endobj 34 0 obj << /Resources 3 0 R /Type /Page /MediaBox [0 0 595.275 841.889] /CropBox [0 0 595.275 841.889] /BleedBox [0 0 595.275 841.889] /TrimBox [0 0 595.275 841.889] /Parent 1 0 R /Annots 45 0 R /Contents 67 0 R >> endobj 68 0 obj 4666 endobj 70 0 obj << /Type /Action /S /GoTo /D [34 0 R /XYZ 242.304 231.151 null] >> endobj 71 0 obj << /Type /Annot /Subtype /Link /Rect [ 87.336 740.009 93.336 750.809 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 70 0 R /H /I >> endobj 73 0 obj << /Type /Action /S /GoTo /D [34 0 R /XYZ 287.304 245.551 null] >> endobj 74 0 obj << /Type /Annot /Subtype /Link /Rect [ 103.332 696.329 109.332 707.129 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 73 0 R /H /I >> endobj 75 0 obj << /Type /Action /S /GoTo /D [16 0 R /XYZ 345.96 704.958 null] >> endobj 76 0 obj << /Type /Annot /Subtype /Link /Rect [ 196.308 652.649 202.308 663.449 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 75 0 R /H /I >> endobj 77 0 obj << /Type /Action /S /GoTo /D [34 0 R /XYZ 260.304 231.151 null] >> endobj 78 0 obj << /Type /Annot /Subtype /Link /Rect [ 128.988 638.249 134.988 649.049 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 77 0 R /H /I >> endobj 79 0 obj << /Type /Action /S /GoTo /D [34 0 R /XYZ 248.304 231.151 null] >> endobj 80 0 obj << /Type /Annot /Subtype /Link /Rect [ 134.988 580.169 140.988 590.969 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 79 0 R /H /I >> endobj 81 0 obj << /Type /Action /S /GoTo /D [34 0 R /XYZ 257.304 231.151 null] >> endobj 82 0 obj << /Type /Annot /Subtype /Link /Rect [ 140.988 565.769 146.988 576.569 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 81 0 R /H /I >> endobj 83 0 obj << /Length 84 0 R /Filter /FlateDecode >> stream xTMo@W$v{T$(8T=ɒZ$M#{f$Y'7"PrϷh cd'p/)jbX嚃@@%9s?R𥺾:Sk7& @K`Y]ՇHCeȜR%T^.n@TT1^I'C54 dPQo 2~r?n5{bȝP$D́HyȞňg^ϚUH!bm'['Ȍ:8fVMg1hоq>a+\~OP.:vƌ, #-]ˆ}Ȍba4=Èk.iig߲v!ӈ%YyJ,? rfTy-6mY+n`A (R$@X]ЙPITr0!RNh@è"tῦ b:/lK endstream endobj 72 0 obj [ 71 0 R 74 0 R 76 0 R 78 0 R 80 0 R 82 0 R ] endobj 69 0 obj << /Resources 3 0 R /Type /Page /MediaBox [0 0 595.275 841.889] /CropBox [0 0 595.275 841.889] /BleedBox [0 0 595.275 841.889] /TrimBox [0 0 595.275 841.889] /Parent 1 0 R /Annots 72 0 R /Contents 83 0 R >> endobj 84 0 obj 513 endobj 85 0 obj << /Type /Action /S /GoTo /D [34 0 R /XYZ 54.0 769.889 null] >> endobj 86 0 obj << /Type /Action /S /GoTo /D [8 0 R /XYZ 54.0 224.89 null] >> endobj 87 0 obj << /Type /Action /S /GoTo /D [8 0 R /XYZ 54.0 164.256 null] >> endobj 89 0 obj << /Title (The Article Title) /Parent 88 0 R /Next 91 0 R /A 85 0 R >> endobj 90 0 obj << /Type /Action /S /GoTo /D [34 0 R /XYZ 54.0 680.75 null] >> endobj 91 0 obj << /Title (Table of Contents) /Parent 88 0 R /Prev 89 0 R /Next 92 0 R /A 90 0 R >> endobj 92 0 obj << /Title /Parent 88 0 R /Prev 91 0 R /Next 96 0 R /First 93 0 R /Last 93 0 R /Count -3 /A 39 0 R >> endobj 93 0 obj << /Title /Parent 92 0 R /First 94 0 R /Last 94 0 R /Count -2 /A 18 0 R >> endobj 94 0 obj << /Title (A Nested Sub-section) /Parent 93 0 R /First 95 0 R /Last 95 0 R /Count -1 /A 86 0 R >> endobj 95 0 obj << /Title (Yet another nested Sub-section) /Parent 94 0 R /A 87 0 R >> endobj 96 0 obj << /Title /Parent 88 0 R /Prev 92 0 R /Next 97 0 R /A 49 0 R >> endobj 97 0 obj << /Title /Parent 88 0 R /Prev 96 0 R /Next 99 0 R /First 98 0 R /Last 98 0 R /Count -1 /A 52 0 R >> endobj 98 0 obj << /Title /Parent 97 0 R /A 55 0 R >> endobj 99 0 obj << /Title (Example Bibliography) /Parent 88 0 R /Prev 97 0 R /Next 100 0 R /A 58 0 R >> endobj 100 0 obj << /Title (Example Glossary) /Parent 88 0 R /Prev 99 0 R /Next 101 0 R /A 61 0 R >> endobj 101 0 obj << /Title (Example Index) /Parent 88 0 R /Prev 100 0 R /A 64 0 R >> endobj 102 0 obj << /Type /Font /Subtype /Type1 /BaseFont /Helvetica /Encoding /WinAnsiEncoding >> endobj 103 0 obj << /Type /Font /Subtype /Type1 /BaseFont /Times-Roman /Encoding /WinAnsiEncoding >> endobj 104 0 obj << /Type /Font /Subtype /Type1 /BaseFont /Helvetica-Bold /Encoding /WinAnsiEncoding >> endobj 105 0 obj << /Type /Font /Subtype /Type1 /BaseFont /Courier /Encoding /WinAnsiEncoding >> endobj 106 0 obj << /Type /Font /Subtype /Type1 /BaseFont /Times-Italic /Encoding /WinAnsiEncoding >> endobj 107 0 obj << /Type /Font /Subtype /Type1 /BaseFont /Times-Bold /Encoding /WinAnsiEncoding >> endobj 108 0 obj << /Limits [(X1) (X1)] /Names [(X1) 18 0 R] >> endobj 109 0 obj << /Limits [(_a_nested_sub_section) (_a_nested_sub_section)] /Names [(_a_nested_sub_section) 86 0 R] >> endobj 110 0 obj << /Limits [(_appendix_sub_section) (_appendix_sub_section)] /Names [(_appendix_sub_section) 55 0 R] >> endobj 111 0 obj << /Limits [(_example_appendix) (_example_appendix)] /Names [(_example_appendix) 52 0 R] >> endobj 112 0 obj << /Limits [(_example_bibliography) (_example_bibliography)] /Names [(_example_bibliography) 58 0 R] >> endobj 113 0 obj << /Limits [(_example_glossary) (_example_glossary)] /Names [(_example_glossary) 61 0 R] >> endobj 114 0 obj << /Limits [(_example_index) (_example_index)] /Names [(_example_index) 64 0 R] >> endobj 115 0 obj << /Limits [(_the_first_section) (_the_first_section)] /Names [(_the_first_section) 39 0 R] >> endobj 116 0 obj << /Limits [(_the_second_section) (_the_second_section)] /Names [(_the_second_section) 49 0 R] >> endobj 117 0 obj << /Limits [(_yet_another_nested_sub_section) (_yet_another_nested_sub_section)] /Names [(_yet_another_nested_sub_section) 87 0 R] >> endobj 118 0 obj << /Limits [(idp5186448) (idp5186448)] /Names [(idp5186448) 85 0 R] >> endobj 119 0 obj << /Limits [(X1) (idp5186448)] /Kids [108 0 R 109 0 R 110 0 R 111 0 R 112 0 R 113 0 R 114 0 R 115 0 R 116 0 R 117 0 R 118 0 R] >> endobj 120 0 obj << /Dests 119 0 R >> endobj 1 0 obj << /Type /Pages /Count 4 /Kids [34 0 R 8 0 R 16 0 R 69 0 R ] >> endobj 2 0 obj << /Type /Catalog /Pages 1 0 R /Metadata 7 0 R /Lang (en) /PageLabels 9 0 R /Outlines 88 0 R /PageMode /UseOutlines /Names 120 0 R >> endobj 3 0 obj << /Font << /F1 102 0 R /F5 103 0 R /F3 104 0 R /F9 105 0 R /F6 106 0 R /F7 107 0 R >> /ProcSet [ /PDF /ImageB /ImageC /Text ] /XObject << /Im1 10 0 R /Im3 36 0 R /Im5 41 0 R /Im2 35 0 R /Im4 40 0 R >> /ColorSpace << /DefaultRGB 6 0 R >> >> endobj 9 0 obj << /Nums [0 << /P (1) >> 1 << /P (2) >> 2 << /P (3) >> 3 << /P (4) >> ] >> endobj 88 0 obj << /First 89 0 R /Last 101 0 R >> endobj xref 0 121 0000000000 65535 f 0000034704 00000 n 0000034783 00000 n 0000034949 00000 n 0000000015 00000 n 0000000213 00000 n 0000002895 00000 n 0000002928 00000 n 0000013297 00000 n 0000035229 00000 n 0000003902 00000 n 0000011791 00000 n 0000011812 00000 n 0000011832 00000 n 0000011853 00000 n 0000013521 00000 n 0000016120 00000 n 0000013542 00000 n 0000013622 00000 n 0000013701 00000 n 0000016051 00000 n 0000013840 00000 n 0000019771 00000 n 0000013980 00000 n 0000019605 00000 n 0000014120 00000 n 0000019688 00000 n 0000014259 00000 n 0000019854 00000 n 0000014399 00000 n 0000019522 00000 n 0000014538 00000 n 0000014676 00000 n 0000016362 00000 n 0000028137 00000 n 0000016383 00000 n 0000016649 00000 n 0000019403 00000 n 0000019422 00000 n 0000019443 00000 n 0000019937 00000 n 0000020196 00000 n 0000020532 00000 n 0000020551 00000 n 0000020571 00000 n 0000028005 00000 n 0000020708 00000 n 0000020846 00000 n 0000020983 00000 n 0000021123 00000 n 0000021203 00000 n 0000021340 00000 n 0000021478 00000 n 0000021558 00000 n 0000021695 00000 n 0000021835 00000 n 0000021915 00000 n 0000022052 00000 n 0000022192 00000 n 0000022272 00000 n 0000022409 00000 n 0000022549 00000 n 0000022629 00000 n 0000022766 00000 n 0000022906 00000 n 0000022986 00000 n 0000023123 00000 n 0000023263 00000 n 0000028379 00000 n 0000030386 00000 n 0000028400 00000 n 0000028483 00000 n 0000030324 00000 n 0000028621 00000 n 0000028704 00000 n 0000028844 00000 n 0000028926 00000 n 0000029066 00000 n 0000029149 00000 n 0000029289 00000 n 0000029372 00000 n 0000029512 00000 n 0000029595 00000 n 0000029735 00000 n 0000030628 00000 n 0000030648 00000 n 0000030728 00000 n 0000030806 00000 n 0000035323 00000 n 0000030885 00000 n 0000030975 00000 n 0000031054 00000 n 0000031158 00000 n 0000031369 00000 n 0000031584 00000 n 0000031703 00000 n 0000031792 00000 n 0000031967 00000 n 0000032174 00000 n 0000032337 00000 n 0000032445 00000 n 0000032550 00000 n 0000032638 00000 n 0000032746 00000 n 0000032856 00000 n 0000032969 00000 n 0000033075 00000 n 0000033186 00000 n 0000033295 00000 n 0000033360 00000 n 0000033482 00000 n 0000033604 00000 n 0000033714 00000 n 0000033836 00000 n 0000033946 00000 n 0000034047 00000 n 0000034160 00000 n 0000034276 00000 n 0000034428 00000 n 0000034517 00000 n 0000034665 00000 n trailer << /Size 121 /Root 2 0 R /Info 4 0 R /ID [<3556EDD6F1CBA8182FE59C52CD21777D> <3556EDD6F1CBA8182FE59C52CD21777D>] >> startxref 35374 %%EOF asciidoc-8.6.9/doc/latex-filter.pdf0000664000175100017510000030445712236331050017334 0ustar srackhamsrackham%PDF-1.4 % 1 0 obj << /S /GoTo /D (section.1) >> endobj 4 0 obj (Using the Filter) endobj 5 0 obj << /S /GoTo /D (section.2) >> endobj 8 0 obj (Limitations) endobj 9 0 obj << /S /GoTo /D (section.3) >> endobj 12 0 obj (Installation) endobj 13 0 obj << /S /GoTo /D [14 0 R /FitH ] >> endobj 17 0 obj << /Length 232 /Filter /FlateDecode >> stream xڕAK1{t&$R+/bBAlBQneKf}^/`\Eq22e d#uCa>6rhg^Yv[U*HUj 9L(> 7'u%CFV1 {> endobj 15 0 obj << /Type /XObject /Subtype /Image /Width 80 /Height 15 /BitsPerComponent 8 /ColorSpace [/Indexed /DeviceRGB 3 24 0 R] /Length 109 /Filter/FlateDecode /DecodeParms<> >> stream xRA GJ.˲0Tb(3mK|QzdHv:2vgςAdV9<9D9+04ⰿ8Dn8L; ;KqbG endstream endobj 24 0 obj << /Length 20 /Filter /FlateDecode >> stream xKKK'% endstream endobj 18 0 obj << /D [14 0 R /XYZ -16.307 900.716 null] >> endobj 21 0 obj << /D [14 0 R /XYZ 56.693 759.068 null] >> endobj 16 0 obj << /Font << /F50 19 0 R /F51 20 0 R /F52 22 0 R >> /XObject << /Im1 15 0 R >> /ProcSet [ /PDF /Text /ImageC /ImageI ] >> endobj 27 0 obj << /Length 483 /Filter /FlateDecode >> stream xŕQo@ )<ؾ;tbhM{VPU4D;iqNAƬ|"젹ۦT.^WG<]~]|3 eH Y3YM`$`jޯkv>'޹Ԟoa^(._,e4&(" 56" +FN UͨwUկ&:Sl2o*OŬ~SStȧW#v*nŃۻyH$l!ӗ'F(lS}zbb48EI6Cndzeں'գOhm[%?>e{v#Q؁ֱn`vh> FIwzBż۱FAךfS7w7SšVI(w6o98q!-!x?[@܏7=!L4ƿ endstream endobj 26 0 obj << /Type /Page /Contents 27 0 R /Resources 25 0 R /MediaBox [0 0 595.276 841.89] /Parent 23 0 R >> endobj 28 0 obj << /D [26 0 R /XYZ -11.232 900.716 null] >> endobj 25 0 obj << /Font << /F50 19 0 R /F51 20 0 R /F52 22 0 R >> /ProcSet [ /PDF /Text ] >> endobj 34 0 obj << /Length 291 /Filter /FlateDecode >> stream xڝAK0slg$mE ,{(nnicEE[`ޛ A KqY&h4P=h (P`*-(iLjJ1V`e(UYl cFu:FīI /,! O{lʖ6)P&;-g2C)T!fۏwQ~Y -RiD< o@FhB6 3Y`i,ikw'x=#|uSY8|N: endstream endobj 33 0 obj << /Type /Page /Contents 34 0 R /Resources 32 0 R /MediaBox [0 0 595.276 841.89] /Parent 23 0 R /Annots [ 29 0 R 30 0 R 31 0 R ] >> endobj 29 0 obj << /Type /Annot /Subtype /Link /Border[0 0 0]/H/I/C[1 0 0] /Rect [55.697 704.453 139.043 715.332] /A << /S /GoTo /D (section.1) >> >> endobj 30 0 obj << /Type /Annot /Subtype /Link /Border[0 0 0]/H/I/C[1 0 0] /Rect [55.697 678.46 121.898 687.437] /A << /S /GoTo /D (section.2) >> >> endobj 31 0 obj << /Type /Annot /Subtype /Link /Border[0 0 0]/H/I/C[1 0 0] /Rect [55.697 650.565 121.35 659.541] /A << /S /GoTo /D (section.3) >> >> endobj 35 0 obj << /D [33 0 R /XYZ -16.307 900.716 null] >> endobj 32 0 obj << /Font << /F50 19 0 R /F51 20 0 R /F52 22 0 R /F58 36 0 R >> /ProcSet [ /PDF /Text ] >> endobj 43 0 obj << /Length 2136 /Filter /FlateDecode >> stream x\m6_!Ea#1WȇWmnq(VmlˑnRjɦ,,_dSÙJ^꼞|w5yN@q9q=ǧpλjill8} Dヨ+JQ郬/9c$PJ 3 }WOFF\ʝh;y: C |ss(F .|82I4:e@u5u ;}GIC߼"ɋ,q:=I}]9,\ u{JyeO ^d.߄E#CPTw߯q*mI[s} E $ 7[+qVċ6h YZN(B}ƦzАПitƻRxWbVk}3:itCEn6|ឞ\P}SjC^V.=w_em0n͸{hǚzT0o~S9ZM:jL\0Z3ny%Xio"#qZrN GɃ[7z9f)ƃl 1٭jX4%0 WY_림s.(vH xYFӷՒ`r9ם*GY*ΤI3bgyۺη]"$kЊY_ǂ& XKV!+:xʣ .P9vM5xr􇷯'5nZ%4~JOs{nG ~f{~Uc޹K嬺gBa#:K2bp OCPFi,YLwf^!X|M^e@ӹ"@jop Wۧ@SaNŸ]>7?!EQCoGjL8>xy7z',BPp|Iz'k˜jXi,X3GTK78/%y!Mƙ{ٰP2 ]X#s[?Xf2 9j||;~Hȸ)͝_t?%xG. ?kK`K<ǻcL֏51hUjYEK=HfRb}]OG?AhF/y(#eS}s1aɈ=$cN&:‚5Fҧp[O[??`:f~1`de.kc cs˛*{Q*Fz$ P$0ns#GRB>"/&@ endstream endobj 42 0 obj << /Type /Page /Contents 43 0 R /Resources 41 0 R /MediaBox [0 0 595.276 841.89] /Parent 23 0 R /Group 38 0 R >> endobj 37 0 obj << /Type /XObject /Subtype /Image /Width 116 /Height 18 /BitsPerComponent 8 /ColorSpace /DeviceRGB /SMask 83 0 R /Length 259 /Filter /FlateDecode >> stream xA0OR$`Ĵ2X u!{} +g) H*N: D} xY74r?!M_vE[7l/e=EU\qp7Uo8ꮂ2l 9|A@g:kim,{yU{B*NW&خeC/J͢2A=Ӗ7]:oKrndغLPh1 7P endstream endobj 83 0 obj << /Type /XObject /Subtype /Image /Width 116 /Height 18 /BitsPerComponent 8 /ColorSpace /DeviceGray /Length 446 /Filter /FlateDecode >> stream xUA 4D?F$ P --a9 [&LRG(&$R&t  {{Eț: Fyބ R:PӍ4OTZ |yd8 `|fmS ƒ{a; |U> endobj 39 0 obj << /Type /XObject /Subtype /Image /Width 206 /Height 33 /BitsPerComponent 8 /ColorSpace /DeviceRGB /SMask 84 0 R /Length 550 /Filter /FlateDecode >> stream xZ aB5E>yvdqt\u2Y %ZO`2[4~GDcթ;~mZ`VO`M|cGDZc#ɿ E0 Mi 4<ִ-;9`C4q_R\yk[>x=:#HcUs `J-BZwD5Vkm{;oSUhbF?3R`MU92ͦE@)^SQfD]}!w6<$> i՚[38kAk:=`JdU JQ$P֑S `+VXj5![AAvHr[vnAC84~0: >hGpc>B0  ,EHd@"1VE>Cx|AhBp׺p|ލ4}{;41aʋ܆7‰4Զ2D:5Gᬎ m}O2= "W- Or 5;',g[ endstream endobj 84 0 obj << /Type /XObject /Subtype /Image /Width 206 /Height 33 /BitsPerComponent 8 /ColorSpace /DeviceGray /Length 1424 /Filter /FlateDecode >> stream xW;sFA|陗2U g&3ind2@fqq<ο K@HmÓ?@7it;IX$Vc?~FE[k /N@w!ztUz%aq"(7B~s L ԫn9ahOUpH2WqN$uSϷwYt D#G3JTkFN}fEtR4M&?C(JWYGײA9!EG7>~oƫX!ĉ@ߟԇ 4ffAtǎv{sX y闓)JhX,Lcf'20l$VqI@G,d7Gm[(US-C3il2`雫6ЧQĂmZ,hKY@a雫6ΕN_RPVam,Uhg9KߢV,~/pp_xϕVQqdKEڴhW'U\7bjj 1UdOfì3:YT$qU+YuAJdvVz%ZgWNU= frjjh΀Yj`֫怪HYZ'ILYf-ֳZM=.Z'I}e2j`2jqi Écev0kV0k9.dizX.H2k V0k98^'Xfy*cl QK왭὆w4kM:Ѕ l6u;|K5\8><+k;h!d wiC܄  Ed|L>!Gp ܃ <>'UF@1Te1 ׃ +o_UX7%}o;8FuwpK5Golп͉bgbBOm|3C^f ̵ A *C )m0GO33)m(?1~_F-syPGZ-Msw Wr5?/\?.؀ ~|ozة'}ث=W׈վ:`]Ԙ~Nhj?_wSzwd-9߾=XDi V a%E endstream endobj 44 0 obj << /D [42 0 R /XYZ -16.307 900.716 null] >> endobj 46 0 obj << /D [42 0 R /XYZ 56.693 699.128 null] >> endobj 47 0 obj << /D [42 0 R /XYZ 56.693 700.588 null] >> endobj 49 0 obj << /D [42 0 R /XYZ 56.693 689.629 null] >> endobj 50 0 obj << /D [42 0 R /XYZ 56.693 587.299 null] >> endobj 51 0 obj << /D [42 0 R /XYZ 56.693 586.701 null] >> endobj 52 0 obj << /D [42 0 R /XYZ 56.693 575.742 null] >> endobj 53 0 obj << /D [42 0 R /XYZ 56.693 564.783 null] >> endobj 54 0 obj << /D [42 0 R /XYZ 56.693 553.824 null] >> endobj 55 0 obj << /D [42 0 R /XYZ 56.693 542.865 null] >> endobj 56 0 obj << /D [42 0 R /XYZ 56.693 424.903 null] >> endobj 57 0 obj << /D [42 0 R /XYZ 56.693 424.305 null] >> endobj 58 0 obj << /D [42 0 R /XYZ 56.693 413.346 null] >> endobj 59 0 obj << /D [42 0 R /XYZ 56.693 402.388 null] >> endobj 60 0 obj << /D [42 0 R /XYZ 56.693 391.429 null] >> endobj 61 0 obj << /D [42 0 R /XYZ 56.693 380.47 null] >> endobj 62 0 obj << /D [42 0 R /XYZ 56.693 369.511 null] >> endobj 63 0 obj << /D [42 0 R /XYZ 56.693 358.552 null] >> endobj 64 0 obj << /D [42 0 R /XYZ 56.693 347.593 null] >> endobj 65 0 obj << /D [42 0 R /XYZ 56.693 336.634 null] >> endobj 66 0 obj << /D [42 0 R /XYZ 56.693 325.675 null] >> endobj 67 0 obj << /D [42 0 R /XYZ 56.693 314.716 null] >> endobj 68 0 obj << /D [42 0 R /XYZ 56.693 303.757 null] >> endobj 69 0 obj << /D [42 0 R /XYZ 56.693 292.799 null] >> endobj 70 0 obj << /D [42 0 R /XYZ 56.693 281.84 null] >> endobj 71 0 obj << /D [42 0 R /XYZ 56.693 270.881 null] >> endobj 72 0 obj << /D [42 0 R /XYZ 56.693 259.922 null] >> endobj 73 0 obj << /D [42 0 R /XYZ 56.693 248.963 null] >> endobj 74 0 obj << /D [42 0 R /XYZ 56.693 238.004 null] >> endobj 75 0 obj << /D [42 0 R /XYZ 56.693 227.045 null] >> endobj 76 0 obj << /D [42 0 R /XYZ 56.693 216.086 null] >> endobj 77 0 obj << /D [42 0 R /XYZ 56.693 205.127 null] >> endobj 78 0 obj << /D [42 0 R /XYZ 56.693 194.168 null] >> endobj 79 0 obj << /D [42 0 R /XYZ 56.693 183.209 null] >> endobj 80 0 obj << /D [42 0 R /XYZ 56.693 172.251 null] >> endobj 81 0 obj << /D [42 0 R /XYZ 56.693 161.292 null] >> endobj 82 0 obj << /D [42 0 R /XYZ 56.693 150.333 null] >> endobj 41 0 obj << /Font << /F50 19 0 R /F51 20 0 R /F89 45 0 R /F90 48 0 R >> /XObject << /Im2 37 0 R /Im3 39 0 R >> /ProcSet [ /PDF /Text /ImageC ] >> endobj 89 0 obj << /Length 1532 /Filter /FlateDecode >> stream xڽY]o6}C@R[Ðv0 %VlI"ߥH:WDsRyR5A+DЫOɳ)FaQ@4!G%-fLfs&eq>xK) `f`m МRJi3X3plbτ( +Caj3@A0@$)+ qk*(BqLTecN9W7 ՅV >{ ̾m{ #miA$`4VjVX|64~OӛhKJ榁LphX2kfN hGs3@yǚ$$R aIfT c1DyRmsPoS3{,!Y8l$!I$Lx*ai󟯐__L_4=eHuet o tNtXNEҨoj G5"tRGJ=l fjw\}mS4ʛ+jXjæ"zmW+١DL.#i4ٖ~?=ϓaovy\I @Pb|d{=ɇdfU7tE##AV' 8Ka %|j}a@$fw(bHQd%4B`&!Ox>k$SFjrSavҙoV0CJ\H+GB[-#ԎjO\\EgahC$TsF$\h(ELPJ (ʖtul;uc["`#͸pdL6%`/quP_τO{Aff G7.ضҒ5~2ͮ>nMFP%=IPW^I Qڂ2O. }Ql)^)!Y*L,qUcQi L\Wt.UOknX(>@y.5hvq#s ;ȱ6c'TScpfp=]U*;4&he IynBv\ ڎ~Wx砤oxVnJc1GӰ-*FU8YbۥIF8`;d)^ؐ::,^eve}x ro. ;"eMGc9D8h8YB58j)Mc6Comi~qt.;x8DTCv!T  eʟ,h&e+> endobj 40 0 obj << /Type /XObject /Subtype /Image /Width 340 /Height 236 /BitsPerComponent 8 /ColorSpace /DeviceRGB /SMask 105 0 R /Length 2293 /Filter /FlateDecode >> stream xْPOs"1H4ZٞhĶTDzeV ~bs;j"a+zh):=><5g?Ӫ >2䏼j@cU}z{t >xvXfށM_WPoN;/!W'_ `&xOݰ'dsk+9?!P j'U}O7|?5*g+gnmP7' ";HA1*ۯKUs}Z=J'~U~yl~!MzdvtY'-p%4B;bŞXƛjO>š3C?:oowU(-ܱv+"]>33UOxa*8ꎶyr^Nż(~ƁCɳW*:Gf0u+}?8 2p׊@FB⣧k~gϿ'e?L>"x^0iOi铅٢Hg4%!Rh_4ݿ(,IEߑ7OMts;/ ĮN{yĝVXE]lb홲P*?_On#C*#fri#{)l\ )*]َ|3m267^:d?}CF%>s>6.bf>2óGg'N];E$6>D_.3n0ꩣY 5ٗ}X7V\q卂Z;>O5- DDD͙gZ5>KߐOaۯ?c߱y3X(S-#OP|ϕiǮ/Gsd= GeG)Ew[&z㟲R_Vk_9i~q"oh5[#4cj\_'ke?9~ݲW}( G!:y)o>6ghd=/xa Q=gUwe[#G_U=b/?dJbO ,;g4Ub M\rhxkuu_==LEm.O~a4:_+/ډw?64k;e)H|Aovp5ғ}ɐg; 2/{^WhGw˃====Hz:,N`lgxV2yѧ} W3E~}>3I6gM>2KJ?$%hO+QO`/rُ>-0vWGYv\ w@o-D_8ݽ#:ه7//|^\z`fYDt#uX%o+ƴ5~i D1gu_^yQUُ UqoR$fg+ƥ+mUQ:vUٯǏ$%_ٜx_=}zO;OOk0tP/B`(n > g>xg|FKaOr[ް#R x͉߬&i짏`-'lڶu"yRsZ<*@OܬٽʟOn.97y} >t}gg?eΩ}*K۝ku37G?\)Hzx@J!n7_5g-))V`H܇MߐܫL,yGRM.[A_ unkm,f+.&,}c7ު}9/ch쟎}}gH֑^}s{YВ}Ezd_ͤO6t64_Uў;B2/e. endstream endobj 105 0 obj << /Type /XObject /Subtype /Image /Width 340 /Height 236 /BitsPerComponent 8 /ColorSpace /DeviceGray /Length 3234 /Filter /FlateDecode >> stream xەF A1bPA!(@ y&bp$nڴm:Ma>.JEG:Pʬ}ttȪM=V UU>jqSSf=h6MM/Y5T>ƅ m4Y,FR#f⩔YP8ϟ"y 4p<|I}B4 L)i%W ٣9Sg:o&a:[ՖnIɜrۦ^"h~Uol~%6Qy]6^-w^X5wkfYMd↣J3yszr ZXٷgr~fs0/)lo m$7^Mmn|~`]*NN0ض4KEk*]˺1M74_k&gKYi䙩J{Lj*hzޱ'5cM .&Z?52˛yՑUXƅѱ<Y].~}BџrbꕽJ6n)3.o8R_oUrݴ`|):v֛b] ū[)=9VI]w|JE~6{{M0(S=Ǘ#e')cFmViß_M3]\3)ӌ|yYmo?WݴW>)\ioWTa㷪/NNٔiF.V[i~Ƌ҇O;KɿȿRSZzYN\MJvV$~ߪS|=v|Voif.<_Y.k[y_OE~lOVv;;W=MsppK6kz[)=ݒ=2J?r>*B=4KkT+uWuMWG0A?5 ͝E ;R~*⧝Y-j?=v϶7tOWiΘ|y:Ҹ// NڏQ,5=vL5h.i/iBfwVSM')^g/m"jjoSMU}lMmrIJB ތ k2MأQRVŪS_lkSq̨}b֝;ԙ|Y<_ԓx$5gZUGSlpeMslTk^ZS{iRg+0+Uo)/hʷBS4E%k1G,tS|oV$_M_#tZqŽkYc'?PZmco &'iߨ}zb]Sp2;a!ܕM$d+Ob ?&7jZFFm4/yTECב=F!95 FzK_i}zb^,j:<_e1! b 񯣃V~N`mkMFմ+է'V];wT.*蠴&+Tkv&]~ph5mg7hlQaǃhh_8dk^M[WZsc\뛮-qTJ?MKݯ?MO~KLRTj[O|@),$4Oc/~evWd4|!=񲬩}&9ӖT c {pA>j*2fWM~.L#/!=QUsrx"`* ؋LfHok ߾NMWjqV_*6CW3GHO,}k ~E1%_6Vď8FFK_y"k}ۣ){p"լǷ#*,iǧu(>YtʌrbUr&iغh4Q6UOD?ȕzܦ=3E7d#ξ =yliDG:jHNPi%Gc쪩JzߐM>`o5A]?~{X]Jϊ{2ۭR{XQxW\' 1V~}|?OKO%Gm? Ƙ29Tts `gkUH1ױf1?꯲ZobH.yQרbH._dpH׋!G4QZ2_-W %{G* Jp/̟-6ܬQ"ݥ7޻Wa_uZh2 ss(AW sbH:SR Y8Ő࣓{!ħl7'gn[oYSQ0K?pÉ|2ܤ*h}Bs~)9{ik: ΃@ 4 12Rz*_!o~#gD\j\i4&B'5m<4 Emb|6ŚVyRSmtu(ė9"Ow_jXoW6ΞWG4@OMA gdK>;NO >B|n~yNjgxښ~bb])M*NiSN Byv=QKQ45 zzt1')4|TaO}۷.ݟZ{2?|5qBg8 QϷlm|y"=,Ljztk(@Ol;_+^{{OTlQ|:wD endstream endobj 85 0 obj << /Type /XObject /Subtype /Image /Width 180 /Height 63 /BitsPerComponent 8 /ColorSpace /DeviceRGB /SMask 106 0 R /Length 667 /Filter /FlateDecode >> stream xAr E{KE7`/KުMp&ev}/+2{m<ҿۙchR.X= KgZm^frzl~}uFԻ|uy}s4I cCE;m\}7H.⽛r߶I'!m:FiSV$tr7 wEWO&⋒̱ӹrhK8-33sK2>ʴ-e,p;h͏qyUm0r;mG=po)^]E7܊Q=Yv)Vh P\m0NARU.9 ,{y3zV##!N;L*ߌ;qڄt3vr<5]i!|lx Pg]ח(6NpCyڛ\S0G_wOiVybx.-levƼ*W'#rEḧ́nG6{4c4^4G極٨ F߸~eiت \Y&jcD.v3$~x06FB*h#.E7)ʮڨFX>tSzoܹy ^ endstream endobj 106 0 obj << /Type /XObject /Subtype /Image /Width 180 /Height 63 /BitsPerComponent 8 /ColorSpace /DeviceGray /Length 1511 /Filter /FlateDecode >> stream x휋q6L \:uwUuȤ݁ ;`vEQԘNH ŷ B\oarI5 lBinm9u,͘ZXlXS;L[Y+Ϛ 7ذaCI .8 4X.}Ja:n#_c5QsW^ %TUK[#SmU(a|6smܰ![{ z645v+ʰ$&,=&M͕m~?؍wlJ5ˆ13|a݅RkSj(%e,-K X<ڌ}BjPղ.+! n)Qa!G^#0j` U{؉f`4JG H6s2jI(Fl3ͶϜҬ¬6õ;TD#̃̀9o6 PumFtݛ9c`Sn:6[h06RpseيZ):zAh"Īw {)3`PJhJGDVVVV&wEUȕrK!5)N GL`]ʗN>"?}dfgC?bK(se(sG0=2ߔ;Lϰ׫Mxa><)?+u2~tݩpF[3t֖"`Xzy!qpoG-!v3} g>Y|w:bhB)l;b2H2g!.|e>M t gLoLix^M ZZ{1Av7E]kL.(\fdz2LvAY5y'3>fL|5ds.G<9c`>NlKkrC.u?3ǝ{gc,˞@KiƜ3+|7 ?ߣ /uo܌"~2M5Z_p<?b02ӈnB͝ȟaYY7/vΧp ّS~/?xRrB &ɡJ㝼ŴiL{*Vxdgc ST@H;;Ԭq(z}4['> *o?135CkALرHV$C3Kg Zg"Ay73$(I. Y?{_h_V֭b"Pi4{c9<ĺɧ&u|D+FA$P# ~D=9RN"Ļ. ;I?? endstream endobj 90 0 obj << /D [88 0 R /XYZ -11.232 900.716 null] >> endobj 91 0 obj << /D [88 0 R /XYZ 56.693 513.099 null] >> endobj 92 0 obj << /D [88 0 R /XYZ 56.693 452.388 null] >> endobj 93 0 obj << /D [88 0 R /XYZ 56.693 453.848 null] >> endobj 94 0 obj << /D [88 0 R /XYZ 56.693 442.889 null] >> endobj 95 0 obj << /D [88 0 R /XYZ 56.693 431.93 null] >> endobj 96 0 obj << /D [88 0 R /XYZ 56.693 420.971 null] >> endobj 97 0 obj << /D [88 0 R /XYZ 56.693 410.012 null] >> endobj 98 0 obj << /D [88 0 R /XYZ 56.693 399.053 null] >> endobj 99 0 obj << /D [88 0 R /XYZ 56.693 388.094 null] >> endobj 100 0 obj << /D [88 0 R /XYZ 56.693 377.135 null] >> endobj 101 0 obj << /D [88 0 R /XYZ 56.693 366.177 null] >> endobj 102 0 obj << /D [88 0 R /XYZ 56.693 355.218 null] >> endobj 103 0 obj << /D [88 0 R /XYZ 56.693 232.433 null] >> endobj 2 0 obj << /D [88 0 R /XYZ 56.693 193.548 null] >> endobj 104 0 obj << /D [88 0 R /XYZ 56.693 154.857 null] >> endobj 87 0 obj << /Font << /F50 19 0 R /F51 20 0 R /F90 48 0 R /F52 22 0 R /F89 45 0 R >> /XObject << /Im4 40 0 R /Im5 85 0 R >> /ProcSet [ /PDF /Text /ImageC ] >> endobj 109 0 obj << /Length 1184 /Filter /FlateDecode >> stream xڝWKo6Wi(@hd,]hd Zmap%ywlɊ[b8/732A[Dj qG  a?*Eޝ\#? :[UWA"ת]8CR$}Zmv=p( 9))愡?#"8z2 )@y5fcJC ?^3Dt> Ue תLURvhrk%fu^%[\֞^%Y:ySuFmV2ǥ,:BIm[g9#e{ !i2y9:7bּ& ԕ%G }VMe?W}搥 .CL`8  6'X{ v ;*Ox?4 .F)&lN&g&\4di7f`#j`_Re}ywk*4CצM/X%/x^'ܬl"_-i_eǃjt[?vts@#3>2 tto:ғ8GF2umYkʳ"nuz xԘ$E!1}nfva?`' `)Yˍٞ}AI851e־b $1gCu<9f*խ=m:ԉvM3|gc> endobj 86 0 obj << /Type /Annot /Border[0 0 0]/H/I/C[0 1 1] /Rect [113.599 733.997 207.246 744.901] /Subtype/Link/A<> >> endobj 110 0 obj << /D [108 0 R /XYZ -16.307 900.716 null] >> endobj 6 0 obj << /D [108 0 R /XYZ 56.693 400.511 null] >> endobj 111 0 obj << /D [108 0 R /XYZ 56.693 362.891 null] >> endobj 10 0 obj << /D [108 0 R /XYZ 56.693 322.099 null] >> endobj 112 0 obj << /D [108 0 R /XYZ 56.693 283.045 null] >> endobj 107 0 obj << /Font << /F50 19 0 R /F51 20 0 R /F52 22 0 R /F90 48 0 R >> /ProcSet [ /PDF /Text ] >> endobj 114 0 obj [600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600] endobj 115 0 obj [500 500 444 500 444 278 500 500 278 278 444 278 722 500 500 500 500 389 389 278 500 444 667 444] endobj 116 0 obj [500 500 500 500 500 500 500 500 500 333 333 570 570 570 500 930 722 667 722 722 667 611 778 778 389 500 778 667 944 722 778 611 778 722 556 667 722 722 1000 722 722 667 333 278 333 581 500 333 500 556 444 556 444 333 500 556 278 333 556 278 833 556 500 556 556 444 389 333] endobj 117 0 obj [556 556 556 556 556 556 556 556 556 333 333 584 584 584 611 975 722 722 722 722 667 611 778 722 278 556 722 611 833 722 778 667 778 722 667 611 722 667 944 667 667 611 333 278 333 584 556 278 556 611 556 611 556 333 611 611 278 278 556 278 889 611 611 611 611 389 556 333] endobj 118 0 obj [278 278 556 556 556 556 556 556 556 556 556 556 278 278 584 584 584 556 1015 667 667 722 722 667 611 778 722 278 500 667 556 833 722 778 667 778 722 667 611 722 667 944 667 667 611 278 278 278 469 556 222 556 556 500 556 556 278 556 556 222 222 500 222 833 556 556 556 556 333 500 278 556 500 722 500 500 500] endobj 119 0 obj [556 556 167 333 611 278 333 333 0 333 564 0 611 444 333 278 0 0 0 0 0 0 0 0 0 0 0 0 333 180 250 333 408 500 500 833 778 333 333 333 500 564 250 333 250 278 500 500 500 500 500 500 500 500 500 500 278 278 564 564 564 444 921 722 667 667 722 611 556 722 722 333 389 722 611 889 722 722 556 722 667 556 611 722 722 944 722 722 611 333 278 333 469 500 333 444 500 444 500 444 333 500 500 278 278 500 278 778 500 500 500 500 333 389 278 500 500 722 500 500 444 480 200 480 541 0 0 0 333 500 444 1000 500 500 333 1000 556 333 889 0 0 0 0 0 0 444 444 350] endobj 120 0 obj << /Length1 1612 /Length2 15145 /Length3 0 /Length 15975 /Filter /FlateDecode >> stream xڭctf]&v8ضmwlv*FŪb;vŶYIy>}z?c9&^DI^(`JP3qswWZp@cW+{1cW @hXXpQG/g+ KW& --J1xk=hhwި \-s+[ @TQI[ZA@-mJn&V9+S ` ``ofOj. _X.c#ktrqzX,]j7u3'/ÿrtv})9:[9*I;NWKc|X}_fn/̗ tǗ `fhk _aX[gtg- g-{cGG[vhk˷=?"mo`f?t@ `4cTppr c῏[ov_pU0jׄq1sc;+[Æj w?8Ү_"B+ +O%Rۛm_zf&S2Vk_$+tF am)m:SeŽW`3yCDCuYX9_kycWg+OWLJ>/0f􊪫W{/?jS7g/Vu­.9Zgdgb M295r Ȉ4z chhZ2)jlaH$!K?G~k<.cGv-zk; !JF=F V}Kz> eH"/EBr2bA2yCH`pe/pęAX:Y'P)8~4? b_[ka/;#.Ky℅<>%^aC*G ۦx}i+ s{8g￝L0~"YA AlyA 7iU|IFkF8k L,as1}wB!KV:plpr~I9P!~`Ra`8s s<6Өʬ߃ܜyt|0GQFК"V-VӜ֍T3-QkXaD^͑$f\<8ݮ⩠"I~DZkU3IxcOlrUXvd*5YԦ6AC,O`zA6/zΎïCM[¯I֔@j;fT0x$5Eb5TzǺ^VEJ )J{xso f_eMi B$2W <J^n@k ٠T2p?Xrk[~cji@87![ex'*&]{Ӊw0,޼t$O1nx(xvAtSV5D+B}?aڷ'Ֆ>ļ#JQ)kS,d7Dԯ 7m%<)WxkR*1TRB98Aɔ^vdpBk}V$L!6evaʳ (΄z= gmdAA4lõZ2 }D?\݄)xa1~Z#8wÈzI,.,L!;{V6ALt;NK4|+baRF"dtcrh=0o4l!@$]pSB9Jl#J {%q(gsBu;fs|}\Z\U$YhyL^V!Fܭ-6,O/ǀ 0fX.qxj3)vBCBfZ}@E.eK&qDL$Y .F+-HvYَٕ vrڸࣤWJĀeP,g{D); c^xAzSRt%211*ISPRa7*Vv s2iPTȅOB$nӫm>"YuJJo4/^:o!:W6'fhN*f)r{FvX'S>bdT3OJ' 2UB:QS{uu-y!w1 A!$;&Мw\AZ>G!>n5vc@wp·"QuS!;%"-Se-ˑJzXd9 ȋ:.߳C Y]]ĒnH rAy2,9SQp)O|ek[RH ' l fMƍi=4뜀SYfO?:}k(TwчYYʂV٘Vc7:zB#i,@rp2¨m?lA]^9NktKD(4Uo3J 7J#&**.ׇ\6x5}Ya4j}HV|*yy&F@|H/%A8w d#rCs;w$)Ndh85^fuZQs\ GLO( -(Y%dSAw=o9D ,~08kP)^un,$,oPŨA5+l֩o}/f* aJ!/솯) ̵U8h5Q'5v1謦0~`Pe{^A%ߘ݇a1hcCޭ Ks+A]:6DaJ幋@N2s!ݬd5#mjxas*h+NѝY(hĈ^V'K xOς$((fC郭(X Z.!̒J)Q,bkRu}S܉`SEOhlFgzHmQ7J?Y4rRik8+Iqz5K~$]+Qͫ =&AFZMvabj jR.o=Zfk;B(mnjby">˙YFX)gΡmi'!.Dŝ$-]J w@gK(jK|Mzć`R񛄌 7$Wb&(o$Sl@b-O?J/fPy/K5+ߜlW ?HDg)?E'cQ c0ƏnJ~RB?5f+ FlnFS6蜶gyls삺6yQ2)IO$M&H؜ZU#_cǑ~Q;5I;"!dL;dB&; U_<G0O,:)%9kR@hw&S$"#JmŃO! 뒋b?4Nd)(;u6kiKZVH`-(0EUkjw([ge0{Ԓc!e+TF?>F, @}_4=2ЁqiYNo+ߟ~#>**f 2Uo)6$jd\7&_:C a>5xjC, D6sC7vzRìe8ɐY>Q/I^Z]_ϝGeipʥ^}=agC +σ5UB̛q뾚Za1񈲦˝4L[튵DNQwEQ2lo:ks": B߳g] E8YЮ| )N~"h5r.pu\h(? qbK"5 k:H6T9݇Xj6m0y iU𐍺~%xsfNPI ƗO>4@ɨW$)*3KV""d <87X% !~ZqoA;Cg¹S)"7T,{h,w1Fn=$oUG_s {0l*x{-}S21댛H?\Μm GL_bxg|$W"Nag`pXCcqR"R.LܲuYK`> u/~!9}۱N8|@ Ժ5C6G.5pn '7̍tX%*iws,D=vلFlntK%Ͷ3 V3`;ϛն?CRBl[~ 8_u:?ȬO5>19֎db,}VN) Cw%!kL- N=m V}#4J݈+(V\ޗa3 _rm)VŶ1Q^XcXtcbe4Ei%iE@,O^ X X>\$%̋^q =Hi *8p E@knW|*5URfU}atm|BivhB ]R2D'.YWPps2[0<4q*z 3f0[^]\I湵4)?W&HK;7+?>ኛ.Wkw`MZc~L43+)DL{MQwt{[ñ}$5N+U 0[j G5ނ*9,x/Z+:4c:_+)s7CTzJBhF.蘞I;Bb\ڙF >7qw~I zckQCCi&8p;AFU764نU|MCP͑UqC|T@'X2\F҉8hq o QʝQ<ܘLJsg҂tB !y9y-`8!BEՇ.Qb`iMnѺ0~WI3BjE`4Rbt^@؏ $'n1I?m)4Τ̊PbiϧZi(tm6Ёp玞X h`K"hyu#uB¢{s|Z\~ھ@XoqԦT`mEʽܸEaW;_!4;.S~XmcYcHu>H,ә e_zaG/nYS#$ Q7J+"X j.ә:M^F+C%BwSFvȋo`Kn WJy Om_QfFR}tQkv' "iB M7PC_V9YD13kV iĚzP5Y=Z/v~1-~$[B68Lcvn2B72EOv(z$S5wE%CylrP>]$"6sYXN̽k("3TH4Nb]#.g(jJ\(XyurAVoLSTVƾ?R{`-bns=|WQrլp7x=˭r?3ډ cfU2PͦrCˈ@{yx8ZٝL[Q"R3)nUq #XaYӾ sZ+S;e^AaEaB/q(7Yar'Zq5PCo_LdFj^ld*aޞ8rhFlAIP=/GEZߦO {'u+ I4{`"3cޡLJɼl%B/~RkEf'QmRY" py@89b]fw۩~t\ sN@}OŸ 0W:c6b`yZAډՖx\m\mDQ~4X P$F`i<Zd^N 2oL%WY#"$[$R5*hbQrHy`!QG%+%I]pg]F<1bœx(B0mۗ_N+ ЖA˵V}PMi:gxXn,@ZJçY5^V=ƇMDU ޞ)P9jY4%}]'r$ [v O^ DU$3S8Yq+V 5yX*\rNjKyAwddlZXS٧\D$2 xc_܃=h,g'a7,i4_J4b2SXyiS LL?*lE3g_.*l̋O-KTSvJ5'RZCp nA;.w\^(p`THtR7HaUl:>?X"̤X%ߗpR[sEv}ﱊP 𚿼)λ,4B]N&s9{9)k0 \="6 )8fN4N>NƍTMLl{B rPrgȬPϲotLk# 0"tR|JaR^ &[n3v*0*l0 Iw3wT sc@ԉWְI{pbb;N1bSvbUrPG `W}xsQK- lzP,Y'\=|.ZLR7 _\S8{ljx!2Ҹ/r8ěMDЁ̂Fw%L6&PToS^YbX5|1桾|R/ns~xdG $T Zʾȉ:tv4BPn4`g_[B?|' #~n;ugU™_yoR LPޏrR4--2P&e28s`3d>R"tM 1(F3Eð_s=ل~a$X-HE)9v$,dK4#o3_) wnθڼ Э&*w'{A,I2@ 6g(7~kޚ&.ZUdU=R1Hpe--mN!Jwȏ@p*OOs?[` zEv:Ro=MS$'ZHKem4'XD6NkQe͈ؐ1ҁ1i=o c`e4%\ZE \:9r 8ꧣM*{-U4̖A\2LeC=iP#h<] AFtY0 iopp׸F9Bk.e.M.ԃ XիIjJG5i6mW| Ŋ+roXafZSjAyfy %^֣ڊF~?&`A2Fʸ" [If+MAmy:+#t V?xH$k`p8|K1E~{eCTGC>q~^I& >Ċȵja(sY6Tbl-H˞,Kd[*b]h9ߛ/&0ش&bqFLsRp:ȸ)275hGwW,% Z 23 urlt6P=MF* 4Y >'LFH] HuO"V"dkh6>rH4M]\9qKhrYEZCIZԅ`j>ܲ½8͘Y i~⹹U^\Qk#,Fl3WGw(`x?=rhTΖF 5,ld Q2ͼ[\+Flj>2"#TPW+[cDIl/Aҡ(qtśri, ["F{5|eiQf*)ܹ҄BWw>`iGogg9ǿϟ1 TwO1ҲbvTS93ԨL_G6PG8YȒ&5晶Ldy\10 H)L?GR=\ 4r[R3d~b$*-5&+Ȇz ^-ȹ'!//V cUl- ә8S$CKDKe+fX"c&\;B DNtoMMvg.ڜ bq .ֻUȋx$ v(d lmj5c~GқkK/=6"YRx~ܚZF 3ژC9hK-[h;CJ× Ir5Юٞ Qfʥ1 KxXzV,-*)Qۛ}qΐv7'I⡰' 1a'Oe:\S>73)2"/C(J]cC|yöO TW|ʠ?;AF?2;f`@וz?u -B` ީ2YWj {F|ml`$Z1!#Sͬڃ[rOTkWt<+l }OĤG?*9hDOFW\*tU n(+iMY#sƑ.iz v\Rwf3u'7W2/H}(;"ckP` /ICTgSi KL~}8qfbNн^79Ns\U-< S"8i6D/ [qѺ,j _%LӜI>SNGSfeϋr|OxZaqSSlLp3v4X9Y5nn9ovo͍pp]e`vmO\K q84,W*>"}jakHJ}}G6ZkDZ /je3h2nQxeu$ԙPY.K@Mmr"9ZEScq|RQ56jK >C*:" DL0ۍ gi%!<8k¢t-L&:{;.br͒TFjQ8H3DHVs]r]0~;,ӫ K(-G =oT֡sxcȞ;,Pa|uR1(ʀV5g޻ᬐW`zۖ 94ԩ7aZ;AoǽhQ8F@S @DxH̕J|}hfo)F5@?!Kb;B)=C-2ӑb{]YCUTE5 PqRI,%$kQm5/[6hPwJoֹ0bY[$e A(ClE%kn?n=T2ڥ#Q`|^aPaC="#`'wYOsЙ4J,~'7=eC ~\n)ɫ!{ң8dyD>'_6ҫʩe{fŕBB=fyVIdhVPz@fDB4CE3vwg1.82-lwuIʊ'83x; :]#a+;?]8ƤH q) ~1il|Cxcib @NcMࢉoNm$49ΠD b'ϥ\I=}x}sUy{+lWb]UPH2+Hطp U],*n t~)wէ;QOŒNѫ3u[ Z(jP>Tk~_c kN Fch u1e ^>`4Oڨ^oJ9bx\Q6iI$a2l*T$fͧVJ-\GUUlJ?TTS|j_B:N5iLjMQr*c)YNB&RAKXFl,`-2!X֤;L_cFuی6KIh6/x :([_}Y dQ'U:bWR]~#L6hN1u5Fx+#r QAOnY7Dcm]ZH-Xֵ#eq}e:0FfKg w+^ ̐W oaV/; ü̠^YKQgã=="ȮchL 79vi ;~t>_eE;M;뵃|іa!;BQdc endstream endobj 121 0 obj << /Type /FontDescriptor /FontName /VAYHNY+NimbusMonL-Regu /Flags 4 /FontBBox [-12 -237 650 811] /Ascent 625 /CapHeight 557 /Descent -147 /ItalicAngle 0 /StemV 41 /XHeight 426 /CharSet (/A/B/C/E/G/L/M/P/R/T/V/X/a/ampersand/asciicircum/at/b/backslash/braceleft/braceright/bracketleft/bracketright/c/comma/d/dollar/e/eight/equal/f/four/g/h/hyphen/i/j/l/m/n/o/one/p/parenleft/parenright/period/plus/q/quotedbl/r/s/seven/six/slash/t/three/two/u/underscore/v/x/y/z/zero) /FontFile 120 0 R >> endobj 122 0 obj << /Length1 1608 /Length2 7659 /Length3 0 /Length 8473 /Filter /FlateDecode >> stream xڭXeXTDiC!bAZII[:%[Z@ZJ{;9\׻׽ֽ0kpJCP:Xજ2pebu @!9( e"=mmV=m6vvy~,=?bk 0AaG(y>6P- 4RRW*p3tق`(B8`0ݚ = pqmA=P!#`v3@"p0 񇐣3>>vpAmr DڀkއL?{(d w ߵ,# y_ W[p g rs{:?9:{Nl9ޮ*?[m%eR2e37 r$oDzS]0-}6ϻjs~̑XQ5m渍3ξC̶U*pDAd~ [HO *;gȇAzp{/e#^+#ƚ4͞Y8b8v:2Mk qmPsGu`Ŵ]Gx()P><^𦚉JKS,\& b0n:nc]'o2 a"Mi/3I<·r@Hd&C]A{cC^j_8dৎN~ͦjAEorXϒ '*qSz:F=$1f#ׅ`Z .uUnҩᕏGxN+YS$;|OFbRɰ w؎lP-6,nm RV8$UׇAƋj=~}YYIi_?Vဧ8(P|'ueL>=^ԅܾքs%t!IHT !w|X.O9:O(e d;e=̱Oš˱oBފ2uD&yLw.]M v~ % L눮e\GY`ﵒ:qJPm }iޯH 'Q<ߋR*f8q4IX5n0u`;Ʈ7`aR͞͹?.U$8֟v%W#]hf(s¶pwtFOA[?tia]@*(1X1;m-8{+{K$tafW=F=ri6z;^|H8~^IVπFpY6jO-S]"7qF84"1/gFlǖۂ9-.<[)=Ud?X1O~;~ԆIK>Z_Q޾\B!)c\/*Ϸ^oFa+0D}Qnn{ e iޭ<B mbUكDceZy5˗ƟDYkٜC:#v]h#B< 4!&!SLXORc~z07"^{IAxuKК b5 6VdfZ>=OL"-o ֛b_6NuzKX Ix<Ի~1)[Z+lv,PKXaCfj=(^30E&pױ{bwܡ$hUjtR͈uJ!"ّN41OOE}wS术Ftސ% }g~#>6KeμgOt@8gCVy pIed߉_}v0):`ѲDKk^}pT.b "JRƱ-T=MX0<䘾$>:F>b- /Yk6Mw.V-V['U}^bY.>/>q@BtTOPE=-a_gsC;OC|}ʝFNTYr.p?rB$k}PkЪ1^!&pV =+'crDB&ˠ6a.C<qRVhOOfju-@]]\->D=:<߼ލĵ<._LnzT"giw/*buUb #^N7 ="(yhDvu%wkֿJcV[YbQbq "n8Nq1IPoʝ7P]'ơOI`&j_بPbtF"?+Chy0'o<,,7Tr0zMD?uzXn/Z{T!C'# 6|Y0+E%L;E.ysl&:WzʜNҏRb(œiG^1 ͂ oUʌ'm|_^3\qߥ =yF\VVPJkweCzèFu%')C32J r+ڃwDQ) 9eQhT?\a *G1E 6yҩdr7ݣ3S q#ħ_%Z ~ 4C_)1E?E g2hFS }~:2#~L{]0\f^O7qY~Ȱ%qeN:jxܫh)C^5Gcfa(-!7zǁ%p7: :63aA8P´[esS‡w;fU}[GF2_73sOX4_߾+(ym@%@޽wrcnK qؗ( /kRߟ(Aq[{nS[ Ⴆ$^3ݔ D03nuSB}ohr P ü[ ;@N8I)R&5^N,nwA[ECq[,V1`K)ܻn5F1N(B>e5`R Qw=my羛zOMٵkDXKC^Ӵ|hmܢ'K*؃IfX/1n^k9*ɼj-?'o(`!CJ)F ".4}U~G47},m#2hY&HRjUYp{(Bg!Z%??Pul|q)ȩF<4syBEٞna[U㙭\ڤZS }0*Eer0 BP %^cNu!8Z=)0P-s_"ٯJcV]'+VfاБ$47A_$%|%5|&Qz:zrP\\,\e#Yskc*2@7pXMoywvn|܅-XWT~䄭E"%3n#B`BIa3SSJ]ioEAR>5gah9 G _,5^Zԉ`=IʬŢUHX3Vhp`.&X>jeÌM"aI$9!4|N{'kp &1<:7XZԗN8؍dg] Ac׌R# p؋rs\1UﵛZ%o=Vrbۯ&[.Ah[+'άr+~r$ώ pb3G== Lt4'ѥe'-/>0zR0f;u(6Sk9t_28S/trYr^; ˾GO%?" k76%UD.]cjr9i#Ebt,5[eژ?vZ0W>za綶sllȣ Dy筻;id3wncC~PFd|¢I96vx1$>6զU#]"Ϡ4~RʝP|s)PHr[,;! :--UfVw-Fz& `;ez,p2psòdo{^j-_u7ei\֒ٓtJ2ۉy?=Dio(00P43a3t Qƞ+gwg=ևtvt z550q*1#{+6YR0KסbczQk}Z 5;xi.?uG? LRGf>u.OlC:NciJ:[rWn7ӍrP q4#tVXoו?굼Δ58ɥk~ aK=bMD&jT](i\~:LxۮSKP[ok0.up(NzHTRDY)s+'aOm&#TD,_Xzrjn_`Y& 8c%v& Y%eڝroAv`6>w΁pMJ6v#Y%!l=]  b9W%EblVЈOa!j 4V@XIv)/̝'so2,BI:nq8.Eh &^< u}L~۽kmm =Ueai됈: ZT1Ю+H[=kV\N50G/Tٞci%Ŵ> 1ã>H)^cUNz{eЈ؀ДmܔqF"heYhXjh*$IDE5Dsoΐe#C3Έao!C'$i;zLh"9vIXK>INY.efⶲ@Wҳ WO jc{YLY2'଻#rvlFYѶkul>IR3 yʭMR9 KdC ޜۗ^qdAݓ-U0|NױW!]< LA@(1QZ?"O7{=zBd02v&Ȉ'*${ 9~]+NMd^QH#Ld@{# )݋?7+ł‹`%cia6OW]6r/(VCnٮȨkSwZB=ڹ zCOЕs{9xYణUux0g{=M-]፵/&-0nVn 6\ꝫEݤj1U)4J)o2,lT}D$PU=Xs\uZǿOBξ%3smOq .Ov ȓΑ&BeOwkQm&&W7c@0`*u}3NYc %2*H*TJGR3lz~%roEk:kMִ zesXjpJbq~\a'jv&Q޵M,}73IJK#?_N]ЦfF@\ή&ځbMMA譔~ X-p(F~pF=(KĘ0.el7eqg/*W{y)RGzff] hq,T<Ίaڸʄ27 +rrhũXq>r:84gm8VYPUQJښw̵EdgKhH`ܚJ=YGIvh9k!v#Uo4H%\m>63U52&6rWVK{?, YV<)phЁdX5!UPB7=?MIq.jp`p!#:tk t,9vbKw2"zGގV?K}_i ڽ57-,AȊy':ގR|&_{}[ ̋: ,M?I s?Se[NqݨQMgX_,0$V͓Pt}E{tzagI)4ݣۮHV9q;&p/1jcdB5Xkfa,u5_Ajp4ݬ1Cv`ія_W Ϋ(Q*IJэW_:#kG34L=zˡRiR¼ Rć:uY)@2iuLL~zX6h ,Ó+ P?Meb jN,N8%w,+ endstream endobj 123 0 obj << /Type /FontDescriptor /FontName /GGNCTL+NimbusSanL-Bold /Flags 4 /FontBBox [-173 -307 1003 949] /Ascent 722 /CapHeight 722 /Descent -217 /ItalicAngle 0 /StemV 141 /XHeight 532 /CharSet (/C/E/F/H/I/L/N/O/R/S/T/U/V/X/Y/a/e/g/h/i/l/m/n/o/one/p/r/s/t/three/two) /FontFile 122 0 R >> endobj 124 0 obj << /Length1 1166 /Length2 7267 /Length3 0 /Length 8035 /Filter /FlateDecode >> stream xuseX\ɺ5IpF]{t#ݸ NN k e99{][ZRUYl ,le[GsHYh fhojBE.@3-$iy5m%3MOeW Eb!@[ % :A -R X]V/wURסgdda{$ G2@i?bṲ,m! @XỲ/ aiT d)v#+Iں-^dn ;`+[#YBX@P@hc@t=,lX(d6Yz;Vf@_[+ @/;4vv`~@ .666v߿WF/j 9xl*+kk+3sG_R2r9_򒑟_:olYEǿFrx@_ !7ۋk^~?P?U=\?q0sp3G[?ur'B dol]m= /-|@U/Ntu}?) %@`K[5@J3Pyl_=hs3` `ඛ1w~+tw%ڱH4m,%r;`†?e}-1Z.CpMfҾP1H;~$Ɏ7Z3zkxLݲi^Hc9UULi/1z*bSv# J=l LSֶ6~x`ބ~Bp^sTY,m4ڶ3ߠp C*b +09+n-G: E5mV3GVڬ؎<&cBG C? E'L[p~^.Ly;'rVI _CKxbɝoOGDdo-U\S3Gŗuˊ\e$P D_8;83VnTY34khqƓ^WgQp\eqAm)%R Bi${O ;uw_g\wYOmSx\kkٚd &FjB;^I`#dwO79IjW6FDoب;#Jݾ٠tw ϨB͞^N޽[k5]}Vp>0Yl'+#u*V(sq9j.=uVRZ Y.IHuFmR@ bUGV ~M.1l?Y~ #P|ڈg<ɂ:`XK W4 GB~ C9?ո>d , 980pA mWZϷS1UW96._k+=ύޘv '2%n2cMe>|@n JֆKxI_@ns=@7Ri'ݜ"HzupY3M@Ħ;>C BBu?bq''<1 ;/%7g\}]Lj !F'IힿoN>-cXS?:"]8 Mql_rE74m"Y .Jp03<閇:EqA_r-mk%iX~,!\mR\0qb~bgjD(W}3x"qg;֝"ERŚ=[ 4Fbn3pO˿勑hZ(0"]paBhG)Lqd $Ki'm(rڮ8 6t3|QVO$})CL#f\PBDD}`,+#Ոnx@C4.pOpv8`x*mA);꘢pe"{cGç`n@ɑ` a Y!57lPY;yިF0:w (INM}:-Ӆiq=5O#S IhZt栲ro'4ƙgϷF@Fu uTxx~f r{K3֑!~mUc t*x!@\1&nvXއl7,1Eku_zh2""BNg:GCNle?qXv&6 l _quOT i_OTL/83eG Mvsco,I"T6p2pGc mG&ۺpLP4?U1=CRF{MѰE)f>i#b ߇{T_Շum̜l ?ޤ^% _UoΑ=>P zGc.ץ]LX5Esbun RR-' C#Z kX6E o8 Ҥڗl\$CZx$2{jmǫeSZ04C$߲qSxdc9TӅ%z\-zö#x;@RII oeeTƏ0hW2+Y0$4sߊޅ(^>Zێ`PLfX ="RԊߟ -v(<|j{r｣FQVoVJ.lIbDjxF{_7~?:{O{"Pr4}f7&2?ZIPV"Cل?~#wnhg~\˓p>1wG8.'l>_' \QV@NTOyLW. cUvst::0S,4’(: m.x8G%H4O'oSy]9oHJ7y{R|rӟKQVbpj;lK)632ڰvM 0:bi`jd88tz੉S&"dX}C@ZykQ~NzNayD-IɒL;br9Sh:Ba7؊BB] dN_NwwV#^#eLˠ?H:-0Y2TEyg|*5~h2ou=´ a^mg@DK)`)& ̘S޼~H dDQ4&PQFT` :/.hCߛP^ k}L2?PYE»bg]!o}Λ==TRoc;x$MTIs9LB(]ɅM[]kB>ؿ$,)WM1mtX92Lw&-6ehdܭCu"]UBuxXѤҢ1}q}sN ~e"lo&IsĤhhQ|i"zxpMīkE٪>@Ͻoq \+\+ctT.vBXDdK/dg0|{_E(F̫-D%S$ڒ8khhj|+ s(%#gm%ڪK w麻ܲҠR#?w*h5}^|?`-GZMˊ cR۲{]˽8Ěqã`bJ795Q;LV[~^|ֲ&CF/n%Sdbk2L2S*;uL>ajY[Ԗa m51TeIEL|O"n10ʼ{ܠ^LZw451 b脼S=GPc U` O*g!bK͝(-@9?"ݒ6|uKQǥ92`?[ |[ ~e&>a3iK)][Wh#W1E N̢,%=f7"S' QLUu!]fT/yV]`=sܓQ:ܥ1@ endstream endobj 125 0 obj << /Type /FontDescriptor /FontName /MZNVVN+NimbusSanL-Regu /Flags 4 /FontBBox [-174 -285 1001 953] /Ascent 712 /CapHeight 712 /Descent -213 /ItalicAngle 0 /StemV 85 /XHeight 523 /CharSet (/A/B/C/D/E/F/I/L/M/N/O/P/R/S/T/U/X/Y/a/b/c/colon/d/e/eight/f/g/h/i/l/m/n/nine/o/one/p/period/r/s/six/slash/t/three/two/u/v/w/x/z/zero) /FontFile 124 0 R >> endobj 126 0 obj << /Length1 1626 /Length2 8236 /Length3 0 /Length 9066 /Filter /FlateDecode >> stream xڭUeX}K閡;D`aSBZ[ZA$sg/RiJZ̀r`+'@doW **-@'=/-4h dLa@!. 4pq81h`Gw(`edff H'hv:R5@ҪjU *yjjPs6@@' # %߭9=t栧09ڃ '4r0s Io  ~=%S;̡ G੪_8a֦ߵ@Ofl?4OV) ~2,@NvO9BA`8;ZB-NNOirοMDxdzi{mr`+,NΎ{g@Z@K v0$2ۿ-;GS9٩?-_7tdLOw}h[= ./R`;^LF"`D _J h[,MG`ځO)o6-kox2,?uQi `ZOe?inOVN>+7{$?_) r[|CVKLʃj'76{Z [G9dԌm7ٍ 1Su#<'qlkܡ5rCю/]>\81OozYSOsyArܶAʜN+lJ蓰Gs7U? ߸;i:;UfmHU,]dMc\Ƕ:Y^v^9A(B@Fݹ|gRT1IWJY|zY C ݺe@VR!Ԫ7tOt(opJ3^;1p]x!H3?`}A;iv& NR`c֝"q&ثtL'*n)Kldgp47wfuQq:l"TAKXVV3SݱIj` g yS2"XFc ~D۝}j _ ṿ Iޞw,S5 FZ[Qlٲ5 K|=b=ZKz!,A Ę'Hx1:nqH"@8fBBD8D;1v9E[<'TXt^sv 8bjң˗-uW힄[3{lawLgZpV}^{xŪIr@1/"3A1~*N89#4ф<5ֆTTz9GB#EJs})ӱз\Z& z_֍8Ƣ`o^db TQp.M(DyMHgk_ީ]򕎏 * P[bqv5ءHYURJR~qV&u'fG̽B`QY5ϐp"8/n(%Dނ2~ h! ْKaݳSW 7C5= 1֦oz~OǶ"r z1,y|*xJ昜a5REtdx:bqyzެJ\`iXm#n(-~&f OZz$<$aHemH \oTE_Es[L%e3k/4Hn3\Ftm>&KzoJK~ګ. !o,681$xͰ'|͂KY/٭e+u ־g[k7nubxX+&w]=dz~ ~,*/:!pofė?gv EG+acuUz0PDJޙLa"phND9BNP`r,N9s~͐\U7L>- )#H+!H=#ݔ\ l]fSfg̻)ۂ~ɔr15!ev"C쏬-5 I92 Nlg~&ܪ-)^e롛.j;)[3vrȔWekHЄC$YNBB >1=z ІJ_ %Jȶ]q#Vy×kD˛\ SXA't*:\5_ Ό$){HXR-,M&nl31;FB_{'FSϯ;p7" #4nFr4F9P$Tq Hry>):hژ\ r,oH-$]gR+9NgeO)f]<D}3X܄ E-d*X1sfo0Z>sY# t-$O' 11wt"B=ѮRh.I&nK]cZ)"?6p&xY \n=:oD9A.O<)dk'FޡZ\9>/BP#\^Yf~\@H&[v:&SؚT, vA{}jWʳmѮ_GM͎qE>mۻĘOyڋcKzEE"fdI\AH^ l6dj,\|Z)NM|׹DYfJ`D1Jo-д70+;+^7)2lZp $}ϐ&a?cB 4aETVfǒ2GJke4@+[{cC^*|瘱zG%Rg/HY\wVqZ0˜K tK{J;NѢm 9ֱ9!-@ߞL](;x;ޕvLٺ(3gW]%U4g"DratFbUXrSLf?e@Veܿf=c{f÷C}V-fVÆRuБt"SY(-mqU.,3*Į_,x-c)aMtyo{nDV=}` Zq#sKLFݪ ix6Ӝ^32s`%"*zYDž͗vpڌznYL9{mi$;7ﵘiPW"yQݖz$t`ֹ+j@)nd`%vu-x?rJF ˄a['4 pPIGӨ{ވn)(.e,Rtj~6x5S]2EȽT˵Wd*=O 4pL8\EÌ~˛ύxU5Q@3uQu}HW;\GF\8"؏׎tF1kJjJ<620]vy/˾G%p"p1i6 ڣ7&sA76{SЌB:{ݥ0bYH="QkMWm";4eS(YA.$]yVʖ>Ns}p! mUj,1bjNn'ry2Lk-}phcH5%MpEoLJӈCu $[Ǯ匚xNK+/?s9NB5ojPǽ;LaӾUXnZDY|o`ro_Ka \jJfVۍ/|юկx. KɊڧlu69{4XQL/nړL*6 N3d%-S?O@BO/"ZrRbRT~T-Z6;Ħ1nwCd)]![F]9$wN?=جU|~s?;DNCjX625V/Q2c<|~{feVAC@{bp⻰G\דL@Tv JA'~&kߞ?k`(e:E-p%~cB?W1;K? Q`F)/P4Ylލ*OշT5XN\teuKc<[`"&5}{{`O? yEOoYSm+xxq"#_*TMKӵѡ։jƨGφ a5 {>x5h̛ԉқ~Y2ZLu,pV{Oؑڦ :Oҿl3{>#}~'_y>7!"DBRLґ0.NHՎ0]b3mX7 F1Pf+q05bO&7ism@t1HZqѭ-K' X=ueA!86I8_qC)=vuSwX0<x57*>o }׆Oq֎(jCM.,pa\J='΅yGN'7+ǀ#jl ~gzVj:̑gJv(\D1"0EX)/`tSgn5͓4y\R!G^eƯnnOrN:z\~{EmOp!Cs9Y:#ң(x~K` Ů|@x|!$BDiUΦ|N^~AN9۔vdE &b<*Œŋqiy/EvE(͏Ź?R]ub3`Z4 `DK }֋Ԗ)R(SW5m>7r5d3vBfFi[žW`ws/h=#E-nW O=V Ql xqĒM}W|.:*q޺UؑG> |a)U݈e$*s9vcHJ{M&Ia l\|)Rqyj"S;>\<5ǻ́ u&j 8{=Ίkeo{\Zۭ;Z{nNt}.kbXRZ_SuRkiO|Fnk=S} I+.M4 CJoaɍC) :5^Cyj$H r^ݽʖH\X xcwY@5k +K81z촡P5NSgP^l%nP=ɮWձ2c-᪴[FҖ`7qyNphdVU 2~6|US6jeG#TNAk d nI33s/ 4YJy R*a A6={ }i XQy86YԜ)R SѹR>/ U{LE.u c"e韛 QzKϣ?el#f_fP;h( WAq |T5)T 69ĔJɻ4?2Yz Oܿ9b/LKs3 K@iC1E&#Q6wS(,gW\Ḓ&b^fnһoXe!~X0]=6GNFU}u;%rGA聐iz(dy="V=`%~eqi]UM; ^kO(W8 띡_V|Y9k4pӫsXhRG )CĿ2k[A @C[AnV/ȠͰ-"/m@& >ͣ뺶TݰY=Fǰ~R~3Cty~!~jMy[+@8 endstream endobj 127 0 obj << /Type /FontDescriptor /FontName /VHMCFX+NimbusRomNo9L-Medi /Flags 4 /FontBBox [-168 -341 1000 960] /Ascent 690 /CapHeight 690 /Descent -209 /ItalicAngle 0 /StemV 140 /XHeight 461 /CharSet (/F/I/L/U/a/e/g/h/i/l/m/n/o/one/r/s/t/three/two) /FontFile 126 0 R >> endobj 128 0 obj << /Length1 1630 /Length2 13493 /Length3 0 /Length 14319 /Filter /FlateDecode >> stream xڭxeP\6Nh]{pwn܃Kpw' w5Hp>ι3s7gf~.y<]jS3; ,l%k{SW#&Fp!֎@ 2Hv>>>j@MO_&S׼y-4o/n ;G'{  V  +$ VH@.@;@ ,]v8̭* %`' r` #'fa{SqCf.N[TI B ~S-,\*ơv _LAsk-i,d t1o0ouuS@'';Ͽ!` ;[L3[lKkֿfEӿ@.7Kh` 0Y*9BBg,ߑ@ 'W%rSڿ ?v mo{k]?ڠ߀Boms|Bk\bfڽo9m0N/9kot?`6Ty[nVwx39x[B|\EȿyVB\=ou]=< '3GFGt06suqy#V{dh&l;TڠQTPWaT89#ǰ;܋gGۓ:'+^ȸը=X;|N昪QD J\[' ?XPj i|칄!f̉E%'A+Z5ݽ\ɨnb6pO9?XAo.ʻp%3Ԑ3\=^yR/̟fc FYĽE'*30o.Ƌ%4H0FhmHyҦh$n*c!!kX/{΂l6 ѷje\1"[D0)kx63C"iM1]5gԜa2kdѲW>WF-=]i?ϊLk/Dlҕ>*,Ǖw1gZ3Ȥu`QA.ɳ$@ =ۢqOi13XNnƘՒPZ СEoQ&ti_i|QF&}5)i-s>./=vׇ`&dh|btI78"SajR8hq.&92\7 [,QGvcO9eΠL}Bd=}`W:֭G.M  ZKJH>\88gKUCsvUu%uoAkϜEG㧁 zU=vhgL b|(~^j<(RiƸ 2/x J_EYUy .V۟Ebܥ3Hǡ{WV|2`aF"lH8juCE<$[jG 4Bv((Ί0)f׆<0ُа=f-Wz%̀tCm|2?N| 'R3ƮWeK'U(sD)&MW\9p %΢Hh?Ӫld"Ӓ}7$ 5ýZfEفV~̲-&Yz&)BgZ%Ք |o@/eZl.}#3\ɾ=0v/vcc0%p {fMp|]!Չ?Z'=?%ҭf4A sbp8~ lw^$mK$L};L?3,|qǏĉA:z_?-Brbsd-;g?Acu ~Se sz[#53zZŏic?(}kK8bB{faG aLD71CuC&)zR,}pX}?#6:~d2 R:5͋tm|,&9,3R#\}R,L$QXLdOCMy`<"b,e\C5#H& 7w!+o ?I5-fHI"}WQ9j ${'Q6K$ (3c%ᦆLe gZu]LKBqѻFQ׿ʖЎuuNb_##!{򏽀=Z( 7E( `݇~0]@ӯ2FTb\Ə1I)3`7ѫQi]h*I#z2Pnp5s@2z ge&Un2>N:Qr\ s$ڡ,kҰ+/E4@^qE7` W)~%H@ndnL-0(wN3=he,+o"Pÿ*fbd4b `K8j!$E sjmRGcZ'Cd9udG0]Xa/S`Zٹ1(dBNE>#~mĊ5u9xp; cM'8&ʎ9xc/W+pd(*AW:ͮgEٗBۢ+ HQmΚ[BwUe*v Pk!NL!iΘE7(Ea\}"!D '{4ǽ .釦jCrn S]J`0$ 38F]F3 rNox X'$Pxr12JEl*~ ZQϐAx jdȪ5p%\0F;Oi@>_mEuS%5USו`L|ILȈ\<^&c0~.c\{ia6WY9I#++AH,y nf=]xznLr k½m  Icsv))Y2G$|wM98 s適#&Q p~J4olJt?? P6L5i|Or+]U\"{iF]CX!A &AΡpMni{6$'MIrc :  9-oTՌgdևdw֐"[Nn;F=&;\g:/{Dg ZBD^,[錞 ?T s!MH: WkͮC-R8s' /ͩЌe)iFT֗ [S1]\v˕?ԚrM72xI. J?P5 #֧cB=)MI#AzU OX۟cd{Y^r.%QZƋT+:Gm ن$뭆CJk8nӇWR~?m|&]H|j%(̗=˝T. bonL2jv'&PreO#0~,MLvAwFfhs ? &c\+(aZF{+alw\q=5tZ{*BߞJ<n](k&~ܔͲ8:>*ͽlSsԴwϸISuz tw.R`аO`8?S얱3:|w/\} 10BQ޼#+{-b CVKoYCۯ]VOYia;lgpk_B[JI 9" ؑ†zP>p)Fӏ."17hmkԌ0 ~U/N$*[)c3o2G0M HO-U'!A"Gk8d[rF8.0# lcҧ)~Cw. e="?:ﾕŋQ2iZE<ԅ C*k̆TFxJL}By4[ in 'kiO}J64 09]sƪ7bMJ_]$֠GBS ̀@L a)evh%B}q0I'SX=k Hv cjP1-JZ㖄9,ɽACa'x i 4njHe,Wo!"+r NcӐ* JaᵬeS?k5DF*xߥ~9]ym^-䁘z$H#_ᥕsmzm /y3CC*8ɲwhb-~&j;\, m8f"`jo-LME60G^zni)8G; =NWG,!f#4wXA0g.qe0w@3~%:vdJO䇡G4N%,ۻʡa(Nlޱҗ}"~=ʘ$ ujgpn?l=jn%G&S?:פ#+[ur"Hl4"'}9fZX#Wp46`;*!ʺ9[obiSOG?Fg/Fz2 e<婟S1Z#};+ { 6)i2sLfgÅ$f]]}B9$siwơчo!@GcF c5Y:_U?B/1vǦͥ# >ֿ8H|#G)>̑U"bȫۊD B3M"5nm)q[m-[Y$c$ я8{ۉt.vJ#Ѳ'ZBHꕻL!ǁ_3b2 coeE-@m5[MGQ X'dއ_~!wc1%פyUw/-ҡHDbgmu+75{K*G)KCh:ZƺzoEQ2H @CܧYؾrmFYz$iے-{8IzMqnéK9ʶzܡʣUGvW@ <_ł8[05׾W IxitUˁZP^zq #|i.vgၡݡZٶ$Ļ`i[ \6a\ލp&ȉ[ ~x[fw-qAK1[]ɄƦʡzp]ꎫ9}:XϯHܫ^*{T?}GpiˏrlgwRiĔçTlD[ 57;RZ=ItuEkeA}^&T):3<*Ex0G)m9FTGKgךQ վn(w8 ĭw~jQQii%X4|o(N4eT޶ AUU8":s8em\eɹZWE88Xj6xG 6LNTSDaGO#`frb4e~c si2f#!Z͜I./Փ  fghCAwqhAT0Q2|k<Iut.hϙ4H^ Vؓ fJZ( Fio6}fo*lQztR6Ql\iX;"ڍc \q}5_:+\3Mc_t\s;@'0gk< {9s0LlsA+n~O秪U P}!1Q'hةE-IH:q:JrDch6  X 5vῪ>+_+ ?sX=k_U:K\ڕާm`QfJ6WNE7S,n?CSc)93md.N"@&9{u%r(31M&RQ5ot@ Ni(/J?@+c98]Am:E.S4q@*<.q| p_ρjYt-dnzu/4Y?O2l%S(#]\jt/żY˹ia&nBZ^!Q9\1xJ2\ e֧JfN7'0xм[!jecQ#*R_6ز;17ndP1C 7w2:݌əCsMpQMG7Ek:,\׌IJvgƂ`z}d eg[PB. u~;ql~fM*T/tWT8^_7 Cinr~_uT1K1%X\GwN|`wCɟ$rCieh՟?BA6@mK^i3jzBk_ʔII( 1&'*YYqI3 b< Pm\\ݞSUn}ҍ{U_Ӭ_@̝#NFyR._EOIw{ਾ0bCp$tK۱k9fn/#S %`6yE mۍF>| ;zgچLyF:bȵ:3sak[ haus7joD8lBfY}73{8~f 7"$gl{ xeG~5/r}ɏ̐7OlSjf=T4B6'|,ԯ`-y l"$a5ե uBAoB)aNX筒gfo,~GΔm5#nGT0NRJ, yw pɥC0^SOٕRUM&1+;UB8[M'ݭ'GBeLCT7!X7|~7#Mpg#jX9]y R\w?}*l>9e˵7Eq0 x9x>|2GڡrUngP3CWJ# O4I_sH7 "꿞2Gs4i1Џ(}L767q0,`4θmJDA {}I~5LkjBH~8wMaguR}g4a݉tYv!!Nx“&m mQ0F ;){gw0VJڔ>U8F.[k a.WN!:-$Q]nq݅vo;#KwRtOE\rAOƙ62Y(ʗ5CIhjM\2zK`Nȡ .#Zp #h;@H]H}4%ic/Td2'T\ޫ׺ŖB G7(k+UEFa)ށj姠2εIFaߜPWt@>ªC+ŷzQbc0F,:!XG95cW#$waTtwd\IKT?YBo8~sʯQtM/C%- Cm27ksĞ0_fyhe[D`sCd`dUWR<`e_~P'?%m8\Rʧ0?͝ VAJS:X>e*Ĝ{Q5c9%14)2C -N;v o՜Վ`|aW0[oŵ[cCi,|ǑqZvӱv{(E3g &Y`"ۚZ<vrTr1YH6~NboQy,<^ud=QQ:LˬF; ,*U^ ,/ W]6D{%x1?ǽz#el )-] ә4н|>wAfGC1~(O&3>16+΄|@`'OH nZayt2~=bj o}ߊD2ݾLh_' Bk먒aZH:9zW)u%d,(:)X\wwK hWŽ< \tJ!o'}'$ŘgJ\ G4VìNص mT?y>.#<`ЄZK$=;'vt{‡ǻـj EҦ[;ӗNt(Wh;NJdOJxmqSɎ/}jn.gT$Z\:qЊx'OljpB*=ZTgVm*:#T7F &Na+ d-ݛ9N8:Q)G]8W MK낚C[ʩ)M%mHH^`YV ctLVnS] @ٳ*tލ$?,4) <NӎZYQνH0*fx IFءSCsbVý^<ذe>ދ1n W!7z`Ꟗ+3t]^ $6 W<Q<.JW R4QY/M!|X/<~gq ^llzPd|Z8LRr2)b$1"Y3EabdZBEtĪ"ldb̍R6A!{IJAC-X 1d}hWXӲ*2KVzBU% ezLp'㷂G f ]M\[qx¾q|Ӓ|t[}X4X_Jm~j=DY82]Nq=rI&!6V(pV*tjo*u]m_(' I$ABm>񯺐s. ʑEL o ,DCo(tc{g($~ʎك4\RAEhp =V0.(&kexh΀Elr¨X*s~MG|8d?ɞ_>Hz ɨ Ȼkoi<;2~Ae/b<6 !) *n@5Ezw3mkk)GwuC'L)Y4j'( g^-ж/ i<4Z=&ZAKȞ) pNFt)6[L; Tt';Il1t$qB AUQ|?" *TN}eWZMeC]'{I  %9'ja H5 ?#b\݁~/ǝ6MriJF8U-_BKo}'JޅB]/NoHd!@c;t'ξ|D^kyfP4g1rC? ӁS"Gr?B(Om1`n1c!|_ J,tn{D}2oCV 2"BEXe wl'lVi?Л أKyj/VCڱipv6Z?\(IM9(z0e"6f>0jk&+S34+)ȔgHYÒ,H%O9#]1bEvi>hnN^?||RJylcC o?MJl;BîGYlɌ!<81)M)H{jdQ@ =qǒ8泻+]njk+Be8+|=vW!n2r@H nT仛rƛ0 0FY{pQMKʘq;9a*VtM4HVځ>T Q?+Y0xð0[ɅK|19F5 B7Mt{xcȀh襚v$pߞt߹u*#K'o^-X5Y>.Ƹ `/3į&ɤytN"W/4$P켦ߋ@4ӲCszroi^{g)}k)Jl В(po |ߜ2q}cpjԼ9rC9 &rz~!FiCD$#i#iamwY&IyIĖn8 ~DQ`jNf 7(׸Z]06bWdB'܊D"ϖ~tmbE% V˧CMw7ۯ&((kT$ř~ Th6f9|gR~Qb+ b2zyj^K/ds/Grf(/]w Mo> endobj 130 0 obj << /Length1 1647 /Length2 6227 /Length3 0 /Length 7067 /Filter /FlateDecode >> stream xڭTuXmFJ$Fa@D. `p!nDA;Ewv?fssss>Jo 8Dy蠍@!H XYe! $!!] 1<} c"l]VH+m]N..Y~޸AE:@-6ԇ(s@ZAP BS_YC CQMh:AjPs @`85pCQaso` :8P=Da?#P6( Ep@:CmTVM9DZs;@Q0a#CѠP$ w !.߹@`- ʍ") W{% 88hPܿo_}K [[hE:@`!Y q;8} @/PfprD*vN.zKU|yT / (U̪FLaC{>_燌V7-ŧId_GPS(cIjKE\=r'EJ-lΗ80?V2Ȕm{2:;eO CNܮ˭)Gjzu+Վ3Zߣ4~lO߽2|BFB7a)u"e]?q]9{o(c%2|k*0P'P |F 60ARh8ka2'xSvGx+UݙP}'E YԵ^'VHAzky@ppW1(=t'kݦTɅ:KdSOEQh/=n  ,GuN~{m,Rp-z踮]F B57a6R;%2/¥Z740X1ю,k4.O_Xu^ʈK+"JRV-.fFaQRsh6u`ftu<h/ˠM/դ-rKS?oA<Ͳ& ε + „,JuR a>mzJ!ooSˆa6&^'_ۓ}f_ 21).ƠS߳UgՁD|'V0,uEP@@7thV }Bݐo,hLKV`b1osr8x|KJniY"W+cjdz*}Erlk+kh CiTb2T oWv}`Do4/?"9KMq.e[c_nHɃ[x`B GOᐚϮ@?M \@@5CS5Mj\sATMWɎcw@y7y~N5NٽN{Ro)2D('Zs^{ï *|FDS8׉d/DGRY;Y4_-!)#='~{D8b0z8:ixFE!PC=?~g^ʌFW%5 ULҌbA7X7yޯvCk+:(չXh+_YҋiX@";R ]+ #Cl lny"mv`\e5U3Te*Z&Ldd(z,El- FnY3܀X0)>WE ENG;K:R[IkQt d3U[%u[zk+@&T08v9 Sc%jjB A򡁼*QLm1\o|INfo)X+VT꯺.)<.Mu;cm\g1d޶ 0cAoZ"(cBN 1F$t-2DMdxfQkހw-pR&z#%ް*"6v/Wy(DL!/ D˃2@Ywd* *CbVsn.u<Ԩ;WmfFFZe {Q7,GEmr"f}Ͻ,4XJQDRἕ|y$Nu0\"jg&q%+ظAM=Uf4۸!tgG>-| ;埝uPVNniHE⤹K: xҸT$;} ʆ3{[q{]86e+}v$<{$Ӏҳl1çafȎjc){d}GSYAs^g?V5BKYJ:&PBX> ranwQ 2S i={}0h^.k9F꜕Riy4"昄,L='w;S&=l!7;*eH?IZrPS}`RLc/s& w5[ &Z)^@}ouz_ʪJPAp!M\w+!WUh;nXʉ_[YӮ6E;CZmnocR%yOMYg&}_"\$=Öt:m+ΒGa/!αWһArɝZ 3MEpyȓܪ3L,8#9 'x'zNrh*C(mbG#5K5U'Ʀ[3jmLaM!ؿ(AWYt~>o YRк*rk 3^c8J.MRv{,$Di=6[.ЧwIk=eКON+\K0(Z9y%e=^n6^+ no*viC4Ϡ,$()#![b Μy.%`ެZl;L,b͢8}̀g hoѵc1NB}aD\ӟL(_KX)VAo=%v)a xGy_F"a|f*ޜIlq[!]5񑭳Gur7@FX1ƞ b^(VMO4"sJLޥrډfZ@9`"Ǎ a,Cu _;QDڨUU>S`akhKa5׌M&1NR̛Ɖwr x]'f  t K.YOGdTO {t֯[5}<-|~'HH9M~u3]}t.}5,Ϭ*:ϰxn[~(:DvMK `DdH=?Cp 0Ȓ1dz.J{XQ ؽR8dk`~gWt!Q|Ic]"PL"bDAf޷WjKԡmhrsc\jw@P;hņKD᫮gЖgz{iGm2yEݔWP&. ,wvШ&S^dzWŷ]TIA;HON8E,kÍ=9}DrAqҜ:\wH@9QQ+ˬuD H1 ?Rsw~;B~83HΛG𳾬 Q`Ϻ[O*Ev6L&ua98LJp"X ٟ @+3.j:c%DuId^mrN0"P}ܷo\l5e6bH_H(/T_hw( 12AUY5%3j?_ P7E}z{!.sJ>ϲ%Q&v}+ј_ocиNyw? &|(wa_+ هl8O؛Gz?։z :Su¢u-+1kZӅ\}mlYu( lUrCÐ7-U׾k]*WzwĜ-L XTU$ endstream endobj 131 0 obj << /Type /FontDescriptor /FontName /DPSCCI+NimbusRomNo9L-ReguItal /Flags 4 /FontBBox [-169 -270 1010 924] /Ascent 669 /CapHeight 669 /Descent -193 /ItalicAngle -15 /StemV 78 /XHeight 441 /CharSet (/a/d/e/g/i/l/p/r/t/x) /FontFile 130 0 R >> endobj 113 0 obj << /Type /Encoding /Differences [2/fi 34/quotedbl 36/dollar 38/ampersand 40/parenleft/parenright 43/plus/comma/hyphen/period/slash/zero/one/two/three/four 54/six/seven/eight/nine/colon/semicolon 61/equal 64/at/A/B/C/D/E/F/G/H/I 76/L/M/N/O/P 82/R/S/T/U/V 88/X/Y 91/bracketleft/backslash/bracketright/asciicircum/underscore 97/a/b/c/d/e/f/g/h/i/j/k/l/m/n/o/p/q/r/s/t/u/v/w/x/y/z/braceleft 125/braceright 149/bullet] >> endobj 48 0 obj << /Type /Font /Subtype /Type1 /BaseFont /VAYHNY+NimbusMonL-Regu /FontDescriptor 121 0 R /FirstChar 34 /LastChar 125 /Widths 114 0 R /Encoding 113 0 R >> endobj 22 0 obj << /Type /Font /Subtype /Type1 /BaseFont /GGNCTL+NimbusSanL-Bold /FontDescriptor 123 0 R /FirstChar 49 /LastChar 116 /Widths 117 0 R /Encoding 113 0 R >> endobj 20 0 obj << /Type /Font /Subtype /Type1 /BaseFont /MZNVVN+NimbusSanL-Regu /FontDescriptor 125 0 R /FirstChar 46 /LastChar 122 /Widths 118 0 R /Encoding 113 0 R >> endobj 36 0 obj << /Type /Font /Subtype /Type1 /BaseFont /VHMCFX+NimbusRomNo9L-Medi /FontDescriptor 127 0 R /FirstChar 49 /LastChar 116 /Widths 116 0 R /Encoding 113 0 R >> endobj 19 0 obj << /Type /Font /Subtype /Type1 /BaseFont /SUQDKN+NimbusRomNo9L-Regu /FontDescriptor 129 0 R /FirstChar 2 /LastChar 149 /Widths 119 0 R /Encoding 113 0 R >> endobj 45 0 obj << /Type /Font /Subtype /Type1 /BaseFont /DPSCCI+NimbusRomNo9L-ReguItal /FontDescriptor 131 0 R /FirstChar 97 /LastChar 120 /Widths 115 0 R /Encoding 113 0 R >> endobj 23 0 obj << /Type /Pages /Count 6 /Kids [14 0 R 26 0 R 33 0 R 42 0 R 88 0 R 108 0 R] >> endobj 132 0 obj << /Type /Outlines /First 3 0 R /Last 11 0 R /Count 3 >> endobj 11 0 obj << /Title 12 0 R /A 9 0 R /Parent 132 0 R /Prev 7 0 R >> endobj 7 0 obj << /Title 8 0 R /A 5 0 R /Parent 132 0 R /Prev 3 0 R /Next 11 0 R >> endobj 3 0 obj << /Title 4 0 R /A 1 0 R /Parent 132 0 R /Next 7 0 R >> endobj 133 0 obj << /Names [(Doc-Start) 21 0 R (_installation) 112 0 R (_limitations) 111 0 R (_using_the_filter) 104 0 R (figure.1) 91 0 R (figure.2) 103 0 R] /Limits [(Doc-Start) (figure.2)] >> endobj 134 0 obj << /Names [(lstlisting.-1) 46 0 R (lstlisting.-2) 50 0 R (lstlisting.-3) 56 0 R (lstlisting.-4) 92 0 R (lstnumber.-1.1) 47 0 R (lstnumber.-1.2) 49 0 R] /Limits [(lstlisting.-1) (lstnumber.-1.2)] >> endobj 135 0 obj << /Names [(lstnumber.-2.1) 51 0 R (lstnumber.-2.2) 52 0 R (lstnumber.-2.3) 53 0 R (lstnumber.-2.4) 54 0 R (lstnumber.-2.5) 55 0 R (lstnumber.-3.1) 57 0 R] /Limits [(lstnumber.-2.1) (lstnumber.-3.1)] >> endobj 136 0 obj << /Names [(lstnumber.-3.10) 66 0 R (lstnumber.-3.11) 67 0 R (lstnumber.-3.12) 68 0 R (lstnumber.-3.13) 69 0 R (lstnumber.-3.14) 70 0 R (lstnumber.-3.15) 71 0 R] /Limits [(lstnumber.-3.10) (lstnumber.-3.15)] >> endobj 137 0 obj << /Names [(lstnumber.-3.16) 72 0 R (lstnumber.-3.17) 73 0 R (lstnumber.-3.18) 74 0 R (lstnumber.-3.19) 75 0 R (lstnumber.-3.2) 58 0 R (lstnumber.-3.20) 76 0 R] /Limits [(lstnumber.-3.16) (lstnumber.-3.20)] >> endobj 138 0 obj << /Names [(lstnumber.-3.21) 77 0 R (lstnumber.-3.22) 78 0 R (lstnumber.-3.23) 79 0 R (lstnumber.-3.24) 80 0 R (lstnumber.-3.25) 81 0 R (lstnumber.-3.26) 82 0 R] /Limits [(lstnumber.-3.21) (lstnumber.-3.26)] >> endobj 139 0 obj << /Names [(lstnumber.-3.3) 59 0 R (lstnumber.-3.4) 60 0 R (lstnumber.-3.5) 61 0 R (lstnumber.-3.6) 62 0 R (lstnumber.-3.7) 63 0 R (lstnumber.-3.8) 64 0 R] /Limits [(lstnumber.-3.3) (lstnumber.-3.8)] >> endobj 140 0 obj << /Names [(lstnumber.-3.9) 65 0 R (lstnumber.-4.1) 93 0 R (lstnumber.-4.10) 102 0 R (lstnumber.-4.2) 94 0 R (lstnumber.-4.3) 95 0 R (lstnumber.-4.4) 96 0 R] /Limits [(lstnumber.-3.9) (lstnumber.-4.4)] >> endobj 141 0 obj << /Names [(lstnumber.-4.5) 97 0 R (lstnumber.-4.6) 98 0 R (lstnumber.-4.7) 99 0 R (lstnumber.-4.8) 100 0 R (lstnumber.-4.9) 101 0 R (page.1) 44 0 R] /Limits [(lstnumber.-4.5) (page.1)] >> endobj 142 0 obj << /Names [(page.2) 90 0 R (page.3) 110 0 R (page.i) 18 0 R (page.ii) 28 0 R (page.iii) 35 0 R (section.1) 2 0 R] /Limits [(page.2) (section.1)] >> endobj 143 0 obj << /Names [(section.2) 6 0 R (section.3) 10 0 R] /Limits [(section.2) (section.3)] >> endobj 144 0 obj << /Kids [133 0 R 134 0 R 135 0 R 136 0 R 137 0 R 138 0 R] /Limits [(Doc-Start) (lstnumber.-3.26)] >> endobj 145 0 obj << /Kids [139 0 R 140 0 R 141 0 R 142 0 R 143 0 R] /Limits [(lstnumber.-3.3) (section.3)] >> endobj 146 0 obj << /Kids [144 0 R 145 0 R] /Limits [(Doc-Start) (section.3)] >> endobj 147 0 obj << /Dests 146 0 R >> endobj 148 0 obj << /Type /Catalog /Pages 23 0 R /Outlines 132 0 R /Names 147 0 R /PageMode/UseOutlines/PageLabels<>3<>]>> /OpenAction 13 0 R >> endobj 149 0 obj << /Author()/Title(LaTeX Filter)/Subject()/Creator(DBLaTeX-0.3.2-2)/Producer(pdfTeX-1.40.10)/Keywords() /CreationDate (D:20131106160616+13'00') /ModDate (D:20131106160616+13'00') /Trapped /False /PTEX.Fullbanner (This is pdfTeX, Version 3.1415926-1.40.10-2.2 (TeX Live 2009/Debian) kpathsea version 5.0.0) >> endobj xref 0 150 0000000000 65535 f 0000000015 00000 n 0000022587 00000 n 0000094353 00000 n 0000000060 00000 n 0000000094 00000 n 0000024504 00000 n 0000094269 00000 n 0000000139 00000 n 0000000168 00000 n 0000024624 00000 n 0000094196 00000 n 0000000213 00000 n 0000000244 00000 n 0000000607 00000 n 0000000722 00000 n 0000001306 00000 n 0000000295 00000 n 0000001187 00000 n 0000093678 00000 n 0000093335 00000 n 0000001247 00000 n 0000093165 00000 n 0000094027 00000 n 0000001087 00000 n 0000002181 00000 n 0000002006 00000 n 0000001443 00000 n 0000002121 00000 n 0000002794 00000 n 0000002944 00000 n 0000003093 00000 n 0000003302 00000 n 0000002646 00000 n 0000002275 00000 n 0000003242 00000 n 0000093505 00000 n 0000005753 00000 n 0000006825 00000 n 0000006895 00000 n 0000013312 00000 n 0000011418 00000 n 0000005624 00000 n 0000003408 00000 n 0000009236 00000 n 0000093850 00000 n 0000009296 00000 n 0000009355 00000 n 0000092995 00000 n 0000009414 00000 n 0000009473 00000 n 0000009532 00000 n 0000009591 00000 n 0000009650 00000 n 0000009709 00000 n 0000009768 00000 n 0000009827 00000 n 0000009886 00000 n 0000009945 00000 n 0000010004 00000 n 0000010063 00000 n 0000010122 00000 n 0000010180 00000 n 0000010239 00000 n 0000010298 00000 n 0000010357 00000 n 0000010416 00000 n 0000010475 00000 n 0000010534 00000 n 0000010593 00000 n 0000010652 00000 n 0000010710 00000 n 0000010769 00000 n 0000010828 00000 n 0000010887 00000 n 0000010946 00000 n 0000011005 00000 n 0000011064 00000 n 0000011123 00000 n 0000011182 00000 n 0000011241 00000 n 0000011300 00000 n 0000011359 00000 n 0000006202 00000 n 0000007635 00000 n 0000019210 00000 n 0000024272 00000 n 0000022705 00000 n 0000013183 00000 n 0000011571 00000 n 0000021757 00000 n 0000021817 00000 n 0000021876 00000 n 0000021935 00000 n 0000021994 00000 n 0000022053 00000 n 0000022111 00000 n 0000022170 00000 n 0000022229 00000 n 0000022288 00000 n 0000022347 00000 n 0000022407 00000 n 0000022467 00000 n 0000022527 00000 n 0000022645 00000 n 0000015797 00000 n 0000020068 00000 n 0000024745 00000 n 0000024135 00000 n 0000022870 00000 n 0000024442 00000 n 0000024563 00000 n 0000024684 00000 n 0000092561 00000 n 0000024852 00000 n 0000025239 00000 n 0000025354 00000 n 0000025646 00000 n 0000025937 00000 n 0000026265 00000 n 0000026832 00000 n 0000042928 00000 n 0000043432 00000 n 0000052025 00000 n 0000052324 00000 n 0000060479 00000 n 0000060840 00000 n 0000070026 00000 n 0000070304 00000 n 0000084744 00000 n 0000085117 00000 n 0000092304 00000 n 0000094122 00000 n 0000094424 00000 n 0000094620 00000 n 0000094835 00000 n 0000095055 00000 n 0000095283 00000 n 0000095510 00000 n 0000095738 00000 n 0000095958 00000 n 0000096180 00000 n 0000096386 00000 n 0000096551 00000 n 0000096654 00000 n 0000096773 00000 n 0000096883 00000 n 0000096964 00000 n 0000097002 00000 n 0000097168 00000 n trailer << /Size 150 /Root 148 0 R /Info 149 0 R /ID [<02FCA902DA3ADF4AE262EEE726C99D73> <02FCA902DA3ADF4AE262EEE726C99D73>] >> startxref 97494 %%EOF asciidoc-8.6.9/doc/music-filter.pdf0000664000175100017510000010740012236331056017332 0ustar srackhamsrackham%PDF-1.4 % 4 0 obj << /Title (Music Filter) /Creator (DocBook XSL Stylesheets with Apache FOP) /Producer (Apache FOP Version 1.0) /CreationDate (D:20131106160620+13'00') >> endobj 5 0 obj << /N 3 /Length 13 0 R /Filter /FlateDecode >> stream xwTSϽ7PkhRH H.*1 J"6DTpDQ2(C"QDqpId߼y͛~kg}ֺLX Xňg` lpBF|،l *?Y"1P\8=W%Oɘ4M0J"Y2Vs,[|e92<se'9`2&ctI@o|N6(.sSdl-c(2-yH_/XZ.$&\SM07#1ؙYrfYym";8980m-m(]v^DW~ emi]P`/u}q|^R,g+\Kk)/C_|Rax8t1C^7nfzDp 柇u$/ED˦L L[B@ٹЖX!@~(* {d+} G͋љς}WL$cGD2QZ4 E@@A(q`1D `'u46ptc48.`R0) @Rt CXCP%CBH@Rf[(t CQhz#0 Zl`O828.p|O×X ?:0FBx$ !i@ڐH[EE1PL ⢖V6QP>U(j MFkt,:.FW8c1L&ӎ9ƌaX: rbl1 {{{;}#tp8_\8"Ey.,X%%Gщ1-9ҀKl.oo/O$&'=JvMޞxǥ{=Vs\x ‰N柜>ucKz=s/ol|ϝ?y ^d]ps~:;/;]7|WpQoH!ɻVsnYs}ҽ~4] =>=:`;cܱ'?e~!ańD#G&}'/?^xI֓?+\wx20;5\ӯ_etWf^Qs-mw3+?~O~ endstream endobj 6 0 obj [/ICCBased 5 0 R] endobj 7 0 obj << /Type /Metadata /Subtype /XML /Length 14 0 R >> stream Music Filter 2013-11-06T16:06:20+13:00 1.4 Apache FOP Version 1.0 2013-11-06T16:06:20+13:00 DocBook XSL Stylesheets with Apache FOP 2013-11-06T16:06:20+13:00 endstream endobj 10 0 obj << /N 1 /Alternate /DeviceGray /Length 15 0 R /Filter /FlateDecode >> stream xc``v fb``+)rrR`g`gfdcOL.. *awqa@FoWA$em[rAQ >)@#yƔܼ {P^RT rf``bRrSjD씒 9 A! ɚ %y ): 99 E% EũEe)z@v:ȟ Eɉ9 yeEřy  z~LA`g8恄! Vppv1> stream x}]oFfmb[#hԎϑVҞbF3e 5A 4X.lE {M ?_*jY i_|X|bq00P0[`셕`DzN+A5FZTl,v GT+8r#C}颋P1." hAGAHm/`*Whr4720j F+Qź݇˴uQE]慡Q0~'g@ۉBcC}3GK>tiE _E aC#rF-d#ӾA;*)h"v:ⲃc5+l? .Fե\a+djGRgj/leq( <dem`P Էmm3#kYbAԉb?Jji'3ΜF_QvȞOx0 O9WEPBeiUT| g"L0VhLFhP_I4STylі: h3m;qKDvk2 >A }`´ІCBo1Vk].!cH9y#5hƽ⯙`; 81S}H ۷60#e<-%٠+ꌓ,iyTiuI'`_ӕ ,m=$$3ꏭR_+ʅ42Cg9``=i h1w JT:wAwyGقQ?T;XV:ѥ밌:e_@?i!Ϯ.ufCQhh};$ ,Q?[33o!d 1V~XRj1>aN9GLA#j3QI=?K #'˰n~GA5~ tP;{?:׍Yv0Z-?$-cr0,Owņ!Sρoz Z,kpj8)70+\Z \1t!,]K 6AhLHq9q߰`&W .n[s C _h^FGX{KF~ gp* t:ϼ"d3/'q׏- O#"8A=SRӗQ?>d7v38 \ I_ѹy~%4p%-q邏}ϲ+qk8>Xcq5X%뤔??镟:g{136t+k˔пf,ņpXGGUGs镟:\w{+8{6w7(e!$ <|M.g=ǨE())=v"&kzMpvCȶeln{5r)_5V}"s"qsxTI}U >wSRح9A|x| Nx3vͯ϶㰭lJTHy]pӌt7k>veۄ&h կj4r:;;K+TC~?@:'nE⦶AtU5!)O8-VrSgK7*ev"6cq|3uNK*_7ݣ7o5JBQOԮ_ՠ^-7;݊MmHvdY~C0__iO3Wb*fXV~<_?JxJ<{`P)5W5JgA3v 6)j 6{t@}//Z=@%^!>`LfE}P_ K}Cw٪- ݜP?lYka[ U*oER4P~iDhP_Ϟ VH}]4%Ňy{'wA}ԟRƒT%y?>AH*oQх7S2P~yW4P=ح)^aAH}Q}g\ܤ&:g'Beݪc Rl](njfyDU춱[k7eŇ8-xd߶fڱߕ|gLV K6ݼ$o 9ÜV%R@5qCU ]vXTsV(nMCaTm=p;wٶӎ\0ɦ3B upo}%vbyͼ\gBj Oy z£gv+Ix R ̡0Tb,LxI-~TcqyE[!x$q5 ) jԿ[!U ԩ 2&w+A2O1DH}>*D~W=ΎK7Ѽ~.WJI:ఴ Wbô-> HxdI!t) Q9 ~h0O3eT]G5$6PQUqϫwTfվ;#bYMTz}j"]pTzGόOEqS;s 7G#٪0anXzݼ3SS>UǑP[T7wCH>3c0RMgٽ jrgnZ[j9:Mzw+'O8IDSCP92 qIx:9)&< 0G}$A q8V~9xeD{ _C@9Ѷ3c7 ꓨ,A+>?ӧEy;.L~:BQ?/d@ z 69+v(G)Y4HYMC4r =҉E@1z3E̍~҄r*.AuQ $tH"n*G 7Ϗs}Nl'(A$'ȅiy&)A*[(e+z\O _*;$mOTQ^7n|$ɨL Ӊ EH U,},|4AxPħk(Bm-&~L^H ivZFxJok!%Ti]aq7Onh[vt.o6i]OSM;•S7:*Aɛ؎ٸ =ꇧM5޼ͨCW=_"K ;SLK:W()rI#ͫrV@:t P]*ż"N$y/)k'p5+͇$j*Z琔<^;t-~SɽXJ}4S.}K^5쓗-tmUq;t#c(NHvyʾ/gaYx@7㓽pM)Q2fr>(^Aw-`$ ^zNvF'/1LNC 鸁5yZճn=1yOT:OV &J\3,#:;n& #;?s#ge|En.S_SuZx4 |0zWi ~gA ɼ{WfrYmOMMFyb/md:Jo^Vx-f'Ox Jq!% t_il^3nX0+ٌQ?d9BAn'OԯsvX/frm`;;I l) .:IkȜL CH̜IHBcegݖxuxyd鋓yWK뭽T\)p;d߳,I}";Oti5,Ԭ!șwCvNTS]aɼpg@\*cڕEP_3´Hdʧ7"ej6"v\cwUu>8$1KM ^!c9sXp/1s$4{ ,#LgH{:j¡(#L@xm쪳1NQ^ǫ11>{sQCz>3&?}ΙSߕnq=}$hFN8ctr~|ҸP=XyY ob|o ]-B}Ϗs;GxZ?ӫY?NI>3~3.HyO*$v׮Gp2Z)6h'zs\<:B.u?߹G^uuK j >$ݏ,NCAkэGQ8FwGP8]aK()<<`<#i?o1So^BG$^4lo|*>wٙv;9UF+F)1'vp_Ut_d+,2uaC =RCw69g5xp*ķgu e_ͼOos!lϥf,' 7\zҿ NU@WyDpa 8Wń'k>IJ78Bb\s*hn`3{tK.0-G}GWQ X-P?q|p OO.A̜qK7EKNNsAyZ  U? 'x'YXC=<߬ 0 ʔOn Pe-#mb`>C*$ `O75@NɆSafb6RO\Ν#~nOԟ\sq!A] %`j)jگ}@\ *qfv6ROܓ3/YBt7ީNYVICHW*Y@]EPD]ۀ΃A8%g))t%8D#_͜9>X-N\_9MD>+i&Z%7ETwf\""7))w3T7HS̛K jᯰ/Nué@}\zC"'?;A7.E/֝@jfԗibDAV낳-nv8E%cA_F|p)@c{:1@QG;I)r˜6(Q?PTYPT~6J/E} ?Uc`c@q˞t#jR dt5mqSAETcg6"oyu2%n\v?)) ܪV+z17>!p2qnjlf2_6Fg@ܔNZ$n1]qSAET%q{fP&aL7Z~%c@s Spe%ep*$<@2SWv~ lTKx-S(oь.XL=͜S?(NIȩUr641ԲW~,;E}(Oc8't@8lԡ>r%[,[PH+<@N0`k=]jԇt5mK}+O}/?c)CS,ʔZ RAjP?Bbp@1E!vW^Ixʍ˪P(R_*>Aԇ2ReK)A}^J}(@9} ~C"RSJԗyjW)aljԗdLce78uR .T0g9:>}|9N ֝bnGpB[Gō}X%)3bkQ$*jաz6~ag 7ےxףp6e\y_r06F?[,qjBlQ࿤&mԳ>ⴭz)E|ʠD_H-%1Vب)&me[,Fx4I;x>,{TЧ $A Q_AG}(`.R?NK c lmnL6kIVe1A+E}PD@,\-HS>\`S%[I('S_M ^LfGb lб0#vVUMyLfF2bԇ6VN}lo0Wu*+njU)]MZ&(J:m`qب#n.,'Sä С{W>N!$rZ K%8NO h\`cZa+i4l}gN&ُœ:w+twĵІ6r11A*<_FZlwZ/o)gWOPڦcJ^m/#aJQ=4tsv%Po]|NGxҀcuOE-;x1M2kG؏&5z]NxZ(=?8חy O;Z'>o*OJ-IJ>*CIc|q?TiT`Q[N'޽ / ot_J`L,A%W4?UUp?yL_nc3"# 4CMtA wa>Hx&5叅p!*Rdw_ ޥtR;,U=VS*RhG`9FAn/'aM`~'%G+|.+Ƚ2 7h]FwK QTiP%Ӂ8w] g4(,(Q;쏩IxT$ (kRWP+@/ UW:$] g=.a⁨VOxSPyJTG}8o5`CP0KbVˮ siQ]hR:YN'Dդ/PD 1PC@9h.J<Xė`9EbS*P%KgRVӱ U6l[(Q3MXFܓ7͚zvsBVr>!juC(SVK]\ V[1ępAɵ0dL5O]ȩQТߍk2|P5wvӣ~J֟7Ⴈ_C;:=BNk/~ K73@]=So/:&'6W'nVGN&nVYm S7+E5%/>^of7"7.)'9WT_kkh2WS[(z|gAko,T}evI^W˾-je=YDzf'Ǯmsgj9B[C}c~ˢ{-KuC;SIhd/EҲ䯀RԧD*P_ Z[W;Eȷ,QSXJKu ŨeY4$ɣ~qM*\J07zR ʡMΔzghCm`1BxgZtG('O endstream endobj 13 0 obj 2596 endobj 14 0 obj 840 endobj 15 0 obj 317 endobj 16 0 obj 12848 endobj 17 0 obj << /Length 18 0 R /Filter /FlateDecode >> stream xV]o6}ׯ00RH{نm#`QTJc+Ʀ=!6 W~Kwf#BHka3=pqRGj85IA)X68;w+JC[Q}oF k'N˥CzHH%~I (\BRaYV!Y$']7 -tR&M(}B~ŸKZ7ͣR쥁YE?Z<ԭU6z3Ž=Θ(Nڇ_ϼrM]?8}/F'eHy=?Y0+\7mV6ey|nM̈ě/})E0lq臮Px.ZFKxIv V/N9xq:w$\##f=Yh7M/Xb8Ga?svx]^3K?;^* endstream endobj 8 0 obj << /Resources 3 0 R /Type /Page /MediaBox [0 0 595.275 841.889] /CropBox [0 0 595.275 841.889] /BleedBox [0 0 595.275 841.889] /TrimBox [0 0 595.275 841.889] /Parent 1 0 R /Contents 17 0 R >> endobj 18 0 obj 816 endobj 20 0 obj << /Name /Im2 /Type /XObject /Length 21 0 R /Filter /FlateDecode /Subtype /Image /Width 290 /Height 44 /BitsPerComponent 8 /ColorSpace [/ICCBased 10 0 R] >> stream xYMk6~O%M,CJa[veR(mO&Ҝ̞KS ܛ/ \KzekޝdwKlG~z*E1dQ>+Q>Q>| ^8Oyݼ9Ob|O-Ȓ : Kt<)K{O ^V[6+ x% XvPRy,%aQ0c.gbx!ל'ǡ5mm}7/ .2[O@bi 1pEDE1p *Ġ|[r[&rM P_o,BrX*5OI8sʣT1(VfYοg%X:^n5[ H?W$/NP 5BjKֆB9ߒBuy\i8 5Zod#tbz4WW@"y1@!V q}[/[!4.<%ݾ8f07˙a l3ܾgmLɊ.Vz{]@=sn3ڈ n_Oy[_Nfz0 ˠzqfY=K/˴^t sVH^: }y!j+Ĉ: yp%z.uN!d_(943kՅk TS+.uN!&rn1->OͦY?I:ƙw;s᠎n9䣻=X[M=vQ|H/p˫~8cjmchX@Ȅ+G<,Sbsr/ZeKvsTGa)ףP`#Kt2u\8Y=5J ddJm?.0'aA an#q/t6`X=I 'WGpT[Oρ~gpT*?Ѫ endstream endobj 21 0 obj 1232 endobj 22 0 obj << /Name /Im3 /Type /XObject /Length 24 0 R /Filter /FlateDecode /Subtype /Image /Width 48 /Height 48 /BitsPerComponent 8 /ColorSpace /DeviceGray >> stream x1 P8 t~5k;PTƏxѣ>~I>< endstream endobj 23 0 obj << /Name /Im4 /Type /XObject /Length 25 0 R /Filter /FlateDecode /Subtype /Image /Width 48 /Height 48 /BitsPerComponent 8 /ColorSpace [/ICCBased 5 0 R] /SMask 22 0 R >> stream x{PSWZݪժUq}2l;Ӈmei-ڑj]A"KAy( *C3 ^&$! IMnnm_ˆvfvw=gw~瞜{'?-Wܹt_S7\_Ro|ҍ G6<ش@bb~y5}VT/,R[@׷nM2eʔSΚ5KձWt?l[f6j[n}iӦ=fϞ ݂`Μ9Ýv[^}s9MÇ.z…0n:8=.}|Rw{IumřPo_v#3&SEOk$'S"RRM_c96Lk󼼼`=ygZ'n_ી${N='x3{#lh!q2TMdFA]b_ܹsmZVϋYss͙ ~gՒ܍Z^\yW]I!aI єISL `8'ZƠ%>>>wgѢE}-:)'d1c:0.C0}Р-ekBTHpL&)*RL2c`9 l'gٲe$dg=]茸6,yzOMUQ~EY,eמ\YN⎓NZjVW\<$J ?S", UWyy)qi6W^1φko;$Kٴ/?Vv8(rPXI$‹ 9QU%I8i W )\@D4T Ixlj(O =ldt>Ox<`hkrßeE"#\ < a!;&xΥ|yCiWeq'xYűs :æ5j9? 28tˇO((=e>< '\QqK+QH\ri\cxf;o>N ;VDum~Ю;ȁŞw䐸h@cF!I\+S&bΛ7ao¼ gOmv(8II I.?wLrr|鸏w%wmvOU%*\%J7?L?|{/>|N:p]`A@@@^^^MM B  9s&"׭0TÇT*Uw> endobj 27 0 obj << /Type /Annot /Subtype /Link /Rect [ 275.304 156.535 385.944 167.335 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 26 0 R /H /I >> endobj 29 0 obj << /Type /Annot /Subtype /Link /Rect [ 392.94 156.535 491.268 167.335 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 26 0 R /H /I >> endobj 30 0 obj << /Length 31 0 R /Filter /FlateDecode >> stream xX[F~ϯ8*/<3PzA[ ڭZq&l߱lQZEswDR?a:J7w{I!u"+ @4" iC'si~?'$7o!7@ah>y}_'/ǀg?$/S?%' P7/*Kl]-<,`#ax_](~_-wx#k\.޴Q.w~pF_scPR:;G2}b뷊b1m/F$H%-4m?~L6۵'%"}$˳|I/U)/ΊM@V+OJuQ~U;#Qm&k$n+@kpB9 !s-/BalЛҩd_H?};]ؙNBb+%P4U d6> IυLK?-媦oɓz!}!e4Ɠ~fģ fIU ǽRE]01CxQ&F?(e0v&mq$M #|>""l36~(Th 9*yWNδrELD-}MIN,ebWY'=1{y|+`l"3|Eٸx8,tbqAT}C{H$(5`z?}*7q-uV.h'u\S< wZBm2iOs;N8x;s0 픰m$PSR4@] uwHTx2rEcK?ٞ*_7^fUWλF&IDipOMOܱ> endobj 31 0 obj 1821 endobj 33 0 obj << /URI (http://lilypond.org/web/) /S /URI >> endobj 34 0 obj << /Type /Annot /Subtype /Link /Rect [ 78.0 689.03 122.676 699.83 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 33 0 R /H /I >> endobj 36 0 obj << /Type /Annot /Subtype /Link /Rect [ 129.672 689.03 244.02 699.83 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 33 0 R /H /I >> endobj 37 0 obj << /URI (http://www.imagemagick.org) /S /URI >> endobj 38 0 obj << /Type /Annot /Subtype /Link /Rect [ 78.0 662.63 144.648 673.43 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 37 0 R /H /I >> endobj 39 0 obj << /Type /Annot /Subtype /Link /Rect [ 151.644 662.63 292.968 673.43 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 37 0 R /H /I >> endobj 40 0 obj << /Length 41 0 R /Filter /FlateDecode >> stream xVn0+P!4I[R$@h$Ybl"z8'ߥ=hz8;]6`@u/J0n}R@ ["KJC`D 8Ґ3{  +C (| .%v}&@G38oHa|\/_ 1GhuD)\;k;S0z$t'ɰ;{FA*6ϦU8N8%9'iYe(+o^~D2i6{!Y]ԉ3jsvGF&`uvpOU&uoFM`[WO>l endstream endobj 35 0 obj [ 34 0 R 36 0 R 38 0 R 39 0 R ] endobj 32 0 obj << /Resources 3 0 R /Type /Page /MediaBox [0 0 595.275 841.889] /CropBox [0 0 595.275 841.889] /BleedBox [0 0 595.275 841.889] /TrimBox [0 0 595.275 841.889] /Parent 1 0 R /Annots 35 0 R /Contents 40 0 R >> endobj 41 0 obj 874 endobj 43 0 obj << /Type /Action /S /GoTo /D [19 0 R /XYZ 54.0 412.179 null] >> endobj 44 0 obj << /Type /Annot /Subtype /Link /Rect [ 66.0 628.694 156.782 639.494 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 43 0 R /H /I >> endobj 46 0 obj << /Type /Annot /Subtype /Link /Rect [ 553.019 628.694 559.019 639.494 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 43 0 R /H /I >> endobj 47 0 obj << /Type /Action /S /GoTo /D [19 0 R /XYZ 54.0 140.335 null] >> endobj 48 0 obj << /Type /Annot /Subtype /Link /Rect [ 66.0 614.294 134.565 625.094 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 47 0 R /H /I >> endobj 49 0 obj << /Type /Annot /Subtype /Link /Rect [ 553.188 614.294 559.188 625.094 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 47 0 R /H /I >> endobj 50 0 obj << /Type /Action /S /GoTo /D [32 0 R /XYZ 54.0 769.889 null] >> endobj 51 0 obj << /Type /Annot /Subtype /Link /Rect [ 66.0 599.894 133.225 610.694 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 50 0 R /H /I >> endobj 52 0 obj << /Type /Annot /Subtype /Link /Rect [ 553.187 599.894 559.187 610.694 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 50 0 R /H /I >> endobj 53 0 obj << /URI (http://lilypond.org/) /S /URI >> endobj 54 0 obj << /Type /Annot /Subtype /Link /Rect [ 449.976 571.094 494.652 581.894 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 53 0 R /H /I >> endobj 55 0 obj << /Type /Annot /Subtype /Link /Rect [ 501.648 571.094 530.328 581.894 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 53 0 R /H /I >> endobj 56 0 obj << /Type /Annot /Subtype /Link /Rect [ 66.0 556.694 128.34 567.494 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 53 0 R /H /I >> endobj 57 0 obj << /URI (http://abcnotation.org.uk/) /S /URI >> endobj 58 0 obj << /Type /Annot /Subtype /Link /Rect [ 148.332 556.694 173.004 567.494 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 57 0 R /H /I >> endobj 59 0 obj << /Type /Annot /Subtype /Link /Rect [ 180.0 556.694 302.004 567.494 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] /A 57 0 R /H /I >> endobj 60 0 obj << /Length 61 0 R /Filter /FlateDecode >> stream xsG>' ʦ®rBx*ƱdF~?=Bf9cgKוfqxݙ(&Kt⣵8|4ksR47娶6̬iM28_|g/PPp!|{|y 5vʾuW{!۳7fgŋ:&o.}9sY8ۉ&kWs6of?^NofΗox^.>uWBm6j1CuS¼W4<\y!Yn+tfkQ,?~ؘq49ĶlDR#(]tr +Sɣŧe\]֝vEe;/q\3_'xA}n f\n~KZX͝yZh}KK_z?Υ4Ll縇sTWtmwZ^'VXrYydʅ3UaT SL52TSML51T3SL53T S-LU2UE"UoH} zTC#UL50TS LU0UaFjb&jffZja*SULUjH5X,R TC#jH5xj` S*L52T#SL51TSL53T S-L0T*SU*E²%aْlIX$,[- ˖eK²%aْlIX$,[- ˖eK²%aْlIX$,[- ˖eK²%aْlIX$,[.*G;UPDphUU5hܯq>f{ҸS֋Lӆ.{ɉQO@u=o#U'T *'m:DG#S'm%jIpAG;fvV:' Zj󎎻9il"52tFtj%QuDՅT;Xʝe׃i#v_)L50T S*L52T#SML51T3SL53T S-L0UeTzP9RmrAHC=Rmrj`*LU0T#SL51TSML53T3S-L0T*SUH׃ʑj;AH׃ʑj3TS LU0UaFjd&jffZ*˕ K˖eK²%aْlIX$,[- ˖eK²%aْlIX$,[- ˖eK²%aْlIX$,[- ˖eK²%aْlIX$,[-.jUG/.Y&YmǴYU]^/E}X~;o5 otWwn 23^G37|E]I1iNW&6s밹xI[[lhe^.Iζ_wP::n}ڠ~jL|sZ]juT-q S6?tNU[N8/;Lb3j{~DZ|uk;mq0q^jg㺎 4/'<n4Wn܌rJ&Fx[9_߬v>~z~AݵFYnT[ 5?O~` .YN]^ft3 [0usf1ԝ2w:iuՃ9s6No{g>Z|[uI7՞>m;ݸ> endobj 61 0 obj 2301 endobj 62 0 obj << /Type /Action /S /GoTo /D [42 0 R /XYZ 54.0 769.889 null] >> endobj 64 0 obj << /Title (Music Filter) /Parent 63 0 R /Next 66 0 R /A 62 0 R >> endobj 65 0 obj << /Type /Action /S /GoTo /D [42 0 R /XYZ 54.0 705.23 null] >> endobj 66 0 obj << /Title (Table of Contents) /Parent 63 0 R /Prev 64 0 R /Next 67 0 R /A 65 0 R >> endobj 67 0 obj << /Title /Parent 63 0 R /Prev 66 0 R /Next 68 0 R /A 43 0 R >> endobj 68 0 obj << /Title /Parent 63 0 R /Prev 67 0 R /Next 69 0 R /A 47 0 R >> endobj 69 0 obj << /Title /Parent 63 0 R /Prev 68 0 R /A 50 0 R >> endobj 70 0 obj << /Type /Font /Subtype /Type1 /BaseFont /Helvetica /Encoding /WinAnsiEncoding >> endobj 71 0 obj << /Type /Font /Subtype /Type1 /BaseFont /Times-Roman /Encoding /WinAnsiEncoding >> endobj 72 0 obj << /Type /Font /Subtype /Type1 /BaseFont /Helvetica-Bold /Encoding /WinAnsiEncoding >> endobj 73 0 obj << /Type /Font /Subtype /Type1 /BaseFont /Courier /Encoding /WinAnsiEncoding >> endobj 74 0 obj << /Type /Font /Subtype /Type1 /BaseFont /Times-Italic /Encoding /WinAnsiEncoding >> endobj 75 0 obj << /Type /Font /Subtype /Type1 /BaseFont /Times-Bold /Encoding /WinAnsiEncoding >> endobj 76 0 obj << /Limits [(_installation) (_installation)] /Names [(_installation) 50 0 R] >> endobj 77 0 obj << /Limits [(_limitations) (_limitations)] /Names [(_limitations) 47 0 R] >> endobj 78 0 obj << /Limits [(_using_the_filter) (_using_the_filter)] /Names [(_using_the_filter) 43 0 R] >> endobj 79 0 obj << /Limits [(idp5133008) (idp5133008)] /Names [(idp5133008) 62 0 R] >> endobj 80 0 obj << /Limits [(_installation) (idp5133008)] /Kids [76 0 R 77 0 R 78 0 R 79 0 R] >> endobj 81 0 obj << /Dests 80 0 R >> endobj 1 0 obj << /Type /Pages /Count 4 /Kids [42 0 R 8 0 R 19 0 R 32 0 R ] >> endobj 2 0 obj << /Type /Catalog /Pages 1 0 R /Metadata 7 0 R /Lang (en) /PageLabels 9 0 R /Outlines 63 0 R /PageMode /UseOutlines /Names 81 0 R >> endobj 3 0 obj << /Font << /F1 70 0 R /F5 71 0 R /F3 72 0 R /F9 73 0 R /F6 74 0 R /F7 75 0 R >> /ProcSet [ /PDF /ImageB /ImageC /Text ] /XObject << /Im1 12 0 R /Im3 22 0 R /Im4 23 0 R /Im2 20 0 R >> /ColorSpace << /DefaultRGB 6 0 R /ICC10 11 0 R >> >> endobj 9 0 obj << /Nums [0 << /P (1) >> 1 << /P (2) >> 2 << /P (3) >> 3 << /P (4) >> ] >> endobj 63 0 obj << /First 64 0 R /Last 69 0 R >> endobj xref 0 82 0000000000 65535 f 0000034149 00000 n 0000034228 00000 n 0000034393 00000 n 0000000015 00000 n 0000000184 00000 n 0000002866 00000 n 0000002899 00000 n 0000018326 00000 n 0000034669 00000 n 0000003829 00000 n 0000004258 00000 n 0000004293 00000 n 0000017351 00000 n 0000017372 00000 n 0000017392 00000 n 0000017412 00000 n 0000017434 00000 n 0000018550 00000 n 0000025358 00000 n 0000018570 00000 n 0000020011 00000 n 0000020032 00000 n 0000020298 00000 n 0000023052 00000 n 0000023071 00000 n 0000023092 00000 n 0000023148 00000 n 0000025324 00000 n 0000023288 00000 n 0000023427 00000 n 0000025600 00000 n 0000027290 00000 n 0000025621 00000 n 0000025683 00000 n 0000027242 00000 n 0000025818 00000 n 0000025955 00000 n 0000026019 00000 n 0000026154 00000 n 0000026292 00000 n 0000027532 00000 n 0000031913 00000 n 0000027552 00000 n 0000027632 00000 n 0000031816 00000 n 0000027769 00000 n 0000027909 00000 n 0000027989 00000 n 0000028126 00000 n 0000028266 00000 n 0000028346 00000 n 0000028483 00000 n 0000028623 00000 n 0000028681 00000 n 0000028821 00000 n 0000028961 00000 n 0000029097 00000 n 0000029161 00000 n 0000029301 00000 n 0000029439 00000 n 0000032155 00000 n 0000032176 00000 n 0000034763 00000 n 0000032256 00000 n 0000032341 00000 n 0000032420 00000 n 0000032524 00000 n 0000032691 00000 n 0000032838 00000 n 0000032975 00000 n 0000033082 00000 n 0000033191 00000 n 0000033303 00000 n 0000033408 00000 n 0000033518 00000 n 0000033626 00000 n 0000033723 00000 n 0000033817 00000 n 0000033926 00000 n 0000034014 00000 n 0000034112 00000 n trailer << /Size 82 /Root 2 0 R /Info 4 0 R /ID [ ] >> startxref 34813 %%EOF asciidoc-8.6.9/doc/source-highlight-filter.pdf0000664000175100017510000037110212236331052021455 0ustar srackhamsrackham%PDF-1.4 % 1 0 obj << /S /GoTo /D (section.1) >> endobj 4 0 obj (DocBook Outputs) endobj 5 0 obj << /S /GoTo /D (section.2) >> endobj 8 0 obj (HTML Outputs) endobj 9 0 obj << /S /GoTo /D (subsection.2.1) >> endobj 12 0 obj (GNU Source Highlight) endobj 13 0 obj << /S /GoTo /D (subsection.2.2) >> endobj 16 0 obj (Highlight) endobj 17 0 obj << /S /GoTo /D (subsection.2.3) >> endobj 20 0 obj (Pygments) endobj 21 0 obj << /S /GoTo /D (section.3) >> endobj 24 0 obj (Block attributes) endobj 25 0 obj << /S /GoTo /D (section.4) >> endobj 28 0 obj (Testing) endobj 29 0 obj << /S /GoTo /D (section.5) >> endobj 32 0 obj (Examples) endobj 33 0 obj << /S /GoTo /D (subsection.5.1) >> endobj 36 0 obj (Source code paragraphs) endobj 37 0 obj << /S /GoTo /D (subsection.5.2) >> endobj 40 0 obj (Unnumbered source code listing) endobj 41 0 obj << /S /GoTo /D (subsection.5.3) >> endobj 44 0 obj (Numbered source code listing with callouts) endobj 45 0 obj << /S /GoTo /D [46 0 R /FitH ] >> endobj 49 0 obj << /Length 250 /Filter /FlateDecode >> stream xڕMo0 @>nr۸M8Q*綠Nh;qgUnIBQKTb jf? /%znﭭt]5pwڀ рZ "r`X0cP+!`EebTvGP_ce„P[ظWGs%)pT (`,{F2^-hϞ) i P{ `f4eZt aEm endstream endobj 46 0 obj << /Type /Page /Contents 49 0 R /Resources 48 0 R /MediaBox [0 0 595.276 841.89] /Parent 55 0 R >> endobj 47 0 obj << /Type /XObject /Subtype /Image /Width 80 /Height 15 /BitsPerComponent 8 /ColorSpace [/Indexed /DeviceRGB 3 56 0 R] /Length 109 /Filter/FlateDecode /DecodeParms<> >> stream xRA GJ.˲0Tb(3mK|QzdHv:2vgςAdV9<9D9+04ⰿ8Dn8L; ;KqbG endstream endobj 56 0 obj << /Length 20 /Filter /FlateDecode >> stream xKKK'% endstream endobj 50 0 obj << /D [46 0 R /XYZ -16.307 900.716 null] >> endobj 53 0 obj << /D [46 0 R /XYZ 56.693 759.068 null] >> endobj 48 0 obj << /Font << /F50 51 0 R /F51 52 0 R /F52 54 0 R >> /XObject << /Im1 47 0 R >> /ProcSet [ /PDF /Text /ImageC /ImageI ] >> endobj 59 0 obj << /Length 497 /Filter /FlateDecode >> stream xŕn0 ~ C9(vM0ɺ %]j;e%ޠyTٛ3&AS}1 D `5iqd;ؼӇⶺP @5%ґ#"H7٬U-#] 2^@T2$A6wD]0؊f}p,!P#DI(B\2 :NhQdI $8*WBo&b=(' O*̀N!Q#</OQ;^tI)qAyUYҋ夆ܒ/ǧuK܉{ѮB~|Y97˶Jɱc%zmXv>@k=@^tMp,? tYjn Յ&xxһݶʺCv p endstream endobj 58 0 obj << /Type /Page /Contents 59 0 R /Resources 57 0 R /MediaBox [0 0 595.276 841.89] /Parent 55 0 R >> endobj 60 0 obj << /D [58 0 R /XYZ -11.232 900.716 null] >> endobj 57 0 obj << /Font << /F50 51 0 R /F51 52 0 R /F52 54 0 R >> /ProcSet [ /PDF /Text ] >> endobj 74 0 obj << /Length 551 /Filter /FlateDecode >> stream xKs0u8iGʓ)faHv<& `Kˇt BCoxN$&Z17Pb Y2Q5qgE>-ͧ'EdupA T|%( TAH)RZŢ(V#QS 2D!]!LogDn3 ʜp}V7 (#Rr_ Es?M6o] ֻ]_+x \NAH_U6mm/h01'p=0d+9ǛlAF)5T"Hל_ZMߪ`$0m[9_}RT~!BQ2b#O_a+mil$+@f&~l<.e5v!6M]\ l,, 4eS'wH'3-~}m۸OH4::>]lOw9&r'ܲ=:] H˲j],N>q˗@J?76 endstream endobj 73 0 obj << /Type /Page /Contents 74 0 R /Resources 72 0 R /MediaBox [0 0 595.276 841.89] /Parent 55 0 R /Annots [ 61 0 R 62 0 R 63 0 R 64 0 R 65 0 R 66 0 R 67 0 R 68 0 R 69 0 R 70 0 R 71 0 R ] >> endobj 61 0 obj << /Type /Annot /Subtype /Link /Border[0 0 0]/H/I/C[1 0 0] /Rect [55.697 704.453 148.747 715.332] /A << /S /GoTo /D (section.1) >> >> endobj 62 0 obj << /Type /Annot /Subtype /Link /Border[0 0 0]/H/I/C[1 0 0] /Rect [55.697 676.558 140.448 687.437] /A << /S /GoTo /D (section.2) >> >> endobj 63 0 obj << /Type /Annot /Subtype /Link /Border[0 0 0]/H/I/C[1 0 0] /Rect [70.641 658.49 187.97 669.394] /A << /S /GoTo /D (subsection.2.1) >> >> endobj 64 0 obj << /Type /Annot /Subtype /Link /Border[0 0 0]/H/I/C[1 0 0] /Rect [70.641 640.558 133.744 651.461] /A << /S /GoTo /D (subsection.2.2) >> >> endobj 65 0 obj << /Type /Annot /Subtype /Link /Border[0 0 0]/H/I/C[1 0 0] /Rect [70.641 622.625 134.849 633.529] /A << /S /GoTo /D (subsection.2.3) >> >> endobj 66 0 obj << /Type /Annot /Subtype /Link /Border[0 0 0]/H/I/C[1 0 0] /Rect [55.697 596.767 140.787 605.743] /A << /S /GoTo /D (section.3) >> >> endobj 67 0 obj << /Type /Annot /Subtype /Link /Border[0 0 0]/H/I/C[1 0 0] /Rect [55.697 566.968 103.268 577.848] /A << /S /GoTo /D (section.4) >> >> endobj 68 0 obj << /Type /Annot /Subtype /Link /Border[0 0 0]/H/I/C[1 0 0] /Rect [55.697 539.073 114.147 549.952] /A << /S /GoTo /D (section.5) >> >> endobj 69 0 obj << /Type /Annot /Subtype /Link /Border[0 0 0]/H/I/C[1 0 0] /Rect [70.641 521.006 190.71 531.91] /A << /S /GoTo /D (subsection.5.1) >> >> endobj 70 0 obj << /Type /Annot /Subtype /Link /Border[0 0 0]/H/I/C[1 0 0] /Rect [70.641 503.073 224.761 513.977] /A << /S /GoTo /D (subsection.5.2) >> >> endobj 71 0 obj << /Type /Annot /Subtype /Link /Border[0 0 0]/H/I/C[1 0 0] /Rect [70.641 485.14 268.487 496.044] /A << /S /GoTo /D (subsection.5.3) >> >> endobj 75 0 obj << /D [73 0 R /XYZ -16.307 900.716 null] >> endobj 72 0 obj << /Font << /F50 51 0 R /F51 52 0 R /F52 54 0 R /F58 76 0 R >> /ProcSet [ /PDF /Text ] >> endobj 82 0 obj << /Length 2154 /Filter /FlateDecode >> stream xYKoW4ͷ9d756vb naԒ#q"E= -Xbhonn+b4S9qИ#uaq_,_uߺ+6:(Y,Ȣ h1J%Lŭ{(v󇇛0F,Rh?6hʣlwW%$ы 2 =y44Qy]̽k%}Wԕ-ܯֽZN``x [xszJP C[ڥ꾱J.U~&Vwа'1X-xp{ODVR[ןI~w M#@sKMfE [ xnzv/?=S+SN$e^UREdtiL-] B K Lee˫߷ZFhZ^3g%2~WeMB`yE׏eg׹M[H9m"ۗiS@췦4|/h,W`SEKeibSkֽj{P:?aڍ{xTtC`I#8${ ߆YfZ_@xl}X=Y<jXqcnB(lkg/WVQ~7'Z:j4~ta'/% q.?] q{ǼEG 8ɠq1/"ۺYZlFXرv Pz! ,@ j -@5Bȏcb,~te0@SFChH; ۾9KviYZƪZ%TQBx+' m:M6/KO! Tt,^[(]hh9 я1VpP-@73 r}hMfεpv&|pݩp[koIL Ab4\h"3x2fL"/1$"Svh¤9An'hQ#*>t!?p,tOGGgY V#W8PJh[%Y8A+yxR=xw+[W|^ʱy{A6Kӛ*?@ OuYK/m#Znj lʿnguA<TkX9^fźwm8ȱJzVVWX9+'v0Z{3 ZMCjqu3K9 HmsK3ϯ홄%F.xةb37ɞ&d?D21Q,Ik4I uk=x5bzv}f箝¹*xr.HгlKS3t';d-#2K'˦|VP#"kkn J9FMyz YT, ELQhqj'%0ad}Y g{ɫI;/E*syr%2 H˛}(vuӹ{}vO/E`kw>Ah27L)k]EYq) ^#aX<c2]yB_hJWlS?br endstream endobj 81 0 obj << /Type /Page /Contents 82 0 R /Resources 80 0 R /MediaBox [0 0 595.276 841.89] /Parent 55 0 R /Annots [ 77 0 R 78 0 R 79 0 R ] >> endobj 77 0 obj << /Type /Annot /Border[0 0 0]/H/I/C[0 1 1] /Rect [175.847 431.653 267.632 442.557] /Subtype/Link/A<> >> endobj 78 0 obj << /Type /Annot /Border[0 0 0]/H/I/C[0 1 1] /Rect [109.659 365.995 149.848 376.899] /Subtype/Link/A<> >> endobj 79 0 obj << /Type /Annot /Border[0 0 0]/H/I/C[0 1 1] /Rect [73.679 221.32 114.974 232.224] /Subtype/Link/A<> >> endobj 83 0 obj << /D [81 0 R /XYZ -16.307 900.716 null] >> endobj 2 0 obj << /D [81 0 R /XYZ 56.693 732.741 null] >> endobj 85 0 obj << /D [81 0 R /XYZ 56.693 697.606 null] >> endobj 86 0 obj << /D [81 0 R /XYZ 56.693 656.421 null] >> endobj 87 0 obj << /D [81 0 R /XYZ 56.693 636.419 null] >> endobj 6 0 obj << /D [81 0 R /XYZ 56.693 607.202 null] >> endobj 88 0 obj << /D [81 0 R /XYZ 56.693 571.947 null] >> endobj 10 0 obj << /D [81 0 R /XYZ 56.693 475.374 null] >> endobj 91 0 obj << /D [81 0 R /XYZ 56.693 446.693 null] >> endobj 14 0 obj << /D [81 0 R /XYZ 56.693 407.558 null] >> endobj 92 0 obj << /D [81 0 R /XYZ 56.693 381.035 null] >> endobj 18 0 obj << /D [81 0 R /XYZ 56.693 262.883 null] >> endobj 93 0 obj << /D [81 0 R /XYZ 56.693 236.359 null] >> endobj 80 0 obj << /Font << /F50 51 0 R /F51 52 0 R /F64 84 0 R /F52 54 0 R /F65 89 0 R /F66 90 0 R >> /ProcSet [ /PDF /Text ] >> endobj 96 0 obj << /Length 1818 /Filter /FlateDecode >> stream xZ[o6~кa!)Rm5튭V{HAe[,y[wxS;߆ D; ֋ѳcGK]k\\CXӅu3~y8)҅{1:0N_ dlBϹ+}rt׈X"w {>A.|3޽0b̍ Fq>ތ~anH-BO"EZ"GP.nl1?;-hPY4"̍ua˦ l,7]c-8N'dZXjl$ffE<-Ey!!3]QSI)-?7&\]@BM΋}Xb䁵ͬ Y9 "y8HV`Bx%:>rhft|P~qK7[p 5$Qǐ/;n3-8xgBu.z0%-bL(GЌo<*4 \-Xf w]A |p1Aq93]'Mʫ-ë@H[PF͢" ddE Eq4X[iV&ܲa*ZjE RX# K}q*"A*QTe2{ a4MSuUOtzJM6  vz +u=)ǡ(!Zi>ܧԑ$5{L`^N%05*z2<}7BO,0煪"zx*71b,e֬4(M CB{N{>?8b>իqYP  v$4S`tVJwxHQ/^^!{$\u5:vfF$hxc ޙGUgԚP/iޘTk/?tWlwEnr3 YZƭWeICf* 6=\3p~Uy 6Pm =,Mzѹ>JhM`tB8&lQxjrOWUn/3q2aD8̊>GXio"o9F̴_Ml $udWtTJU;lޖ2C\feC&뾾׿Y6$| ^,y77TYZ`>va "{aS{:`^j[TdӸ6W=\@P`j5 -7JHKм!&Nq8]"Jֲ~@mv7`)F 403q <\C }V'Qѝ&wb˟le$k|_l[k -Ags14:gwԈWl%TlA ~(~zԇ6oʓIf͒/Jr4iń5/w/g&@c xpd?R߻DC7Sfbitń5pę11T endstream endobj 95 0 obj << /Type /Page /Contents 96 0 R /Resources 94 0 R /MediaBox [0 0 595.276 841.89] /Parent 55 0 R >> endobj 97 0 obj << /D [95 0 R /XYZ -11.232 900.716 null] >> endobj 22 0 obj << /D [95 0 R /XYZ 56.693 759.068 null] >> endobj 98 0 obj << /D [95 0 R /XYZ 56.693 731.272 null] >> endobj 26 0 obj << /D [95 0 R /XYZ 56.693 393.801 null] >> endobj 99 0 obj << /D [95 0 R /XYZ 56.693 356.6 null] >> endobj 30 0 obj << /D [95 0 R /XYZ 56.693 287.31 null] >> endobj 100 0 obj << /D [95 0 R /XYZ 56.693 249.86 null] >> endobj 34 0 obj << /D [95 0 R /XYZ 56.693 249.86 null] >> endobj 101 0 obj << /D [95 0 R /XYZ 56.693 222.675 null] >> endobj 102 0 obj << /D [95 0 R /XYZ 56.693 201.13 null] >> endobj 103 0 obj << /D [95 0 R /XYZ 56.693 202.589 null] >> endobj 104 0 obj << /D [95 0 R /XYZ 56.693 191.63 null] >> endobj 105 0 obj << /D [95 0 R /XYZ 56.693 180.671 null] >> endobj 106 0 obj << /D [95 0 R /XYZ 56.693 169.712 null] >> endobj 107 0 obj << /D [95 0 R /XYZ 56.693 158.753 null] >> endobj 108 0 obj << /D [95 0 R /XYZ 56.693 147.795 null] >> endobj 109 0 obj << /D [95 0 R /XYZ 56.693 136.836 null] >> endobj 110 0 obj << /D [95 0 R /XYZ 56.693 125.877 null] >> endobj 111 0 obj << /D [95 0 R /XYZ 56.693 114.918 null] >> endobj 112 0 obj << /D [95 0 R /XYZ 56.693 103.959 null] >> endobj 113 0 obj << /D [95 0 R /XYZ 56.693 93 null] >> endobj 94 0 obj << /Font << /F50 51 0 R /F51 52 0 R /F52 54 0 R /F64 84 0 R /F58 76 0 R /F66 90 0 R >> /ProcSet [ /PDF /Text ] >> endobj 116 0 obj << /Length 2363 /Filter /FlateDecode >> stream x\oFע$wknm );|\i:oڙ4hٷWg_~hdy]F1'qiaDt5'Wb^\rE'\O?.//2-.\ , Pj@2dH'%zesPig]qƀ-H$HLy4?~C9it>gҨFㆡWi>K)uit D…UU$2J%Euń3qb4e6k ) 4o.VL 7'`+ZW㸱;eLxmLt}S:;dyX楽 QO ?{N~LlAWE6[o~dU"> 2RFVt@4#J06p?Z!U8I9s@4۬F™ɳ$8N &x%A`NW&pbNu7$'Y;75}8;k=(|5Et3u_`L!5&'lU,N[V!j| |6?J?ԏ-C:۷&=FקBͧ-5 lVCA*)Ҏevkט tx"tJ~ F' X(C6gM=\wm[/vSyT×n'7Jy 7jo!K4A%` HFx <\iqX.VyoU|@~i YvJbX)$4'.>RXfW???ߟ}Woriťۑe܃Tk]|ק pXKCVr'EDڬ>Rhf=@ҶYggynU̇J@ܯwQN4\Gˬ18_;<#k JI_.#DpM L4#SD4bM_}?ʹ+V!?v[_stUSgjE\9yufvyQIt5{vR.s? tmў&w]MHdlY`T8,&amHM?62 P\qi F*IX}B-:,JHM@#*ۺ;s'AT n>Sgl2 ٱ0]|`%؂4٠nakO4[8FO&4M5\GjIO@-;YhҋG`|`BJ[HSD3Qll .Dlg?jp{װlF-NhhlRXfS:3hGˬ[R}ʎ&A+2(!:sm׿M淵w((~2Uv73|>Y}0E_bã l+8\af#fUϾ6qd& .>R mt%,:HQ Y pEŤU{{߽OgszzUYG>1YE~X).MvFemR$1[<+oȆdU.t)dGˬ[9?&\L=7K}w\L=.{C'EN~SY23.>؃1 jF) 4>7XP_}wo/84|?Ub[Z~{';Ӕ, 3443¹-žt:[U]~ggK}tp=.<\Ьz_H@o[ٵǏ 6CC 5~-ǀ4+/Ǯo:Ħ > endobj 117 0 obj << /D [115 0 R /XYZ -16.307 900.716 null] >> endobj 118 0 obj << /D [115 0 R /XYZ 56.693 740.971 null] >> endobj 119 0 obj << /D [115 0 R /XYZ 56.693 742.431 null] >> endobj 120 0 obj << /D [115 0 R /XYZ 56.693 713.24 null] >> endobj 121 0 obj << /D [115 0 R /XYZ 56.693 715.532 null] >> endobj 122 0 obj << /D [115 0 R /XYZ 56.693 686.341 null] >> endobj 123 0 obj << /D [115 0 R /XYZ 56.693 688.633 null] >> endobj 124 0 obj << /D [115 0 R /XYZ 56.693 677.674 null] >> endobj 38 0 obj << /D [115 0 R /XYZ 56.693 640.523 null] >> endobj 125 0 obj << /D [115 0 R /XYZ 56.693 612.97 null] >> endobj 126 0 obj << /D [115 0 R /XYZ 56.693 591.087 null] >> endobj 127 0 obj << /D [115 0 R /XYZ 56.693 592.546 null] >> endobj 128 0 obj << /D [115 0 R /XYZ 56.693 581.588 null] >> endobj 129 0 obj << /D [115 0 R /XYZ 56.693 570.629 null] >> endobj 130 0 obj << /D [115 0 R /XYZ 56.693 559.67 null] >> endobj 131 0 obj << /D [115 0 R /XYZ 56.693 548.711 null] >> endobj 132 0 obj << /D [115 0 R /XYZ 56.693 537.752 null] >> endobj 133 0 obj << /D [115 0 R /XYZ 56.693 526.793 null] >> endobj 134 0 obj << /D [115 0 R /XYZ 56.693 515.834 null] >> endobj 135 0 obj << /D [115 0 R /XYZ 56.693 504.875 null] >> endobj 136 0 obj << /D [115 0 R /XYZ 56.693 493.916 null] >> endobj 137 0 obj << /D [115 0 R /XYZ 56.693 482.957 null] >> endobj 138 0 obj << /D [115 0 R /XYZ 56.693 471.999 null] >> endobj 139 0 obj << /D [115 0 R /XYZ 56.693 425.707 null] >> endobj 140 0 obj << /D [115 0 R /XYZ 56.693 427.167 null] >> endobj 141 0 obj << /D [115 0 R /XYZ 56.693 416.208 null] >> endobj 142 0 obj << /D [115 0 R /XYZ 56.693 405.249 null] >> endobj 143 0 obj << /D [115 0 R /XYZ 56.693 394.29 null] >> endobj 144 0 obj << /D [115 0 R /XYZ 56.693 383.331 null] >> endobj 145 0 obj << /D [115 0 R /XYZ 56.693 372.372 null] >> endobj 146 0 obj << /D [115 0 R /XYZ 56.693 361.413 null] >> endobj 147 0 obj << /D [115 0 R /XYZ 56.693 350.454 null] >> endobj 148 0 obj << /D [115 0 R /XYZ 56.693 339.495 null] >> endobj 42 0 obj << /D [115 0 R /XYZ 56.693 302.345 null] >> endobj 149 0 obj << /D [115 0 R /XYZ 56.693 274.792 null] >> endobj 150 0 obj << /D [115 0 R /XYZ 56.693 252.909 null] >> endobj 151 0 obj << /D [115 0 R /XYZ 56.693 254.368 null] >> endobj 152 0 obj << /D [115 0 R /XYZ 56.693 243.409 null] >> endobj 153 0 obj << /D [115 0 R /XYZ 56.693 232.45 null] >> endobj 154 0 obj << /D [115 0 R /XYZ 56.693 221.492 null] >> endobj 155 0 obj << /D [115 0 R /XYZ 56.693 210.533 null] >> endobj 156 0 obj << /D [115 0 R /XYZ 56.693 199.574 null] >> endobj 157 0 obj << /D [115 0 R /XYZ 56.693 188.615 null] >> endobj 158 0 obj << /D [115 0 R /XYZ 56.693 177.656 null] >> endobj 159 0 obj << /D [115 0 R /XYZ 56.693 166.697 null] >> endobj 160 0 obj << /D [115 0 R /XYZ 56.693 155.738 null] >> endobj 161 0 obj << /D [115 0 R /XYZ 56.693 144.779 null] >> endobj 162 0 obj << /D [115 0 R /XYZ 56.693 133.82 null] >> endobj 163 0 obj << /D [115 0 R /XYZ 56.693 122.861 null] >> endobj 164 0 obj << /D [115 0 R /XYZ 56.693 111.902 null] >> endobj 165 0 obj << /D [115 0 R /XYZ 56.693 100.944 null] >> endobj 166 0 obj << /D [115 0 R /XYZ 56.693 89.985 null] >> endobj 114 0 obj << /Font << /F50 51 0 R /F51 52 0 R /F66 90 0 R /F52 54 0 R >> /ProcSet [ /PDF /Text ] >> endobj 173 0 obj << /Length 2512 /Filter /FlateDecode >> stream x]]o}-bc#A`[],-JnWJ]F8g{yy'VR )2jmeYF{Cʔ+lcId9]>|=/(^uHpx7ay^Gښk6c=Tl /XVh}|@V6jH"Q46 %B)?᠝[my.1zziWҎwl=($ Gׁ{rAsF_G2MrKC|`Bwf ԁCzTߑ.qF}jlz{|LP;vrORq^ę8i*%T٨CS/PȞr$4_r56=3HuT&|$jj]R)){x+Qɉ2qbo0U:U y тX+gH#d]R-nΰ4*ErlR Rl/ ײ7wǢWa~?F]W9^$jҳIsi L&|>W19R̫ru6^C| Pc,*Ks1 2l@.FF$jl\ }Ko.f13t4p_ٺ'vxpljMhь#5R'rd^ہڇnQʕ |`7Av'T *IR(s #}NEr| lH2-KQ)Gkpn0'(?P{;(t NeԣS~]yߨGܴ%@߅]b ~?^fI{={nM!>PPc1 [(B?Ř xVgG֓O0N,rXW^`sE>,€0)^!+i]M]lfH8yZ".<2 }/xD'ŗyb;OCfЫwr6N(K9FWlj˭%rl] jlՔ@B*7\Upkhrt=嗖~r0kcR6Q@MMKJr$/B>Jjvr56=^G! S7F}jlzFTORb0+ AG1RėBJ|Pga8DMwqD4tpq l.0FɣF#ek"ܣmЙ8unwOHx}s $e@Fu_, eSSlR RVHz߃\C>&!MPl2 2H+ﲔ<3^<;(+-I)+ hj\WR C|ygH_a 7iɦ(-qm AqbbV+-t٤56.-' Y]fUظCrBV+-&٤56.-J־GeڳP@ &IH<"l>~hmiXӴft4M1vٗbߢb9v+C1B+x7>56c B}ѕ*S?ݽPgQM8 l7!b\1#Z0cD̓>dJEb50JkֵP^)͚mgG!esPcLA1<2\%!>{qR j4O"Ȩ#n2Ҷxs۹)k:G*L5DPNpV> endobj 168 0 obj << /Type /Annot /Subtype /Link /Border[0 0 0]/H/I/C[1 0 0] /Rect [55.697 140.09 64.918 149.311] /A << /S /GoTo /D (cocnt.1) >> >> endobj 170 0 obj << /Type /Annot /Subtype /Link /Border[0 0 0]/H/I/C[1 0 0] /Rect [55.697 120.164 64.918 129.385] /A << /S /GoTo /D (cocnt.2) >> >> endobj 174 0 obj << /D [172 0 R /XYZ -11.232 900.716 null] >> endobj 175 0 obj << /D [172 0 R /XYZ 56.693 760.065 null] >> endobj 176 0 obj << /D [172 0 R /XYZ 56.693 749.106 null] >> endobj 177 0 obj << /D [172 0 R /XYZ 56.693 738.147 null] >> endobj 178 0 obj << /D [172 0 R /XYZ 56.693 727.188 null] >> endobj 179 0 obj << /D [172 0 R /XYZ 56.693 716.229 null] >> endobj 180 0 obj << /D [172 0 R /XYZ 56.693 705.27 null] >> endobj 181 0 obj << /D [172 0 R /XYZ 56.693 694.311 null] >> endobj 182 0 obj << /D [172 0 R /XYZ 56.693 683.352 null] >> endobj 183 0 obj << /D [172 0 R /XYZ 56.693 672.393 null] >> endobj 184 0 obj << /D [172 0 R /XYZ 56.693 661.435 null] >> endobj 185 0 obj << /D [172 0 R /XYZ 56.693 650.476 null] >> endobj 186 0 obj << /D [172 0 R /XYZ 56.693 639.517 null] >> endobj 187 0 obj << /D [172 0 R /XYZ 56.693 628.558 null] >> endobj 188 0 obj << /D [172 0 R /XYZ 56.693 617.599 null] >> endobj 189 0 obj << /D [172 0 R /XYZ 56.693 606.64 null] >> endobj 190 0 obj << /D [172 0 R /XYZ 56.693 595.681 null] >> endobj 191 0 obj << /D [172 0 R /XYZ 56.693 584.722 null] >> endobj 192 0 obj << /D [172 0 R /XYZ 56.693 573.763 null] >> endobj 193 0 obj << /D [172 0 R /XYZ 56.693 562.804 null] >> endobj 194 0 obj << /D [172 0 R /XYZ 56.693 551.845 null] >> endobj 195 0 obj << /D [172 0 R /XYZ 56.693 505.554 null] >> endobj 196 0 obj << /D [172 0 R /XYZ 56.693 507.014 null] >> endobj 197 0 obj << /D [172 0 R /XYZ 56.693 496.055 null] >> endobj 198 0 obj << /D [172 0 R /XYZ 56.693 485.096 null] >> endobj 199 0 obj << /D [172 0 R /XYZ 56.693 474.137 null] >> endobj 200 0 obj << /D [172 0 R /XYZ 56.693 463.178 null] >> endobj 201 0 obj << /D [172 0 R /XYZ 56.693 452.219 null] >> endobj 202 0 obj << /D [172 0 R /XYZ 56.693 441.26 null] >> endobj 203 0 obj << /D [172 0 R /XYZ 56.693 430.301 null] >> endobj 204 0 obj << /D [172 0 R /XYZ 56.693 419.342 null] >> endobj 205 0 obj << /D [172 0 R /XYZ 56.693 408.383 null] >> endobj 206 0 obj << /D [172 0 R /XYZ 56.693 397.425 null] >> endobj 207 0 obj << /D [172 0 R /XYZ 56.693 386.466 null] >> endobj 208 0 obj << /D [172 0 R /XYZ 56.693 375.507 null] >> endobj 209 0 obj << /D [172 0 R /XYZ 56.693 364.548 null] >> endobj 210 0 obj << /D [172 0 R /XYZ 56.693 353.589 null] >> endobj 211 0 obj << /D [172 0 R /XYZ 56.693 342.63 null] >> endobj 212 0 obj << /D [172 0 R /XYZ 56.693 331.671 null] >> endobj 213 0 obj << /D [172 0 R /XYZ 56.693 320.712 null] >> endobj 214 0 obj << /D [172 0 R /XYZ 56.693 309.753 null] >> endobj 215 0 obj << /D [172 0 R /XYZ 336.447 309.753 null] >> endobj 217 0 obj << /D [172 0 R /XYZ 56.693 298.794 null] >> endobj 218 0 obj << /D [172 0 R /XYZ 56.693 287.836 null] >> endobj 219 0 obj << /D [172 0 R /XYZ 56.693 276.877 null] >> endobj 220 0 obj << /D [172 0 R /XYZ 56.693 265.918 null] >> endobj 221 0 obj << /D [172 0 R /XYZ 56.693 254.959 null] >> endobj 222 0 obj << /D [172 0 R /XYZ 56.693 244 null] >> endobj 223 0 obj << /D [172 0 R /XYZ 56.693 233.041 null] >> endobj 224 0 obj << /D [172 0 R /XYZ 336.447 233.041 null] >> endobj 225 0 obj << /D [172 0 R /XYZ 56.693 222.082 null] >> endobj 226 0 obj << /D [172 0 R /XYZ 56.693 211.123 null] >> endobj 227 0 obj << /D [172 0 R /XYZ 56.693 200.164 null] >> endobj 228 0 obj << /D [172 0 R /XYZ 56.693 189.205 null] >> endobj 171 0 obj << /Font << /F50 51 0 R /F51 52 0 R /F66 90 0 R /F4 216 0 R /F52 54 0 R >> /ProcSet [ /PDF /Text ] >> endobj 232 0 obj << /Length 600 /Filter /FlateDecode >> stream xڕTMs0+t+ ql;I:@@pAߕWvǁjY{VZFvOɇuru)i&-тVPYJn&汶J(~h}nw>ۛvַ sMNVR)LPa+\T8\ Zp4Հ_j&H'FwKKC~#{8Bj;r|MX,oo,hrR(C._c, 'N]rk]c} +}(}/: 'R: O>oD:aWkuJQ 8{Un7W;Fgd ھVޏي}KgqՄƣ.B[dbԺ+. dUfFڎC֋kV],H9` 34{痢Pi$AEȁ0r؈O2)_8rxNS_&/[M endstream endobj 231 0 obj << /Type /Page /Contents 232 0 R /Resources 230 0 R /MediaBox [0 0 595.276 841.89] /Parent 229 0 R >> endobj 233 0 obj << /D [231 0 R /XYZ -16.307 900.716 null] >> endobj 230 0 obj << /Font << /F50 51 0 R /F51 52 0 R /F52 54 0 R /F65 89 0 R >> /ProcSet [ /PDF /Text ] >> endobj 234 0 obj [700] endobj 236 0 obj [600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600 600] endobj 237 0 obj [333 278 278 556 556 556 556 556 556 556 556 556 556 278 278 584 584 584 556 1015 667 667 722 722 667 611 778 722 278 500 667 556 833 722 778 667 778 722 667 611 722 667 944 667 667 611 278 278 278 469 556 222 556 556 500 556 556 278 556 556 222 222 500 222 833 556 556 556 556 333 500 278 556 500 722 500 500] endobj 238 0 obj [333 250 278 500 500 500 500 500 500 500 500 500 500 333 333 675 675 675 500 920 611 611 667 722 611 611 722 722 333 444 667 556 833 667 722 611 722 611 500 556 722 611 833 611 556 556 389 278 389 422 500 333 500 500 444 500 444 278 500 500 278 278 444 278 722 500 500 500 500 389 389 278 500 444 667 444 444 389] endobj 239 0 obj [500 500 500 500 500 500 500 500 500 333 333 570 570 570 500 930 722 667 722 722 667 611 778 778 389 500 778 667 944 722 778 611 778 722 556 667 722 722 1000 722 722 667 333 278 333 581 500 333 500 556 444 556 444 333 500 556 278 333 556 278 833 556 500 556 556 444 389 333 556 500 722 500 500] endobj 240 0 obj [278 278 556 556 556 556 556 556 556 556 556 556 333 333 584 584 584 611 975 722 722 722 722 667 611 778 722 278 556 722 611 833 722 778 667 778 722 667 611 722 667 944 667 667 611 333 278 333 584 556 278 556 611 556 611 556 333 611 611 278 278 556 278 889 611 611 611 611 389 556 333 611 556 778 556 556] endobj 241 0 obj [500 500 167 333 556 222 333 333 0 333 584 0 611 500 333 278 0 0 0 0 0 0 0 0 0 0 0 0 333 191 278 278 355 556 556 889 667 222 333 333 389 584 278 333 278 278 556 556 556 556 556 556 556 556 556 556 278 278 584 584 584 556 1015 667 667 722 722 667 611 778 722 278 500 667 556 833 722 778 667 778 722 667 611 722 667 944 667 667 611 278 278 278 469 556 222 556 556 500 556 556 278 556 556 222 222 500 222 833 556 556 556 556 333 500 278 556 500 722 500 500 500 334 260 334 584 0 0 0 222 556 333 1000 556 556 333 1000 667 333 1000 0 0 0 0 0 0 333 333 350 556 1000] endobj 242 0 obj [556 556 167 333 611 278 333 333 0 333 564 0 611 444 333 278 0 0 0 0 0 0 0 0 0 0 0 0 333 180 250 333 408 500 500 833 778 333 333 333 500 564 250 333 250 278 500 500 500 500 500 500 500 500 500 500 278 278 564 564 564 444 921 722 667 667 722 611 556 722 722 333 389 722 611 889 722 722 556 722 667 556 611 722 722 944 722 722 611 333 278 333 469 500 333 444 500 444 500 444 333 500 500 278 278 500 278 778 500 500 500 500 333 389 278 500 500 722 500 500 444 480 200 480 541 0 0 0 333 500 444 1000 500 500 333 1000 556 333 889 0 0 0 0 0 0 444 444 350] endobj 243 0 obj << /Length1 1360 /Length2 1006 /Length3 0 /Length 1841 /Filter /FlateDecode >> stream xڍSiTWmpQP nHfDPzMtWH"aDe :jd dY< A'.PD1nř9}z}~.MT HƓEAT$>$*"%`p^i5AH!4D ˕R$(|^H@j H "B 4)g'pÔDJHJ)ȡ=C p 3ʟt\TRt&w#9jHk!A4s('ӱJPP$l! IQAr5M3|.LAQ *4d& b¢(BM%hK0a8"g$1P1jPeeNxTBQs4xsER:2g #H\fkT?. gh,ę2! ]19xLAMAf(b`.!'Gj!`h ͙X'0dLUga(޳@zs75"9yS6̩SzW/d̒l#^4Ƣ%U2 LkaBvfLflM ۜ!co6)yXKi m?TI( 3$4&L-8Q0(km"#%L>=I&6YJbn@PF /YPoTæ2<Ը0gAiLCӬLoȞbo-zqz),`'͓5:ϱBQnkwG5?wNײj)h[kW!sȶ{n3-Rq4x~]I[okCn=E]1Ng}|vHj}KUj#zOsUf:Hr7kk@g}81+A2/PR^@I[NCgZ-hǷ:?L"iX_v7ſQYX\|ot41?-ybOmS 3Hw= qZޮ:1q5ݲ_{ ݩ{vb 牖K6}dm֊d㷼υ+27[9 (T֜\wzjE;_6:n<6x =jjZYÕd>_OϫyjhSNY[# \+b솺[^>}(a_D߭/-~KqWo_~_纎WIuD[ WPy=K߹Rt(/O21;cǼ%?fCKU z**p}qcX$ Y$=sq.v:H+Êeb!aОhyJFݶº&oW&+-MKl?kynZ>ZzOZmP44rԺZ ##,]Htl8Wj S% fo3o Ke_ß endstream endobj 244 0 obj << /Type /FontDescriptor /FontName /TPKZYA+LCIRCLE10 /Flags 4 /FontBBox [-2000 -2000 2040 2040] /Ascent 0 /CapHeight 0 /Descent 0 /ItalicAngle 0 /StemV 40 /XHeight 0 /CharSet (/a118) /FontFile 243 0 R >> endobj 245 0 obj << /Length1 1612 /Length2 15388 /Length3 0 /Length 16223 /Filter /FlateDecode >> stream xڭePeݲ% ;lpw7q wwwww+W9};"9rd3V,rbe:![#=#7@dm(kk#C4s58 @6N@n: 403"v 3s': Y Oߝ 3/.@+[;k_@ 0Y" rJq9U8`hPp6d@@G `OiG;161-` rt9 m1r6_9 `hsͪ *oNNvulMF;Sҿ|az A6'?@1//__u _QheJ7f xEo f/ C[+w AoJ}"7H"OC<'{d1VpCkaMGo3l Ho#Q 4Q9L v_vUW5@>s?g hc/ ʒ4y+JN*vRdmM aa[7'H`_0L5tr_+aclkϬ(;ژemWtï.Zf9b Mj0A ٕԫVvpU7Lq/ٽHQ`YQt'yRm~o9g+AJ;W^نbgT;ܝPT+~&jgq~%u {C6Nف{#`-T>Mv 9!wqz]JĖH'kAFOHP& YE2,Ѣ<_%FI\9Nsm&la4[[MHR8^!`m1s[UOx X/\}ݽ:1xtBqgwv,Cto42p?}9tL@eFV*2X4*xĊV\Dy?Wps\h7*PY={O;ih{,q%AQ [3a'P_H ^fS8E!)ނtaj!i$%I86V̫I.ڇbƫ]Mwץ8OjFQ~Bn}p0ߖn>$'̟=_7\o,_|h42ںHFd^OOl#y,oC'#P;[!_iū&Bc Lvo?(UuQGٳ AZh JS\xT>!#emcdNw;$w+#i%V*86>zkݶuLWB[<_ނV*!i|F? 7ڰcAh'MtbwRS#)VL\>lzJ~+9G| r Z _FYv ke;s-rhe4u J {sfoe1mLtOʑb{fbpnZWbY*VJNg4!,/Chy\kVzVENdI"$v6}[J 9x.kJId"VHoܣ /V5z¡[aS.janVأR-fh0R}maVIZOr)'1lppqu5k;Ϣ{c`Rt  _qJ #/gg15TՙR5, }_I"ԯM&8`DymIAnlv&oáᖨgizZA+oJkcu%혺aIl>dz2BRd qL:;~6I&1. atdNMDā; ~ XV-YNfrȅ+X |&>($<'D胻3iTyb0yE޳ "xLU<^e1{hκQ I8~Z+"1 .I_'%9F>"ykkvz=Ey}IN6IP,UJ1Xg%ms|zvdlH5gŝ93 *mjm]A07عzY( ̗\<<>O* ,|r; 5qiJVJ pC4ʶ!P 2!Ie#[yC'8k>i5)Xiii&S;N.ɟv|A5&LHdk;Rpet[%qGÚ.Ag^&n:TV3lXaЗҡiZCVh%t*LqsQ?Gjϊɫql0K;bY-XC=}?,H25 _VRhxic{n„C*:+YgLpoB e~&k4Yj(,0虱S>Qpxw ?Gʴc,iDm,Ck;s++R\!PvνZJ(3!Shpɾ󧟪Htzp+ .2l'_mvu$z8<*vD :Eq'S#;=YҨ8xY؃7u`;!c=0JQH(#]Vg_ҊYphb` ]`K]j瀣SWLo cΥ)H, m]o8_˸ _|Fe.3ghw%&O>]BmC6_yL3vdwł$c*⸀vZ|; 0?bv,#[Vl*^QnW cQ"~BrW F ?* aVm{^y!/ ~"K>+GaUsI|riVl2*r %zܣ:XIwi@\ӌp<! 㕍sYSrz)Q7f卝@^~hDQU/C^7#y"0qc; ?ȋmn8 4a`5U.rNidބ!7lB=Ǔnm>w#`Ƿn𘸋VG-)Tj_.LDo*6m>qTЋ$W7Ƅ O(IzWՑ99Jt̊`҂i{}!yp z$>c 3.65h|[>5탦Fx47r̄fb4<v>ʈA\Ot 0F n8D]`. T _@4X1gB ,kkG{{&|p?bWq\@$az;{ Z7&71Ԓߊݿ+N<}Ѵ%O{19> CZ85k2 괹Dx6l/ZBL+w- 20pD~%s.4/B?'ztR_h9&"&LCh^˗˿t) gyU;L~zmIIdYyw?C*kUdB~R H2;47MH m+}'Et>28 6TPaHV(0&Yy UҼco$4o)FI_ jGr@w}m/Mzt ]JHUOxe`;Iٶž2Sd2geIhDDqy+W0ڄ.J$YƧ靘H1D}Ć/f++#4U᥅ {p.lObi% :aN>kڵk)~ǘ+xG;Y} Ru&[m׌xOpSg}vDPQt ֍4I$|.e|ݓ` X׼t$79@+¨#mXk*ӗ[GfgT6u۞?. ?(v<˦T.ݢ['{$)Tgk,pcQ\[xuzi3%K. . 2Ƚ?3W+^gr=CCo?=8tk~|A1I{ l:DTC%CY(Jj CyB0rh:Mx^[:!Aw!3xSq(=0΅~%2ZZ%uwgE ;bHC:nBYibf  {- V(xxp N Ӽ3eWrpZ4j>3&a<(qoj!*3m5zoU,9 [R[' 4 L|U}uLm^/ 6OZoI?7J:}f1:Wd3m) nb{M{-kJa-](WvDV/V3Y[dZy nĘEƫLz`u+:0WR 6ʝN̖hLEoF+$Ma //3إOg;]If BY3manXFK? [v0Z;tE P!"<砐8roz \ҬzΓR7Md#.> YgQWm(TA/?5ztH4gĪgݼ"Rke+#N(.4- ʱ$**xtVC*TɃ.#UM;0hˆbQ) JwaC31P2h)UdO, 3X2cYE~q#ɥd2BZ2h:vG%9y1d{J<|؉7UB$}ZnVȇ±(@ mU TjD{ldj)O n d%d\2mUo.1yK#[h8XhL"B.I UZ4÷H0MM_iJ+\TݍHomT9gai%RiqB{f7Y٦`-B-EQzʕAl_%eK">jbœԏL+:I2yD.7!?~ܴgk# 4f(1E׌_)Eb/ҙ;B'}d*1bР$%PƼ8-C2v&dmfǣ~bPcK\@'-yv?A.+Ih'V_ٹc H哨U޶N; No?U(kCe:) t|C 59NE% F?~.rRwbN<=?KiO8-Y,3UFK7i(AU}v)װ8lmRfة?f3nt0bzeL1q!:^ߠ^VյaNϴ.3ޛ1v}]â16ubr8@B ;oYd [~ȍU!9^4g 53€Fa$@=oLsyt`c.^Wp v#u׫XZUtBHlм7W7v.ēzBMgP!gC쵨c8 1BZ08jEt$ RPb,#(HiK!-/ J_k觙`s7z4u1UFZ(c's7F>]-%͘> jㆫ̎& Nޠ THGHg'E'Zwe} 3Uq"0iVDO˙Vfee?S4OX?ZZ˷Z\4,]l&H.:^xL\uD/10+G,0|mx+|H*"8üRc)ztT e_ɦ teUCxZ#]SAwƑ_~~!ΕdzOiO(ȷQqCJQi~("gcˏtٿ6FSAg:WQ >b=Uo} xi1Q*"Uxqmj)e}y5V[*`mpxJ#ʉ|pBQ;]tQC OIfV8s o} \ DyͿ}Fթ_}lge [53znW)P̃p{w\g12O͙\'=וŭ<en|W|YtcZQ,:dCz`f&k.foqsv 9u4]VّxV +ˮ? EwX4WpPk&˨J:iEhoq(j|נ`sؘM#uϯ\`dԪ{ GVNǮ'%^&?K+u6P)ua'~[.%l47OM}᎜ee~j^˴!^?vb(YąLZ68ܶu;>!0)3"4UBCx@>Á;DB~ޗ3-2uc,tOE0ptY}InIjTEEX eJߔF4rX9u*Q#[{j6J+1]7G0ήo\plfJale -cq%nV9%Ck$fAྏl?OM\_RmBrs͐Pz䲳e Jd\UJk]ɱٹN\#`C0$;(lb$يm%{gx 5g,)im6qlqazBG) Ԡq\N3DpɰO&l7?ٕHg\/+2j̝³5;zjvP["7k#2$C:~a|WCA(]مH!hUfdn;Jo0ϕC^h`S]}7 rܬKu7uqS;>aa,/> o< ԧWNe*IL*B8Q;*J/!]D"˯Ӭ?V3/Fj2;9י6M]R S6f!{.ׄ+l{!! HD[`TV5BjxPfHشY`Xp&V:A[ԛEs J%g2Ց 'j߰kSZc3}~0lAwARjZуSrQ ;Ү6:aJԈKKi/5~Q_-2,EA..X_v:2BY{fs',$in蜃WwAZ.Fb$+R~j_5#/[VBHg|-7+䂄, [MkeycN f,%dϦG,ཧ\[*]s'.`}(,SaV=Yٶ̆Þ,4\4+WnwkJ:z* &wCK\8`MAgZI'>$ܕ뀊^4.~蟔 D?c6>KBU31d~7JP:$͈BךW!j$|ZJD+ś˩@Eps`SNKSSvBWj/~jY#XӐ ]"/u ր= AДת`_ /I=B $k#N*FeZĐ|dygh^ۘqt94-OM9AgrL0/ dәB#4-z'M7/m ez`A"m֭y:׈ff#Ipg኿p f͒80jJπfOn+9_PA7̑^>ո4+p$%Nbg܇ i5QCW{ɜ0frYX$`' Hx#.:Y/(xWŪy9ƥ:0yd$(R䤉cESx20ʋF(I$N.Ilk Τ&ApcVS"^{DN\i,]<.-JÙf,!̂%X(dI4E0&|ϸ3_ قfWFXP!L-*iΏ+"[nꎣo$P#s |>G5%5m _ 61KjJh4bG&֕47CBs~emP}2mn{Z"xK0U!zY˯Zy'W D(PA*x[XGq Xjpװ"WNN]N^AVO彉+s [u'>+VI!}! J_uYgcD)4X/-brVi[u5Ooin&a GAړr}k'qӧUi#xw^W [u!}`HؕXs<(إ}d&Y_n5:uGh)Eq X1Ǎ'O9nONAҽZW:1S,4+b*=c⟶~Ut (WHig㍪ Rg>,θ2ppȈ1 5B+еAYςY .rMZUJoHcõIx# I#b3! I?^]%qi$T.zMXWOsj`L(ӴpPl`lG4°&ŊV\ltCTU߱|X/Yn{B x Ii3ŒE܎p- ~Jc\Z#:ncyrk["r&:r;z)J0II?.lYDLBM)6|7kPvwL{cAXqa,#nH92Rߐq-+cã?=ppjfsBPY'0;(kE9 f&Y+`͉M"UOϪ`Mj~= 9tJw_,#W9гNߜ$}qN/v82ӹXf/! JGꌃ`e*sq29 [0*gC赹vdD'hd-X_gz`4P݈ZJo&KqS|Pjxψ~r҄շ:~FDAٰ=6$_@C@:l DgrR.3>TrҒ1e<YKo-!D!YK$.upN`'V4ahHon1^( FW_9 5zyP+ОD3(><;a\v&u|t7׶[k O?I(37ww2:VW BFz>xŞo` _eaKêCp#}_H²gEId,o0[2AҐ%R1g[>-6^0Yg”6Hþ*B$|mnl `(נT{Ю^JN‹L=^{ȋaEZ8lQө|">>|neqJ$~Bt>ײoZ5_}}?&3 -P޾S%ܵOTliKF,^1""ՆC=J3mENMT`ߋ_W#N̓b F!Ad-ǫ),5,T< Z "EB 铚U!FN1>WwuTF%4h eLt :]gQH,S_t~mI xؔS^1XaU)I>Yg>Kz]BED݁5P9ycvq;+NB9Veq"/mueꗺ+i5vV ..9[yi]1nHZ%^ܓX}z:K#!#𮲯zCvE"{2l#DHOXUuN5~9| M_E-bВEő=!_ Q]`D $Vx .-p!',x"`sqbj.5I*D9ZbB-";_kP@-b!mjcԗW&0'mmNTj oqȴ i>kWv'(Ab9^zlKll9")lTFyJ>_~IV%TSjf턬:`rTn̡?Sf oWzpM6VPD 4]k'v' lƦf2zs?RDQ7Rt`QE#3ّ>632p@ @_u˴/ 8ȌH "H !)6U8]={ɺwfnw>s ~tu*[뵙B>9Xswh Γb? ^Cfʆ\vp\I@؇(4nbzw$IXDk=Y U-h~/u-Wș-sFĖ5Lkt*&>C?R\,D}ΞrSo[U0MG%#MڔX N^=̮N\]g}CBSq^Q^C+ź'ی v^.pGA,j/jy .5p +,"b)jnp\{&$vo ? RM#Xf$~)os]= (OwCq{"*{MD2tlk $jh1zCL|OZ6+.}^>ubp/)3uPip!擋ڒ0ؠO'i# endstream endobj 246 0 obj << /Type /FontDescriptor /FontName /ISIUBK+NimbusMonL-Regu /Flags 4 /FontBBox [-12 -237 650 811] /Ascent 625 /CapHeight 557 /Descent -147 /ItalicAngle 0 /StemV 41 /XHeight 426 /CharSet (/A/E/F/H/I/L/O/R/S/U/W/a/ampersand/asciitilde/b/bar/braceleft/braceright/bracketleft/bracketright/c/colon/comma/d/dollar/e/equal/exclam/f/four/g/greater/h/hyphen/i/k/l/less/m/n/numbersign/o/one/p/parenleft/parenright/percent/period/plus/q/quotedbl/quoteright/r/s/slash/t/three/two/u/underscore/v/w/x/y/zero) /FontFile 245 0 R >> endobj 247 0 obj << /Length1 1608 /Length2 9271 /Length3 0 /Length 10094 /Filter /FlateDecode >> stream xڭteTђ-B$C@Ҹ<ww'w< #3sg7foTٵvRd9e,U2-bArA!fP @ HNN-@biпa`bbO?=/7] 7񿾨 V` z*S}ۃlj @ۻ@{Oi./X.3#y`g;?t6m]A-rtvx{񽀩9@]G(%?xB̠r@^HOI}/0/^{@2@G[3ϗ/`ΐ4\] d p[9l../0/:z3GG[ϿFlk}m Gc3( As;max!arhlЗʬ> [_5oZVe`/ cX3;:0@f/m|F, R@V 3ۗm!-/>-+Oye"_l5߫16:Tԡ II7 山s||8yV1:C</Es-?F3'P3{hR9--8S3ҠD9}=!% Z*LjBX'Z=ww{mvR3ѵ1`Dy)o knk? QLs90P\;bSc :apk n t#1eǢ %Q%A=M5YC&}H54=4dVF"\e9}CEI:#xa$Id!}9[GUMX]h#-\pdz} C3,7mvu?g:{j9t6oüvO*?ytY=u PTusi_.h|W<bK?ZG)9М4c$,nPc^n U&c.0u|vS&wo Sp5tO 5)] AꂓNDB)6E!E(Y(0tǻ!bE0Su$@u_G "DiT#6^El4cQ~@S'STo.?jX2!H*m !z=3[auqTr 2XEp$,d"NX˥ۊ/ؔz]׃a\Hec"fArg|#}0oIB.6~Hm.8T'T LS"R{XbXxpn>r.𴭄ku1ac~1߻ǧ%#%&;vϔoUOF R,'o?sʓڕD˱g)RoƇ9+[{\AEU8l:{ym0 KXKz׾rRbB dam\b߮WG}9LV3M8M5Fp^!Ŵz2-vU꺍10SDQzxk%7MXXb"ۼܞb,~c]3k#ak*OwZp)yi]-~A{A}'^@G8߀*d/Bo)Ņ]OȆpI-N]vjp6~D'"#1khߚzesG1UN"D-{{VV=H+<-qݫ#OH']op\r1):΋I+IYY'uvSp*ǐ]3P6ʟF)M\$yNؠV]߰1HJL!O|~tK7SFEhHT*:'XkY.Nk wFU6kgLvikokގ72rArs(fRQ=zOz?kw2.L inI@6oVswƷ= |/!8 붯J`Y,=~1_/7콣4DkBj}aЛtgZs7>ʔQGΟBĘm.C#i˯B>/M9oƺUY {|l9j2*=[mmwv :o:YNB2H5-[Sb[ M3C޷?pDʻUG"~x֢jdqRhI3c(%5,(8~I DȈBƢk99UG]yKPeR_ƫX< A'H.bE S3yNkdNa"iyKN~k!uaVތɼReq>m5M#>\cMX~:o Mm a;L\3ATs7|I\Mmr q IP( %>/jէړKD>@=pE8u=4\)#Ocכ# Ѧ z8ѠĪ\ $o7j 2s`ϩTK5Mo*AUϺaY^'ˬ}QO$ޣYj(Xv ܘ (WN\\-eF( p/ 6"QJ/ f夬N'4oCv,>\8ɫqLf騐׀DѺUpHA&Nw:-$qMSIAoZ/c?ῒBZ^p=0ʨul*0Qf{rzu ǒS!lΚ9]x] *~%*ڙc^ ¥,%3܈JTt-HkO[+}1['14kA{8AFզ4v1f2Cs$ٞu":}%h;cc/t0a="W+연6mlAH!ʲ=bʐ_OXi#ڍMC]RQvqQ <:qupG._ya`c [(HFQ7"BaO2,"U&~)\ݍTȴV[d ># O P :=' ՔKRi=dp ÈK}39wr#Sb5]u$̾ &Qrd.C$1 wLۏ`ܧ\+a׷C_7gubXpdGHUXW|:Qy+'^EloXR$j\^KӍ/3 Cb]>W%0lj. J;. ŠmM07/~=PHZ:p{Ֆi-5[unT]$-=6$PSlZ4=E usL?o6$KgRFDТxF|x_g߁GXJ; #̛zߍ;C+`׹0,wv#-̸? lkJ-3Sx{1X"P|82Wnvxw䥅fh}L- iˉy=7TC~Y.KsQaiۮw-B<1_l b^0E%9d %*7Ǽ쯄|B"Gާ[E<ܴ ZI 0w~όVUцԦ8zp}@-rLjz4ܼ٘n9`> =W =6OݿMwuiўߌj(~"*g{tkG.bQN*Ӎ"f ծ1~Sq@(#Tb^Af&L~N7gK4&+G0ϝy3`rG iv "$>gMջK#!VԼ_ƽA&)$[ #C:Z2=H|NbN ^-O9ICq"r6,3Ux)A7.2#fM%E@RQEkEM KyBZo -PS[]UrCyX䚦p3v7Rq4Wӂ&Ōh|4xnؤ+GwZ'$ WG5Q:!!CO0nS@~#ŝ́P.><ѮYN3R;yO~S3}#3zU;]{s):j fz2ayָ*bL)LՄ$*)LfVep 8k|7!Y-T8l5;wmܸKg2 _%iq@,oHڵw~F;QR0Td25O)QN!X:;P/jU?7F';φ`-yB>t(, &ǎJu{ʺ)$Df{cp卺ӊX~  Wmp>ʂ\<"U>5q=yu ~oA70*!Ab?Me༊hà 땦 o#V2 T*ETjsD^z[ 0w ˃_p|Axs<.S&~Rs\]ܓg n_Eu#L鴎3ZPq3$X{$! WNՄ@OaF<}ɔc tD1W{w+yq Ţi7驓N cerZy.9#fEiA61 ediTA0w6:!A"2$+3)հ'2FK3ǻpsVدy xxW}\K@:Z>t:޹e!dI" ;yC%avf0{z s]~܆y%#c<[ 0 q\RElHyX Ֆİת=B5AP̢Uc:>*osJh9 Ʈ"@bkaU'H$G\0ǍMS~TA^ràafQiY1W@60PA/Xٖ0wggJF܉h!Iiۃ1LsGtv&BE G&UO5{F!1GGwX(xw1C GsaY+," yJBh+fŬ` ,P|8(wE|j R5&Gyd4qƶ,Foy%Z-5v<grZá̪yZ`/jt(OpѦJтI_8եe,C<9 ^u{.[}LQxj̶t"b`YL]DgN~B}Y93w#7ڕI۰/Jrj'lyZ~ĖyFBҎ"4 >)+H- ,;|1H ct6;\ʖ2ҥ!8їѯk 5#uGc YDo{uRF%h>Ujkѵؒ㔨L1Y]YMzG 9dVag_L/jIث]ص~TZ 6VgC7eX9Kagr [aʿH_$(eˤyW`4u#kHQGmj88џTӬ#=o{J1~ u0] ;Kƍnupy#Hbm¿(a덪fMхT޽E^sg`6 vBlN:$gX$4u=m=D ra&Vi*ÈFw̺ѕsK08hݮiFfLhnپ&z.63B5A_?87EA}o38\cͰ(H}.E3t*a!}& e*a;̚!#7zdWcf`٦ޕ A'Χb)-(x~KS޺ەsiryEjBf|٩/`"@\V+o")рDU 5*f;@˼ml|Djb2&iAf1A 84 Q.WT *͙E j&fox[\vyȿT*Ys( $SŁbL+n|Cj.1CRيksj) X#%CihnmzWY3Cx]:0bz]k\9JcN3hNuGNO@[SB(~t5\dAxXT$w$~apYYb 5B͖:z xRΫxr2mͮ}'5 whÞm~3$ZT*op3!ʧ]Ss_ A9#AxrR8awS$_lKmW4nf3ukJ|wĘ}&ՏVG]+JN*VuYԲuaIqrh"RoM5,b9S-<8 ŭ EȯyN0cFĻx{7gr6KD}9^ۭ +h%X}QDTP!G kjE63=e ԯQIO|m@";t}SB1[A@X5F0k"媇FE)_ 祶WtС }wˈ^R(Fb.?K$GrM]z*M*ne̥y]hHl[&>ņ R]g Mp֎=#ەB;ZwX((ޱRG@h: c_9tMWhkY/``.C/2t O;j,<2\9޽z?ČVΣO̺؝-06jC/v'lY3^KJq(،L5`&]j'Bh1~D<-tPʮ "ZQdl\gڀ颤hěAE$'=kmNPs?lVk91JiX0׈yΩ. =rz=j}. 2]v}fkq~#Z16ZTh;zctϴ7Mc X , ٰ ޽Ʒ_V}*pwU`{a{^[*dX>I=k~A>G|WӚhWNrOU1&i*ѴJ|&7}:^ ʕIN${ [Lڠ={Ȅ[|sL w1kr2Oyj95G韙]HKѿz֭<)"€E !;IoIaQ %q!\s$.n_ Cjt[Td6j4#Y2x)FNP&А W6%cbe8P&Z4"O^auxal"Z\է7;J J~vdxSp5DX>Vz76ڛ /zF{s< Mj]4|{.M蠨QF=Ƶ?VKP. QR^dkwI)]N݉ endstream endobj 248 0 obj << /Type /FontDescriptor /FontName /UVSUMP+NimbusSanL-Bold /Flags 4 /FontBBox [-173 -307 1003 949] /Ascent 722 /CapHeight 722 /Descent -217 /ItalicAngle 0 /StemV 141 /XHeight 532 /CharSet (/B/C/D/E/F/G/H/I/L/M/N/O/P/R/S/T/U/V/Y/a/b/c/d/e/five/four/g/h/i/k/l/m/n/o/one/p/period/r/s/t/three/two/u/w/x/y) /FontFile 247 0 R >> endobj 249 0 obj << /Length1 1166 /Length2 8038 /Length3 0 /Length 8809 /Filter /FlateDecode >> stream xuweTۺ-B44wwwFq@p \Cp ݂essߨ֜_}2׬1ȕE̡ I(ę3uqR33,]/ :_ !2qC!&/ Pdeefa+ TvA= g-BC\@g5{{[0\uq49-^:@1#HE=+/(r[B/ W-J/)@K*[HHklloaz, gfF% bP?88d2?u@ ^[!dbϬ;d7B99YXxX؀  ̊?I?`=hab[^nh^N& %s 49MA/wd񯽂# d@͡[M@@fYQM]QЗ@F/Nyό/DM')e P Ͽy\AN/ic:W:@@ڿ⚗iOcퟪKN@yؚ8WxZGl&L`'I;\lf/!HM2rS@@NN/g' jX՜_\ihoE?ٿA w Ԍ/Ⱥ:R؍qkK-Z-\"M1G qA+r=xxXb(n7V&d7pÈ+bЎt}$H>!/ҡQ :(!䕡*}e6YZjV2SS*[e|Ahk:ºv{&S'JKW!c1ja{aeQORmhâ#nԖCkԿM/Y#C1ria+ 8v;lKbB"Rq.]q*ٍe{~PRפ{\is~m'bϰѭFoyRԪV@~ШhҧF|cK~r,hd]"찚±GJ 10;l".:3o(g) B0uܘX83p7V-{xָyY6 D0e&>)l@vl$n>zo9([-#Hn'EL/. 17J4؟othikf }k ҩB7PE/j{+ ې%FNU0D Sj)fz}g@`4S2Q?0̛!>svFPx?1tbQ,w&hˎmۂb:(xWM,] )X4rOcBB~pc9W# ≾GCYBP <ɑȼApC`CrQwVbg.+0hǀ9(Ӯ (xz1( }t>mx%7DZzXM)Oh䒹E;|*L_cڠN]B<ژ&(}Vzb@TJ[?˪u_%spqUBckô^kKUG!)*;jGˇKԇϑ@BaM;{]WAISwr&Ci- »O!*~$a O~w ǡw1jS tWi,_Yl_$T=O*:_Cq(rd_/}ର:W︥kmJ۞?'l+n Ik3F+zVVaLOC >k:盂gt1%M5'+6v6; ȸ}xjMx#}'-*pZZ&)r`bp_RS6! j=R%QKNX gfˌƩv>H> LOS|~V澥2~m,P"]y^E^BKUjt,)ǜsnSo"˘;؝\M^f|9q&پx~+ I¶GBv?KKLV6&|!35ςL$gboĜ">"KLtCچx:N.Lt1\]Z${\~$#BTߔ_},o.tA^?Hg4݊+$ 7ݙ^ mD{+>I.8z~U@'] g.NP"\kܥ$ՒbX: ZI0Y](ti"4ikbi편#]dJ+OTvB.}2J\R3 p7ORo6 GR1k$,%XnKŜ_P3e3b~=\3̽!Sq7M7]boXj ~ 4f>3{摜d,apU*?uR>*x&H~4_-R ^9bےjr]p,kz1;PN@&<-.SYOjOmcCf7g(|KwR9%Z[y; wh{w8GK]uaߗO=$ QܺG=d>ס:O)i~lCͩ{MsiT^]6V1`Z>o6qg7s-]Ȭl%"[0@.gfci4(.5@CCϭMyDoAx䛉v}QdEWR(/H' |>*2tofrf%㧤\g7ߞ-K.ipЭ$e\.ͷ/?6" HkߕrC\?Nt$;gf-ģ}7LNnYs~N Q=fޝu"CX~ <2V-^Nu/%w "XDzO@ zvL4g(Mydi­%>m@p6FtD?W|݇Yj< +v`˺⣲]WUq?o+hHxnÃlTx!"V Ɂ>DZ D8j}ӊxYkzPIt'IoGJ'ʝ yl2hA%XLCڪg0!zB/A7sF[` 9l#aH$YHz 5 a#;rpG1Sq*%;ua oXNwDӳ5t8D7raѻV+ܱ cq;i}iݖN Y1;[T3a!$]V;$`$V=ZFc_zPšu[/IS=1xu\XhE>hU\5  S5'-wmqA}4J5{12<a{{dw|{R >y)UiRu:ISÂvf>=v5̍$ʞg?,?yV =z[*,N C@I6k!IR>ns^?ɯ}Ԟr+@&Z7EA^g aQ4MFYhaV4f-F 0?{N0id@5|$36'߷_X=t slunnd:K:i+,&2/H`FL,5bqC^olP<,)\ 8de sqdj1ZϐNlz%تkFUU!{Wn%EP\o1F(`zʉ5r+g7N+] Ž=Ctn ?BHfKTMJ¼I+d-seM_TPYg~%~ K_UDmPFxL+1~Wg[nG@- ioz=rHԲ$L& ~PA.*y͡zCچ&ƭx{6ܮ8&;WDy "L,_jifæU26ALnrLZ%+bOyX[ԏM.& 'OcVu#iK^#l{pb5(~͈+ʰ.ƅFs1aE^3хSYrJnz,Xep$ݿk2S#g9GM٩ @l}=2JwTkJ%&*psڟ.wV'0k5޽6I:{Kv:!-[vIAiے87i I9ojDAH2tlڟQ|2 "dg&tlEQ ^8p5WK. ^ҍ=*kloyoimg%9D62vaC>L%O_LSZS5Ҕ4iôr(T?,DJ8+e6d+ KHY%O/xY4Blfp>qT_v|a'xFFȘdl) >r,;+ʲ́}bzpjZ4Q8/f&ܚIzaYROE% gtE>eoKL->(Ro#9s4(20K(`|kz]%acCL Srɰ&ՕAT#$+ &omv6p?#Q3[ 2%`lE۔#_b.}yMq1ZAh;oDs% َJUOKf=)z9E:ӷI Zj7I&hFpH2 KFӋK% n5&󎿵YhO-BϡY>Or gɜO( %>z~,z2@ fdG& 5y$|1q-.oH7x#j^F)=bef[]%H ]{>vCY^%&E`~3V 五@d <mmXu5\%6́=G$1Uݕsw ]IaYcjBs1)L]93nD{Ÿy [V)5eLIKBUaFww!9OhJ'wg ak ܰ4 (Nج%vo&+f%]%P = VSq@vO;{(6ھg?HB]mJx'yXS1pȬAvKZjqBQq@NR6:v{Ɖ~V'v3{CLSU:,y*0dJ,l^nZe]U[,&Bd_|@]ӣ-tٓP}[VklR.k`U`7鄷& 8`^iϸSE91e&~"J&2>flAgq$U;Joqr9P~) e/rd+v>*7VvbkC+;Ҡ8דH'lbpT+oa="9g֠g;QR[qe ͊ƔLĽhZ1u aÒ]+C:jX#"ɍt ׸J8\BlsG57yvƂsG YM> :۟ԱCCrY#ڿF ЛC=zBa#N'8{_%r*Nndiq/ߕk-f1*}#i d"8 0v7LB2]ڃr*0q ,Xa,{4-88'u#cM;-/]M}q/bT cKf@TW&r DG:r0ߋ"|, a+%NU:H$M㢣2+o|7ݎ=7fuhlUqS$~-+n{^ak"M:.vڜUb&/<(qʛT $+S1gqk'ʣygW$8R4sX(.^e()z.pI3Yx(E% pw\#!>Gt&~ 0)oײD]maLQGtҬcU#/euv7leB$ endstream endobj 250 0 obj << /Type /FontDescriptor /FontName /JBYVZZ+NimbusSanL-Regu /Flags 4 /FontBBox [-174 -285 1001 953] /Ascent 712 /CapHeight 712 /Descent -213 /ItalicAngle 0 /StemV 85 /XHeight 523 /CharSet (/A/B/C/D/E/I/M/N/O/P/R/S/T/U/Y/a/b/bullet/c/comma/d/e/eight/emdash/f/fi/five/four/g/h/hyphen/i/k/l/m/n/nine/o/one/p/parenleft/parenright/period/quoteright/r/s/six/slash/t/three/two/u/v/w/y/zero) /FontFile 249 0 R >> endobj 251 0 obj << /Length1 1199 /Length2 3953 /Length3 0 /Length 4717 /Filter /FlateDecode >> stream xmSw\S& $ Ez  @K `/"z/%i6^w?޳f̬=#"`i#(4D 2Gybm`(Sik;C"FDCu!:CQ0'dÀ X&91 K p@!]4<@l1p "V (YKHI]B п.Ex@CDF0PX_K/'m*+6 JCy~`i~觋pbcFB</kBF hy8"X 6 B~a(ψp? / ‚D_o4ǁ<oN4^f0rˀɕh2wsղֺlm&Fi!* i9B(oֿKVK⿵4ByA_- %*HhKC?cV'v;~ S_`A CE7] @_FVxZ"pp_ܞ?Dc?Vf냀,(?!z(8# xm1N?_ A,B8 ~1jCܓ:-`w#=Jv 4iHU3朾< E*9u-}4jϚ%MKSjwPƳ1LޒiT3WۡpH+x7(Py(3b>wDX9_b}F9viJ1T|561ָeD؉e눵smzŨ\ÎcN>&v]x\(Fؗ/9EG}'h98ϝt*Z+ɯ* 8M) , E{{;{N9ux6n ioQ2oY!֯}J :Ỳ>w@Bc/ \5n$M9owDoб@d/UC0 's?'^ īj&ݓjUR"o(O%_?wTnn-, 7?@4of >]^aeocDS Pi<-KUr){W_xkl+< ,B̾ƅ+f5lN+iA3mzog[dծ+1${wϭ)f<8`"j5 %p=zu 3)a}lLN+4qzњ׊ |6YW҉ňLcR8RiJ8hA;^"02= 'Wj6VwKqS]A6pP޾/ɸͷ{G5giqh#Y 3g:Gf/0kinSCـ9&o/2IMǛWF(/rC V[wO6G8- BzW8:& m5zlGȾǞч7@>$izuRod@"߽3c܄3XzFMS?ic~Hܟyɉ{z\?Ko_,%NC( ]bw$4Ivfig҉I'%%C$%RK`ltMfN~N +g*~,d،{tM9YAT#Qfn}|[V@롻ZlL,o4@׎Oj_..7U*kgaPLIooVi fSl(?^Bm"^mzwUO iouP=~W!:Nr=萷$>BI+xD]'|17V'XhOmp/R`QW l3%ÛCm[Qo i.^Ru&@w@Cer<=~cɰt1d&fhMi: v*,f-p޼[m]BvcgoJlECor3Ę=zPWrt "_I` ٤.Cx+9_%l%ԁ:/t 0n9饫lcʧNI2ܾ=sUIC%G"=4E8|<K;Y*S7 LfJ `mKvM[N<ӂ{5_ ںvw>W`h%j(Ǣ FƊ QiO!תNeeit5ɫ5JKfW҅V _Y#Ĺ2o[ v`cropm@bwO߬ 3Ylv8QwcWD>%oY`a0&f4f6h8׏m2^:6bh6Ɖdi%Uf]0sϼN*EpnǕG'kfwgKz̤RܵV:8Nv.3yLC RJQr8L!)~ (ڻq҅Nn2 u\ςم FәYG޵&  %5wz)2f7͗7l2*m̙sMio62Y>6~U4'd]4e#PỜ'M⎚/HKxɴ/$?h PuwHXStUC$<yMf{WqM#͘tJtm~#m#>cT];TǟF\oŚ3wD4 CLQCPJh^W4d*w-<齄juWNoj~s[Gv$AR2A =xGdS3x\E|㍃oҊn ;^Bg3wMxdžMb?Tyܸ&;mf^p̭Ϸ%O%_ֽnj,xE>A}H`eA*BU~sq6 LDâ2pEuw9vuQkgETu|]=)||kaK7ũ`a:JtMH w?yBYI!~M>lBۗ%cFUL.|CCRsl89'@2UᅨBފ$|ٙlDz(Gj/3bW>*!v#g9~/N,}3 R)أ~r2890Q\u}e㴙F -6Aǂiy5b>jIj=sHU\*e%C1|yi(m)g$=wZ4А5~6G>"E5!T PVG>*ZxY'8||nXN&߰|ŝw!H{ݣy^+\ F>hH5iz雳 ZWj1EHOv)ojqSQ, R:w}i  BƴS^VBG Y8,yݳCZA;+Pݐ{m?jEk x%QGXh`4Eӡ֮DpUi;{XVcQ4a74D4="R OWP7m3J:maZ3Z> endobj 253 0 obj << /Length1 1626 /Length2 10555 /Length3 0 /Length 11392 /Filter /FlateDecode >> stream xڭteT..in'./{9ΝgOSUZlP ,cb,\5P!e6%"CrP9 $ YA@77KHH up[:L,,eO͋3x :: kG- QNU .` @ AAL+ U3K, g9܁ ǿTGvX;C`/=A`//r+߀//`Pg3 dUN95jbi Uߺ0/Z9 a,Ύ/_9: X+ dmdirv~ NooV s[qq^r[!h͊ ?u 00B= +4U(%%2-% -boj21#c2C;=_Nj ZI`/-X!YTÀ6+s~-ׁX /:m0|P sI(+oC!i{8`RT+$/`zٽ@B>Cʿqbs _202 тC,_&.NN//UA@(P$6)5VE7,m/ıV;/ǿiU2nTczqSyg=C{8܇3wmV I!fnɔ ?燭a MYl}^v K !xΝĶxW*Ryօx/,)CX9KhtEҫ,"qLzQD?ir3*vlQ=ЈF 3[ zelKϢdϳA$CS,GTORR@+{Q(o> WJ DŽwu/f'&e%&QNw0Ux3x߲v~kz ?M,ש9Pn۱+wyҞY\o|T0E|BS ,crjd?DWMrLz4:^ݳWA$>3ӌr?Gatu^?[([g81$j&fe2om1Z2Fx(.ZI̎nr9'ߤ n׷g}Dzsq?35SeF 0xi*QjaUV}HQO՗ܽYBr8[Hof/fث6fw^V tw /7kߨ'SΚ!>^}}EM1ȎR77#Mfz?Cri=4UXW˻K3mʎY-Y|b^Y\7(A03ygUJ| u,bT)ԝJ1\h-c_K۝h}͠7Af͝[D C.Zx_3yhEO#ZLM0 SSYihCVVP_`f0$Yeۙ~nܤWDI;}HR2R[x9!/ ЯȍQP,h7ŨIBi[1hLȦdSEhE'*6FS7Ìs,zd %415(ɫ?`PstʩFtm1sg>rN, (^X2r, ?U6}{!T4s,oC;w1y"m\A4G͹%{27W}GvoPiAy-$_;ϤC&"/qC%:\tYB=(0upqQoP$z&L߅@_,pƶ6aH&NϠ)N#2! [uB"!=۫<{X[M׎3pl5K>?VkG6>1ê&rPB0ʕĒQ{i^ =wlb{0 N H6F]|rm0֗H{p2T3{_.p- Dnۣ dsVhUi˔;R!oȣ*d6gve/s½͂g`̎i%Ψ2Gi&]Bn[]Ó2TLQFA;wH oFLJUR:ʑu2ܚ1Ypo}U؞&ڲDE~FŁ "[o%fg;vaXlSx6:} ] qJu^)tChY?D?~=鮡qE )C l~zUHSdB&zI& FKr() vjEtJϖ7b?y̫c9[ v{̻C%l1:ar-9~kvwW^hD7 trq;!ÿj 負܃gåNp*&O@&-#QCK:tS+`#"͌nW %[No]B̕2d*m4X3UL\L$ _׮ 5%/ O ܚUD,dysڱ੮Ѿ|ο60f^ɗNbhb'5GDa"䥢=I ZwC otw%+skhFB&F3(A}hun OzNӔ˵髯ܘ \9ՒEiAU 8BlcCYX]d\ TKs^S2ޜZNL[vO/LwS#%(nuoiEbzj.:x) m;oRd<,8.mq jomYs'}y!J9m(iZn~MIoQ 4G) cDQ-aIiCǣaU#ݪ em:rqM6ܤh)Tg=S hB >I=Q+<&-" {m~y~888 fl7* w$ŕd~BK edA.ڱ>?ZS6LTEFv#yAye!(uJoN,-M VhM`1V=_FZY*e$a[2"l{*Mū(Q&&SX9g';&4ǵd[&zq0;7O /PM+,0LƗ^x}i-QVp!?݌!yڑwżHOfTXsןz65^5Ў{ɧt]=VǴVJƢ-M%y1+@9훌+_:7$x:>7F,XrSfV$=ʁ C״K^Cdqɵ܁A_E`vFQ)>ɵ.y UMJjTvK?D;B9T8V:%Zc^}EJ/Kt庭*K7t%.ҥ]A6OS+2`.n4_ҔO>Ǫ#2wBhUaOk9gHL+y2B6%ڴu`S_rz1M%^UpJ,P#+AnY 8~35teW /w% '3iP帒19uf-x{yYQ"_"'Z (1Y\mܝ#@NzDl:$8{Ҍ<}LKap6B^ZȼVZڜZ՘|6QkĞ- 6[gGQp[K7|y fkMIF#nރq*{q}}9m_]%{{Ya7b1x@a㖑1_~,3H^pwusg -oϥHfG @:z:Żob MYbJN=ss9gP,: ՠ9K7~`ƹ~ﵴ{6R+B]rosE=|؞jwvnBg1}wtqBeF&a2! _Ke5^?QZTG SdPr\f\ ӹ \Xt>=.jܥ\<,SXG6&j} H5F WZzTTAPj5ukwҧx7uGw\u}.3r7 t Rqm]=jϯo!{#cJ:jd6iN[2׋F%@Bɵh,^hd^-e$> Sʒy)rbV PTDT%Qf EgѨd֛g.Hxۊ3' sC)t]:ee J @V_Ĕd\ŷkm "iK4NH^0$ PMjE7 ѫONqA4M7tKd=<SU3qĮ6rE3OZvLDŽÛԀ-:,r>AA+>JLMRzh'~[f~nzv.ވ;6M?Q*z"Hw(QL[R>jBx+0U%*.Ե⿏7ĞI?bcpQ@{M09eK]I,z ϝ[J/ω؞Ӷ_\ <$ Ni zIo<ȑH׬kIZe "H +L-\%DVն[i>ʶܷwzR}N[|I3>_f?N?ضFg+y7PBԶۊa4s_M%=9,L4e8;z- _v2|8b!D$ V$0vSw܄xJ٢qӨFOq ?6rcu|Rƀ*wG$-jnڡ0+=t(K$biAyQ{B1(g_hמMZPek?Y*2Ux ֦wQ@7K|^,k4@ !=R|tRnXR S^Ky!Dv޷z6;_-jN9ީSmEW:~qfxg n WAL.|c`8fss,mPJ`)Yg*dJPCD; ZQ\?1'zb@GLjPZCK(wmq>FӕZvd-s=Gi/*~hNKtd7}_3zmTCQ'&ǧ>ty`]\u1:$\~Em%@S OR'VH{[Z|FD2Y d]!͊%?|ZW cV_.>ګs%!'V04pBE@(8IU(bJRpd[%jgh'mVM vAtj:KxZL>kڐܶ= m]E Vv jYBF0IaoەbmJ#fDRUYP9D>؆Hh*l0A9'oOWhcm:]IwAjVӽو,xepF ձ`k6bd].[p mBb?o<+U>ս?م1M: Uhu{. u*Q]vLzۈ'_g)Semf8p!Ba1qj7%$j3˱7Qu&xqx+ La%3qD56cm>G@X{\.B$y&iOX[+*ꟙ8NIx xlKi?8S53(k2 c-ظ2rpe0>Mk4qvyNDvP*&s^L䯎;rN\@ҁ?TM"i1$ 1C -7KrRA\8VV328E)jdבoPP{)~5|u(3T*vmbNG畳犯7zK?wJå( Qiq!A+K5aM-P{si:oP%S+K̈u̞4 {1\]oh#~%W'JםHB, NG{"IUmf h$?a .eOapzDrl!f?'i"& aߤ@8K<9e`hWgx+!qeo0j&V?Ypbģi1  )5D`%eSUI´N!8E6j9mǬbe ~7BKinf槉!/A}r:'UB$Ӑ^!12ϐ1!"TG39-OũH-f4r1vi)ot.Fo`(bX6]KaQcqǎ'1>3|'+`2ȅEz'?|Ҏ 0HCdQe}/~-ccu'c2)'Uiaf闽63ut^ >_m&~bdt@Y~'?٧8~xQ1Bǚ}1ޯD 1s@|{oF)?{}Iu+ lfx)Jm. ٢s[@R eN?qW~ə/*#=0ϯ ,9n-~ZK;>]{m.lҥ bgŜG6دt欷}VImv1.X_Go׆j?(ql)ft.n$0+_O.xBN4*yǤpD'J8FsJETt q6aD(/ÝmP |%iH%T7Gֽ#fq}0]+Q1}cS%UuqC fT{0!S}Nb:R(Vyw7}&y;*΢?^PiT` eԔH1G}n*AqGAǵKYk}nqs.dܝt+p5` L + k" o?,#UH-O 8{Gj$0&Nr9X.49*nk؇:1U_mxc2~mκie?>EJOVOtDWC%>O;ҽmxat=#_#Dп Ѳ-*4,R2s^#;"*M˼νG|A']1>:6w_,(z:n:%}@Ox`NBBK$#'  5v `kR܆LԕI&(DwujF`̛7?pw6q}=|a`g[^J%̓ERh 77IɖbL!-DHVqq:rd}d(C#jkx%n1,|frq>_XKhv!eìvVw>o䄒Ł1fNd/QzWNʼB t\vN HkHspd;tO%{Nu>*I.(/>eiT 1tY =e f"'KxC&\0C.' zW8-5FGM袗l_DT''VyKt=ׯd %orP|BY%4Ύ1 endstream endobj 254 0 obj << /Type /FontDescriptor /FontName /XDUZLI+NimbusRomNo9L-Medi /Flags 4 /FontBBox [-168 -341 1000 960] /Ascent 690 /CapHeight 690 /Descent -209 /ItalicAngle 0 /StemV 140 /XHeight 461 /CharSet (/B/D/E/H/L/M/O/T/a/b/c/d/e/five/four/g/i/k/l/m/n/o/one/p/r/s/t/three/two/u/underscore/x/y) /FontFile 253 0 R >> endobj 255 0 obj << /Length1 1630 /Length2 15006 /Length3 0 /Length 15851 /Filter /FlateDecode >> stream xڭctem&F%qŶmIvlU+v*FŶmI}Oq?c59Xj "@I{WFf^"ENсGAh+@sM\-9@h`e PAVZ4tt)`?4=]@/@[G;_kG5 jXl1%eE)W)E lb Pv3Af@{ `Oi.D\&G t}\&{ٛٺ_ÿrtvkaWL UY\yZW pki`OIu5ٻ\2A.&^cst+ 7f@pZ8]\;Y'_9\],cm G`gVd-,9;_ M `@`Rtpe>(o!7r+G%ZV{.{=hlM>&v [;߶[B$h r5Xٿ@g[=/j+ԭ@f6oV$#IY2T;^sjQQO '7+&俀X` _'#ao`訹؛)Gm-U!,:Zge @96vH0~ clkc_`ǖ;xYŏU;A0a)rƙVռ.'θa; d;3M @,GG8F03G#C7нtq|&)ɮ^ f_ݹ\*[ѓ4< H(b1Y2.؈-?EM<.#cYIFŦe :eΖ9WymybAQRE5 K O0dFPьb#D #\cG 'V_s0(da9~,,cN{Z+Oш#sºrvpV()Cr?]zî7Z&.Ű[+]#yNxꨯQdΫaPGL^0V1ߟ=Ee޴f^/X0M45;n2Qg]H u9 \@-%l6|=]7 OϢໄDN:fDrz/(*J=x_w*lN⅏P&p\b}dž )wx"Saj"T(pL N&YrL@0v7#O~>suMe˓M ZӉM]sJؠHrH_sO-Jȳo굖&'mw;=\>ezcU)Q N>8){S;ZT=ӹzRm߯h%K);@2z1n>عdtw81/؜C#8^H5%1_բhaoyc_͵#Ac@=ղ=#($U͂Ȗs\^ƂpxUŌGO&!?uv_ًp'zb٤`HWfϾX؞J^W3 ˦ERS([m`j4gL:'SMj-.QItO!4})tSUqZ]kBJlz{B9eUv=ۻ|!]5_2.U_'\h#oh?bv9$8paɔу)Ζ@|Kif´.^Ye~Y}:[ŭ͖xAR<#UZh `ۅY6s/KgeXhfJ K*) Y=|c&-.#*8"̗İK¥fL:pAT;q2V7sD^_d{xq56,|D$K"y ߋB)ԡ;j. d ^{Dvy`$1&!2!Y%|_S "[c|ydu<޶&Xvk 1,*QF ikyIEsܧWd3&֫08 :@6I_pbU0HKU=&n~FAc&t m0sNG6? yX#kN'K_)I,]ѩ-..;z'SX0-eV\|Z%6sl\F6C?=m?8 SA竫:/; ]ލurM~E&gHԍ=6 w["%#[hDtD| ^H|S "FWLHH홑8;]5>-^)!ZvmJx/,y=&9LCxѷ4*-b0=YMBHk؅j+V]:7_eBPFEؐW6뫇%3si(.,MVatօ6P :&6CU(, ABj*Zov)D("7b豝vb1EF+JVdh-!Kf>I91İX~ V^~ly]x4x5joŮ6L>gIX"YrG%0qcm{O vd+uqoi,X/poƺ,e5uǁѩ墙,>?87gɁz_Im%^hBޜjynY+eG«5lTOPW ȿȁl_5!CϧY>nX-~W$ЁtWO0F^*c*XMT3kOƇ[/7ԊӻZwqu%كٰVn6]d;_E_ S9L R㪑30m251፵a䝋;^/E-qIKe)"=. ^+3sx40ݒv_ו,z6Xgzhyԓ0w}-6˚R!%c; gN:~bYazQxU֢E2-\U"ױbpXy nVMƒ1n P|Ge\rR,,]Yw&ȂV 3b~ VI?vvES6b,ϒjqX̡ao +X%f>6[lSVغ\iDc#RXVپ6o<6Esjs /F0xoT aT]+z kE) NmSos;^p+ 8Il,ؙ(^}!RRP|d# SٙOwh 8pp_.|A2W1!y([Ij1~5e!hcC%a7Wg S(+A^1X@o;0~הbKQABc,MHr$܍h*VYu]7,i~s34e&e3qF6s|BI^] ~ށsjy$`J 3R`vŸ} MHhVNP6VJ<#VO"N:xWc,LҳO gڍCD +P3.*x2%(Gϛ*/.Ѡ \5e %^-S?SEd! ?N;7JM` 9pz#5a}( & \eVIUw2+fHbN P╾y(@?ظG =fej>3Ca*z*I }6gjQ"&ؔߕ :A |qN{)flTbP¯މ\u4>M.2L.gx3JrHRLAe /ڞG?CY6D-%`_BkIw)MU&B:>baoW X8[\E6W%b $::(6Ժet<~7cW~wcJxk2Ӟ;R cɳBqpRWseAzgta([ӿGa\I2V@wwD{!U  Lv؇K #Kb(R&_4knpY&>#dݜ(>-D7_ώ-3( F*>] ňYvrtnX"5rRǎf :Tgl̢ ,l2yPeO19peV){#/"kdLGȱW H̤~=ؠϐZє5 wb_!|G}Zn͐g{ung^NZ>)G|QvbF *34&rTW~jRq#^`Ȃ}|R忺kT:IfhRM2o9PA>N:NC!{|^ 5s>w5QL .^ E;s&bJ~Hk-M  n}*ӳ?'tB"SmzY/$f[F ftפr@.BES{,8beãOE*_#iW&|qUç{7O,6g}]627C)>ό; EYEA3*Q0LD+$PJ Mm0.V܌/m(^U̸W;PDf7w?QuN.2cbUiN3B}M2,PE/as/]+ũNHrmm:bZqVqW0jѺZE5wdsab#V9[ȢоcnSNFmܲ2Yi"DGc'>53'RS&軄"8SKӷq[-'u6UA7[X巄v:߯JFz:HnM1:~#*۴lO/gZT7,kաl1AݙP/Yd6||v{r]qd !Z1+ ?(=ꗎJ ϢK'SY8[yQt c ʘ:0iM479}!߂Z-98tfZ}Zo2-s[?"D>!~BlhAH[us1f9$UQ,Zx1D솓 r%$Pxp1vuȏ<$P\uul|6~.CS6Q:|L~O;a&2GFrm.l;`a@0NXl7i ] 67dk>T ⨃d9=<] .n= «gK ney~L 5 [1{&Fvro<* Oxa "644]~aGWqd :ٞ%%J  E"U rj 4jaN)i?հ|%[y4UKo=zɪBvO2݆qY3Ҕji?,=C64]N{%%NNi2h!-GۙԄ;B׌+HoLY{8?iªĬ7 T[!?.&^r4ZaP2Ҋe̖[6FRVW7 1.l>*ͲF[t:s=#/^kU9zI7ѭ2AB ٌ.?3<{a3 U 1vH^)X0T5bkqP]iyĵ"fd+ |4OCo6|]oQ2WFqtX)#U[xLnSb#UJK-@ioAqV}tj̷l\R)uzޓǥ\)WF. ʵ ͆"Nh9`,|+ij}A mֿPڈ\Y?mpf` u"'h*a6fIyVdG$,$ *c^U8HACBr ft9dFvZ됅s_G#J+3'oV-)qwUuXdXn _u^Eba/]_;Tq[ܲ-u(0#˿)}+։@9-}-onoYOyQA%?ϓh1駪^hBIe|h4*+aVϸye&2)/hp:KX9_@t݃A*ɛ{g ! tri@P FU[!1_n'(LUl%hÉ9u~Ad)M׭Q|I%qҡπ°0 f/+5ʶZ˃Q8k┟kG KR2X $)K=mpHKȱG#mFH3r9Uڽ(FʮCAr12-Zvm~NGuÏ @Duh,MZ.BZG()X*w:-!X5>:FeeGV+zrcOij;gZp"9lhT4EZָfP/Voӂb~"[~ ZBU[ avph*d $ZrNto:03h]?:VCﲾA/w2+rꀜ4yYw~ 0gi 4\ !AeHmcKULC2I_;u!;幁y)5=Y]s0 \*T,^B)+ŽeC؊ !2q`.CDRA@VO|[@-4ؑL7g&J[ȇ5վ49"j)F͎*Y0,~Mj}YxdAj5wB!6OkiGqJO! @:YOMu%l U5*}ʗ QC.g @H4]z;< "ل ѩZž qG[›t)JE/CɨVJΙPLq>mEqC/Yr !~Z I0_^)P%5A3О>/i%E2H7nCjbB;\8- QS FX˛[i},="D[1hp^0&Zj"1WK[)pnJ!\P]Fρ܏&Ji2? &N7 )5%.~#>P h I8Lr!Kz G i3]k%m 68_^Q;TtFLsq`?ʡ ڝ2xĻr3g퀁2l`-H+E"y/t]]X' +b};#]Yn#K TW؞wMfW\t WEf,‰|[u (o %ԨdlV45ؓm qؖԏ7K@X =Exvn>aXe{PBg`J'C@r^`ei"I?Pf¸Mq}G懲%VdFסNB#W;둜=9/=|"zƎ.11Ō9.SʧgIbS|]>kQsOHYEk7= @IRMVƻ2E'0L 0!=h5J8%4]{ %);Ё=6&Oc`z =2)33Mtm;@җqpRw0O\]޷x]Is3v6! z $5"eXs +BŒaSls>O6{,̕9j'TlFPr1W&Qa)޳h Y،exFĖi9SX`IP`/?Iy+N/w8X;5PDls\ׇ)Olx3/ :ڧ: jn@zK@caQܬ޿3H)~NB4-)PHz*2aߥlx_\}}29,qK<rڵ=zu}.dO$rx9s13!m9z36_nG'w5c 9Dl^I6fΩ#J=r l9a`SşaW-;d)X֣ߕ>rIOTݻp+&} 3:Brimk'r;j)ذ[ g'vd:9:Xtˊ*vj*% p=&F@S(BCNAaMm+^uJ3rA6|iD.>wǸշ6M).@JnB߻)o^rImAϷϭ<JV'K=CSSENH=.Doj:9VS$G mBl#_[|_#E opz ၫaӞqU" cYkdȇ1 Âv;!mE3V/i4r .QH W<ܴni5,3IG:4zB5-P]뎡\.z*YwՋp/wҶ}=,32閟[T\Kwc( rXK=њ;1ɴِdEva,&FuxiiN`Y츣c͆7x{䎾;c'ӟ#/ !66f;0 @A´OjU |#hxOJP8K^~i {Tېks}QX=Z<+8õRyOΪ*`߁,v% 1خ_ʩ\2&oyLWH.f* b?<d+?\2) k %PO/m4Ww46Do1V]xvMc)F;5-8PVgb?OU% k8Mۭ nQC"s7& |GO:\ab鄭[<>U"N6ǍnW =\rؔXt XPه338Ghy h}Y*i7- 6z-']"4ePZ K 0te7rd{@' "~z:U%̉6U,#]vkq7G4y MꙞe+G49[Ts@%4ȯt]ãF8-iXҰPXV2JB'M?E4+2 fDoMn/[FMݴE :!&POcӺ mNc8 }Jˢ1OsDq#eB0G$zI(e kXDoL~2uF?U8:?r:e" G_ XN]JDrjI覮pה]&½s;0]C{Hu>Fn`oAtŹiЅ64wH⑾]h. ڜ:16(_𢖚v)~{KQKRXҤћA?@brd d<6؊le*# -ZϺvqC=&f e-jxV:igsu̖Jy}k{j, Mz+w({t5B]~`_^!͈|cH!sDBRՖHc ݺjA9AtU@>Vz5Alׯn EJ|P)fl؝Q#IwrlH)7;yNNg< F7kҾѥRգȎ.Jˋ.+:VD$D1 WxwGʯDo^++7(>fu '8 W.Xv-? ë105PrG'@%!M)0"$5S)&DN\ΧCBA j *e n*i|گQFX~mv!嘸(Mfl'R"^/%fEEwJЩIE3'ǥ1Y>^.inM9#f)6붜0L`TS}nj+ ,:MR\$bY+41;^H9ћ92}PBPRٔCʬ@vQ(QW"@e81Zɾ?6rp6dXr?')<'HyDf^ip4%qP4b\PH)jǦx !fj1v;b7T}?u;xټ $o][6eG}c>ߏFs8?hNl#|Xѱж4{&}EROnU2cpv'dD! W i}8 N ϋS}х-پ|>&?Zu.9T03Tޞu-㞵Gu7QZrhA?5YqG0[ڟHq*3d,RcdA"ƌPqgF+%ɩ?ƙdO/vp ŕ&_d\,ek$H#b&-Զ΂d>7{ wcy4MgL;KL0%a|y4f+K~O?T*+o+WTp(bSgɭsdfm-o+{9@9ٺ4p^:z ϯp+ښC,{mSo&z@2]~\sf[~&s!r,oZvin-ʸt U<9byhQ$AS9-!(Rv5pK]mWh޾۫Y̾:K`ñ%˝H~&+ˁ+L$Oq]88i|\OcvGA:rpxp]kC(x8C*B@\H;.T>{`7T.}QtїGS𳷡N+HV XGJ%xD{vh[^/}1|@ dQĀqהmFR}>2dTpH(flE^sE::F:},Uבvlpɚ<*3˘iEnIݴH3M -={|'fWx&sC:śdyFHo?<6Fe~^Xg.)PV S$IfP0t͒j)>E Qh3@|5dMVf=c~}VɰZq׽AH` z];xKF60tp\SRVA% z܏58mU-#e#%{_rJ?зR%hs"7vRdi3*Iþz9I~uSzߘ23K8Y"T:œ?|}{5ύȑ99>캞]d1l槜SşcߓhZiĵg[}&BVфs ! v\s=&b1iRq)m{ ^ܐ)]_4j-[aZvಿz$oo_ÎBTдL$ 4`$ODXLo @ے>v%5F^G:8˙,!&_̞bqvƟ:nR|I> endobj 257 0 obj << /Length1 1647 /Length2 9129 /Length3 0 /Length 9965 /Filter /FlateDecode >> stream xڭweX\ݒ5k ܂; 4 M ; 4Hpn;w?yήkU^f搶X!`'@ dqRphmݔ`gQ `Y Paaa F  XtXi`d 0=:B`3Q# a`QP(@sn + vl P l S+3+ == v3ru}\P 0 `lf'g 䯄N3j9Q5dfg  6;!VnJ {yFa +e X\-_Ga^>&_D<\Z 7'77+[A6lzi[Aϊ5 +Kz0 VijҜY.:|JH_Z21-Ώo^n v82w(}YWٶLNfT֐ nhj=Pܰӿ'bvJ#nǫ#{s74 {c:o>mzYg;a}. "S~ן"huk݂]=K;qz@eCw|5}U)f.7e*݌wWuSX^e*y[Y5/h-Qebj_vl{A=ϛ茡U+1J@Z#qU,VE{H>>~ZRۆKbf)~!C<)>rx3&|Yˋ&B*?ysZY7 0T)M(z$ݗi,#% ES)~J.B|SenE QTQ1(]ܜ죄z>E5Y%AѲ %z68"fʒpO\Z"=J)dX$bmp{FSpl :QcN}ݕ]h>g/fXI4h0ЏJ`w{f2K E-8seϣari ~ߙ?#}k,, tjt@_*<+(ܶTH8|ӬLiN{[zeQaIZx?Mk1kyqtcUCs /7.ۛδkjL*T5 ᘖQ IQc2m;`u!+YL,Qμw [k?=hty=S>iR,}+}k`LDvWug1 P"g.Uho 9@ۆ ld˞9ތ~.^u fO=`,< PFl<v>=\ovG 27~h~^{țSi Lkzj7{+n/.&(e谉0:rP4TpTv]VÓ2\褣pG݃\VA惨gpS۴iO ߜΩUx$ zuDQܜ&\:"-ƍ`Q<&^$Z3jF@_5ODaqX~l˙bL.1;aWm1cѵeq㨑}t$hZq.sq߇V9Զ~{䋸12b+!b474K(or׶W:w'fԅ0p}"t~*Ekz%؛|P\z ;|t$Ezz+lj!M"}/^`t,SGꋡ >C5h.WM\n•hI3gf G֎Q7 :I!*()SbL'Ry5\t$,(:v]f D84.Ḡ9"Pq2J4bΞI~Vן#]U LlV"E۶ PNĒ__#QGEwcƝT1k|{b!&6/-Yw(}3;A46uocdX$n٥=q)+ 3c GFӒyp.Oue꼌종f9`|W޺\-OVF4*tPo2~~Rۜs~~`,LpnSG+^ȣGjqiU"0p>*0 y soԎuPokg=HXxئ0$h .mWcXWǶ[1*<檓j;o>'TSr/X}>өȘS 7nptȪNV,RXe.9튾8b 3f;jyyOݯCWYC9R"DזadE(Apw? d͋5 zuotP׿NRm婿+`6oA~?$ۥX=rF1Г,H#hkCx 3($'HW:͢/tA`?QO uB=V,P}1W'Xy GQmzbG$!g!oΖv]$]\JD+|X/GB)8WCUFm9["X?vhTVݔUSa}"Q- d/|x!D; L)qU6( gNڟwZlzd?݊'ytvխjwa HEQ*IWȢka2-ۯ~QWw ,f)<3#c˫NI,yM[;sE|l,bYK&f;g U9+lF5'';T1:±URj#_*_$Ymo*(=Fpeq}##VdYیۛEK_h]ʫe/DEq9ks.x+cj(}]$jpImrs2{4U)XDn+< ~ē=L$r/57ӒLNv<?fE>hjuE%$/ՍPXlk,@;6씝߳yeVYrlW^DiV!?*X!VZui2!cq`JM4bC 7[ U˦Up}/ ,0wb*4G("C?iDBfֱ ˨ijx 5j'^ֻX}:Tȭc,SMe6 F!n^Z&a T9=Z&e#t ?I [:( D,^q* KViW|ULVItw {~ЬEN)cAKד(FVVEs0R\9?AV1:-귔w+P6!IJf\< f}<7r9Jۣ'kq$HiDy qoDޓ2aȾhPf0Ux,twDEs[ʬVw?ObL>ԃFiQ/[wy2IJKkxҞD!Q𼓁gYܬ@6Z8ZOwAp<@ԑ"Od0=6@CʮG? %jB :|]!_iy"DgvmDjK "J -zdҷB5-.߄ae亭 )؉i*("Fe{zea*ˉ7G+2Ĉa<.ZI.‡>ʖl/!R/a`|/@QмCuARQa@T9gmt5jG!?Wېcgy'1*3ײxV=m<} 4d!{Xzȥ^C' o'^WE(@mc -~R5 K\YNs`$Q׌vNY7xo_Mpa2Y`}:8wLmЇLj[Ϗa>:{E}|1xH'G92jJ&HP;p׷8T UT]F`I\"Pg~B!UZhS5ڻzm;^=:bb t)Xí*ʯrLԡ qL,Oޝj{Gxl2N&2k7#CH e(n/{poGvpX۟$-Hܤf4FFo*;IVį4ULpq 9[D,|?I& iX-6*y쭙Uiٴl/靪\,c(sÈU/*vMi]먠YZEJK8`z(̴]qS7ѐ3j m}l U~H  " O$ckp%͙l>]Ga 4F A/Uč .'2DD0j[B ~/j%67GT~=G`c5/uF-HVC_ոl j[sݓ>?HR8$8#YTb^ 5~6݃`#UhcE4jEJo4BQL:d}+gԫ(Q 8n2+_i4r?T߾$AT^gdpeq.[k![>b[V] -?h(;Qmzu+AQvNxۅRlakſͯ=< ߱[>}Kl-ȝ$t)M1g .α#C# =oᣕ酽>1v"Kt0^ W Dȕt4Z0Zf,zs+fd3'-( pa[ssK[OĠSyv4Biϭv;y7UҿqFMąjb O %LOrݪwB.}'anR&ÚX (X>|n5+3w*R(N&C'zeom'1pٺK+ЫbB%R-D{\jLL&=QkmW.J;IAZ#Av kɤƏx?ܲy,pNmu(;/l(GI r$DA*:t._:?}i_g̪I0 y)xgL,}~kp"`a>A+e" v"![ݎ~fG h+m0^) W1N [_UFfOʷd鈧&cN*&XݯkhM*$+l OA 2,x,R~2CG:hć,Q?e9VJ(~ST0 <}Ma|6f/3Ōȁ~ڱA ܋6\y+=W=>i̝nefB#Ֆ_H;f{Kan=ՙ!0-e,c]`\&[~hyeZy7(!xlteP:&5kC*ReT{pAe5 z9v/{F.ЌD~ >/14LVG@iv> JmKɆ_K0a3U_*F[[y[vxw쨃$7R|BfI,KBN(pSk]J̛jR=k8HM_b!|4w2 (eҿ*;zƒ.҈,3)hTڻkF 4ژڣv3!#j\ӦpBPKNq0d|xW5D 1cep8hlP8j.!"]tJBf"Ǣ}qe6pBF$]w8+mp7>K+3=:6imsL*+;t fn5~Rp}KK?(eQ8͗˱L1F9xk\{!1>C5Ý @~ExkS2 uE熢~ b9DgGkiAKݏcnV*|ɔ+Ƙ 5wps+cujީhb) )Q9>:j FFW"1oX\+YwW1XV5/RDZZ1h1egIW] }}Ǹ&Sf!`Q`d^F VNJ1;u+hit\7^o&)—00Pj{Ma+ov"PToC droyMa[3.tkᠲU$ݦoBxK$(Xb3KQ| = - ~;N'#4qTAҷ'r}˫i5b͵=#f3BH7kEVU1ƾի 5YkaEZ"!4?%!d[&YRqJ] x!!dzx@m^p-߃yv(.@v6xTRiJ]_~zlz%,$P,\rs_Zeо(f|ka+Q*>A]/^xrG79$_J]rSd$f~#WքQ{}*O=t~Zx w}6,'cjD/UCGޙ'ã+KH :Zq*>x T1 qb 8p:w]aV_0oZDAǷ% 7^;&uQj]rF Jeq 1RcD1[:A|v&fC[.r椞e]k!BGIJ)lծ}__[vHrO-W *?2]^ d1hQfsAerPnOԨ?|:7kd&ɢNc;nEy'gqvYD70m) E@gB2Kpp>pݯRq&8:v? endstream endobj 258 0 obj << /Type /FontDescriptor /FontName /XJSVMM+NimbusRomNo9L-ReguItal /Flags 4 /FontBBox [-169 -270 1010 924] /Ascent 669 /CapHeight 669 /Descent -193 /ItalicAngle -15 /StemV 78 /XHeight 441 /CharSet (/A/H/P/T/a/b/c/d/e/five/four/g/h/hyphen/i/l/m/n/o/one/p/r/s/t/u/underscore/x/y/z) /FontFile 257 0 R >> endobj 235 0 obj << /Type /Encoding /Differences [2/fi 33/exclam/quotedbl/numbersign/dollar/percent/ampersand/quoteright/parenleft/parenright 43/plus/comma/hyphen/period/slash/zero/one/two/three/four/five/six/seven/eight/nine/colon 60/less/equal/greater 65/A/B/C/D/E/F/G/H/I 76/L/M/N/O/P 82/R/S/T/U/V/W 89/Y 91/bracketleft 93/bracketright 95/underscore 97/a/b/c/d/e/f/g/h/i 107/k/l/m/n/o/p/q/r/s/t/u/v/w/x/y/z/braceleft/bar/braceright/asciitilde 149/bullet 151/emdash] >> endobj 216 0 obj << /Type /Font /Subtype /Type1 /BaseFont /TPKZYA+LCIRCLE10 /FontDescriptor 244 0 R /FirstChar 118 /LastChar 118 /Widths 234 0 R >> endobj 90 0 obj << /Type /Font /Subtype /Type1 /BaseFont /ISIUBK+NimbusMonL-Regu /FontDescriptor 246 0 R /FirstChar 33 /LastChar 126 /Widths 236 0 R /Encoding 235 0 R >> endobj 54 0 obj << /Type /Font /Subtype /Type1 /BaseFont /UVSUMP+NimbusSanL-Bold /FontDescriptor 248 0 R /FirstChar 46 /LastChar 121 /Widths 240 0 R /Encoding 235 0 R >> endobj 52 0 obj << /Type /Font /Subtype /Type1 /BaseFont /JBYVZZ+NimbusSanL-Regu /FontDescriptor 250 0 R /FirstChar 2 /LastChar 151 /Widths 241 0 R /Encoding 235 0 R >> endobj 89 0 obj << /Type /Font /Subtype /Type1 /BaseFont /ARAVRM+NimbusSanL-ReguItal /FontDescriptor 252 0 R /FirstChar 45 /LastChar 121 /Widths 237 0 R /Encoding 235 0 R >> endobj 76 0 obj << /Type /Font /Subtype /Type1 /BaseFont /XDUZLI+NimbusRomNo9L-Medi /FontDescriptor 254 0 R /FirstChar 49 /LastChar 121 /Widths 239 0 R /Encoding 235 0 R >> endobj 51 0 obj << /Type /Font /Subtype /Type1 /BaseFont /DZYHTV+NimbusRomNo9L-Regu /FontDescriptor 256 0 R /FirstChar 2 /LastChar 149 /Widths 242 0 R /Encoding 235 0 R >> endobj 84 0 obj << /Type /Font /Subtype /Type1 /BaseFont /XJSVMM+NimbusRomNo9L-ReguItal /FontDescriptor 258 0 R /FirstChar 45 /LastChar 122 /Widths 238 0 R /Encoding 235 0 R >> endobj 55 0 obj << /Type /Pages /Count 6 /Parent 259 0 R /Kids [46 0 R 58 0 R 73 0 R 81 0 R 95 0 R 115 0 R] >> endobj 229 0 obj << /Type /Pages /Count 2 /Parent 259 0 R /Kids [172 0 R 231 0 R] >> endobj 259 0 obj << /Type /Pages /Count 8 /Kids [55 0 R 229 0 R] >> endobj 260 0 obj << /Type /Outlines /First 3 0 R /Last 31 0 R /Count 5 >> endobj 43 0 obj << /Title 44 0 R /A 41 0 R /Parent 31 0 R /Prev 39 0 R >> endobj 39 0 obj << /Title 40 0 R /A 37 0 R /Parent 31 0 R /Prev 35 0 R /Next 43 0 R >> endobj 35 0 obj << /Title 36 0 R /A 33 0 R /Parent 31 0 R /Next 39 0 R >> endobj 31 0 obj << /Title 32 0 R /A 29 0 R /Parent 260 0 R /Prev 27 0 R /First 35 0 R /Last 43 0 R /Count -3 >> endobj 27 0 obj << /Title 28 0 R /A 25 0 R /Parent 260 0 R /Prev 23 0 R /Next 31 0 R >> endobj 23 0 obj << /Title 24 0 R /A 21 0 R /Parent 260 0 R /Prev 7 0 R /Next 27 0 R >> endobj 19 0 obj << /Title 20 0 R /A 17 0 R /Parent 7 0 R /Prev 15 0 R >> endobj 15 0 obj << /Title 16 0 R /A 13 0 R /Parent 7 0 R /Prev 11 0 R /Next 19 0 R >> endobj 11 0 obj << /Title 12 0 R /A 9 0 R /Parent 7 0 R /Next 15 0 R >> endobj 7 0 obj << /Title 8 0 R /A 5 0 R /Parent 260 0 R /Prev 3 0 R /Next 23 0 R /First 11 0 R /Last 19 0 R /Count -3 >> endobj 3 0 obj << /Title 4 0 R /A 1 0 R /Parent 260 0 R /Next 7 0 R >> endobj 261 0 obj << /Names [(Doc-Start) 53 0 R (Item.1) 86 0 R (Item.2) 87 0 R (_block_attributes) 98 0 R (_docbook_outputs) 85 0 R (_examples) 100 0 R] /Limits [(Doc-Start) (_examples)] >> endobj 262 0 obj << /Names [(_gnu_source_highlight) 91 0 R (_highlight) 92 0 R (_html_outputs) 88 0 R (_numbered_source_code_listing_with_callouts) 149 0 R (_pygments) 93 0 R (_source_code_paragraphs) 101 0 R] /Limits [(_gnu_source_highlight) (_source_code_paragraphs)] >> endobj 263 0 obj << /Names [(_testing) 99 0 R (_unnumbered_source_code_listing) 125 0 R (cocnt.1) 215 0 R (cocnt.2) 224 0 R (lstlisting.-1) 102 0 R (lstlisting.-2) 118 0 R] /Limits [(_testing) (lstlisting.-2)] >> endobj 264 0 obj << /Names [(lstlisting.-3) 120 0 R (lstlisting.-4) 122 0 R (lstlisting.-5) 126 0 R (lstlisting.-6) 139 0 R (lstlisting.-7) 150 0 R (lstlisting.-8) 195 0 R] /Limits [(lstlisting.-3) (lstlisting.-8)] >> endobj 265 0 obj << /Names [(lstnumber.-1.1) 103 0 R (lstnumber.-1.10) 112 0 R (lstnumber.-1.11) 113 0 R (lstnumber.-1.2) 104 0 R (lstnumber.-1.3) 105 0 R (lstnumber.-1.4) 106 0 R] /Limits [(lstnumber.-1.1) (lstnumber.-1.4)] >> endobj 266 0 obj << /Names [(lstnumber.-1.5) 107 0 R (lstnumber.-1.6) 108 0 R (lstnumber.-1.7) 109 0 R (lstnumber.-1.8) 110 0 R (lstnumber.-1.9) 111 0 R (lstnumber.-2.1) 119 0 R] /Limits [(lstnumber.-1.5) (lstnumber.-2.1)] >> endobj 267 0 obj << /Names [(lstnumber.-3.1) 121 0 R (lstnumber.-4.1) 123 0 R (lstnumber.-4.2) 124 0 R (lstnumber.-5.1) 127 0 R (lstnumber.-5.10) 136 0 R (lstnumber.-5.11) 137 0 R] /Limits [(lstnumber.-3.1) (lstnumber.-5.11)] >> endobj 268 0 obj << /Names [(lstnumber.-5.12) 138 0 R (lstnumber.-5.2) 128 0 R (lstnumber.-5.3) 129 0 R (lstnumber.-5.4) 130 0 R (lstnumber.-5.5) 131 0 R (lstnumber.-5.6) 132 0 R] /Limits [(lstnumber.-5.12) (lstnumber.-5.6)] >> endobj 269 0 obj << /Names [(lstnumber.-5.7) 133 0 R (lstnumber.-5.8) 134 0 R (lstnumber.-5.9) 135 0 R (lstnumber.-6.1) 140 0 R (lstnumber.-6.2) 141 0 R (lstnumber.-6.3) 142 0 R] /Limits [(lstnumber.-5.7) (lstnumber.-6.3)] >> endobj 270 0 obj << /Names [(lstnumber.-6.4) 143 0 R (lstnumber.-6.5) 144 0 R (lstnumber.-6.6) 145 0 R (lstnumber.-6.7) 146 0 R (lstnumber.-6.8) 147 0 R (lstnumber.-6.9) 148 0 R] /Limits [(lstnumber.-6.4) (lstnumber.-6.9)] >> endobj 271 0 obj << /Names [(lstnumber.-7.1) 151 0 R (lstnumber.-7.10) 160 0 R (lstnumber.-7.11) 161 0 R (lstnumber.-7.12) 162 0 R (lstnumber.-7.13) 163 0 R (lstnumber.-7.14) 164 0 R] /Limits [(lstnumber.-7.1) (lstnumber.-7.14)] >> endobj 272 0 obj << /Names [(lstnumber.-7.15) 165 0 R (lstnumber.-7.16) 166 0 R (lstnumber.-7.17) 175 0 R (lstnumber.-7.18) 176 0 R (lstnumber.-7.19) 177 0 R (lstnumber.-7.2) 152 0 R] /Limits [(lstnumber.-7.15) (lstnumber.-7.2)] >> endobj 273 0 obj << /Names [(lstnumber.-7.20) 178 0 R (lstnumber.-7.21) 179 0 R (lstnumber.-7.22) 180 0 R (lstnumber.-7.23) 181 0 R (lstnumber.-7.24) 182 0 R (lstnumber.-7.25) 183 0 R] /Limits [(lstnumber.-7.20) (lstnumber.-7.25)] >> endobj 274 0 obj << /Names [(lstnumber.-7.26) 184 0 R (lstnumber.-7.27) 185 0 R (lstnumber.-7.28) 186 0 R (lstnumber.-7.29) 187 0 R (lstnumber.-7.3) 153 0 R (lstnumber.-7.30) 188 0 R] /Limits [(lstnumber.-7.26) (lstnumber.-7.30)] >> endobj 275 0 obj << /Names [(lstnumber.-7.31) 189 0 R (lstnumber.-7.32) 190 0 R (lstnumber.-7.33) 191 0 R (lstnumber.-7.34) 192 0 R (lstnumber.-7.35) 193 0 R (lstnumber.-7.36) 194 0 R] /Limits [(lstnumber.-7.31) (lstnumber.-7.36)] >> endobj 276 0 obj << /Names [(lstnumber.-7.4) 154 0 R (lstnumber.-7.5) 155 0 R (lstnumber.-7.6) 156 0 R (lstnumber.-7.7) 157 0 R (lstnumber.-7.8) 158 0 R (lstnumber.-7.9) 159 0 R] /Limits [(lstnumber.-7.4) (lstnumber.-7.9)] >> endobj 277 0 obj << /Names [(lstnumber.-8.1) 196 0 R (lstnumber.-8.10) 205 0 R (lstnumber.-8.11) 206 0 R (lstnumber.-8.12) 207 0 R (lstnumber.-8.13) 208 0 R (lstnumber.-8.14) 209 0 R] /Limits [(lstnumber.-8.1) (lstnumber.-8.14)] >> endobj 278 0 obj << /Names [(lstnumber.-8.15) 210 0 R (lstnumber.-8.16) 211 0 R (lstnumber.-8.17) 212 0 R (lstnumber.-8.18) 213 0 R (lstnumber.-8.19) 214 0 R (lstnumber.-8.2) 197 0 R] /Limits [(lstnumber.-8.15) (lstnumber.-8.2)] >> endobj 279 0 obj << /Names [(lstnumber.-8.20) 217 0 R (lstnumber.-8.21) 218 0 R (lstnumber.-8.22) 219 0 R (lstnumber.-8.23) 220 0 R (lstnumber.-8.24) 221 0 R (lstnumber.-8.25) 222 0 R] /Limits [(lstnumber.-8.20) (lstnumber.-8.25)] >> endobj 280 0 obj << /Names [(lstnumber.-8.26) 223 0 R (lstnumber.-8.27) 225 0 R (lstnumber.-8.28) 226 0 R (lstnumber.-8.29) 227 0 R (lstnumber.-8.3) 198 0 R (lstnumber.-8.30) 228 0 R] /Limits [(lstnumber.-8.26) (lstnumber.-8.30)] >> endobj 281 0 obj << /Names [(lstnumber.-8.4) 199 0 R (lstnumber.-8.5) 200 0 R (lstnumber.-8.6) 201 0 R (lstnumber.-8.7) 202 0 R (lstnumber.-8.8) 203 0 R (lstnumber.-8.9) 204 0 R] /Limits [(lstnumber.-8.4) (lstnumber.-8.9)] >> endobj 282 0 obj << /Names [(page.1) 83 0 R (page.2) 97 0 R (page.3) 117 0 R (page.4) 174 0 R (page.5) 233 0 R (page.i) 50 0 R] /Limits [(page.1) (page.i)] >> endobj 283 0 obj << /Names [(page.ii) 60 0 R (page.iii) 75 0 R (section.1) 2 0 R (section.2) 6 0 R (section.3) 22 0 R (section.4) 26 0 R] /Limits [(page.ii) (section.4)] >> endobj 284 0 obj << /Names [(section.5) 30 0 R (subsection.2.1) 10 0 R (subsection.2.2) 14 0 R (subsection.2.3) 18 0 R (subsection.5.1) 34 0 R (subsection.5.2) 38 0 R] /Limits [(section.5) (subsection.5.2)] >> endobj 285 0 obj << /Names [(subsection.5.3) 42 0 R] /Limits [(subsection.5.3) (subsection.5.3)] >> endobj 286 0 obj << /Kids [261 0 R 262 0 R 263 0 R 264 0 R 265 0 R 266 0 R] /Limits [(Doc-Start) (lstnumber.-2.1)] >> endobj 287 0 obj << /Kids [267 0 R 268 0 R 269 0 R 270 0 R 271 0 R 272 0 R] /Limits [(lstnumber.-3.1) (lstnumber.-7.2)] >> endobj 288 0 obj << /Kids [273 0 R 274 0 R 275 0 R 276 0 R 277 0 R 278 0 R] /Limits [(lstnumber.-7.20) (lstnumber.-8.2)] >> endobj 289 0 obj << /Kids [279 0 R 280 0 R 281 0 R 282 0 R 283 0 R 284 0 R] /Limits [(lstnumber.-8.20) (subsection.5.2)] >> endobj 290 0 obj << /Kids [285 0 R] /Limits [(subsection.5.3) (subsection.5.3)] >> endobj 291 0 obj << /Kids [286 0 R 287 0 R 288 0 R 289 0 R 290 0 R] /Limits [(Doc-Start) (subsection.5.3)] >> endobj 292 0 obj << /Dests 291 0 R >> endobj 293 0 obj << /Type /Catalog /Pages 259 0 R /Outlines 260 0 R /Names 292 0 R /PageMode/UseOutlines/PageLabels<>3<>]>> /OpenAction 45 0 R >> endobj 294 0 obj << /Author()/Title(Source Code Highlight Filter)/Subject()/Creator(DBLaTeX-0.3.2-2)/Producer(pdfTeX-1.40.10)/Keywords() /CreationDate (D:20131106160618+13'00') /ModDate (D:20131106160618+13'00') /Trapped /False /PTEX.Fullbanner (This is pdfTeX, Version 3.1415926-1.40.10-2.2 (TeX Live 2009/Debian) kpathsea version 5.0.0) >> endobj xref 0 295 0000000167 65535 f 0000000015 00000 n 0000008683 00000 n 0000114745 00000 n 0000000060 00000 n 0000000093 00000 n 0000008918 00000 n 0000114624 00000 n 0000000138 00000 n 0000000168 00000 n 0000009035 00000 n 0000114552 00000 n 0000000218 00000 n 0000000257 00000 n 0000009153 00000 n 0000114466 00000 n 0000000308 00000 n 0000000336 00000 n 0000009271 00000 n 0000114393 00000 n 0000000387 00000 n 0000000414 00000 n 0000011592 00000 n 0000114306 00000 n 0000000460 00000 n 0000000495 00000 n 0000011710 00000 n 0000114218 00000 n 0000000541 00000 n 0000000567 00000 n 0000011826 00000 n 0000114106 00000 n 0000000613 00000 n 0000000640 00000 n 0000011943 00000 n 0000114032 00000 n 0000000691 00000 n 0000000732 00000 n 0000015954 00000 n 0000113945 00000 n 0000000783 00000 n 0000000832 00000 n 0000017475 00000 n 0000113871 00000 n 0000000883 00000 n 0000000944 00000 n 0000001325 00000 n 0000001440 00000 n 0000002024 00000 n 0000000995 00000 n 0000001905 00000 n 0000113184 00000 n 0000112668 00000 n 0000001965 00000 n 0000112498 00000 n 0000113533 00000 n 0000001805 00000 n 0000002913 00000 n 0000002738 00000 n 0000002161 00000 n 0000002853 00000 n 0000003842 00000 n 0000003992 00000 n 0000004142 00000 n 0000004295 00000 n 0000004450 00000 n 0000004605 00000 n 0000004755 00000 n 0000004905 00000 n 0000005055 00000 n 0000005208 00000 n 0000005363 00000 n 0000005577 00000 n 0000003638 00000 n 0000003007 00000 n 0000005517 00000 n 0000113011 00000 n 0000008065 00000 n 0000008253 00000 n 0000008458 00000 n 0000009389 00000 n 0000007917 00000 n 0000005683 00000 n 0000008623 00000 n 0000113356 00000 n 0000008741 00000 n 0000008800 00000 n 0000008859 00000 n 0000008976 00000 n 0000112837 00000 n 0000112328 00000 n 0000009094 00000 n 0000009212 00000 n 0000009330 00000 n 0000012774 00000 n 0000011417 00000 n 0000009519 00000 n 0000011532 00000 n 0000011651 00000 n 0000011769 00000 n 0000011884 00000 n 0000012001 00000 n 0000012061 00000 n 0000012120 00000 n 0000012180 00000 n 0000012239 00000 n 0000012299 00000 n 0000012359 00000 n 0000012419 00000 n 0000012479 00000 n 0000012539 00000 n 0000012599 00000 n 0000012659 00000 n 0000012719 00000 n 0000018630 00000 n 0000015348 00000 n 0000012904 00000 n 0000015466 00000 n 0000015528 00000 n 0000015589 00000 n 0000015650 00000 n 0000015710 00000 n 0000015771 00000 n 0000015832 00000 n 0000015893 00000 n 0000016014 00000 n 0000016074 00000 n 0000016135 00000 n 0000016196 00000 n 0000016257 00000 n 0000016318 00000 n 0000016378 00000 n 0000016439 00000 n 0000016500 00000 n 0000016561 00000 n 0000016622 00000 n 0000016683 00000 n 0000016744 00000 n 0000016805 00000 n 0000016866 00000 n 0000016927 00000 n 0000016988 00000 n 0000017049 00000 n 0000017110 00000 n 0000017170 00000 n 0000017231 00000 n 0000017292 00000 n 0000017353 00000 n 0000017414 00000 n 0000017535 00000 n 0000017596 00000 n 0000017657 00000 n 0000017718 00000 n 0000017779 00000 n 0000017839 00000 n 0000017900 00000 n 0000017961 00000 n 0000018022 00000 n 0000018083 00000 n 0000018144 00000 n 0000018205 00000 n 0000018266 00000 n 0000018327 00000 n 0000018387 00000 n 0000018448 00000 n 0000018509 00000 n 0000018570 00000 n 0000000169 00000 f 0000021477 00000 n 0000000000 00000 f 0000021624 00000 n 0000025061 00000 n 0000021330 00000 n 0000018737 00000 n 0000021772 00000 n 0000021834 00000 n 0000021895 00000 n 0000021956 00000 n 0000022017 00000 n 0000022078 00000 n 0000022139 00000 n 0000022199 00000 n 0000022260 00000 n 0000022321 00000 n 0000022382 00000 n 0000022443 00000 n 0000022504 00000 n 0000022565 00000 n 0000022626 00000 n 0000022687 00000 n 0000022747 00000 n 0000022808 00000 n 0000022869 00000 n 0000022930 00000 n 0000022991 00000 n 0000023052 00000 n 0000023113 00000 n 0000023174 00000 n 0000023235 00000 n 0000023296 00000 n 0000023357 00000 n 0000023418 00000 n 0000023479 00000 n 0000023539 00000 n 0000023600 00000 n 0000023661 00000 n 0000023722 00000 n 0000023783 00000 n 0000023844 00000 n 0000023905 00000 n 0000023966 00000 n 0000024027 00000 n 0000024087 00000 n 0000024148 00000 n 0000024209 00000 n 0000024270 00000 n 0000112180 00000 n 0000024332 00000 n 0000024393 00000 n 0000024454 00000 n 0000024515 00000 n 0000024576 00000 n 0000024637 00000 n 0000024694 00000 n 0000024755 00000 n 0000024817 00000 n 0000024878 00000 n 0000024939 00000 n 0000025000 00000 n 0000113644 00000 n 0000026042 00000 n 0000025861 00000 n 0000025180 00000 n 0000025980 00000 n 0000026149 00000 n 0000111708 00000 n 0000026172 00000 n 0000026567 00000 n 0000026895 00000 n 0000027226 00000 n 0000027538 00000 n 0000027861 00000 n 0000028439 00000 n 0000029006 00000 n 0000030967 00000 n 0000031188 00000 n 0000047532 00000 n 0000048064 00000 n 0000058278 00000 n 0000058618 00000 n 0000067547 00000 n 0000067968 00000 n 0000072805 00000 n 0000073080 00000 n 0000084593 00000 n 0000084914 00000 n 0000100886 00000 n 0000101306 00000 n 0000111391 00000 n 0000113729 00000 n 0000113797 00000 n 0000114816 00000 n 0000115006 00000 n 0000115279 00000 n 0000115492 00000 n 0000115710 00000 n 0000115938 00000 n 0000116164 00000 n 0000116393 00000 n 0000116621 00000 n 0000116847 00000 n 0000117073 00000 n 0000117305 00000 n 0000117537 00000 n 0000117771 00000 n 0000118004 00000 n 0000118238 00000 n 0000118464 00000 n 0000118696 00000 n 0000118928 00000 n 0000119162 00000 n 0000119395 00000 n 0000119621 00000 n 0000119780 00000 n 0000119953 00000 n 0000120163 00000 n 0000120263 00000 n 0000120381 00000 n 0000120504 00000 n 0000120628 00000 n 0000120752 00000 n 0000120835 00000 n 0000120945 00000 n 0000120983 00000 n 0000121150 00000 n trailer << /Size 295 /Root 293 0 R /Info 294 0 R /ID [<0730A41E0415501B143A4A1C319E5548> <0730A41E0415501B143A4A1C319E5548>] >> startxref 121492 %%EOF asciidoc-8.6.9/doc/a2x.1.txt0000664000175100017510000002701512076105604015631 0ustar srackhamsrackhamA2X(1) ====== :doctype: manpage NAME ---- a2x - A toolchain manager for AsciiDoc (converts Asciidoc text files to other file formats) SYNOPSIS -------- *a2x* ['OPTIONS'] 'SOURCE_FILE' DESCRIPTION ----------- A DocBook toolchain manager that translates an AsciiDoc text file 'SOURCE_FILE' to PDF, EPUB, DVI, PS, LaTeX, XHTML (single page or chunked), man page, HTML Help or plain text formats using 'asciidoc(1)' and other applications (see <>). 'SOURCE_FILE' can also be a DocBook file with an .xml extension. OPTIONS ------- *-a, --attribute*='ATTRIBUTE':: Set asciidoc(1) attribute value (shortcut for *--asciidoc-opts*='"-a ATTRIBUTE"' option). This option may be specified more than once. *--asciidoc-opts*='ASCIIDOC_OPTS':: Additional 'asciidoc(1)' options. This option may be specified more than once. *--conf-file*='CONF_FILE':: Load configuration file. See <>. *-D, --destination-dir*='DESTINATION_DIR':: Output directory. Defaults to 'SOURCE_FILE' directory. This option is only applicable to HTML based output formats ('chunked', 'epub', 'htmlhelp', 'xhtml'). *-d, --doctype*='DOCTYPE':: DocBook document type: 'article', 'manpage' or 'book'. Default document type is 'article' unless the format is 'manpage' (in which case it defaults to 'manpage'). *-b, --backend*='BACKEND':: 'BACKEND' is the name of an installed backend plugin. When this option is specified 'a2x' attempts load a file name 'a2x-backend.py' from the 'BACKEND' plugin directory It then converts the 'SOURCE_FILE' to a 'BACKEND' formatted output file using a global function defined in 'a2x-backend.py' called 'to_BACKEND'. *-f, --format*='FORMAT':: Output formats: 'chunked', 'docbook', 'dvi', 'epub', 'htmlhelp', 'manpage', 'pdf' (default), 'ps', 'tex', 'text', 'xhtml'. The AsciiDoc 'a2x-format' attribute value is set to 'FORMAT'. *-h, --help*:: Print command-line syntax and program options to stdout. *--icons*:: Use admonition or navigation icon images in output documents. The default behavior is to use text in place of icons. *--icons-dir*='PATH':: A path (relative to output files) containing admonition and navigation icons. Defaults to `images/icons`. The '--icons' option is implicit if this option is used. *-k, --keep-artifacts*:: Do not delete temporary build files. *--lynx*:: Use 'lynx(1)' to generate text formatted output. The default behavior is to use 'w3m(1)'. *-L, --no-xmllint*:: Do not check asciidoc output with 'xmllint(1)'. *---epubcheck*:: Check EPUB output with 'epubcheck(1)'. *-n, --dry-run*:: Do not do anything just print what would have been done. *-r, --resource*='RESOURCE_SPEC':: Specify a resource. This option may be specified more than once. See the <> section for more details. *-m, --resource-manifest*='FILE':: 'FILE' contains a list resources (one per line). Manifest 'FILE' entries are formatted just like *--resource* option arguments. Environment variables and tilde home directories are allowed. *--stylesheet*='STYLESHEET':: A space delimited list of one or more CSS stylesheet file names that are used to style HTML output generated by DocBook XSL Stylesheets. Defaults to 'docbook-xsl.css'. The stylesheets are processed in list order. The stylesheets must reside in a valid <> location. Applies to HTML formats: 'xhtml', 'epub', 'chunked', 'htmlhelp' formats. *-v, --verbose*:: Print operational details to stderr. A second *-v* option applies the verbose option to toolchain commands. *--version*:: Print program version to stdout. *--xsltproc-opts*='XSLTPROC_OPTS':: Additional 'xsltproc(1)' options. This option may be specified more than once. *--xsl-file*='XSL_FILE':: Override the built-in XSL stylesheet with the custom XSL stylesheet 'XSL_FILE'. *--fop*:: Use FOP to generate PDFs. The default behavior is to use 'dblatex(1)'. The '--fop' option is implicit if this option is used. *--fop-opts*='FOP_OPTS':: Additional 'fop(1)' options. If this option is specified FOP is used to generate PDFs. This option may be specified more than once. *--dblatex-opts*='DBLATEX_OPTS':: Additional 'dblatex(1)' options. This option may be specified more than once. *--backend-opts*='BACKEND_OPTS':: Options for the backend plugin specified by the '--backend' option. This option may be specified more than once. Options can also be set in the AsciiDoc source file. If 'SOURCE_FILE' contains a comment line beginning with *// a2x:* then the remainder of the line will be treated as 'a2x' command-line options. For example: // a2x default options. // a2x: -dbook --epubcheck // Suppress revision history in dblatex outputs. // a2x: --dblatex-opts "-P latex.output.revhistory=0" - Options spanning multiple such comment lines will be concatenated. - Zero or more white space characters can appear between the leading *//* and *a2x:*. - Command-line options take precedence over options set in the source file. [[X4]] OUTPUT FILES ------------ Output files are written to the directory specified by the *--destination-dir* option. If no *--destination-dir* option is set output files are written to the 'SOURCE_FILE' directory. Output files have the same name as the 'SOURCE_FILE' but with an appropriate file name extension: `.html` for 'xhtml'; `.epub` for 'epub'; `.hhp` for 'htmlhelp'; `.pdf` for 'pdf'; `.text` for 'text', `.xml` for 'docbook'. By convention manpages have no `.man` extension (man page section number only). Chunked HTML directory names have a `.chunked` extension; chunked HTML Help directory names have a `.htmlhelp` extension. Same named existing files are overwritten. In addition to generating HTML files the 'xhtml', 'epub', 'chunked' and 'htmlhelp' formats ensure <> are copied to their correct destination directory locations. [[X3]] RESOURCES --------- Resources are files (typically CSS and images) that are required by HTML based outputs ('xhtml', 'epub', 'chunked', 'htmlhelp' formats). 'a2x' scans the generated HTML files and builds a list of required CSS and image files. Additional resource files can be specified explicitly using the *--resource* option. 'a2x' searches for resource files in the following locations in the following order: . The 'SOURCE_FILE' directory. . Resource directories specified by the *--resource* option (searched recursively). . Resource directories specified by the *--resource-manifest* option (searched recursively in the order they appear in the manifest file). . The stock `images` and `stylesheets` directories in the 'asciidoc(1)' configuration files directories (searched recursively). . The destination directory. When a resource file is found it is copied to the correct relative destination directory. Missing destination sub-directories are created automatically. There are two distinct mechanisms for specifying additional resources: . A resource directory which will be searched recursively for missing resource files. . A resource file which will be copied to the output destination directory. Resources are specified with *--resource* option values which can be one of the following formats: [=] .= Where: ``:: Specifies a directory (absolute or relative to the 'SOURCE_FILE') which is searched recursively for missing resource files. To eliminate ambiguity the `` name should end with a directory separator character. ``:: Specifies a resource file (absolute or relative to the 'SOURCE_FILE') which will be copied to ``. If `` is not specified then it is the same as the ``. ``:: Specifies the destination of the copied source file. The `` path is relative to the destination directory (absolute paths are not allowed). The location of the destination directory depends on the output 'FORMAT' (see the <> section for details): chunked, htmlhelp;; The chunked output directory. epub;; The archived `OEBPS` directory. xhtml;; The output *DESTINATION_DIR*. `.=`:: When adding resources to EPUB files the mimetype is inferred from the `` extension, if the mimetype cannot be guessed an error occurs. The `.=` resource syntax can be used to explicitly set mimetypes. `` is the file name extension, `` is the corresponding MIME type. Resource option examples: --resource ../images/ --resource doc/README.txt=README.txt --resource ~/images/tiger.png=images/tiger.png --resource .ttf=application/x-font-ttf EXAMPLES -------- `a2x -f pdf doc/source-highlight-filter.txt`:: Generates `doc/source-highlight-filter.pdf` file. `a2x -f xhtml -D ../doc --icons -r ../images/ team.txt`:: Creates HTML file `../doc/team.html`, uses admonition icons and recursively searches the `../images/` directory for any missing resources. `a2x -f manpage doc/asciidoc.1.txt`:: Generate `doc/asciidoc.1` manpage. [[X1]] REQUISITES ---------- 'a2x' uses the following programs: - *Asciidoc*: http://asciidoc.org/ - *xsltproc*: (all formats except text): http://xmlsoft.org/XSLT/ - *DocBook XSL Stylesheets* (all formats except text): http://docbook.sourceforge.net/projects/xsl/ - *dblatex* (pdf, dvi, ps, tex formats): http://dblatex.sourceforge.net/ - *FOP* (pdf format -- alternative PDF file generator): http://xmlgraphics.apache.org/fop/ - *w3m* (text format): http://w3m.sourceforge.net/index.en.html - *Lynx* (text format -- alternative text file generator): http://lynx.isc.org/ - *epubcheck* (epub format -- EPUB file validator): http://code.google.com/p/epubcheck/ See also the latest README file. [[X2]] CONF FILES ---------- A configuration file contains executable Python code that overrides the global configuration parameters in `a2x.py`. Optional configuration files are loaded in the following order: . `a2x.conf` from the directory containing the 'a2x.py' executable. . `a2x.conf` from the AsciiDoc global configuration directory. Skip this step if we are executing a locally installed (non system wide) copy. . `a2x.conf` from the AsciiDoc `$HOME/.asciidoc` configuration directory. . The 'CONF_FILE' specified in the '--conf-file' option. Here are the default configuration file option values: --------------------------------------------------------------------- # Optional environment variable dictionary passed to # executing programs. If set to None the existing # environment is used. ENV = None # External executables. ASCIIDOC = 'asciidoc' XSLTPROC = 'xsltproc' DBLATEX = 'dblatex' # pdf generation. FOP = 'fop' # pdf generation (--fop option). W3M = 'w3m' # text generation. LYNX = 'lynx' # text generation (if no w3m). XMLLINT = 'xmllint' # Set to '' to disable. EPUBCHECK = 'epubcheck' # Set to '' to disable. # External executable default options. ASCIIDOC_OPTS = '' DBLATEX_OPTS = '' FOP_OPTS = '' XSLTPROC_OPTS = '' --------------------------------------------------------------------- BUGS ---- See the AsciiDoc distribution BUGS file. AUTHOR ------ a2x was originally written by Stuart Rackham. Many people have contributed to it. RESOURCES --------- SourceForge: http://sourceforge.net/projects/asciidoc/ Main web site: http://asciidoc.org/ COPYING ------- Copyright \(C) 2002-2011 Stuart Rackham. Free use of this software is granted under the terms of the MIT license. asciidoc-8.6.9/doc/article.txt0000664000175100017510000000701112031161153016405 0ustar srackhamsrackhamThe Article Title ================= Author's Name v1.0, 2003-12 This is the optional preamble (an untitled section body). Useful for writing simple sectionless documents consisting only of a preamble. NOTE: The abstract, preface, appendix, bibliography, glossary and index section titles are significant ('specialsections'). :numbered!: [abstract] Example Abstract ---------------- The optional abstract (one or more paragraphs) goes here. This document is an AsciiDoc article skeleton containing briefly annotated element placeholders plus a couple of example index entries and footnotes. :numbered: The First Section ----------------- Article sections start at level 1 and can be nested up to four levels deep. footnote:[An example footnote.] indexterm:[Example index entry] And now for something completely different: ((monkeys)), lions and tigers (Bengal and Siberian) using the alternative syntax index entries. (((Big cats,Lions))) (((Big cats,Tigers,Bengal Tiger))) (((Big cats,Tigers,Siberian Tiger))) Note that multi-entry terms generate separate index entries. Here are a couple of image examples: an image:images/smallnew.png[] example inline image followed by an example block image: .Tiger block image image::images/tiger.png[Tiger image] Followed by an example table: .An example table [width="60%",options="header"] |============================================== | Option | Description | -a 'USER GROUP' | Add 'USER' to 'GROUP'. | -R 'GROUP' | Disables access to 'GROUP'. |============================================== .An example example =============================================== Lorum ipum... =============================================== [[X1]] Sub-section with Anchor ~~~~~~~~~~~~~~~~~~~~~~~ Sub-section at level 2. A Nested Sub-section ^^^^^^^^^^^^^^^^^^^^ Sub-section at level 3. Yet another nested Sub-section ++++++++++++++++++++++++++++++ Sub-section at level 4. This is the maximum sub-section depth supported by the distributed AsciiDoc configuration. footnote:[A second example footnote.] The Second Section ------------------ Article sections are at level 1 and can contain sub-sections nested up to four deep. An example link to anchor at start of the <>. indexterm:[Second example index entry] An example link to a bibliography entry <>. :numbered!: [appendix] Example Appendix ---------------- AsciiDoc article appendices are just just article sections with 'specialsection' titles. Appendix Sub-section ~~~~~~~~~~~~~~~~~~~~ Appendix sub-section at level 2. [bibliography] Example Bibliography -------------------- The bibliography list is a style of AsciiDoc bulleted list. [bibliography] - [[[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. [glossary] Example Glossary ---------------- Glossaries are optional. Glossaries entries are an example of a style of AsciiDoc labeled lists. [glossary] A glossary term:: The corresponding (indented) definition. A second glossary term:: The corresponding (indented) definition. ifdef::backend-docbook[] [index] Example Index ------------- //////////////////////////////////////////////////////////////// The index is normally left completely empty, it's contents being generated automatically by the DocBook toolchain. //////////////////////////////////////////////////////////////// endif::backend-docbook[] asciidoc-8.6.9/doc/asciidoc.1.txt0000664000175100017510000001344312067375563016732 0ustar srackhamsrackhamASCIIDOC(1) =========== :doctype: manpage NAME ---- asciidoc - converts an AsciiDoc text file to HTML or DocBook SYNOPSIS -------- *asciidoc* ['OPTIONS'] 'FILE' DESCRIPTION ----------- The asciidoc(1) command translates the AsciiDoc text file 'FILE' to DocBook or HTML. If 'FILE' is '-' then the standard input is used. OPTIONS ------- *-a, --attribute*='ATTRIBUTE':: Define or delete document attribute. 'ATTRIBUTE' is formatted like 'NAME=VALUE'. Command-line attributes take precedence over document and configuration file attributes. Alternate acceptable forms are 'NAME' (the 'VALUE' defaults to an empty string); 'NAME!' (delete the 'NAME' attribute); 'NAME=VALUE@' (do not override document or configuration file attributes). Values containing spaces should be enclosed in double-quote characters. This option may be specified more than once. A special attribute named 'trace' controls the output of diagnostic information. *-b, --backend*='BACKEND':: Backend output file format: 'docbook45', 'xhtml11', 'html4', 'html5', 'slidy', 'wordpress' or 'latex' (the 'latex' backend is experimental). You can also use the backend alias names 'html' (aliased to 'xhtml11') or 'docbook' (aliased to 'docbook45'). Defaults to 'html'. The *--backend* option is also used to manage backend plugins (see <>). *-f, --conf-file*='CONF_FILE':: Use configuration file 'CONF_FILE'.Configuration files processed in command-line order (after implicit configuration files). This option may be specified more than once. *--doctest*:: Run Python doctests in 'asciidoc' module. *-d, --doctype*='DOCTYPE':: Document type: 'article', 'manpage' or 'book'. The 'book' document type is only supported by the 'docbook' backend. Default document type is 'article'. *-c, --dump-conf*:: Dump configuration to stdout. *--filter*='FILTER':: Specify the name of a filter to be loaded (used to load filters that are not auto-loaded). This option may be specified more than once. The *--filter* option is also used to manage filter plugins (see <>). *-h, --help* ['TOPIC']:: Print help TOPIC. *--help* 'topics' will print a list of help topics, *--help* 'syntax' summarizes AsciiDoc syntax, *--help* 'manpage' prints the AsciiDoc manpage. *-e, --no-conf*:: Exclude implicitly loaded configuration files except for those named like the input file ('infile.conf' and 'infile-backend.conf'). *-s, --no-header-footer*:: Suppress document header and footer output. *-o, --out-file*='OUT_FILE':: Write output to file 'OUT_FILE'. Defaults to the base name of input file with 'backend' extension. If the input is stdin then the outfile defaults to stdout. If 'OUT_FILE' is '-' then the standard output is used. *-n, --section-numbers*:: Auto-number HTML article section titles. Synonym for *--attribute numbered*. *--safe*:: Enable safe mode. Safe mode is disabled by default. AsciiDoc 'safe mode' skips potentially dangerous scripted sections in AsciiDoc source files. *--theme*='THEME':: Specify a theme name. Synonym for *--attribute theme*='THEME'. The *--theme* option is also used to manage theme plugins (see <>). *-v, --verbose*:: Verbosely print processing information and configuration file checks to stderr. *--version*:: Print program version number. [[X1]] PLUGIN COMMANDS --------------- The asciidoc(1) *--filter*, *--backend* and *--theme* options are used to install, remove and list AsciiDoc filter, backend and theme plugins. Syntax: asciidoc OPTION install ZIP_FILE [PLUGINS_DIR] asciidoc OPTION remove PLUGIN_NAME [PLUGINS_DIR] asciidoc OPTION list asciidoc OPTION build ZIP_FILE PLUGIN_SOURCE Where: *OPTION*:: asciidoc(1) *--filter*, *--backend* or *--theme* option specifying the type of plugin. *PLUGIN_NAME*:: A unique plugin name containing only alphanumeric or underscore characters. *ZIP_FILE*:: A Zip file containing plugin resources, the name must start with the plugin name e.g. `my_filter-1.0.zip` packages filter `my_filter`. *PLUGINS_DIR*:: The directory containing installed plugins. Each plugin is contained in its own separate subdirectory which has the same name as the plugin. *PLUGINS_DIR* defaults to the `$HOME/.asciidoc/filters` (for filter plugins) or `$HOME/.asciidoc/backends` (for backend plugins) or `$HOME/.asciidoc/themes` (for theme plugins). *PLUGIN_SOURCE*:: The name of a directory containing the plugin source files or the name of a single source file. The plugin commands perform as follows: *install*:: Create a subdirectory in *PLUGINS_DIR* with the same name as the plugin then extract the *ZIP_FILE* into it. *remove*:: Delete the *PLUGIN_NAME* plugin subdirectory and all its contents from the *PLUGINS_DIR*. *list*:: List the names and locations of all installed filter or theme plugins (including standard plugins installed in the global configuration directory). *build*:: Create a plugin file named *ZIP_FILE* containing the files and subdirectories specified by *PLUGIN_SOURCE*. File and directory names starting with a period are skipped. EXIT STATUS ----------- *0*:: Success *1*:: Failure (syntax or usage error; configuration error; document processing failure; unexpected error). BUGS ---- See the AsciiDoc distribution BUGS file. AUTHOR ------ AsciiDoc was originally written by Stuart Rackham. Many people have contributed to it. RESOURCES --------- SourceForge: Main web site: COPYING ------- Copyright \(C) 2002-2011 Stuart Rackham. Free use of this software is granted under the terms of the GNU General Public License (GPL). asciidoc-8.6.9/doc/asciidoc.txt0000664000175100017510000066370312070213636016567 0ustar srackhamsrackhamAsciiDoc User Guide =================== Stuart Rackham :Author Initials: SJR :toc: :icons: :numbered: :website: http://asciidoc.org/ 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 <> 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 cannot be used within tables. - 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 aligns block macro images horizontally. 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 'replacements2' 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://asciidoc.org[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) {plus} plus character {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:·,eol:¬ set listchars=tab:»·,trail:· set list " Reformat paragraphs and list. nnoremap <Leader>r gq} " Delete trailing white space and Dos-returns and to expand tabs to spaces. nnoremap <Leader>t :set et<CR>:retab!<CR>:%s/[\r \t]\+$//<CR> autocmd BufRead,BufNewFile *.txt,*.asciidoc,README,TODO,CHANGELOG,NOTES,ABOUT \ 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 distribution directory contains a Vim syntax highlighter for AsciiDoc (`./vim/syntax/asciidoc.vim`), you can find the latest version in the online https://code.google.com/p/asciidoc/source/browse/[AsciiDoc repository]. Install the highlighter by copying `asciidoc.vim` to your `$HOME/.vim/syntax` directory (create it if it doesn't already exist). To enable syntax highlighing: - Put a Vim 'autocmd' in your Vim configuration file (see the <>). - or execute the Vim command `:set syntax=asciidoc`. - or add the following line to the end of you AsciiDoc source files: // vim: set syntax=asciidoc: [[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 |hr |html4 | Defines the 'html4' inter-section horizontal ruler element. By default 'html4' top level sections are separated by a horizontal ruler element, undefine this attribute or set it to an empty string if you do not want them. The default 'html4' backend value for the 'hr' attribute is `
    `. |[[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`. If admonition icons are embedded using the <> scheme then the 'iconsdir' attribute defaults to the location of the icons installed in the AsciiDoc configuration directory. |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. Copyright (C) 2002-2011 Stuart Rackham. asciidoc-8.6.9/doc/asciidocapi.txt0000664000175100017510000001434312067375563017265 0ustar srackhamsrackhamAsciiDoc API ============ 'asciidocapi' -- a Python API module for 'AsciiDoc'. Introduction ------------ The 'asciidocapi' module implements a Python API for AsciiDoc. It allows you to set `asciidoc(1)` program options, compile an AsciiDoc source file and then interrogate the results. The `asciidocapi.py` module file contains the `AsciiDocAPI` wrapper class for `asciidoc.py`. .Benefits - Stable API Shields the user from the undocumented and possibly volatile `asciidoc.py` internals. - Easier to use and more flexible than the alternative of running `asciidoc(1)` as a separate process. - Executes inside your application (better performance than running separate `asciidoc(1)` command processes). Using asciidocapi ----------------- To use the API just drop the `asciidocapi.py` file into your application directory, import it and use the `AsciiDocAPI` class. The only requirement is that a compatible version of 'AsciiDoc' is already installed -- simple, no setuptools to run, no Eggs to install, no non-standard library dependencies. You can find `asciidocapi.py` in the AsciiDoc http://asciidoc.org/INSTALL.html#X1[distribution archives] (version 8.4.1 or better). Once you have `asciidocapi.py` Verify everything is working by running the module doctests: python asciidocapi.py If there are no messages then all is well. The following minimal example compiles `mydoc.txt` to `mydoc.html`: [source,python] ------------------------------------------------------------------------------- from asciidocapi import AsciiDocAPI asciidoc = AsciiDocAPI() asciidoc.execute('mydoc.txt') ------------------------------------------------------------------------------- The next interactive example uses file-like objects for input and output: ------------------------------------------------------------------------------- $ python Python 2.5.2 (r252:60911, Jul 31 2008, 17:28:52) [GCC 4.2.3 (Ubuntu 4.2.3-2ubuntu7)] on linux2 Type "help", "copyright", "credits" or "license" for more information. >>> from asciidocapi import AsciiDocAPI >>> import StringIO >>> infile = StringIO.StringIO('Hello *{author}*') >>> outfile = StringIO.StringIO() >>> asciidoc = AsciiDocAPI() >>> asciidoc.options('--no-header-footer') >>> asciidoc.attributes['author'] = 'Joe Bloggs' >>> asciidoc.execute(infile, outfile, backend='html4') >>> print outfile.getvalue()

    Hello Joe Bloggs

    >>> ------------------------------------------------------------------------------- Implementation Rationale ------------------------ .Leverage existing knowledge The API maps directly onto the `asciidoc(1)` command -- this is deliberate -- if you know the `asciidoc(1)` command learning the API will be trivial. A nice side effect of this goal is that API and command-line modes share the same code -- virtually no `asciidoc(1)` code is specific to API usage. .Simplicity Implemented with a single Python module file (`asciidocapi.py`) containing the 'AsciiDocAPI' API class. 'AsciiDocAPI' contains just one method plus a few attributes for processing options and result messages. No external setup tools and no non-standard library dependencies are used or required. .Loose coupling The dependency between `asciidocapi.py` and `asciidoc.py` is minimal -- the current `asciidocapi.py` module uses only two attributes and one function from the `asciidoc.py` module. .Why isn't the API baked right into the asciidoc.py command script? 1. You can't just drop `asciidoc.py` into your application because it requires all the related config files and filters -- complex and unnecessary since all this was already done when you installed AsciiDoc. 2. This scheme separates the API from the AsciiDoc application -- the API implementation can be extended or replaced independently of AsciiDoc. API reference ------------- [[X2]] Class `AsciiDocAPI(object)` ~~~~~~~~~~~~~~~~~~~~~~~~~~~ This is the 'AsciiDoc' API class. Instance attributes ^^^^^^^^^^^^^^^^^^^ `asciidoc`:: The imported `asciidoc.py` module. `attributes`:: A dictionary of AsciiDoc attribute values passed to AsciiDoc. - Setting an attribute value to `None` (`name: None`) will undefine (delete) the attribute (this in addition to the `name!` attribute name format that the `asciidoc(1)` command uses). - To simply define an attribute set the attribute value to a blank string (`name: ''`) `cmd`:: The file path of the `asciidoc.py` script. Set by the `__init__` method. `messages`:: A chronologically ordered list of message strings generated during AsciiDoc execution (last message at the end of the list). `options`:: An instance of the <>. Contains a list of command options passed to AsciiDoc. Instance methods ^^^^^^^^^^^^^^^^ `__init__(self, asciidoc_py=None)`:: Locate and import `asciidoc.py` module and verify API compatibility. Initialize instance attributes. A search for the `asciidoc` module is made in the following order: . Use the `ASCIIDOC_PY` environment variable if it is set. . Use the `asciidoc_py` argument if it is set. . Search the environment 'PATH' for `asciidoc.py`, `asciidoc.pyc` and `asciidoc` (in that order). . Finally repeat the previous search in the current working directory. `execute(self, infile, outfile=None, backend=None)`:: Compile `infile` to `outfile` using `backend` format. `infile` and `outfile` can be file path strings or file-like objects. `backend` is name of 'AsciiDoc' backend (takes same values as `asciidoc(1)` command `--backend` option). If `outfile` or `backend` are `None` then their respective `asciidoc(1)` defaults are used. [[X1]] Class `Options(object)` ~~~~~~~~~~~~~~~~~~~~~~~ Stores `asciidoc(1)` command options. You can use any `asciidoc(1)` options with the exception of the `--doctest` and `--filter` options. Instance attributes ^^^^^^^^^^^^^^^^^^^ `values`:: The list of `(name,value)` command option tuples. Instance methods ^^^^^^^^^^^^^^^^ `__call__(self, name, value=None)`:: A shortcut for the `append` method. Example: opts = Options() opts('--verbose') `append(self, name, value=None)`:: Append `(name,value)` to the options list. Example: opts = Options() opts.append('--conf-file', 'blog.conf') Class `AsciiDocError(Exception)` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Thrown by the <> when an 'AsciiDoc' execution error occurs. asciidoc-8.6.9/doc/asciimathml.txt0000664000175100017510000000452012031161153017257 0ustar srackhamsrackhamASCIIMathML Formulae ==================== http://www1.chapman.edu/~jipsen/mathml/asciimath.html[ASCIIMathML] is a clever JavaScript written by Peter Jipsen that dynamically transforms mathematical formulae written in a wiki-like plain text markup to http://www.w3.org/Math/[MathML] markup which is displayed as standard mathematical notation by the Web Browser. See 'Appendix E' in the AsciiDoc User Guide for more details. The AsciiDoc `xhtml11` backend supports ASCIIMathML -- it links the ASCIIMathML script and escapes ASCIIMathML delimiters and special characters to yield valid XHTML. To use ASCIIMathML: 1. Include the `-a asciimath` command-line option when you run `asciidoc(1)`. 2. Enclose ASCIIMathML formulas inside math or double-dollar passthroughs or in math passthrough blocks. Here's the link:asciimathml.txt[AsciiDoc source] that generated this page. .NOTE - When you use the `asciimath:[]` inline macro you need to escape `]` characters in the formulas with a backslash, escaping is unnecessary if you use the double-dollar macro (for examples see the second formula below). - See the http://www1.chapman.edu/~jipsen/mathml/asciimath.html[ASCIIMathML] website for ASCIIMathML documentation and the latest version. - If the formulas don't appear to be correct you probably need to install the correct math fonts (see the http://www1.chapman.edu/~jipsen/mathml/asciimath.html[ASCIIMathML] website for details). - See the link:latexmathml.html[LaTeXMathML page] if you prefer to use LaTeX math formulas. A list of example formulas: - $$`[[a,b],[c,d]]((n),(k))`$$ - asciimath:[x/x={(1,if x!=0),(text{undefined},if x=0):}] - asciimath:[d/dxf(x)=lim_(h->0)(f(x+h)-f(x))/h] - +++`sum_(i=1)\^n i=(n(n+1))/2`$+++ and *bold asciimath:[int_0\^(pi/2) sinx\ dx=1]* - asciimath:[(a,b\]={x in RR : a < x <= b}] - asciimath:[x^2+y_1+z_12^34] ********************************************************************* The first three terms factor to give asciimath:[(x+b/(2a))^2=(b^2)/(4a^2)-c/a]. asciimath:[x+b/(2a)=+-sqrt((b^2)/(4a^2)-c/a)]. Now we take square roots on both sides and get asciimath:[x+b/(2a)=+-sqrt((b^2)/(4a^2)-c/a)]. Finally we move the asciimath:[b/(2a)] to the right and simplify to get the two solutions: *asciimath:[x_(1,2)=(-b+-sqrt(b^2-4ac))/(2a)]*. ********************************************************************* asciidoc-8.6.9/doc/book-multi.txt0000664000175100017510000001102412031161153017043 0ustar srackhamsrackhamMulti-Part Book Title Goes Here =============================== Author's Name v1.0, 2003-12 :doctype: book [dedication] Example Dedication ================== The optional dedication goes here. This document is an AsciiDoc multi-part book skeleton containing briefly annotated element placeholders plus a couple of example index entries and footnotes. Books are normally used to generate DocBook markup and the preface, appendix, bibliography, glossary and index section titles are significant ('specialsections'). NOTE: Multi-part books differ from all other AsciiDoc document formats in that top level sections (dedication, preface, book parts, appendices, bibliography, glossary, index) must be level zero headings (not level one). [preface] Example Preface ================ The optional book preface goes here at section level zero. Preface Sub-section ~~~~~~~~~~~~~~~~~~~ NOTE: Preface and appendix subsections start out of sequence at level 2 (level 1 is skipped). This only applies to multi-part book documents. The First Part of the Book ========================== [partintro] .Optional part introduction title -- Optional part introduction goes here. -- The First Chapter ----------------- Chapters can be grouped by preceeding them with a level 0 Book Part title. Book chapters are at level 1 and can contain sub-sections nested up to three deep. footnote:[An example footnote.] indexterm:[Example index entry] It's also worth noting that a book part can have it's own preface, bibliography, glossary and index. Chapters can have their own bibliography, glossary and index. And now for something completely different: ((monkeys)), lions and tigers (Bengal and Siberian) using the alternative syntax index entries. (((Big cats,Lions))) (((Big cats,Tigers,Bengal Tiger))) (((Big cats,Tigers,Siberian Tiger))) Note that multi-entry terms generate separate index entries. Here are a couple of image examples: an image:images/smallnew.png[] example inline image followed by an example block image: .Tiger block image image::images/tiger.png[Tiger image] Followed by an example table: .An example table [width="60%",options="header"] |============================================== | Option | Description | -a 'USER GROUP' | Add 'USER' to 'GROUP'. | -R 'GROUP' | Disables access to 'GROUP'. |============================================== .An example example =============================================== Lorum ipum... =============================================== [[X1]] Sub-section with Anchor ~~~~~~~~~~~~~~~~~~~~~~~ Sub-section at level 2. Chapter Sub-section ^^^^^^^^^^^^^^^^^^^ Sub-section at level 3. Chapter Sub-section +++++++++++++++++++ Sub-section at level 4. This is the maximum sub-section depth supported by the distributed AsciiDoc configuration. footnote:[A second example footnote.] The Second Chapter ------------------ An example link to anchor at start of the <>. indexterm:[Second example index entry] An example link to a bibliography entry <>. The Second Part of the Book =========================== The First Chapter of the Second Part ------------------------------------ Chapters grouped into book parts are at level 1 and can contain sub-sections. :numbered!: [appendix] Example Appendix ================ One or more optional appendixes go here at section level zero. Appendix Sub-section ~~~~~~~~~~~~~~~~~~~ NOTE: Preface and appendix subsections start out of sequence at level 2 (level 1 is skipped). This only applies to multi-part book documents. [bibliography] Example Bibliography ==================== The bibliography list is a style of AsciiDoc bulleted list. [bibliography] - [[[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. [glossary] Example Glossary ================ Glossaries are optional. Glossaries entries are an example of a style of AsciiDoc labeled lists. [glossary] A glossary term:: The corresponding (indented) definition. A second glossary term:: The corresponding (indented) definition. [colophon] Example Colophon ================ Text at the end of a book describing facts about its production. [index] Example Index ============= //////////////////////////////////////////////////////////////// The index is normally left completely empty, it's contents are generated automatically by the DocBook toolchain. //////////////////////////////////////////////////////////////// asciidoc-8.6.9/doc/book.txt0000664000175100017510000000717412031161153015726 0ustar srackhamsrackhamBook Title Goes Here ==================== Author's Name v1.0, 2003-12 :doctype: book [dedication] Example Dedication ------------------ Optional dedication. This document is an AsciiDoc book skeleton containing briefly annotated example elements plus a couple of example index entries and footnotes. Books are normally used to generate DocBook markup and the titles of the preface, appendix, bibliography, glossary and index sections are significant ('specialsections'). [preface] Example Preface --------------- Optional preface. Preface Sub-section ~~~~~~~~~~~~~~~~~~~ Preface sub-section body. The First Chapter ----------------- Chapters can contain sub-sections nested up to three deep. footnote:[An example footnote.] indexterm:[Example index entry] Chapters can have their own bibliography, glossary and index. And now for something completely different: ((monkeys)), lions and tigers (Bengal and Siberian) using the alternative syntax index entries. (((Big cats,Lions))) (((Big cats,Tigers,Bengal Tiger))) (((Big cats,Tigers,Siberian Tiger))) Note that multi-entry terms generate separate index entries. Here are a couple of image examples: an image:images/smallnew.png[] example inline image followed by an example block image: .Tiger block image image::images/tiger.png[Tiger image] Followed by an example table: .An example table [width="60%",options="header"] |============================================== | Option | Description | -a 'USER GROUP' | Add 'USER' to 'GROUP'. | -R 'GROUP' | Disables access to 'GROUP'. |============================================== .An example example =============================================== Lorum ipum... =============================================== [[X1]] Sub-section with Anchor ~~~~~~~~~~~~~~~~~~~~~~~ Sub-section at level 2. Chapter Sub-section ^^^^^^^^^^^^^^^^^^^ Sub-section at level 3. Chapter Sub-section +++++++++++++++++++ Sub-section at level 4. This is the maximum sub-section depth supported by the distributed AsciiDoc configuration. footnote:[A second example footnote.] The Second Chapter ------------------ An example link to anchor at start of the <>. indexterm:[Second example index entry] An example link to a bibliography entry <>. The Third Chapter ----------------- Book chapters are at level 1 and can contain sub-sections. :numbered!: [appendix] Example Appendix ---------------- One or more optional appendixes go here at section level 1. Appendix Sub-section ~~~~~~~~~~~~~~~~~~~ Sub-section body. [bibliography] Example Bibliography -------------------- The bibliography list is a style of AsciiDoc bulleted list. [bibliography] .Books - [[[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. [bibliography] .Articles - [[[abc2003]]] Gall Anonim. 'An article', Whatever. 2003. [glossary] Example Glossary ---------------- Glossaries are optional. Glossaries entries are an example of a style of AsciiDoc labeled lists. [glossary] A glossary term:: The corresponding (indented) definition. A second glossary term:: The corresponding (indented) definition. [colophon] Example Colophon ---------------- Text at the end of a book describing facts about its production. [index] Example Index ------------- //////////////////////////////////////////////////////////////// The index is normally left completely empty, it's contents being generated automatically by the DocBook toolchain. //////////////////////////////////////////////////////////////// asciidoc-8.6.9/doc/epub-notes.txt0000664000175100017510000001600512031161153017046 0ustar srackhamsrackhamAsciiDoc EPUB Notes =================== Restrictions ------------ - If the date format of the DocBook 'data' element is not formatted like `YYYY[-MM[-DD]]` you will get an error like the following one when validating with `epubcheck(1)`: ERROR: doc/article.epub/OEBPS/content.opf(6): date value 'Dec 2003' is not valid, YYYY[-MM[-DD]] expected - Navigation headers are suppressed by `docbook-xsl/epub.xsl` (see <>). DocBook XSL Stylesheets related limitations and bugs ---------------------------------------------------- === epub: toc.section.depth parameter ignored https://sourceforge.net/tracker/?func=detail&aid=3043393&group_id=21935&atid=373747 epub outputs include every section in the table of contents regardless of the toc.section.depth XSL Stylesheets parameter (http://docbook.sourceforge.net/release/xsl/current/doc/html/toc.section.depth.html). This behavior is specific to epub (xhtml and fo outputs honor toc.section.depth). Environment: DocBook XSL 1.75.2; Xubuntu 10.04 Also epub/docbook.xsl has written a hard-coded illegal dtb:depth value of -1 into the toc.ncx navigation control file: Shouldn't it be a positive integer equal to the depth navPoint nesting in the navMap element (see http://www.niso.org/workrooms/daisy/Z39-86-2005.html#NavMeta)? Though epubcheck 1.05 doesn't flag it as invalid -- are they both wrong? [[X1]] === epub: untitled DocBook sidebar emits invalid XHTML https://sourceforge.net/tracker/index.php?func=detail&aid=2840768&group_id=21935&atid=373747 I get the same problem, but is confined to EPUB outputs (not XHTML) and results in the sidebar and all subsequent text on the page displayed in bold text in both Firefox 3.6.8 and Google Chrome 5.0.375.125 (I haven't checked other browsers). Environment: DocBook XSL 1.75.2; Xubuntu 10.04 If a DocBook sidebar element does not have a title then the emitted title is (I haven't checked other browsers). set to instead of , for example this DocBook markup: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Generates this EPUB XHTML:

    Lorem ipsum dolor sit amet, consectetuer adipiscing elit.

    This problem is not picked up by either the epubcheck or the W3C validators. The problem does not occur generating XHTML which emits the following for the above example:

    Lorem ipsum dolor sit amet, consectetuer adipiscing elit.

    === epub: Unreferenced callout icons in OPF NOTE: A workaround for this problem was added in `a2x(1)` version 8.6.5. https://sourceforge.net/tracker/?func=detail&aid=2854075&group_id=21935&atid=373747 Environment: DocBook XSL 1.75.2; Xubuntu 8.04 When callouts are used in a document and callout graphics are disabled (callout.graphics=0) the generated 'contents.opf' still contains references to all the callout icons even though none are not referenced in the generated XHTML content. This results in 10 epubcheck validation errors like: image file OEBPS/images/icons/callouts/1.png is missing It appears that epub is adding the icons to the OPF without first checking the callout.graphics parameter. === epub: Table grids not generated https://sourceforge.net/tracker/?func=detail&aid=2849647&group_id=21935&atid=373747 Environment: DocBook XSL 1.75.2; Xubuntu 8.04 DocBook XSL epub does not appear to process the DocBook table element rowsep and colsep attributes -- table grids are not displayed. The DocBook results in: epub DocBook XSL generates: ......................................... Now you can use the style name to style cells or columns (in this example we use an unambiguous shortened abbreviation 'r'): [listing] ......................................... |================================== |Normal cell r|Red cell |================================== ......................................... == How can I add highlighted editorial comments to an AsciiDoc document? Both block and inline link:userguide.html#X25[comment lines] are displayed on the output if the 'showcomments' attribute is defined. Example: [listing] ......................................... :showcomments: // A block comment line. Qui in magna commodo, est labitur dolorum an. Est ne magna primis // An inline comment line. adolescens. ......................................... Is rendered as: :showcomments: // A block comment line. Qui in magna commodo, est labitur dolorum an. Est ne magna primis // An inline comment line. adolescens. NOTE: link:userguide.html#X26[Comment blocks] are never displayed. == What is the preferred file name extension for AsciiDoc files? The `.txt` http://en.wikipedia.org/wiki/Text_file[text file] extension is preferred, but it's just a convention and it's not enforced by the software. AsciiDoc source files are human readable http://en.wikipedia.org/wiki/Plain_text[plain text] files which is what the `.txt` extension is for. All text editors recognize and open files with a `.txt` extension. The `.txt` extension is universally recognized and unambiguous -- you are not left asking questions like ``What on earth is this file with the funny extension?'', ``How do I open it?'' and ``Is it safe to open?''. == How can I generate numbered bibliographic entries? If your outputs are DocBook generated then adding the following inline macro to a custom configuration file will result in auto-incrementing bibliography entry numbers (instead of displaying the bibliographic identifiers): [anchor3-inlinemacro] [{counter:bibliography2}] This FAQ submitted by Bela Hausmann. == How can I include lines of dashes inside a listing block? A line of four or more dashes will be mistaken for the ListingBlock terminator, one way round this problem is to use a LiteralBlock styled as a listing block. For example: [listing] ........................... Lorum ipsum ----------- ........................... == How can I customize PDF files generated by dblatex? There are a number of dblatex XSL parameters that can be used to customize PDF output. You can set them globally in the AsciiDoc `./dblatex/asciidoc-dblatex.xsl` configuration file or you can also pass them on the a2x(1) command-line. Here are some examples: The http://dblatex.sourceforge.net/doc/manual/latex.output.revhistory.html[latex.output.revhistory] parameter is used to suppress the revision history: a2x -f pdf --dblatex-opts "-P latex.output.revhistory=0" doc/article.txt The http://dblatex.sourceforge.net/doc/manual/doc.layout.html[doc.layout] parameter is used to include the cover page and document body (i.e. excludes table of contents and index), the http://dblatex.sourceforge.net/doc/manual/doc.publisher.show.html[doc.publisher.show] parameter is used to exclude the cover page logo: a2x -f pdf --dblatex-opts " -P doc.layout=\"coverpage mainmatter\" -P doc.publisher.show=0" doc/article.txt See also the http://dblatex.sourceforge.net/doc/manual/sec-params.html[dblatex XSL parameter reference]. == How can I add lists of figures and tables to PDFs created by dblatex? Set the http://dblatex.sourceforge.net/doc/sec-custom.html[doc.lot.show XSL parameter] -- you can set it using the dblatex `--param` command-line option, for example: a2x --dblatex-opts="--param=doc.lot.show=figure,table" doc/article.txt == How can I stop the document title being displayed? You could simply omit the document title, but this will result in a blank 'title' element in HTML outputs. If you want the HTML 'title' element to contain the document title then define the 'notitle' attribute (this will just suppress displaying the title), for example: My document title ================= :no title: == Why am I having trouble getting nested macros to work? The following example expands the 'image' inline macro, but the expansion contains double-quote characters which confuses the ensuing 'footnoteref' macro expansion: footnoteref:["F1","A footnote, with an image image:smallnew.png[]"] The solution is to use unquoted attribute values, replacing embedded commas with the comma character entity (`,`): footnoteref:[F1,A footnote, with an image image:smallnew.png[]] Similarly, you can embed double-quote characters in unquoted attribute values using the `"` character entity. == Why am I getting DocBook validation errors? Not all valid AsciiDoc source generates valid DocBook, for example 'special sections' (abstract, preface, colophon, dedication, bibliography, glossary, appendix, index, synopsis) have different DocBook schema's to normal document sections. For example, a paragraph is illegal in a bibliography. Don't forget if your document is a book you need to specify the asciidoc `-d book` command option, if you don't an article DocBook document will be generated, possibly containing book specific sections, resulting in validation errors. == How can I disable special section titles? For example, you want to use 'References' as a normal section name but AsciiDoc is auto-magically generating a DocBook 'bibliography' section. All you need to do is explicitly specify the section template name, for example: [sect1] References ---------- == How can I insert XML processing instructions into output documents? Use an inline or block passthrough macros. This example inserts `` into the DocBook output generated by AsciiDoc: pass::[] NOTE: XML processing instructions are specific to the application that processes the XML (the previous `dblatex` processing instruction is recognized by `dblatex(1)` when it processes the DocBook XML generated by Asciidoc). [[X4]] == How do I prevent double-quoted text being mistaken for an inline literal? Mixing doubled-quoted text with inline literal passthroughs can produce undesired results, for example, all of the following line is interpreted as an inline literal passthrough: ``XXX'' `YYY` In this case the solution is to use monospace quoting instead of the inline literal: ``XXX'' +YYY+ Use the +\pass:[]+ macro if it's necessary to suppress substitutions in the monospaced text, for example: ``XXX'' +pass:[don't `quote` me]+ == How can I generate a single HTML document file containing images and CSS styles? With the advent of Internet Explorer 8 all major web browsers now support the http://en.wikipedia.org/wiki/Data:_URI_scheme[data URI scheme] for embedded images. The AsciiDoc 'xhtml11' and 'html5' backends supports the data URI scheme for embedded images and by default it embeds the CSS stylesheet. For example the following command will generate a single `article.html` file containing embedded images, admonition icons and the CSS stylesheet: asciidoc -a data-uri -a icons article.txt == Are there any tools to help me understand what's going on inside AsciiDoc? AsciiDoc has a built-in trace mechanism which is controlled by the 'trace' attribute; there is also the `--verbose` command-line option. These features are detailed in http://asciidoc.org/userguide.html#X82[Appendix G of the User Guide]. == One-liner ifdef::[]'s are disproportionately verbose can they shortened? This is the response to a question posted on the AsciiDoc discussion list, it illustrates a number of useful techniques. The question arose because the source highlight filter language identifier for the C++ language is `c++` when generating PDFs via dblatex (LaTeX listings package) or `cpp` when generating HTML (GNU source-highlight). Using straight `ifdef::[]` block macros we have: [listing] ......................................... \ifdef::basebackend-docbook[] [source,c++] \endif::basebackend-docbook[] \ifdef::basebackend-html[] [source,cpp] \endif::basebackend-html[] ----------------------------------------- class FooParser { public: virtual void startDocument() = 0; virtual void endDocument() = 0; }; ----------------------------------------- ......................................... This can be shortened using the short form of the `ifdef::[]` macro: [listing] ......................................... \ifdef::basebackend-docbook[[source,c++]] \ifdef::basebackend-html[[source,cpp]] ----------------------------------------- class FooParser { public: virtual void startDocument() = 0; virtual void endDocument() = 0; }; ----------------------------------------- ......................................... Using a conditional attribute instead of the `ifdef::[]` macro is even shorter: [listing] ......................................... [source,{basebackend@docbook:c++:cpp}] ----------------------------------------- class FooParser { public: virtual void startDocument() = 0; virtual void endDocument() = 0; }; ----------------------------------------- ......................................... If you have a number of listings it makes sense to factor the conditional attribute to a normal attribute: [listing] ......................................... :cpp: {basebackend@docbook:c++:cpp} [source,{cpp}] ----------------------------------------- class FooParser { public: virtual void startDocument() = 0; virtual void endDocument() = 0; }; ----------------------------------------- ......................................... Even shorter, set the default source highlight filter `language` attribute so you don't have to specify it every time: [listing] ......................................... :language: {basebackend@docbook:c++:cpp} [source] ----------------------------------------- class FooParser { public: virtual void startDocument() = 0; virtual void endDocument() = 0; }; ----------------------------------------- ......................................... == Some of my inline passthroughs are not passed through, why? Most likely the passthrough encloses another passthrough with a higher precedence. For example trying to render this +\pass:[]+ with this +\`\pass:[]`+ results in a blank string because the +\pass:[]+ passthrough evaluates first, instead use monospaced quoting and escape the passthrough i.e. ++ \+\\pass:[]+ ++ == How can I place an anchor (link target) on a list item? You can't use a 'BlockId' block element inside a list but you can use the syntactically identical 'anchor' inline macro. For example: --------------------- one:: Item one. [[X2]]two:: Item two. three:: Item three. --------------------- This *will not* work: --------------------- one:: Item one. [[X2]] two:: Item two. three:: Item three. --------------------- == How can I stop lists from nesting? If you place two lists with different syntax hard up against each other then the second list will be nested in the first. If you don't want the second list to be nested separate them with a comment line block macro. For example: ------------------- 1. List 1. 2. List 1. // a. List 2. b. List 2. ------------------- == Is it possible to include charts in AsciiDoc documents? There are a number of programs available that generate presentation charts from textual specification, for example http://home.gna.org/pychart/[Pychart] is a library for writing chart scripts in Python. Here's an example from the 'Pychart' documentation: .barchart.py --------------------------------------------------------------------- # # Example bar chart (from Pychart documentation http://home.gna.org/pychart/). # from pychart import * theme.get_options() data = [(10, 20, 30, 5), (20, 65, 33, 5), (30, 55, 30, 5), (40, 45, 51, 7), (50, 25, 27, 3), (60, 75, 30, 5), (70, 80, 42, 5), (80, 62, 32, 5), (90, 42, 39, 5), (100, 32, 39, 4)] # The attribute y_coord=... tells that the Y axis values # should be taken from samples. # In this example, Y values will be [40,50,60,70,80]. ar = area.T(y_coord = category_coord.T(data[3:8], 0), x_grid_style=line_style.gray50_dash1, x_grid_interval=20, x_range = (0,100), x_axis=axis.X(label="X label"), y_axis=axis.Y(label="Y label"), bg_style = fill_style.gray90, border_line_style = line_style.default, legend = legend.T(loc=(80,10))) # Below call sets the default attributes for all bar plots. chart_object.set_defaults(bar_plot.T, direction="horizontal", data=data) # Attribute cluster=(0,3) tells that you are going to draw three bar # plots side by side. The plot labeled "foo" will the leftmost (i.e., # 0th out of 3). Attribute hcol tells the column from which to # retrive sample values from. It defaults to one. ar.add_plot(bar_plot.T(label="foo", cluster=(0,3))) ar.add_plot(bar_plot.T(label="bar", hcol=2, cluster=(1,3))) ar.add_plot(bar_plot.T(label="baz", hcol=3, cluster=(2,3))) ar.draw() --------------------------------------------------------------------- To execute the script and include the generated chart image in your document add the following lines to the AsciiDoc source: --------------------------------------------------------------------- // Generate chart image file. \sys2::[python "{indir}/barchart.py" --format=png --output="{outdir}/barchart.png" --scale=2] // Display chart image file. image::barchart.png[] --------------------------------------------------------------------- [NOTE] ===================================================================== - The `barchart.py` script is located in the same directory as the AsciiDoc source file (`{indir}`). - The generated chart image file (`barchart.png`) is written to the same directory as the output file (`{outdir}`). ===================================================================== == How can I render indented paragraphs? Styling is backend dependent: [float] ==== Create an indented paragraph style (xhtml11 and html5 backends) . Define an 'indented' paragraph style, for example, by putting this in a custom configuration file: + --------------------------------------------------------------------- [paradef-default] indented-style=template="indentedparagraph" [indentedparagraph]
    {title?
    {title}
    }

    |

    --------------------------------------------------------------------- . Now apply the 'indented' style to normal paragraphs, for example: + --------------------------------------------------------------------- [indented] Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas ultrices justo porttitor augue. Vestibulum pretium. Donec porta vestibulum mi. Aliquam pede. Aenean lobortis lorem et lacus. Sed lacinia. Vivamus at lectus. --------------------------------------------------------------------- [float] ==== Use the role attribute (xhtml11 and html5 backends) . Add the following line to custom stylesheet: + --------------------------------------------------------------------- div.paragraph.indented p {text-indent: 3em;} --------------------------------------------------------------------- . Apply the 'role' attribute to indented paragraphs, for example: + --------------------------------------------------------------------- [role="indented"] Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas ultrices justo porttitor augue. Vestibulum pretium. Donec porta vestibulum mi. Aliquam pede. Aenean lobortis lorem et lacus. Sed lacinia. Vivamus at lectus. --------------------------------------------------------------------- . Include the custom stylesheet by setting the 'stylesheet' attribute (either from the command-line or with an attribute entry in the document header). [float] ==== Use the role attribute (docbook backend) . Add the following line to the distributed `docbook-xsl.css` stylesheet or include it in a custom stylesheet: + --------------------------------------------------------------------- p.indented {text-indent: 3em;} --------------------------------------------------------------------- . Apply the 'role' attribute to indented paragraphs, for example: + --------------------------------------------------------------------- [role="indented"] Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas ultrices justo porttitor augue. Vestibulum pretium. Donec porta vestibulum mi. Aliquam pede. Aenean lobortis lorem et lacus. Sed lacinia. Vivamus at lectus. --------------------------------------------------------------------- . If you have included the custom CSS in a separate stylesheet you will need to specify the stylesheet file name (along with the default `docbook-xsl.css` stylesheet file name) with the `html.stylesheet` XSL parameter. If you are using 'a2x(1)' use the `--stylesheet` option (it sets the `html.stylesheet` XSL parameter), for example: `--stylesheet "docbook-xsl.css mycss.css"`. NOTE: This applies to HTML outputs not PDF. To achieve the same results with PDF outputs you will need to customize the DocBook XSL Stylesheets to render indented paragraphs from DocBook `simpara` elements containing the the `role="indented"` attribute. == Is there a way to set default table grid and frame attributes? You can set the 'grid' and 'frame' attributes globally in your document header with Attribute Entries or from the command-line using the `--attribute` option. In the following example tables that don't explicitly set the 'grid' and 'frame' values will default to 'all' and 'topbot' respectively: --------------------------------------------------------------------- :grid: all :frame: topbot --------------------------------------------------------------------- TIP: This technique can be applied to any block element attribute (just beware of possible ambiguity, for example, table and image blocks both have a 'width' attribute). == How can I place a backslash character in front of an attribute reference without escaping the reference? Use the predefined `{backslash}` attribute reference instead of an actual backslash, for example if the `{projectname}` attribute has the value `foobar` then: d:\data{backslash}{projectname} would be rendered as: d:\data\foobar == How can I escape AsciiDoc markup? Most AsciiDoc inline elements can be suppressed by preceding them with a backslash character. These elements include: - Attribute references. - Text formatting. - Quoting, - Macros. - Replacements. - Special words. - Table cell separators. But there are exceptions -- see the next question. == Some elements can't be escaped with a single backslash There are a number of exceptions to the usual single backslash rule -- mostly relating to URL macros that have two syntaxes or quoting ambiguity. Here are some non-standard escape examples: [cols="l,v",width="40%",frame="topbot",options="header"] |======================================== |AsciiDoc | Renders 2*| \joe.bloggs@example.com <\joe.bloggs@example.com> \mailto:[\joe.bloggs@example.com] 2*| \http://www.example.com \\http://www.example.com[] \\http://www.example.com[Foobar Limited] 2*| A C\++ Library for C++ \\``double-quotes'' \*\*F**ile Open\... |======================================== The source of this problem is ambiguity across substitution types -- the first match unescapes allowing the second to substitute. A work-around for difficult cases is to side-step the problem using the +\pass:[]+ passthrough inline macro. NOTE: Escaping is unnecessary inside 'inline literal passthroughs' (backtick quoted text). == How can I escape a list? Here's how to handle situations where the first line of a paragraph is mistaken for a list item. [float] ==== Numbered and bulleted lists Precede the bullet or index of the first list item with an `{empty}` attribute, for example: {empty}- Qui in magna commodo est labitur dolorum an. Est ne magna primis adolescens. The predefined `{empty}` attribute is replaced by an empty string and ensures the first line is not mistaken for a bulleted list item. [float] ==== Labeled lists Two colons or semicolons in a paragraph may be confused with a labeled list entry. Use the predefined `{two-colons}` and `{two-semicolons}` attributes to suppress this behavior, for example: Qui in magna commodo{two-colons} est labitur dolorum an. Est ne magna primis adolescens. Will be rendered as: Qui in magna commodo{two-colons} est labitur dolorum an. Est ne magna primis adolescens. == How can I set default list and tables styles? You can set the element's 'style' entry in a global or custom configuration file. This example this will horizontally style all labeled lists that don't have an explicit style attribute: ---------------------------------- [listdef-labeled] style=horizontal [listdef-labeled2] style=horizontal ---------------------------------- This example will put a top and bottom border on all tables that don't already have an explicit style attribute: ---------------------------------- [tabledef-default] style=topbot topbot-style=frame="topbot" ---------------------------------- Alternatively you can set the configuration entries from inside your document, the above examples are equivalent to: ---------------------------------- :listdef-labeled.style: horizontal :listdef-labeled2.style: horizontal :tabledef-default.topbot-style: frame="topbot" :tabledef-default.style: topbot ---------------------------------- == Why do I get a filter non-zero exit code error? An error was returned when AsciiDoc tried to execute an external filter command. The most common reason for this is that the filter command could not be found by the command shell. To figure out what the problem is run AsciiDoc with the `--verbose` option to determine the command that is failing and then try to run the command manually from the command-line. == Are there any DocBook viewers? http://live.gnome.org/Yelp[Yelp], the GNOME help viewer, does a creditable job of displaying DocBook XML files directly. == Can you create ODF and PDF files using LibreOffice? https://www.libreoffice.org/[LibreOffice] can convert HTML produced by AsciiDoc to ODF text format and PDF format (I used LibreOffice 3.5 at the time of writing, the fidelity is very good but it's not perfect): . Create the HTML file using AsciiDoc, for example: asciidoc -a icons -a numbered -a disable-javascript article.txt + JavaScript is disabled because LibreOffice does not execute JavaScript, this means that AsciiDoc table of contents and footnotes will not be rendered into ODF (if you want the table of contents and footnotes you could manually cut and paste them from a Web browser). . Convert the HTML file to an ODF text file using LibreOffice: lowriter --invisible --convert-to odt article.html + -- The images imported from an HTML file will be linked, if your document contains images you should convert them to embedded images: [lowerroman] . Open the document in LibreOffice Writer. . Run the 'Edit->Links...' menu command. . Select all links and press the 'Break Link' button. Some images may also have been resized. To restore an image to its original size: [lowerroman] . Right-click on the image and select the 'Picture...' menu item. . Click on the 'Crop' tab. . Press the 'Original Size' button. -- . Convert the ODF file to an PDF text file using LibreOffice: lowriter --invisible --convert-to pdf article.odt + A PDF index is automatically created using the section headings. Alternatively you could manually copy-and-paste the entire document from a Web browser into a blank ODF document in LibreOffice -- this technique will bring through the table of contents and footnotes. This tip was originally contributed by Bernard Amade. == How can I suppress cell separators in included table data files? Use the `{include:}` system attribute instead of the `include::[]` macro (the former is not expanded until after the table data has been parsed into cells, whereas the latter is included before the table is processed. == How can I preserve paragraph line boundaries? Apply the The 'verse' paragraph style, the rendered text preserves line boundaries and is useful for lyrics and poems. For example: --------------------------------------------------------------------- [verse] Consul *necessitatibus* per id, consetetur, eu pro everti postulant homero verear ea mea, qui. --------------------------------------------------------------------- Alternatively, if you are generating PDF files, you can use line breaks. For example: --------------------------------------------------------------------- Consul *necessitatibus* per id, + consetetur, eu pro everti postulant + homero verear ea mea, qui. --------------------------------------------------------------------- == How can I include non-breaking space characters? Use the non-breaking space character entity reference ` ` (see the next question). You could also use the predefined `{nbsp}` attribute reference. == Can I include HTML and XML character entity references in my document? Yes, just enter the reference in your document. For example `β` will print a Greek small beta character β [[X1]] == How do I include spaces in URLs? URL inline macro targets (addresses) cannot contain white space characters. If you need spaces encode them as `%20`. For example: image:large%20image.png[] http://www.foo.bar.com/an%20example%20document.html == How can I get AsciiDoc to assign the correct DocBook language attribute? Set the AsciiDoc 'lang' attribute to the appropriate language code. For example: a2x -a lang=es doc/article.txt This will ensure that downstream DocBook processing will generate the correct language specific document headings (things like table of contents, revision history, figure and table captions, admonition captions). == How can I turn off table and image title numbering? For HTML outputs set the 'caption' attribute to an empty string, either globally: ------------------------- :caption: ------------------------- or on an element by element basis, for example: ------------------------- .Tiger [caption=""] image::images/tiger.png[] ------------------------- == How can I assign multiple author names? A quick way to do this is put both authors in a single first name, for example: --------------------------------------- My Document =========== :Author: Bill_and_Ben_the_Flowerpot_Men :Author Initials: BB & BC --------------------------------------- asciidoc(1) replaces the underscores with spaces. If you are generating DocBook then a more flexible approach is to create a 'docinfo' file containing a DocBook 'authorgroup' element (search the 'User Guide' for 'docinfo' for more details). == How can I selectively disable a quoted text substitution? Omitting the tag name will disable quoting. For example, if you don't want superscripts or subscripts then put the following in a custom configuration file or edit the global `asciidoc.conf` configuration file: ------------------- [quotes] ^= ~= ------------------- Alternatively you can set the configuration entries from within your document, the above examples are equivalent to: ------------------- :quotes.^: :quotes.~: ------------------- == How can I customize the \{localdate} format? The default format for the `{localdate}` attribute is the ISO 8601 `yyyy-mm-dd` format. You can change this format by explicitly setting the `{localdate}` attribute. For example by setting it using the asciidoc(1) `-a` command-line option: asciidoc -a localdate=`date +%d-%m-%Y` mydoc.txt You could also set it by adding an Attribute Entry to your source document, for example: :localdate: {sys: date +%Y-%m-%d} == Where can I find examples of commands used to build output documents? The User Guide has some. You could also look at `./doc/main.aap` and `./examples/website/main.aap` in the AsciiDoc distribution, they have all the commands used to build the AsciiDoc documentation and the AsciiDoc website (even if you don't use A-A-P you'll still find it useful). == Why have you used the DocBook element instead of ? `` is really the same as `` except it can't contain block elements -- this matches, more closely, the AsciiDoc paragraph semantics. == How can I format text inside a listing block? By default only 'specialcharacters' and 'callouts' are substituted in listing blocks; you can add quotes substitutions by explicitly setting the block 'subs' attribute, for example: [listing] .......................................... [subs="quotes"] ------------------------------------------ $ ls *-al* ------------------------------------------ .......................................... The `-al` will rendered bold. Note that: - You would need to explicitly escape text you didn't want quoted. - Don't do this in source code listing blocks because it modifies the source code which confuses the syntax highlighter. - This only works if your DocBook processor recognizes DocBook `` elements inside `` elements. Alternative, if the lines are contiguous, you could use the 'literal' paragraph style: ------------------------------------------ ["literal",subs="quotes"] $ ls *-al* ------------------------------------------ == Why doesn't the include1::[] macro work? 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. `include1` won't work, for example, in a ListingBlock (unless attribute substitution is enabled). `include1` is intended for use in configuration files, use the `include` macro and set the attribute `depth=1` instead, for example: [listing] ................................................ ------------------------------------------------ \include::blogpost_media_processing.txt[depth=1] ------------------------------------------------ ................................................ == How can I make the mailto macro work with multiple email addresses? For the AsciiDoc 'mailto' macro to work with multiple email addresses (as per RFC2368) you need to URL encode the '@' characters (replace them with '%40'), if you don't the individual addresses will be rendered as separate links. You also need to <>. For example, the following call won't work: mailto:jb@example.com,jd@example.com?subject=New foofoo release[New foofoo release] Use this instead: mailto:jb%40example.com,jd%40example.com?subject=New%20foofoo%20release[New foofoo release] == How can a replacement have a trailing backslash? Quote the entry name -- this nonsensical example replaces `x\` with `y`: "x\\"=y If quoting were omitted the equals character (separating the entry name `x` from the value `y`) would be escaped. == How can I control page breaks when printing HTML outputs? Here are some techniques you can use to control page breaks in HTML outputs produced by the 'xhtml11' and 'html5' backends: - You can generate a page break with the '<<<' block macro. The following example prints the 'Rats and Mice' section on a new page: + ---------------- <<< == Rats and Mice Lorum ipsum ... ---------------- - You can use the 'unbreakable' option to instruct the browser not to break a block element. The following image and it's caption will be kept together the printed page: + ------------------------------------ [options="unbreakable"] .Tiger block image image::images/tiger.png[Tiger image] ------------------------------------ - You can apply the 'unbreakable' option globally to all block elements by defining the 'unbreakable-option' attribute in your document header. - Finally, the most powerful technique is to create custom CSS containing paged media properties. For example this asciidoc(1) command: + -- asciidoc --attribute stylesheet=article.css article.txt Will include the following `article.css` file in the output document: ------------------------------------------------- div#toc, div.sect1 { page-break-before: always; } ------------------------------------------------- Which will ensure the table of contents and all top level sections start on a new printed page. -- == Is it possible to reposition the Table of Contents in HTML outputs? By default the 'xhtml11' and 'html5' backends auto-position the TOC after the header. You can manually position the TOC by setting the 'toc-placement' attribute value to 'manual' and then inserting the `toc::[]` block macro where you want the TOC to appear. For example, put this in the document header: ---------------------- :toc: :toc-placement: manual ---------------------- The put this where you want the TOC to appear: ------- toc::[] ------- == HTML generated by AsciiDoc fills the width of the browser, how can I limit it to a more readable book width? You can set the maximum with for outputs generated by 'html5', 'xhtml11' and 'slidy' backends by assigning the link:userguide.html#X103[max-width] attribute (either from the command-line or with an attribute entry in the document header). For example: asciidoc -a max-width=55em article.txt == Using roles to select fonts for PDF Some applications require mixing fonts beyond the set of faces normally provided by default (normal, monospace, italic etc.) for example mixed language text where the font used for the majority of text does not contain suitable glyphs in the minority language. As AsciiDoc can not provide presentation markup since it is not provided by Docbook this is achieved by marking text which should use a different font with a custom role which can be rendered by the the docbook toolchain. NOTE: For XHTML outputs AsciiDoc translates the role attribute to a class which can be selected and styled by CSS as described in the AsciiDoc users guide. The Docbook toolchains will have to be configured to render the text that you mark with the custom role. For FOP a small XSL wrapper is needed, say a file called `my_fo.xsl` containing: --------------------------------------------------------------- --------------------------------------------------------------- This is used with `a2x` by: a2x -f pdf --fop --xsl-file=my_fo.xsl input.txt and the AsciiDoc source marked by: normal text [f2]#special font is like this# and back to normal Thanks to Antonio Borneo for this answer. == How can I place a footnote immediately following quoted text? A closing quote is not recognised if it is immediately followed by a letter (the 'f' in 'footnote' in the following example): ``Double-quoted text''footnote:[Lorum ipsum...] A workaround is to put a word-joiner between the trailing quote and the footnote (the `{empty}` attribute would also work), for example: ``Double-quoted text''{wj}footnote:[Lorum ipsum...] == How can I convert documents from other formats to AsciiDoc? You can use http://johnmacfarlane.net/pandoc/[Pandoc] to convert documents in http://daringfireball.net/projects/markdown/[markdown], http://docutils.sourceforge.net/docs/ref/rst/introduction.html[reStructuredText], http://redcloth.org/textile[textile], http://www.w3.org/TR/html40/[HTML], http://www.docbook.org/[DocBook], or http://www.latex-project.org/[LaTeX] to AsciiDoc. == How can I insert raw HTML in a document processed by a2x? `a2x` generates HTML via DocBook (DocBook XSL Stylesheets) so if you use a passthrough block it must contain DocBook (not HTML). Fortunately DocBook XSL Stylesheets has a http://www.sagehill.net/docbookxsl/InsertExtHtml.html[dbhtml-include processing instruction] which will inlcude a file containing raw HTML into the generated HTML output. For example: --------------------------------------------------------------- ++++ ++++ --------------------------------------------------------------- == Why is there a period after the block title in the PDF output? If your document has blocks that have block titles, you may notice in the PDF output (generated by `a2x(1)` using the `--fop` flag) that a period gets added to the end of the block title. You will not see the period in the intermediary DocBook XML that’s generated when creating a PDF -- it’s added by the DocBook XSL templates when the DocBook XML is converted to FO XML. The DocBook XSL attribute that controls what character is added after a block title is http://docbook.sourceforge.net/release/xsl/1.78.1/doc/html/runinhead.default.title.end.punct.html[ runinhead.default.title.end.punct]. You can override it and eliminate the default period value by adding the following line to the `./docbook-xsl/common.xsl` file that ships with AsciiDoc: This FAQ was https://groups.google.com/group/asciidoc/browse_thread/thread/19dda8807fa7c3f2[contributed by Dan Allen]. asciidoc-8.6.9/doc/latex-backend.txt0000664000175100017510000002642412067375563017522 0ustar srackhamsrackhamLaTeX backend for Asciidoc ========================== Benjamin Klum v1.0, June 2006 == Introduction LaTeX backend is a configuration file for Stuart Rackham's http://asciidoc.org/[Asciidoc]. It generates high-level LaTeX markup from Asciidoc documents. LaTeX is a document preparation system for TeX which in turn is a popular typesetting system. It is well known for producing excellently typesetted high quality printouts, especially suited for scientific text. == Tutorial Getting a ready-to-print document from an Asciidoc document using the LaTeX backend involves at least two steps: 1. Conversion of the Asciidoc document into a LaTeX document (this is done by Asciidoc using the LaTeX backend) 2. Conversion of the LaTeX document into a PDF document (this is done by the TeX system) Try to create a PDF document from the Asciidoc document `article.txt` which resides in the `doc` directory of Asciidoc: .. Make a copy of `article.txt` in a directory of your choice, let's call it `latex-test`. .. Make sure that all images referenced in `article.txt` exist in `latex-test`. Brute force approach: Copy the whole `images` directory from Asciidoc directory into `latex-test`. .. Change directory to `latex-test` and type following commands: + asciidoc --unsafe --backend=latex article.txt pdflatex article.tex + .. Now there should be a file `article.pdf` in the `latex-test` directory. [IMPORTANT] ============================== - Asciidoc has to be started in 'unsafe mode' when using LaTeX backend. - Note that some special LaTeX packages are necessary, see <>. ============================== == General notes === Quality of LaTeX output High-level LaTeX is not very straightforward to generate. Therefore there's no guarantee that the generated output is valid and compiles successfully. At all, this backend should be considered as rather experimental. You should have been already in touch with LaTeX in order to use the backend effectively because LaTeX compilation errors can be really nasty. Nevertheless good results can be achieved by using LaTeX backend. Try for example to compile Stuart Rackham's Asciidoc documentation, a rather large document. It should compile without problems. However, the code filter might have to be reconfigured for the code filter example to work. === Configuration file customization Like every other Asciidoc backend the LaTeX backend can be customized easily to fit the user's needs. Actually it is very important to have this option since LaTeX doesn't have a companion language like CSS which allows to put styling information in a separate file. Read more about the LaTeX backend configuration file <>. === Output optimization The LaTeX output is optimized for creating PDF documents using 'pdflatex'. [[unicodeSupport]] === Unicode support Unfortunately TeX/LaTeX does not have native unicode support. The package 'ucs' adds elementary unicode support by introducing UTF-8 input encoding recognition and by defining lookup tables which contain the corresponding LaTeX commands for unicode characters. But these lookup tables are far from being complete. When a unicode character is found which is not defined in the lookup tables an error is raised by the TeX/LaTeX compiler. Note that TeX/LaTeX compilation errors caused by missing unicode character definitions are not fatal, that means the result is probably readable but undefined unicode characters are replaced with `[U+...]`. You may (de)activate the recognition of escaped unicode characters. See the <> backend option. == Backend specific features === Special sections LaTeX backend supports the following special sections and replaces them with corresponding LaTeX commands or environments: - Abstract (only for document type 'article') - Dedication (only for document type 'book') - Index - Bibliography (only when the attribute 'latex-use-bibliography-environment' is set) - Appendix - Contents [[internalCrossReferences]] === Internal cross references Macros for internal cross references have been extended by the attribute 'style'. xref:[
    i.e. epub is not generating CSS borders (same for generated th elements). Compare this with the (correct) xhtml DocBook XSL generates the correct border styles: === epub: htmltoc is not generated https://sourceforge.net/tracker/?func=detail&aid=2849686&group_id=21935&atid=373747 Environment: DocBook XSL 1.75.2; Xubuntu 8.04 If DocBook XSL TOC generation is specified the generated 'contents.opf' contains an 'htmltoc' element but the referenced TOC file is not generated by DocBook XSL. For example the contents.opf contains: but the actual TOC file `OEBPS/ar01-toc.html` is missing and epubcheck generates validation errors like: ERROR: doc/article.epub: OPS/XHTML file OEBPS/ar01-toc.html is missing === epub: leading dot in directory name error https://sourceforge.net/tracker/?func=detail&aid=2849683&group_id=21935&atid=373747 Environment: DocBook XSL 1.75.2; Xubuntu 8.04 Specifying paths with a leading dot causes problems, for example: This generates validation errors like: ERROR: article.epub/OEBPS/index.html(4): 'OEBPS/./docbook-xsl.css': referenced resource missing in the package The file is in the archive at the correct location, just doesn't seem to like './' in the path name -- the path needs to be normalized before being written to the contents.opf. It's not just the validator, the file is missing when the EPUB is viewed (in bookworm). This works fine: [[X2]] === epub: admonition icon images missing from contents.opf NOTE: A workaround for this problem was added in `a2x(1)` version 8.6.5. https://sourceforge.net/tracker/?func=detail&aid=2849681&group_id=21935&atid=373747 Environment: DocBook XSL 1.75.2; Xubuntu 8.04 When admonition icons are specified epubcheck generates validation errors like: ERROR: article.epub/OEBPS/index.html(4): 'OEBPS/images/icons/note.png': referenced resource exists, but not declared in the OPF file i.e. The admonition icon is in the EPUB file but DocBook XSL has not been added to the content.opf manifest. Compare this with callout icons which are processed correctly. [[X3]] === Table width attribute validation error https://sourceforge.net/tracker/?func=detail&aid=2848734&group_id=21935&atid=373747 Environment: DocBook XSL 1.75.2; Xubuntu 8.04 I get the following validation errors when navigation headers are in included in the generated XHTML: ERROR: article.epub/OEBPS/ix01.html(3): attribute "width" not allowed at this point; ignored This is because DocBook XSL has emitted invalid XHTML 1.1: tables using the 'width' element are generated automatically in navigation headers. Though, admittedly, navigation is redundant if you're reading with an EPUB reader. Suppress by setting the suppress.navigation param to 1. Is this a DocBook XSL bug? The Linux zip(1) command ------------------------ If you use the Linux `zip(1)` command to update or create EPUB files you must use the `-X`, `--no-extra` command-line option, if you do not the platform dependent extra fields will confuse `epubcheck(1)` which will emit errors like ``extra field length for first filename must be 0, but was 28''. asciidoc-8.6.9/doc/faq.txt0000664000175100017510000013463412156277621015565 0ustar srackhamsrackhamAsciiDoc Frequently Asked Questions =================================== NOTE: New FAQs are appended to the bottom of this document. ///////////////////////////////////////////////////////////////// ADD NEW FAQS TO THE BOTTOM OF THIS DOCUMENT TO MAINTAIN NUMBERING ///////////////////////////////////////////////////////////////// == How do you handle spaces in included file names? Spaces are not allowed in macro targets so this include macro will not be processed: include::my document.txt[] The work-around is to replace the spaces with the `{sp}` (space character) attribute, for example: include::my{sp}document.txt[] == How do I number all paragraphs? Some documents such as specifications and legalese require all paragraphs to be sequentially numbered through the document, and to be able to reference these numbers. This can be achieved by using the DocBook toolchain but numbering the paragraphs with AsciiDoc using a custom config file containing the following (see http://asciidoc.org/userguide.html#X27 for ways to include such a file): --------------------------------------------------------------------- [paragraph] {title} {title%} {paracounter} | {title%} {title#} {counter2:paracounter} {empty} --------------------------------------------------------------------- References to the paragraphs operate in the normal way, you label the paragraph: ----------------------------- [[some_label_you_understand]] paragraph contents ----------------------------- and reference it in the normal manner: ----------------------------- <> ----------------------------- The text of the reference will be the paragraph number. For this to work for HTML you have to generate it via the DocBook toolchain. == Sources of information on configuring DocBook toolchains DocBook is a content and structure markup language, therefore AsciiDoc generated DocBook markup is also limited to content and structure. Layout and formatting definition is specific to the DocBook toolchain. The dblatex toolchain can be configured by setting parameters defined at http://dblatex.sourceforge.net/doc/manual/sec-params.html or for more complex styling by custom Latex stylesheets described at http://dblatex.sourceforge.net/doc/manual/sec-custom-latex.html. Similarly FOP can be configured by parameters described at http://sagehill.net/docbookxsl/OptionsPart.html and with custom xsl stylesheets generating formatting objects as described at http://sagehill.net/docbookxsl/CustomizingPart.html. [[X5]] == How can I include embedded fonts in an EPUB document? This is a two step process: 1. Declare the font files and their use in your document's CSS stylesheet. For example: + [listing] ......................................... @font-face { font-family : LiberationSerif-Regular; font-weight : normal; font-style: normal; src : url(LiberationSerif-Regular.ttf); } body { font-family: LiberationSerif-Regular, serif; } ......................................... 2. Declare the font file as resource when you use `a2x(1)` to compile the EPUB. For example: a2x -f epub -d book --epubcheck --stylesheet epubtest.css --resource .ttf=application/x-font-ttf --resource LiberationSerif-Regular.ttf epubtest.txt [NOTE] ====== - Requires AsciiDoc 8.6.5 or better. - The True Type Font mimetype had to be declared explicitly with the `--resource .ttf=application/x-font-ttf` option because it wasn't registered on my Linux system. - In the above example the font file is in the same directory as the AsciiDoc source file and is installed to the same relative location in the EPUB archive OEBPS directory -- if your font file resides in a different location you'll need to adjust the `--resource` option accordingly (see the 'RESOURCES' section in the `a2x(1)` man page for details). - The URL value of the CSS 'src' property is set to the destination font file relative to the CSS file. - The `--resource` option allows you to inject any file (not just font files) into the EPUB output document. - Using the CSS '@font-face' rule is a complex subject and is outside the scope of this FAQ. - Many EPUB readers do not process embedded fonts. ====== == What's the difference between + quoted text and ` quoted monospaced text? `+` (plus) quoted text is implemented as an AsciiDoc 'quotes' whereas +`+ (grave accent or backtick) quoted text is implemented as an AsciiDoc 'inline literal' passthrough macro. The semantics are different: 1. Inline passthrough macros are processed before any other inline substitutions e.g. all of the following line will be processed as a single inline passthrough and rendered as monospaced text (which is not the intended result): + -- `single quoted text' and `monospaced quoted text` This line works as expected: `single quoted text' and +monospaced quoted text+ -- 2. Backtick quoted text is rendered literally i.e. no substitutions are performed on the enclosed text. Here are some examples that would have to be escaped if plus quoting were used (<>): The `++i` and `++j` auto-increments. Paths `~/.vim` and `~/docs`. The `__init__` method. The `{id}` attribute. == Why is the generated HTML title element text invalid? Probably because your document title contains formatting that has generated HTML title markup. You can resolve this by explicitly defining the 'title' attribute in your document's header. == AsciiDoc sometimes generates invalid output markup, why? AsciiDoc is backend agnostic, the 'asciidoc' command has no knowledge of the syntax or structure of the backend format that it generates. Output document validation (syntactic and structural) should be performed separately by external validation tools. For example, AsciiDoc's 'a2x' toolchain command automatically performs validation checks using 'xmllint'. == The AsciiDoc toclevels attribute does not work with DocBook outputs, why? DocBook has no provision for specifying table of contents levels but you can set the TOC level further down the toolchain by passing the DocBook XSL Stylesheets http://docbook.sourceforge.net/release/xsl/current/doc/html/toc.section.depth.html[toc.section.depth] parameter to 'dblatex' (using the `--param` option) or 'xsltproc' (using the `--stringparam` option). For example to show only chapter titles in the TOC of a 'book' document set 'toc.section.depth' to '0'. Increment the 'toc.section.depth' value to show more sub-section titles. If you are using 'a2x' you can set the options in the source file, for example: // a2x: --xsltproc-opts "--stringparam toc.section.depth 0" // a2x: --dblatex-opts "--param toc.section.depth=0" If the document is of type 'article' use the value '1' to show only top level section titles in the TOC, use the value '2' for two levels etc. == How can I include chapter and section tables of contents? DocBook outputs processed by DocBook XSL Stylesheets (either manually or via 'a2x') can generate additional separate section and chapter tables of contents using combinations of the http://www.sagehill.net/docbookxsl/TOCcontrol.html[TOC parameters]. Here are some examples using combinations of the `generate.section.toc.level` and `toc.section.depth` DocBook XSL Stylesheets parameters: [cols="2*l,4",width="90%",frame="topbot",options="header"] |====================================================== |generate.section.toc.level |toc.section.depth | |1 | |Single level book chapter TOCs or article section TOCs |1 | 3 |Article section TOCs with two levels |1 | 2 |Book chapter TOCs with two levels |====================================================== == How can I customize the appearance of XHTML and EPUB documents generated by a2x? You can customize the appearance of an EPUB document with CSS. See the link:publishing-ebooks-with-asciidoc.html[Sherlock Holmes eBook example] on the AsciiDoc website. == DocBook has many elements for document meta-data -- how can I use them from AsciiDoc? The 'docinfo', 'docinfo1' and 'docinfo2' attributes allow you include link:userguide.html#X97[document information files] containing DocBook XML into the header of the output file. == Do element titles automatically generate link captions? If you go the DocBook route then yes -- just omit the caption from the AsciiDoc 'xref' (`<<...>>`) macro. Both dblatex and DocBook XSL will use the target element's title text. Examples: [listing] .................................................................. [[X1]] Section One ----------- Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas ultrices justo porttitor augue. Vestibulum pretium. Donec porta See also <> (this link displays the text 'A titled paragraph'). [id="X2",reftext="2nd section"] Section Two ----------- See also <> (this link displays the text 'Section One'). [[X3]] .A titled paragraph Lorem ipsum dolor sit amet, consectetuer adipiscing elit. See also <> (this link displays the text '2nd section'). .................................................................. The AsciiDoc 'reftext' attribute has been used to explicitly set the link text to '2nd section' for 'Section Two'. == Can I define my own table styles? In addition to the built-in styles you can define your own. This (simplified) example for HTML backends defines a table style called 'red' which sets the background cell color to red. First put the definition in a configuration file: [listing] ......................................... [tabledef-default] red-style=tags="red" [tabletags-red] bodydata=|
    , style=