README.adoc in asciidoctor-1.5.3 vs README.adoc in asciidoctor-1.5.4

- old
+ new

@@ -1,8 +1,8 @@ = Asciidoctor Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]>; Ryan Waldron <https://github.com/erebor[@erebor]> -v1.5.3, 2015-10-31 +v1.5.4, 2016-01-05 // settings: :page-layout: base :idprefix: :idseparator: - :source-language: ruby @@ -33,11 +33,12 @@ :uri-discuss: http://discuss.asciidoctor.org :uri-irc: irc://irc.freenode.org/#asciidoctor :uri-rubygem: https://rubygems.org/gems/asciidoctor :uri-what-is-asciidoc: {uri-docs}/what-is-asciidoc :uri-user-manual: {uri-docs}/user-manual -:uri-install-doc: {uri-docs}/install-toolchain +:uri-install-docker: https://github.com/asciidoctor/docker-asciidoctor +//:uri-install-doc: {uri-docs}/install-toolchain :uri-install-osx-doc: {uri-docs}/install-asciidoctor-macosx :uri-render-doc: {uri-docs}/render-documents :uri-themes-doc: {uri-docs}/produce-custom-themes-using-asciidoctor-stylesheet-factory :uri-gitscm-repo: https://github.com/git/git-scm.com :uri-prototype: {uri-gitscm-repo}/commits/master/lib/asciidoc.rb @@ -87,17 +88,17 @@ image::{image-uri-screenshot}[Preview of AsciiDoc source and corresponding rendered HTML] == AsciiDoc Processing -Asciidoctor reads and parses text written in the AsciiDoc syntax, then feeds the parse tree into a set of built-in templates to produce HTML5, DocBook 5 (or 4.5). -You have the option of writing your own converter or providing {uri-tilt}[Tilt]-supported templates to customize the generated output or produce alternative formats. +Asciidoctor reads and parses text written in the AsciiDoc syntax, then feeds the parse tree to a set of built-in converters to produce HTML5, DocBook 5 (or 4.5) or man(ual) page output. +You have the option of using your own converter or loading {uri-tilt}[Tilt]-supported templates to customize the generated output or produce additional formats. NOTE: Asciidoctor is a drop-in replacement for the original AsciiDoc Python processor (`asciidoc.py`). The Asciidoctor test suite has {uri-tests}[> 1,600 tests] to ensure compatibility with the AsciiDoc syntax. -In addition to the standard AsciiDoc syntax, Asciidoctor recognizes additional markup and formatting options, such as font-based icons (e.g., `+icon:fire[]+`) and UI elements (e.g., `+button:[Save]+`). +In addition to the classic AsciiDoc syntax, Asciidoctor recognizes additional markup and formatting options, such as font-based icons (e.g., `+icon:fire[]+`) and UI elements (e.g., `+button:[Save]+`). Asciidoctor also offers a modern, responsive theme based on {uri-foundation}[Foundation] to style the HTML5 output. == Requirements Asciidoctor works on Linux, OSX (Mac) and Windows and requires one of the following implementations of {uri-ruby}[Ruby]: @@ -188,12 +189,14 @@ TIP: Your Debian or Ubuntu system may be configured to automatically update packages, in which case no action is required by you to update the gem. === Other installation options -* {uri-install-doc}[Installing the Asciidoctor toolchain] +* {uri-install-docker}[Installing Asciidoctor using Docker] * {uri-install-osx-doc}[Installing Asciidoctor on Mac OS X] +// at the moment, the following entry is just a reiteration of the information in this README +//* {uri-install-doc}[Installing the Asciidoctor toolchain] == Usage If the Asciidoctor gem installed successfully, the `asciidoctor` command line interface (CLI) will be available on your PATH. To verify it's available, run the following in your terminal: @@ -333,11 +336,11 @@ Issue tracker:: {uri-issues} Asciidoctor organization on GitHub:: {uri-org} == Copyright and Licensing -Copyright (C) 2012-2015 Dan Allen, Ryan Waldron and the Asciidoctor Project. +Copyright (C) 2012-2016 Dan Allen, Ryan Waldron and the Asciidoctor Project. Free use of this software is granted under the terms of the MIT License. See the {uri-license}[LICENSE] file for details. == Authors @@ -347,25 +350,74 @@ *AsciiDoc* was started by Stuart Rackham and has received contributions from many other individuals in the AsciiDoc community. == Changelog +== 1.5.4 (2016-01-03) - @mojavelinux + +Enhancements:: + * translate README into French (@anthonny, @mogztter, @gscheibel, @mgreau) (#1630) + * allow linkstyle in manpage output to be configured (#1610) + +Improvements:: + * upgrade to MathJax 2.6.0 and disable loading messages + * upgrade to Font Awesome 4.5.0 + * disable toc if document has no sections (#1633) + * convert inline asciimath to MathML (using asciimath gem) in DocBook converter (#1622) + * add attribute to control build reproducibility (@bk2204) (#1453) + * recognize \file:/// as a file root in Opal browser env (#1561) + * honor icon attribute on admonition block when font-based icons are enabled (@robertpanzer) (#1593) + * resolve custom icon relative to iconsdir; add file extension if absent (#1634) + * allow asciidoctor cli to resolve library path when invoked without leading ./ + +Compliance:: + * allow special section to be nested at any depth (#1591) + * ensure colpcwidth values add up to 100%; increase precision of values to 4 decimal places (#1647) + * ignore blank cols attribute on table (#1647) + * support shorthand syntax for block attributes on document title (#1650) + +Bug fixes:: + * don't include default toc in AsciiDoc table cell; don't pass toc location attributes to nested document (#1582) + * guard against nil dlist list item in find_by (#1618) + * don't swallow trailing line when include file is not readable (#1602) + * change xlink namespace to xl in DocBook 5 output to prevent parse error (#1597) + * make callouts globally unique within document, including AsciiDoc table cells (#1626) + * initialize Slim-related attributes regardless of when Slim was loaded (@terceiro) (#1576) + * differentiate literal backslash from escape sequence in manpage output (@ds26gte) (#1604) + * don't mistake line beginning with \. for troff macro in manpage output (@ds26gte) (#1589) + * escape leading dots so user content doesn't trigger troff macros in manpage output (@ds26gte) (#1631) + * use \c after .URL macro to remove extraneous space in manpage output (@ds26gte) (#1590) + * fix missing endline after .URL macro in manpage output (#1613) + * properly handle spacing around .URL/.MTO macro in manpage output (@ds26gte) (#1641) + * don't swallow doctitle attribute followed by block title (#1587) + * change strategy for splitting names of author; fixes bug in Opal/Asciidoctor.js + * don't fail if library is loaded more than once + +Infrastructure:: + * remove trailing endlines in project source code + * update contributing guidelines + * explicitly test ifeval scenario raised in issue #1585 + * remove backreference substitution hack for Opal/Asciidoctor.js + * fix assignment of default Hash value for Opal/Asciidoctor.js + * add JRuby 9.0.4.0 and Ruby 2.3.0 to the Travis CI build matrix + == 1.5.3 (2015-10-31) - @mojavelinux Enhancements:: * add support for interactive & inline SVGs (#1301, #1224) * add built-in manpage backend (@davidgamba) (#651) * create Mallard backend; asciidoctor/asciidoctor-mallard (@bk2204) (#425) * add AsciiMath to MathML converter to support AsciiMath in DocBook converter (@pepijnve) (#954) * allow text of selected lines to be highlighted in source block by Pygments or CodeRay (#1429) * use value of `docinfo` attribute to control docinfo behavior (#1510) * add `docinfosubs` attribute to control which substitutions are performed on docinfo files (@mogztter) (#405) - * add title accessor as alias to main on Document::Title (@rmannibucau) (#1350) + * drop ability to specify multiple attributes with a single `-a` flag when using the CLI (@mogztter) (#405) + * make subtitle separator chars for document title configurable (@rmannibucau) (#1350) * make XrefInlineRx regexp more permissive (Mathieu Boespflug) (#844) Improvements:: - * load JavaScript and CSS at the end of HTML document (@mogztter) (#1238) + * load JavaScript and CSS at bottom of HTML document (@mogztter) (#1238) * list available backends in help text (@plaindocs) (#1271) * properly expand tabs in literal text (#1170, #841) * add `source-indent` as document attribute (@mogztter) (#1169) * upgrade MathJax to 2.5.3 (#1329) * upgrade Font Awesome to 4.4.0 (@mogztter) (#1465) @@ -399,11 +451,11 @@ * introduce helper methods for sniffing URIs (#1422) * add helper to calculate basename without file extension * document `-I` and `-r` options in the manual page (@bk2204) * fix `+--help+` output text for `-I` (@bk2204) * don't require open-uri-cached if already loaded - * do not attempt to scan pattern of non-existent directory + * do not attempt to scan pattern of non-existent directory in template converter Compliance:: * use `<sup>` for footnote reference in text instead of `<span>` (#1523) * fix alignment of wrapped text in footnote (#1524) * include full stop after footnote number in embeddable HTML @@ -484,27 +536,7 @@ Bug fixes:: * add explicit to_s call to generate delimiter settings for MathJax config (#1198) * fix includes that reference absolute Windows paths (#1144) * apply DSL to extension block in a way compatible with Opal - -== 1.5.1 (2014-09-29) - @mojavelinux - -Bug fixes:: - - * recognize tag directives inside comments within XML files for including tagged regions - * restore passthroughs inside footnotes when more than one footnote appears on the same line - * -S flag in cli recognizes safe mode name as lowercase string - * do not match # in character reference when looking for marked text - * add namespace to lang attribute in DocBook 5 backend - * restore missing space before conum on last line of listing when highlighting with Pygments - * place conums on correct lines when line numbers are enabled when highlighting with Pygments - * don't expand mailto links in print styles - -Improvements:: - - * implement File.read in Node (JavaScript) environment - * assign sectnumlevels and toclevels values to maxdepth attribute on AsciiDoc processing instructions in DocBook output - * add test for usage of image block macro with data URI - * use badges from shields.io in README Refer to the {uri-changelog}[CHANGELOG] for a complete list of changes in older releases.