Bug 556171 - New release of asciidoc available
Summary: New release of asciidoc available
Keywords:
Status: CLOSED RAWHIDE
Alias: None
Product: Fedora
Classification: Fedora
Component: asciidoc
Version: rawhide
Hardware: All
OS: Linux
low
medium
Target Milestone: ---
Assignee: Stanislav Ochotnicky
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2010-01-16 22:44 UTC by Fabian Affolter
Modified: 2013-03-12 17:03 UTC (History)
17 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2013-03-12 17:03:13 UTC
Type: ---
Embargoed:


Attachments (Terms of Use)
Patch updating asciidoc to latest version and fixing up all kinds of stuff (11.60 KB, patch)
2013-03-07 13:59 UTC, Stanislav Ochotnicky
no flags Details | Diff

Description Fabian Affolter 2010-01-16 22:44:33 UTC
There is a new release of asciidoc available.

Latest version :     8.5.2
Version in Fedora :  8.4.5

http://www.methods.co.nz/asciidoc/CHANGELOG.html

Comment 1 Fabian Affolter 2010-03-03 08:58:34 UTC
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.

Comment 2 Bug Zapper 2010-03-15 14:05:58 UTC
This bug appears to have been reported against 'rawhide' during the Fedora 13 development cycle.
Changing version to '13'.

More information and reason for this action is here:
http://fedoraproject.org/wiki/BugZappers/HouseKeeping

Comment 3 Fabian Affolter 2010-08-30 19:00:43 UTC
Version 8.6.1

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).

Comment 4 Fabian Affolter 2010-10-10 13:39:01 UTC
Version 8.6.2 was released.

Comment 5 Fabian Affolter 2010-11-18 11:12:38 UTC
Version 8.6.3 was released.

Comment 6 Fabian Affolter 2011-03-14 09:45:01 UTC
8.6.4 is out.

Comment 7 Michael J Gruber 2011-03-16 08:52:15 UTC
(In reply to comment #6)
> 8.6.4 is out.

Can you confirm that 8.6.4 does not cause compatibility problems for packages which build their documentation with asciidoc? Asciidoc has a bit of a bad track record in that regard for changes in x of 8.x.y. Rawhide may be the only place for 8.6.y to go.

Comment 8 Remi Collet 2011-07-02 11:45:40 UTC
8.6.5 is out... 8.4.5 is very old (2009, May)

> Rawhide may be the only place for 8.6.y to go.

Yes.

I have some doc which fails with 8.4.5...

Comment 9 jrnieder 2011-07-18 22:00:07 UTC
(In reply to comment #7)
> (In reply to comment #6)
> > 8.6.4 is out.
> 
> Can you confirm that 8.6.4 does not cause compatibility problems for packages
> which build their documentation with asciidoc? Asciidoc has a bit of a bad
> track record in that regard for changes in x of 8.x.y. Rawhide may be the only
> place for 8.6.y to go.

8.6.4 has been working well for me.  If I remember correctly, the last time asciidoc changes caused me suffering was version 8.3.0's introduction of `single quoted' text.

That said, the changelog mentions some regressions.

8.6.1:
   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
   [26]http://groups.google.com/group/asciidoc/browse_thread/thread/b22603
   bfb879418c.

8.5.1:
   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:
   [60]http://hg.sharesource.org/asciidoc/diff/55a5999bfd04/xhtml11.conf

8.5.0:
     * 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 [76]DocBook table widths.

Context: http://thread.gmane.org/gmane.comp.version-control.git/177288/focus=177341

Comment 10 Nathan Lynch 2012-04-13 02:05:48 UTC
Buildroot 2012.02's "manual" target fails on current Fedora releases because asciidoc 8.4 lacks support for the --resource/-r flag for a2x:

[buildroot.git ((2012.02))]$ make V=1 manual
Generating HTML manual...
mkdir -p output/docs/manual
a2x  -f xhtml -d book -L -r /home/nathanl/devel/buildroot.git/docs/images -D output/docs/manual docs/manual/manual.txt
a2x: failed: invalid command options, run: a2x --help
make: *** [output/docs/manual/manual.html] Error 1
[buildroot.git ((2012.02))]$ rpm -qf /usr/bin/a2x 
asciidoc-8.4.5-6.fc15.noarch

At least one other major distribution I checked has been shipping asciidoc 8.6 for a year now.

Current asciidoc release is 8.6.7.

Comment 11 Olivier Bilodeau 2012-04-18 17:17:47 UTC
Anything I can do to make this move forward? I'm trying to port our PacketFence (www.packetfence.org) system to fc16 but can't build the documentation on it because of the too old asciidoc.

Comment 12 Olivier Bilodeau 2012-04-18 19:00:48 UTC
Ok, this is my first stab at contributing package fixes to Fedora (although far from my first non-fedora contribution) so please let me know if I'm taking any misdirected steps or anything. I would really like to see this go in the distribution.

First, the issues against 8.4.5 were fixed upstream so I think that trying to build an updated package in rawhide would make sense. The only thing I'm not sure is the datadir patch and I requested comments from upstream about it since it no longer applies.

I cloned the fedora asciidoc package repo, applied changes on top and pushed my changes here: https://github.com/inverse-inc/asciidoc.spec. It built 8.6.7 and installed fine on my machine. Then I generated a fairly large docbook from our asciidoc (https://raw.github.com/inverse-inc/packetfence/stable/docs/PacketFence_Administration_Guide.asciidoc) with success.

Let me know of anything else I can do.

Comment 13 Dan Allen 2012-06-07 04:38:46 UTC
I'd really like to see this package update get accepted. Various JBoss Community projects have adopted AsciiDoc (e.g., http://github.com/jboss-jdf) and we'd like to roll out adoption wider. Support in Linux is a critical part of acceptance.

We specifically need something in the 8.6.x series, optimally 8.6.7. Right now we're having to tell team members and contributors to avoid using the package in the Fedora 16 or 17 repository because they can't build the documentation without the source filter.

I can confirm that 8.6.7 is a reliable release. Considering people are running into problems generating documentation with version in Fedora (8.4.5), I'd say upgrading is a step forward for sure.

Comment 14 Dan Allen 2012-06-07 05:31:11 UTC
To allow the use of source code blocks out of the box, one of the syntax highlighting engines is required.

Here's an example of a source block:

[source,python]
----
if n < 0: print 'Hello World!'
----

If you try to process a document aftering installing the asciidoc 8.6.7 package, it results in these warnings.

asciidoc: WARNING: test.asciidoc: line 16: filter non-zero exit code: source-highlight -f xhtml -s java: returned 127
asciidoc: WARNING: test.asciidoc: line 16: no output from filter: source-highlight -f xhtml -s java

I think that the following requires line should be added to the spec file:

Requires: source-highlight

If there were a way to specify optional dependencies (but there doesn't seem to be), I'd recommend added the following package as optional:

python-pygments

Python pygments is preferred by many because, unlike source-highlight, it uses CSS classes to style the keywords, making it easy to change the theme without changing the generated document. It also has some nice themes out of the box.

Unfortunately, it's not the default. So if we marked it as a requires instead of source-highlight, it still has to be selected explicitly in the commandline:

asciidoc -a pygments test.asciidoc

Thus, source-highlight is probably the better choice. But I'm open to either approach.

Comment 15 Dan Allen 2012-07-27 05:44:52 UTC
8.6.8 is out and has some key bug fixes and improvements. I would recommend 8.6.8 over 8.6.7. Details here: 

http://www.methods.co.nz/asciidoc/CHANGELOG.html

Comment 16 Simon Arnaud 2012-09-28 12:50:11 UTC
The 8.4.5 version is 3 years old.

It would make sense to include the latest version, 8.6.8, in F18.

I understand it might break some documentation, but as per fedora core value :
"there are other Linux products derived from Fedora you can use for long-term stability"

Comment 17 Rex Dieter 2012-09-28 14:24:00 UTC
We've yet to get any sort of response from Chris here, perhaps one of you may be interested in becoming comaintainer and help out?

Chris, would that be agreeable?

and consider this first ping, wrt 
https://fedoraproject.org/wiki/Policy_for_nonresponsive_package_maintainers
in case Chris is absent or doesn't respond

Comment 18 Robin Lee 2012-11-14 06:49:00 UTC
Another ping.

Comment 19 Dan Allen 2012-12-05 22:04:32 UTC
Usage of AsciiDoc is picking up and the version in Fedora is unable to render many of the documents that are being created because of lack of features like the source filter.

On the flip side, we have lots of documents that we can test and we'll start to get feedback sooner. Here's a partial list I've accumulated.

* Neo4j - https://github.com/neo4j/neo4j/tree/master/manual/src/main/resources
* CDI Specification - https://github.com/jboss/cdi
* JBoss Developer Framework - https://github.com/jboss-jdf/ticket-monster/tree/master/tutorial
* AeroGear - https://github.com/aerogear/aerogear.org/tree/master/docs/guides
* O'Reilly Authors (iOS book, Scala book, Gradle book, etc)
* PacketFence -  https://github.com/inverse-inc/packetfence/tree/devel/docs

I'd say this upgrade is becoming more than just a wishlist, but a priority.

Comment 20 Eric Hopper 2013-02-19 23:58:40 UTC
Yes, I'm going to be needing the new version as well.

Comment 21 Rex Dieter 2013-02-20 00:55:02 UTC
OK, looks like we're up to step 4 of
https://fedoraproject.org/wiki/Policy_for_nonresponsive_package_maintainers#Outline

4. reporter posts to the Fedora devel list with a link to the bug report and asks if anyone knows how to contact the maintainer.

and if that still fails,

5.  reporter posts a formal request to the Fedora devel list with the bug link, indicating all reasonable efforts to contact the maintainer have failed and that they wish to take over the package.


Any volunteer willing to take these steps with the intention of taking over maintenance of asciidoc moving forward?

Comment 22 Eric Hopper 2013-02-20 01:20:25 UTC
I just made myself an rpm of the very latest version of asciidoc, so it's tempting, but I don't think I can promise the time going forward.

I'm also not positive I got the datadir patch correct.

Comment 23 Stanislav Ochotnicky 2013-03-07 13:59:09 UTC
Created attachment 706594 [details]
Patch updating asciidoc to latest version and fixing up all kinds of stuff

Comment 24 Stanislav Ochotnicky 2013-03-07 14:01:46 UTC
To be clear my update drops the datadir patch and instead I just used symlinks. It's much less error-prone and easier to update the package this way. 

Working with upstream to move their things appropriately would be ideal though I guess...

Comment 25 Fedora Admin XMLRPC Client 2013-03-07 21:33:28 UTC
This package has changed ownership in the Fedora Package Database.  Reassigning to the new owner of this component.

Comment 26 Stanislav Ochotnicky 2013-03-08 12:48:25 UTC
I have built the package in rawhide:
http://koji.fedoraproject.org/koji/buildinfo?buildID=400964

I untagged it and plan to tag it as is on Monday unless there will be some major issues.

Comment 27 Stanislav Ochotnicky 2013-03-12 17:03:13 UTC
Build tagged, closing


Note You need to log in before you can comment on or make changes to this bug.