11:15 a.m.
Pete,
I head from Jason that you're experimenting with using Asciidoctor to
generate the HTML for some of the guides. I'm thrilled to here that. It
also prompted me to review how Asciidoctor handles these documents. I
processed the following guide:
https://github.com/jboss-jdf/jboss-as-quickstart/tree/master/guide
I've come up with some observations and recommendations. But first, some
general advice for using Asciidoctor.
If you are using Asciidoctor view the API, you'll want to disable SafeMode
(since that's not relevant for builds) and enable full document output:
Asciidoctor.render_file('guide.asciidoc', :safe =>
Asciidoctor::SafeMode::UNSAFE, :header_footer => true, :in_place => true)
The :in_place option mimics the behavior of AsciiDoc of rendering to file
w/ the same basename as the source file.
Coming in 0.1.0 is a cli, named asciidoctor. You'll be able to use that as
a drop-in replacement for the asciidoc command.
Moving on to the feedback.
* AsciiDoc clips the label of the following xref (because of the comma in
the label), whereas Asciidoctor gets it right:
<<GettingStarted-on_linux, Installing and starting the JBoss server on
Linux, Unix or Mac OS X>>
* Asciidoctor does not process the anchor:name[] macro, use [[name]]
instead (best is to put it above a section title)
* Asciidoctor does not render callout numbers as icons (I recommend we use
FontAwesome or CSS to accomplish this markup)
* Use a conditional block to setup the source-highlighter when using
Asciidoctor:
ifdef::asciidoctor[]
:source-highlighter: highlightjs
:highlightjs-theme: github
endif::asciidoctor[]
Another option for source highlighting is CodeRay, which is more or less
like Pygments in that it formats the code directly. You'll need to gem
install coderay, then:
ifdef::asciidoctor[]
:source-highlighter: coderay
endif::asciidoctor[]
I noticed a couple of places where Asciidoctor was incorrectly parsing the
text. I fixed them and pushed the changes. They will likely make it into
0.1.0.
If you have any questions, or have any features you'd like to see, let me
know or just post the feedback in the Asciidoctor issue tracker [1].
Cheers!
-Dan
[1] https://github.com/erebor/asciidoctor/issues?state=open
--
Dan Allen
Principal Software Engineer, Red Hat | Author of Seam in Action
Registered Linux User #231597
http://google.com/profiles/dan.j.allen
http://mojavelinux.com
http://mojavelinux.com/seaminaction
11:18 a.m.
Oh yeah, I almost forgot. These feedback comes with a pull request :)
https://github.com/jboss-jdf/jboss-as-quickstart/pull/412
-Dan
On Thu, Jan 24, 2013 at 3:15 AM, Dan Allen <dan.j.allen(a)gmail.com> wrote:
Pete,
I head from Jason that you're experimenting with using Asciidoctor to
generate the HTML for some of the guides. I'm thrilled to here that. It
also prompted me to review how Asciidoctor handles these documents. I
processed the following guide:
https://github.com/jboss-jdf/jboss-as-quickstart/tree/master/guide
I've come up with some observations and recommendations. But first, some
general advice for using Asciidoctor.
If you are using Asciidoctor view the API, you'll want to disable SafeMode
(since that's not relevant for builds) and enable full document output:
Asciidoctor.render_file('guide.asciidoc', :safe =>
Asciidoctor::SafeMode::UNSAFE, :header_footer => true, :in_place => true)
The :in_place option mimics the behavior of AsciiDoc of rendering to file
w/ the same basename as the source file.
Coming in 0.1.0 is a cli, named asciidoctor. You'll be able to use that as
a drop-in replacement for the asciidoc command.
Moving on to the feedback.
* AsciiDoc clips the label of the following xref (because of the comma in
the label), whereas Asciidoctor gets it right:
<<GettingStarted-on_linux, Installing and starting the JBoss server on
Linux, Unix or Mac OS X>>
* Asciidoctor does not process the anchor:name[] macro, use [[name]]
instead (best is to put it above a section title)
* Asciidoctor does not render callout numbers as icons (I recommend we use
FontAwesome or CSS to accomplish this markup)
* Use a conditional block to setup the source-highlighter when using
Asciidoctor:
ifdef::asciidoctor[]
:source-highlighter: highlightjs
:highlightjs-theme: github
endif::asciidoctor[]
Another option for source highlighting is CodeRay, which is more or less
like Pygments in that it formats the code directly. You'll need to gem
install coderay, then:
ifdef::asciidoctor[]
:source-highlighter: coderay
endif::asciidoctor[]
I noticed a couple of places where Asciidoctor was incorrectly parsing the
text. I fixed them and pushed the changes. They will likely make it into
0.1.0.
If you have any questions, or have any features you'd like to see, let me
know or just post the feedback in the Asciidoctor issue tracker [1].
Cheers!
-Dan
[1] https://github.com/erebor/asciidoctor/issues?state=open
--
Dan Allen
Principal Software Engineer, Red Hat | Author of Seam in Action
Registered Linux User #231597
http://google.com/profiles/dan.j.allen
http://mojavelinux.com
http://mojavelinux.com/seaminaction
--
Dan Allen
Principal Software Engineer, Red Hat | Author of Seam in Action
Registered Linux User #231597
http://google.com/profiles/dan.j.allen
http://mojavelinux.com
http://mojavelinux.com/seaminaction
11:32 a.m.
One more thing I want to mention because it's an important difference from
AsciiDoc.
For consistency, flexibility and speed, Asciidoctor enforces that start
delimiters match end delimiters around blocks. For instance, the following
would not work:
====
example block
===============
So if the document totally loses all processing after a certain point, that
could be the culprit.
I also noticed in the Ticket Monster tutorial that tabs are littered in a
lot of places. I strongly recommend against mixing spaces and tabs for
indenting. Asciidoctor can handle it, but I don't normalize tabs to spaces
so you could get misalignment in literal blocks in the output.
-Dan
On Thu, Jan 24, 2013 at 3:18 AM, Dan Allen <dan.j.allen(a)gmail.com> wrote:
Oh yeah, I almost forgot. These feedback comes with a pull request
:)
https://github.com/jboss-jdf/jboss-as-quickstart/pull/412
-Dan
On Thu, Jan 24, 2013 at 3:15 AM, Dan Allen <dan.j.allen(a)gmail.com> wrote:
> Pete,
>
> I head from Jason that you're experimenting with using Asciidoctor to
> generate the HTML for some of the guides. I'm thrilled to here that. It
> also prompted me to review how Asciidoctor handles these documents. I
> processed the following guide:
>
> https://github.com/jboss-jdf/jboss-as-quickstart/tree/master/guide
>
> I've come up with some observations and recommendations. But first, some
> general advice for using Asciidoctor.
>
> If you are using Asciidoctor view the API, you'll want to disable
> SafeMode (since that's not relevant for builds) and enable full document
> output:
>
> Asciidoctor.render_file('guide.asciidoc', :safe =>
> Asciidoctor::SafeMode::UNSAFE, :header_footer => true, :in_place => true)
>
> The :in_place option mimics the behavior of AsciiDoc of rendering to file
> w/ the same basename as the source file.
>
> Coming in 0.1.0 is a cli, named asciidoctor. You'll be able to use that
> as a drop-in replacement for the asciidoc command.
>
> Moving on to the feedback.
>
> * AsciiDoc clips the label of the following xref (because of the comma in
> the label), whereas Asciidoctor gets it right:
>
> <<GettingStarted-on_linux, Installing and starting the JBoss server on
> Linux, Unix or Mac OS X>>
>
> * Asciidoctor does not process the anchor:name[] macro, use [[name]]
> instead (best is to put it above a section title)
> * Asciidoctor does not render callout numbers as icons (I recommend we
> use FontAwesome or CSS to accomplish this markup)
> * Use a conditional block to setup the source-highlighter when using
> Asciidoctor:
>
> ifdef::asciidoctor[]
> :source-highlighter: highlightjs
> :highlightjs-theme: github
> endif::asciidoctor[]
>
> Another option for source highlighting is CodeRay, which is more or less
> like Pygments in that it formats the code directly. You'll need to gem
> install coderay, then:
>
> ifdef::asciidoctor[]
> :source-highlighter: coderay
> endif::asciidoctor[]
>
> I noticed a couple of places where Asciidoctor was incorrectly parsing
> the text. I fixed them and pushed the changes. They will likely make it
> into 0.1.0.
>
> If you have any questions, or have any features you'd like to see, let me
> know or just post the feedback in the Asciidoctor issue tracker [1].
>
> Cheers!
>
> -Dan
>
> [1] https://github.com/erebor/asciidoctor/issues?state=open
>
> --
> Dan Allen
> Principal Software Engineer, Red Hat | Author of Seam in Action
> Registered Linux User #231597
>
> http://google.com/profiles/dan.j.allen
> http://mojavelinux.com
> http://mojavelinux.com/seaminaction
>
--
Dan Allen
Principal Software Engineer, Red Hat | Author of Seam in Action
Registered Linux User #231597
http://google.com/profiles/dan.j.allen
http://mojavelinux.com
http://mojavelinux.com/seaminaction
--
Dan Allen
Principal Software Engineer, Red Hat | Author of Seam in Action
Registered Linux User #231597
http://google.com/profiles/dan.j.allen
http://mojavelinux.com
http://mojavelinux.com/seaminaction
12:25 p.m.
Oh yes, and the underlines for the section titles must be within +/- 1 of
the length of the title.
For instance, this won't work
Section Title
---------
It needs to match up (if this were monospaced font, it would)
Section Title
-------------
But I strongly urge you to prefer the single-line syntax:
= Section Title
It's so much simpler. Plus, the number of equal signs is the section level
(easy to remember), whereas I can never remember which symbol to use for a
given level using the underlines.
-Dan
On Thu, Jan 24, 2013 at 3:32 AM, Dan Allen <dan.j.allen(a)gmail.com> wrote:
One more thing I want to mention because it's an important
difference from
AsciiDoc.
For consistency, flexibility and speed, Asciidoctor enforces that start
delimiters match end delimiters around blocks. For instance, the following
would not work:
====
example block
===============
So if the document totally loses all processing after a certain point,
that could be the culprit.
I also noticed in the Ticket Monster tutorial that tabs are littered in a
lot of places. I strongly recommend against mixing spaces and tabs for
indenting. Asciidoctor can handle it, but I don't normalize tabs to spaces
so you could get misalignment in literal blocks in the output.
-Dan
On Thu, Jan 24, 2013 at 3:18 AM, Dan Allen <dan.j.allen(a)gmail.com> wrote:
> Oh yeah, I almost forgot. These feedback comes with a pull request :)
>
> https://github.com/jboss-jdf/jboss-as-quickstart/pull/412
>
> -Dan
>
>
> On Thu, Jan 24, 2013 at 3:15 AM, Dan Allen <dan.j.allen(a)gmail.com> wrote:
>
>> Pete,
>>
>> I head from Jason that you're experimenting with using Asciidoctor to
>> generate the HTML for some of the guides. I'm thrilled to here that. It
>> also prompted me to review how Asciidoctor handles these documents. I
>> processed the following guide:
>>
>> https://github.com/jboss-jdf/jboss-as-quickstart/tree/master/guide
>>
>> I've come up with some observations and recommendations. But first, some
>> general advice for using Asciidoctor.
>>
>> If you are using Asciidoctor view the API, you'll want to disable
>> SafeMode (since that's not relevant for builds) and enable full document
>> output:
>>
>> Asciidoctor.render_file('guide.asciidoc', :safe =>
>> Asciidoctor::SafeMode::UNSAFE, :header_footer => true, :in_place => true)
>>
>> The :in_place option mimics the behavior of AsciiDoc of rendering to
>> file w/ the same basename as the source file.
>>
>> Coming in 0.1.0 is a cli, named asciidoctor. You'll be able to use that
>> as a drop-in replacement for the asciidoc command.
>>
>> Moving on to the feedback.
>>
>> * AsciiDoc clips the label of the following xref (because of the comma
>> in the label), whereas Asciidoctor gets it right:
>>
>> <<GettingStarted-on_linux, Installing and starting the JBoss server on
>> Linux, Unix or Mac OS X>>
>>
>> * Asciidoctor does not process the anchor:name[] macro, use [[name]]
>> instead (best is to put it above a section title)
>> * Asciidoctor does not render callout numbers as icons (I recommend we
>> use FontAwesome or CSS to accomplish this markup)
>> * Use a conditional block to setup the source-highlighter when using
>> Asciidoctor:
>>
>> ifdef::asciidoctor[]
>> :source-highlighter: highlightjs
>> :highlightjs-theme: github
>> endif::asciidoctor[]
>>
>> Another option for source highlighting is CodeRay, which is more or less
>> like Pygments in that it formats the code directly. You'll need to gem
>> install coderay, then:
>>
>> ifdef::asciidoctor[]
>> :source-highlighter: coderay
>> endif::asciidoctor[]
>>
>> I noticed a couple of places where Asciidoctor was incorrectly parsing
>> the text. I fixed them and pushed the changes. They will likely make it
>> into 0.1.0.
>>
>> If you have any questions, or have any features you'd like to see, let
>> me know or just post the feedback in the Asciidoctor issue tracker [1].
>>
>> Cheers!
>>
>> -Dan
>>
>> [1] https://github.com/erebor/asciidoctor/issues?state=open
>>
>> --
>> Dan Allen
>> Principal Software Engineer, Red Hat | Author of Seam in Action
>> Registered Linux User #231597
>>
>> http://google.com/profiles/dan.j.allen
>> http://mojavelinux.com
>> http://mojavelinux.com/seaminaction
>>
>
>
>
> --
> Dan Allen
> Principal Software Engineer, Red Hat | Author of Seam in Action
> Registered Linux User #231597
>
> http://google.com/profiles/dan.j.allen
> http://mojavelinux.com
> http://mojavelinux.com/seaminaction
>
--
Dan Allen
Principal Software Engineer, Red Hat | Author of Seam in Action
Registered Linux User #231597
http://google.com/profiles/dan.j.allen
http://mojavelinux.com
http://mojavelinux.com/seaminaction
--
Dan Allen
Principal Software Engineer, Red Hat | Author of Seam in Action
Registered Linux User #231597
http://google.com/profiles/dan.j.allen
http://mojavelinux.com
http://mojavelinux.com/seaminaction
2:49 p.m.
On 24 Jan 2013, at 04:32, Dan Allen wrote:
One more thing I want to mention because it's an important
difference from AsciiDoc.
For consistency, flexibility and speed, Asciidoctor enforces that start delimiters match
end delimiters around blocks. For instance, the following would not work:
====
example block
===============
So if the document totally loses all processing after a certain point, that could be the
culprit.
I also noticed in the Ticket Monster tutorial that tabs are littered in a lot of places.
I strongly recommend against mixing spaces and tabs for indenting. Asciidoctor can handle
it, but I don't normalize tabs to spaces so you could get misalignment in literal
blocks in the output.
We should definitely normalize this in the sources. I blame the authors (me, Burr, Marius
;-).
Rafael, could you pick this one up?
-Dan
On Thu, Jan 24, 2013 at 3:18 AM, Dan Allen <dan.j.allen(a)gmail.com> wrote:
Oh yeah, I almost forgot. These feedback comes with a pull request :)
https://github.com/jboss-jdf/jboss-as-quickstart/pull/412
-Dan
On Thu, Jan 24, 2013 at 3:15 AM, Dan Allen <dan.j.allen(a)gmail.com> wrote:
Pete,
I head from Jason that you're experimenting with using Asciidoctor to generate the
HTML for some of the guides. I'm thrilled to here that. It also prompted me to review
how Asciidoctor handles these documents. I processed the following guide:
https://github.com/jboss-jdf/jboss-as-quickstart/tree/master/guide
I've come up with some observations and recommendations. But first, some general
advice for using Asciidoctor.
If you are using Asciidoctor view the API, you'll want to disable SafeMode (since
that's not relevant for builds) and enable full document output:
Asciidoctor.render_file('guide.asciidoc', :safe =>
Asciidoctor::SafeMode::UNSAFE, :header_footer => true, :in_place => true)
The :in_place option mimics the behavior of AsciiDoc of rendering to file w/ the same
basename as the source file.
Coming in 0.1.0 is a cli, named asciidoctor. You'll be able to use that as a drop-in
replacement for the asciidoc command.
Moving on to the feedback.
* AsciiDoc clips the label of the following xref (because of the comma in the label),
whereas Asciidoctor gets it right:
<<GettingStarted-on_linux, Installing and starting the JBoss server on Linux,
Unix or Mac OS X>>
* Asciidoctor does not process the anchor:name[] macro, use [[name]] instead (best is to
put it above a section title)
* Asciidoctor does not render callout numbers as icons (I recommend we use FontAwesome or
CSS to accomplish this markup)
* Use a conditional block to setup the source-highlighter when using Asciidoctor:
ifdef::asciidoctor[]
:source-highlighter: highlightjs
:highlightjs-theme: github
endif::asciidoctor[]
Another option for source highlighting is CodeRay, which is more or less like Pygments in
that it formats the code directly. You'll need to gem install coderay, then:
ifdef::asciidoctor[]
:source-highlighter: coderay
endif::asciidoctor[]
I noticed a couple of places where Asciidoctor was incorrectly parsing the text. I fixed
them and pushed the changes. They will likely make it into 0.1.0.
If you have any questions, or have any features you'd like to see, let me know or
just post the feedback in the Asciidoctor issue tracker [1].
Cheers!
-Dan
[1] https://github.com/erebor/asciidoctor/issues?state=open
--
Dan Allen
Principal Software Engineer, Red Hat | Author of Seam in Action
Registered Linux User #231597
http://google.com/profiles/dan.j.allen
http://mojavelinux.com
http://mojavelinux.com/seaminaction
--
Dan Allen
Principal Software Engineer, Red Hat | Author of Seam in Action
Registered Linux User #231597
http://google.com/profiles/dan.j.allen
http://mojavelinux.com
http://mojavelinux.com/seaminaction
--
Dan Allen
Principal Software Engineer, Red Hat | Author of Seam in Action
Registered Linux User #231597
http://google.com/profiles/dan.j.allen
http://mojavelinux.com
http://mojavelinux.com/seaminaction
_______________________________________________
jdf-dev mailing list
jdf-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/jdf-dev
9:10 p.m.
Em 24-01-2013 11:49, Pete Muir escreveu:
On 24 Jan 2013, at 04:32, Dan Allen wrote:
> One more thing I want to mention because it's an important difference from
AsciiDoc.
>
> For consistency, flexibility and speed, Asciidoctor enforces that start delimiters
match end delimiters around blocks. For instance, the following would not work:
>
> ====
> example block
> ===============
>
> So if the document totally loses all processing after a certain point, that could be
the culprit.
>
> I also noticed in the Ticket Monster tutorial that tabs are littered in a lot of
places. I strongly recommend against mixing spaces and tabs for indenting. Asciidoctor can
handle it, but I don't normalize tabs to spaces so you could get misalignment in
literal blocks in the output.
We should definitely normalize this in the sources. I blame the authors (me, Burr, Marius
;-).
Rafael, could you pick this one up?
Sure!
Dan, do I need to update the jdf-site to use asciidoctor or is it
embedded to awestruct 0.4.8 ?
> -Dan
>
> On Thu, Jan 24, 2013 at 3:18 AM, Dan Allen<dan.j.allen(a)gmail.com> wrote:
> Oh yeah, I almost forgot. These feedback comes with a pull request :)
>
> https://github.com/jboss-jdf/jboss-as-quickstart/pull/412
>
> -Dan
>
>
> On Thu, Jan 24, 2013 at 3:15 AM, Dan Allen<dan.j.allen(a)gmail.com> wrote:
> Pete,
>
> I head from Jason that you're experimenting with using Asciidoctor to generate
the HTML for some of the guides. I'm thrilled to here that. It also prompted me to
review how Asciidoctor handles these documents. I processed the following guide:
>
> https://github.com/jboss-jdf/jboss-as-quickstart/tree/master/guide
>
> I've come up with some observations and recommendations. But first, some general
advice for using Asciidoctor.
>
> If you are using Asciidoctor view the API, you'll want to disable SafeMode (since
that's not relevant for builds) and enable full document output:
>
> Asciidoctor.render_file('guide.asciidoc', :safe =>
Asciidoctor::SafeMode::UNSAFE, :header_footer => true, :in_place => true)
>
> The :in_place option mimics the behavior of AsciiDoc of rendering to file w/ the same
basename as the source file.
>
> Coming in 0.1.0 is a cli, named asciidoctor. You'll be able to use that as a
drop-in replacement for the asciidoc command.
>
> Moving on to the feedback.
>
> * AsciiDoc clips the label of the following xref (because of the comma in the label),
whereas Asciidoctor gets it right:
>
> <<GettingStarted-on_linux, Installing and starting the JBoss server on
Linux, Unix or Mac OS X>>
>
> * Asciidoctor does not process the anchor:name[] macro, use [[name]] instead (best is
to put it above a section title)
> * Asciidoctor does not render callout numbers as icons (I recommend we use
FontAwesome or CSS to accomplish this markup)
> * Use a conditional block to setup the source-highlighter when using Asciidoctor:
>
> ifdef::asciidoctor[]
> :source-highlighter: highlightjs
> :highlightjs-theme: github
> endif::asciidoctor[]
>
> Another option for source highlighting is CodeRay, which is more or less like
Pygments in that it formats the code directly. You'll need to gem install coderay,
then:
>
> ifdef::asciidoctor[]
> :source-highlighter: coderay
> endif::asciidoctor[]
>
> I noticed a couple of places where Asciidoctor was incorrectly parsing the text. I
fixed them and pushed the changes. They will likely make it into 0.1.0.
>
> If you have any questions, or have any features you'd like to see, let me know or
just post the feedback in the Asciidoctor issue tracker [1].
>
> Cheers!
>
> -Dan
>
> [1] https://github.com/erebor/asciidoctor/issues?state=open
>
> --
> Dan Allen
> Principal Software Engineer, Red Hat | Author of Seam in Action
> Registered Linux User #231597
>
> http://google.com/profiles/dan.j.allen
> http://mojavelinux.com
> http://mojavelinux.com/seaminaction
>
>
>
> --
> Dan Allen
> Principal Software Engineer, Red Hat | Author of Seam in Action
> Registered Linux User #231597
>
> http://google.com/profiles/dan.j.allen
> http://mojavelinux.com
> http://mojavelinux.com/seaminaction
>
>
>
> --
> Dan Allen
> Principal Software Engineer, Red Hat | Author of Seam in Action
> Registered Linux User #231597
>
> http://google.com/profiles/dan.j.allen
> http://mojavelinux.com
> http://mojavelinux.com/seaminaction
> _______________________________________________
> jdf-dev mailing list
> jdf-dev(a)lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/jdf-dev
_______________________________________________
jdf-dev mailing list
jdf-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/jdf-dev
2:48 p.m.
Thanks Dan!
Sande, can you review Dan's pull, and also update the CONTRIBUTING.md to reflect his
recommendations below?
Pete
On 24 Jan 2013, at 04:18, Dan Allen wrote:
Oh yeah, I almost forgot. These feedback comes with a pull request
:)
https://github.com/jboss-jdf/jboss-as-quickstart/pull/412
-Dan
On Thu, Jan 24, 2013 at 3:15 AM, Dan Allen <dan.j.allen(a)gmail.com> wrote:
Pete,
I head from Jason that you're experimenting with using Asciidoctor to generate the
HTML for some of the guides. I'm thrilled to here that. It also prompted me to review
how Asciidoctor handles these documents. I processed the following guide:
https://github.com/jboss-jdf/jboss-as-quickstart/tree/master/guide
I've come up with some observations and recommendations. But first, some general
advice for using Asciidoctor.
If you are using Asciidoctor view the API, you'll want to disable SafeMode (since
that's not relevant for builds) and enable full document output:
Asciidoctor.render_file('guide.asciidoc', :safe =>
Asciidoctor::SafeMode::UNSAFE, :header_footer => true, :in_place => true)
The :in_place option mimics the behavior of AsciiDoc of rendering to file w/ the same
basename as the source file.
Coming in 0.1.0 is a cli, named asciidoctor. You'll be able to use that as a drop-in
replacement for the asciidoc command.
Moving on to the feedback.
* AsciiDoc clips the label of the following xref (because of the comma in the label),
whereas Asciidoctor gets it right:
<<GettingStarted-on_linux, Installing and starting the JBoss server on Linux,
Unix or Mac OS X>>
* Asciidoctor does not process the anchor:name[] macro, use [[name]] instead (best is to
put it above a section title)
* Asciidoctor does not render callout numbers as icons (I recommend we use FontAwesome or
CSS to accomplish this markup)
* Use a conditional block to setup the source-highlighter when using Asciidoctor:
ifdef::asciidoctor[]
:source-highlighter: highlightjs
:highlightjs-theme: github
endif::asciidoctor[]
Another option for source highlighting is CodeRay, which is more or less like Pygments in
that it formats the code directly. You'll need to gem install coderay, then:
ifdef::asciidoctor[]
:source-highlighter: coderay
endif::asciidoctor[]
I noticed a couple of places where Asciidoctor was incorrectly parsing the text. I fixed
them and pushed the changes. They will likely make it into 0.1.0.
If you have any questions, or have any features you'd like to see, let me know or
just post the feedback in the Asciidoctor issue tracker [1].
Cheers!
-Dan
[1] https://github.com/erebor/asciidoctor/issues?state=open
--
Dan Allen
Principal Software Engineer, Red Hat | Author of Seam in Action
Registered Linux User #231597
http://google.com/profiles/dan.j.allen
http://mojavelinux.com
http://mojavelinux.com/seaminaction
--
Dan Allen
Principal Software Engineer, Red Hat | Author of Seam in Action
Registered Linux User #231597
http://google.com/profiles/dan.j.allen
http://mojavelinux.com
http://mojavelinux.com/seaminaction
_______________________________________________
jdf-dev mailing list
jdf-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/jdf-dev
12:35 a.m.
Hi Dan,
I tried at all cost to install asciidoctor (0.0.7/0.0.9/master) to start
this migration.
For 0.0.7 and 0.0.9 (from rubygems) I got the same error:
$ asciidoctor
/usr/lib64/ruby/1.9.1/rubygems/custom_require.rb:36:in `require': cannot
load such file -- asciidoctor/cli (LoadError)
This error also happens when I built from gem build .gemspec / gem
install .gem
From git repo (master branch)
I CAN use 'bundle exec asciidoctor' BUT when I try to use rake (10.0.3)
I got this error:
rake aborted!
undefined method `markup=' for #<RDoc::Task:0x00000000f1bd50>
that is similar to:
https://github.com/erebor/asciidoctor/pull/41#issuecomment-11742889 but
I couldn't find the solution.
Jason Porter give me some help but now I'm stuck again, so basically I
want to know if can you contribute with some other help to make
asciidoctor run under my environment?
RHEL 6.3
Ruby 1.9.3
Gem 1.8.11
asciidoctor 0.0.9
rake 10.0.3
rdoc 3.12
Thank you.
Em 24-01-2013 08:15, Dan Allen escreveu:
Pete,
I head from Jason that you're experimenting with using Asciidoctor to
generate the HTML for some of the guides. I'm thrilled to here that.
It also prompted me to review how Asciidoctor handles these documents.
I processed the following guide:
https://github.com/jboss-jdf/jboss-as-quickstart/tree/master/guide
I've come up with some observations and recommendations. But first,
some general advice for using Asciidoctor.
If you are using Asciidoctor view the API, you'll want to disable
SafeMode (since that's not relevant for builds) and enable full
document output:
Asciidoctor.render_file('guide.asciidoc', :safe =>
Asciidoctor::SafeMode::UNSAFE, :header_footer => true, :in_place => true)
The :in_place option mimics the behavior of AsciiDoc of rendering to
file w/ the same basename as the source file.
Coming in 0.1.0 is a cli, named asciidoctor. You'll be able to use
that as a drop-in replacement for the asciidoc command.
Moving on to the feedback.
* AsciiDoc clips the label of the following xref (because of the comma
in the label), whereas Asciidoctor gets it right:
<<GettingStarted-on_linux, Installing and starting the JBoss server on
Linux, Unix or Mac OS X>>
* Asciidoctor does not process the anchor:name[] macro, use [[name]]
instead (best is to put it above a section title)
* Asciidoctor does not render callout numbers as icons (I recommend we
use FontAwesome or CSS to accomplish this markup)
* Use a conditional block to setup the source-highlighter when using
Asciidoctor:
ifdef::asciidoctor[]
:source-highlighter: highlightjs
:highlightjs-theme: github
endif::asciidoctor[]
Another option for source highlighting is CodeRay, which is more or
less like Pygments in that it formats the code directly. You'll need
to gem install coderay, then:
ifdef::asciidoctor[]
:source-highlighter: coderay
endif::asciidoctor[]
I noticed a couple of places where Asciidoctor was incorrectly parsing
the text. I fixed them and pushed the changes. They will likely make
it into 0.1.0.
If you have any questions, or have any features you'd like to see, let
me know or just post the feedback in the Asciidoctor issue tracker [1].
Cheers!
-Dan
[1] https://github.com/erebor/asciidoctor/issues?state=open
--
Dan Allen
Principal Software Engineer, Red Hat | Author of Seam in Action
Registered Linux User #231597
http://google.com/profiles/dan.j.allen
http://mojavelinux.com
http://mojavelinux.com/seaminaction
_______________________________________________
jdf-dev mailing list
jdf-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/jdf-dev
1:29 a.m.
Try this Rafael:
$> sudo gem install bundler (if you haven't done this)
$> edit a Gemfile with this content:
source 'https://rubygems.org'
gem 'awestruct', :git => 'git://github.com/erebor/asciidoctor.git'
gem 'awestruct', '~> 0.4.8'
# if you want HEAD from the git repo and comment out the above line
#gem 'awestruct', :git => git://github.com/awestruct/awestruct.git'
gem 'html_truncator' # I don't recall which version here, whatever is latest
in rubygems will be fine
gem 'vpim' # same here
# Use these if you're using awestruct HEAD
#gem 'therubyracer', '~> 0.10.0'
#gem 'tilt', '~> 1.3.3'
#gem 'less', '~> 2.2.2'
$> bundle install --path vendor/bundle
add this to .awestruct_ignore and .gitignore (in case you commit)
vendor
.bundle
$> bundle exec awestruct
That should work just fine then. All of the needed gems will be in vender/bundle. Make
sure you use bundle exec awestruct when you want to invoke awestruct
----- Original Message -----
From: "Rafael Benevides" <benevides(a)redhat.com>
To: "Dan Allen" <dan.j.allen(a)gmail.com>, "Pete Muir"
<pmuir(a)redhat.com>, "jdf-dev" <jdf-dev(a)lists.jboss.org>
Sent: Monday, January 28, 2013 4:35:08 PM
Subject: Re: [jdf-dev] migration feedback for using Asciidoctor
Hi Dan,
I tried at all cost to install asciidoctor (0.0.7/0.0.9/master) to
start this migration.
For 0.0.7 and 0.0.9 (from rubygems) I got the same error:
$ asciidoctor
/usr/lib64/ruby/1.9.1/rubygems/custom_require.rb:36:in `require':
cannot load such file -- asciidoctor/cli (LoadError)
This error also happens when I built from gem build .gemspec / gem
install .gem
From git repo (master branch)
I CAN use 'bundle exec asciidoctor' BUT when I try to use rake
(10.0.3) I got this error:
rake aborted!
undefined method `markup=' for #<RDoc::Task:0x00000000f1bd50>
that is similar to:
https://github.com/erebor/asciidoctor/pull/41#issuecomment-11742889
but I couldn't find the solution.
Jason Porter give me some help but now I'm stuck again, so basically
I want to know if can you contribute with some other help to make
asciidoctor run under my environment?
RHEL 6.3
Ruby 1.9.3
Gem 1.8.11
asciidoctor 0.0.9
rake 10.0.3
rdoc 3.12
Thank you.
10:47 a.m.
Rafael,
We're just about to put out a 0.1.0 gem, which adds the cli among (many)
other features and enhancements. Although there is a cli file prior to
0.1.0, it didn't contain any runnable code.
The problem with the Rakefile seems to be an issue in how Ruby resolves the
Rake version. I have an idea for how to make that failsafe. I'll submit a
patch so that under no circumstances will that line cause the build to fail.
I'll post back once we have 0.1.0 out and we can work through it from there.
-Dan
On Mon, Jan 28, 2013 at 4:35 PM, Rafael Benevides <benevides(a)redhat.com>wrote:
Hi Dan,
I tried at all cost to install asciidoctor (0.0.7/0.0.9/master) to start
this migration.
For 0.0.7 and 0.0.9 (from rubygems) I got the same error:
$ asciidoctor
/usr/lib64/ruby/1.9.1/rubygems/custom_require.rb:36:in `require': cannot
load such file -- asciidoctor/cli (LoadError)
This error also happens when I built from gem build .gemspec / gem install
.gem
From git repo (master branch)
I CAN use 'bundle exec asciidoctor' BUT when I try to use rake (10.0.3) I
got this error:
rake aborted!
undefined method `markup=' for #<RDoc::Task:0x00000000f1bd50>
that is similar to:
https://github.com/erebor/asciidoctor/pull/41#issuecomment-11742889 but I
couldn't find the solution.
Jason Porter give me some help but now I'm stuck again, so basically I
want to know if can you contribute with some other help to make asciidoctor
run under my environment?
RHEL 6.3
Ruby 1.9.3
Gem 1.8.11
asciidoctor 0.0.9
rake 10.0.3
rdoc 3.12
Thank you.
Em 24-01-2013 08:15, Dan Allen escreveu:
Pete,
I head from Jason that you're experimenting with using Asciidoctor to
generate the HTML for some of the guides. I'm thrilled to here that. It
also prompted me to review how Asciidoctor handles these documents. I
processed the following guide:
https://github.com/jboss-jdf/jboss-as-quickstart/tree/master/guide
I've come up with some observations and recommendations. But first, some
general advice for using Asciidoctor.
If you are using Asciidoctor view the API, you'll want to disable
SafeMode (since that's not relevant for builds) and enable full document
output:
Asciidoctor.render_file('guide.asciidoc', :safe =>
Asciidoctor::SafeMode::UNSAFE, :header_footer => true, :in_place => true)
The :in_place option mimics the behavior of AsciiDoc of rendering to
file w/ the same basename as the source file.
Coming in 0.1.0 is a cli, named asciidoctor. You'll be able to use that
as a drop-in replacement for the asciidoc command.
Moving on to the feedback.
* AsciiDoc clips the label of the following xref (because of the comma
in the label), whereas Asciidoctor gets it right:
<<GettingStarted-on_linux, Installing and starting the JBoss server on
Linux, Unix or Mac OS X>>
* Asciidoctor does not process the anchor:name[] macro, use [[name]]
instead (best is to put it above a section title)
* Asciidoctor does not render callout numbers as icons (I recommend we use
FontAwesome or CSS to accomplish this markup)
* Use a conditional block to setup the source-highlighter when using
Asciidoctor:
ifdef::asciidoctor[]
:source-highlighter: highlightjs
:highlightjs-theme: github
endif::asciidoctor[]
Another option for source highlighting is CodeRay, which is more or less
like Pygments in that it formats the code directly. You'll need to gem
install coderay, then:
ifdef::asciidoctor[]
:source-highlighter: coderay
endif::asciidoctor[]
I noticed a couple of places where Asciidoctor was incorrectly parsing
the text. I fixed them and pushed the changes. They will likely make it
into 0.1.0.
If you have any questions, or have any features you'd like to see, let
me know or just post the feedback in the Asciidoctor issue tracker [1].
Cheers!
-Dan
[1] https://github.com/erebor/asciidoctor/issues?state=open
--
Dan Allen
Principal Software Engineer, Red Hat | Author of Seam in Action
Registered Linux User #231597
http://google.com/profiles/dan.j.allen
http://mojavelinux.com
http://mojavelinux.com/seaminaction
_______________________________________________
jdf-dev mailing
listjdf-dev@lists.jboss.orghttps://lists.jboss.org/mailman/listinfo/jdf-dev
--
Dan Allen
Principal Software Engineer, Red Hat | Author of Seam in Action
Registered Linux User #231597
http://google.com/profiles/dan.j.allen
http://mojavelinux.com
http://mojavelinux.com/seaminaction
1:54 p.m.
Just to give you a feeback, I was able to build awestruct 0.1.0 from
source - repo: https://github.com/asciidoctor/asciidoctor
Anyway I still having some issues to run awestruct 0.4.8:
[rafael@Colossus jdf-site (awestruct048)]$ awestruct -d
Using profile: development
Generating site: http://localhost:4242
undefined method `[]=' for nil:NilClass
/usr/lib64/ruby/gems/1.9.1/gems/awestruct-0.4.8/lib/awestruct/handlers/asciidoc_handler.rb:24:in
`initialize'
/usr/lib64/ruby/gems/1.9.1/gems/awestruct-0.4.8/lib/awestruct/handler_chain.rb:21:in
`new'
/usr/lib64/ruby/gems/1.9.1/gems/awestruct-0.4.8/lib/awestruct/handler_chain.rb:21:in
`block in create'
/usr/lib64/ruby/gems/1.9.1/gems/awestruct-0.4.8/lib/awestruct/handler_chain.rb:20:in
`each'
/usr/lib64/ruby/gems/1.9.1/gems/awestruct-0.4.8/lib/awestruct/handler_chain.rb:20:in
`create'
I'll try some luck on #awestruct but if some of you have any clues,
please ping me.
Thank you
Em 29-01-2013 07:47, Dan Allen escreveu:
Rafael,
We're just about to put out a 0.1.0 gem, which adds the cli among
(many) other features and enhancements. Although there is a cli file
prior to 0.1.0, it didn't contain any runnable code.
The problem with the Rakefile seems to be an issue in how Ruby
resolves the Rake version. I have an idea for how to make that
failsafe. I'll submit a patch so that under no circumstances will that
line cause the build to fail.
I'll post back once we have 0.1.0 out and we can work through it from
there.
-Dan
On Mon, Jan 28, 2013 at 4:35 PM, Rafael Benevides
<benevides(a)redhat.com <mailto:benevides@redhat.com>> wrote:
Hi Dan,
I tried at all cost to install asciidoctor (0.0.7/0.0.9/master) to
start this migration.
For 0.0.7 and 0.0.9 (from rubygems) I got the same error:
$ asciidoctor
/usr/lib64/ruby/1.9.1/rubygems/custom_require.rb:36:in `require':
cannot load such file -- asciidoctor/cli (LoadError)
This error also happens when I built from gem build .gemspec / gem
install .gem
From git repo (master branch)
I CAN use 'bundle exec asciidoctor' BUT when I try to use rake
(10.0.3) I got this error:
rake aborted!
undefined method `markup=' for #<RDoc::Task:0x00000000f1bd50>
that is similar to:
https://github.com/erebor/asciidoctor/pull/41#issuecomment-11742889 but
I couldn't find the solution.
Jason Porter give me some help but now I'm stuck again, so
basically I want to know if can you contribute with some other
help to make asciidoctor run under my environment?
RHEL 6.3
Ruby 1.9.3
Gem 1.8.11
asciidoctor 0.0.9
rake 10.0.3
rdoc 3.12
Thank you.
Em 24-01-2013 08:15, Dan Allen escreveu:
> Pete,
>
> I head from Jason that you're experimenting with using
> Asciidoctor to generate the HTML for some of the guides. I'm
> thrilled to here that. It also prompted me to review how
> Asciidoctor handles these documents. I processed the following guide:
>
> https://github.com/jboss-jdf/jboss-as-quickstart/tree/master/guide
>
> I've come up with some observations and recommendations. But
> first, some general advice for using Asciidoctor.
>
> If you are using Asciidoctor view the API, you'll want to disable
> SafeMode (since that's not relevant for builds) and enable full
> document output:
>
> Asciidoctor.render_file('guide.asciidoc', :safe =>
> Asciidoctor::SafeMode::UNSAFE, :header_footer => true, :in_place
> => true)
>
> The :in_place option mimics the behavior of AsciiDoc of rendering
> to file w/ the same basename as the source file.
>
> Coming in 0.1.0 is a cli, named asciidoctor. You'll be able to
> use that as a drop-in replacement for the asciidoc command.
>
> Moving on to the feedback.
>
> * AsciiDoc clips the label of the following xref (because of the
> comma in the label), whereas Asciidoctor gets it right:
>
> <<GettingStarted-on_linux, Installing and starting the JBoss
> server on Linux, Unix or Mac OS X>>
>
> * Asciidoctor does not process the anchor:name[] macro, use
> [[name]] instead (best is to put it above a section title)
> * Asciidoctor does not render callout numbers as icons (I
> recommend we use FontAwesome or CSS to accomplish this markup)
> * Use a conditional block to setup the source-highlighter when
> using Asciidoctor:
>
> ifdef::asciidoctor[]
> :source-highlighter: highlightjs
> :highlightjs-theme: github
> endif::asciidoctor[]
>
> Another option for source highlighting is CodeRay, which is more
> or less like Pygments in that it formats the code directly.
> You'll need to gem install coderay, then:
>
> ifdef::asciidoctor[]
> :source-highlighter: coderay
> endif::asciidoctor[]
>
> I noticed a couple of places where Asciidoctor was incorrectly
> parsing the text. I fixed them and pushed the changes. They will
> likely make it into 0.1.0.
>
> If you have any questions, or have any features you'd like to
> see, let me know or just post the feedback in the Asciidoctor
> issue tracker [1].
>
> Cheers!
>
> -Dan
>
> [1] https://github.com/erebor/asciidoctor/issues?state=open
>
> --
> Dan Allen
> Principal Software Engineer, Red Hat | Author of Seam in Action
> Registered Linux User #231597
>
> http://google.com/profiles/dan.j.allen
> http://mojavelinux.com
> http://mojavelinux.com/seaminaction
>
>
> _______________________________________________
> jdf-dev mailing list
> jdf-dev(a)lists.jboss.org <mailto:jdf-dev@lists.jboss.org>
> https://lists.jboss.org/mailman/listinfo/jdf-dev
--
Dan Allen
Principal Software Engineer, Red Hat | Author of Seam in Action
Registered Linux User #231597
http://google.com/profiles/dan.j.allen
http://mojavelinux.com
http://mojavelinux.com/seaminaction
3:59 p.m.
You're trying the build the jdf site, correct? There some things in the jdf site we
need to fix first. I'm working on it.
----- Rafael Benevides <benevides(a)redhat.com> wrote:
Just to give you a feeback, I was able to build awestruct 0.1.0 from
source - repo: https://github.com/asciidoctor/asciidoctor
Anyway I still having some issues to run awestruct 0.4.8:
[rafael@Colossus jdf-site (awestruct048)]$ awestruct -d
Using profile: development
Generating site: http://localhost:4242
undefined method `[]=' for nil:NilClass
/usr/lib64/ruby/gems/1.9.1/gems/awestruct-0.4.8/lib/awestruct/handlers/asciidoc_handler.rb:24:in
`initialize'
/usr/lib64/ruby/gems/1.9.1/gems/awestruct-0.4.8/lib/awestruct/handler_chain.rb:21:in
`new'
/usr/lib64/ruby/gems/1.9.1/gems/awestruct-0.4.8/lib/awestruct/handler_chain.rb:21:in
`block in create'
/usr/lib64/ruby/gems/1.9.1/gems/awestruct-0.4.8/lib/awestruct/handler_chain.rb:20:in
`each'
/usr/lib64/ruby/gems/1.9.1/gems/awestruct-0.4.8/lib/awestruct/handler_chain.rb:20:in
`create'
I'll try some luck on #awestruct but if some of you have any clues,
please ping me.
Thank you
Em 29-01-2013 07:47, Dan Allen escreveu:
> Rafael,
>
> We're just about to put out a 0.1.0 gem, which adds the cli among
> (many) other features and enhancements. Although there is a cli file
> prior to 0.1.0, it didn't contain any runnable code.
>
> The problem with the Rakefile seems to be an issue in how Ruby
> resolves the Rake version. I have an idea for how to make that
> failsafe. I'll submit a patch so that under no circumstances will that
> line cause the build to fail.
>
> I'll post back once we have 0.1.0 out and we can work through it from
> there.
>
> -Dan
>
> On Mon, Jan 28, 2013 at 4:35 PM, Rafael Benevides
> <benevides(a)redhat.com <mailto:benevides@redhat.com>> wrote:
>
> Hi Dan,
>
> I tried at all cost to install asciidoctor (0.0.7/0.0.9/master) to
> start this migration.
>
> For 0.0.7 and 0.0.9 (from rubygems) I got the same error:
> $ asciidoctor
> /usr/lib64/ruby/1.9.1/rubygems/custom_require.rb:36:in `require':
> cannot load such file -- asciidoctor/cli (LoadError)
>
> This error also happens when I built from gem build .gemspec / gem
> install .gem
>
> From git repo (master branch)
> I CAN use 'bundle exec asciidoctor' BUT when I try to use rake
> (10.0.3) I got this error:
> rake aborted!
> undefined method `markup=' for #<RDoc::Task:0x00000000f1bd50>
> that is similar to:
> https://github.com/erebor/asciidoctor/pull/41#issuecomment-11742889 but
> I couldn't find the solution.
>
> Jason Porter give me some help but now I'm stuck again, so
> basically I want to know if can you contribute with some other
> help to make asciidoctor run under my environment?
> RHEL 6.3
> Ruby 1.9.3
> Gem 1.8.11
> asciidoctor 0.0.9
> rake 10.0.3
> rdoc 3.12
>
> Thank you.
>
>
> Em 24-01-2013 08:15, Dan Allen escreveu:
>> Pete,
>>
>> I head from Jason that you're experimenting with using
>> Asciidoctor to generate the HTML for some of the guides. I'm
>> thrilled to here that. It also prompted me to review how
>> Asciidoctor handles these documents. I processed the following guide:
>>
>> https://github.com/jboss-jdf/jboss-as-quickstart/tree/master/guide
>>
>> I've come up with some observations and recommendations. But
>> first, some general advice for using Asciidoctor.
>>
>> If you are using Asciidoctor view the API, you'll want to disable
>> SafeMode (since that's not relevant for builds) and enable full
>> document output:
>>
>> Asciidoctor.render_file('guide.asciidoc', :safe =>
>> Asciidoctor::SafeMode::UNSAFE, :header_footer => true, :in_place
>> => true)
>>
>> The :in_place option mimics the behavior of AsciiDoc of rendering
>> to file w/ the same basename as the source file.
>>
>> Coming in 0.1.0 is a cli, named asciidoctor. You'll be able to
>> use that as a drop-in replacement for the asciidoc command.
>>
>> Moving on to the feedback.
>>
>> * AsciiDoc clips the label of the following xref (because of the
>> comma in the label), whereas Asciidoctor gets it right:
>>
>> <<GettingStarted-on_linux, Installing and starting the JBoss
>> server on Linux, Unix or Mac OS X>>
>>
>> * Asciidoctor does not process the anchor:name[] macro, use
>> [[name]] instead (best is to put it above a section title)
>> * Asciidoctor does not render callout numbers as icons (I
>> recommend we use FontAwesome or CSS to accomplish this markup)
>> * Use a conditional block to setup the source-highlighter when
>> using Asciidoctor:
>>
>> ifdef::asciidoctor[]
>> :source-highlighter: highlightjs
>> :highlightjs-theme: github
>> endif::asciidoctor[]
>>
>> Another option for source highlighting is CodeRay, which is more
>> or less like Pygments in that it formats the code directly.
>> You'll need to gem install coderay, then:
>>
>> ifdef::asciidoctor[]
>> :source-highlighter: coderay
>> endif::asciidoctor[]
>>
>> I noticed a couple of places where Asciidoctor was incorrectly
>> parsing the text. I fixed them and pushed the changes. They will
>> likely make it into 0.1.0.
>>
>> If you have any questions, or have any features you'd like to
>> see, let me know or just post the feedback in the Asciidoctor
>> issue tracker [1].
>>
>> Cheers!
>>
>> -Dan
>>
>> [1] https://github.com/erebor/asciidoctor/issues?state=open
>>
>> --
>> Dan Allen
>> Principal Software Engineer, Red Hat | Author of Seam in Action
>> Registered Linux User #231597
>>
>> http://google.com/profiles/dan.j.allen
>> http://mojavelinux.com
>> http://mojavelinux.com/seaminaction
>>
>>
>> _______________________________________________
>> jdf-dev mailing list
>> jdf-dev(a)lists.jboss.org <mailto:jdf-dev@lists.jboss.org>
>> https://lists.jboss.org/mailman/listinfo/jdf-dev
>
>
>
>
> --
> Dan Allen
> Principal Software Engineer, Red Hat | Author of Seam in Action
> Registered Linux User #231597
>
> http://google.com/profiles/dan.j.allen
> http://mojavelinux.com
> http://mojavelinux.com/seaminaction
4:02 p.m.
Ah! Cool!
Thanks for the info!
Em 31-01-2013 12:59, Jason Porter escreveu:
You're trying the build the jdf site, correct? There some things
in the jdf site we need to fix first. I'm working on it.
----- Rafael Benevides<benevides(a)redhat.com> wrote:
> Just to give you a feeback, I was able to build awestruct 0.1.0 from
> source - repo: https://github.com/asciidoctor/asciidoctor
>
> Anyway I still having some issues to run awestruct 0.4.8:
>
> [rafael@Colossus jdf-site (awestruct048)]$ awestruct -d
> Using profile: development
> Generating site: http://localhost:4242
> undefined method `[]=' for nil:NilClass
>
/usr/lib64/ruby/gems/1.9.1/gems/awestruct-0.4.8/lib/awestruct/handlers/asciidoc_handler.rb:24:in
> `initialize'
> /usr/lib64/ruby/gems/1.9.1/gems/awestruct-0.4.8/lib/awestruct/handler_chain.rb:21:in
> `new'
> /usr/lib64/ruby/gems/1.9.1/gems/awestruct-0.4.8/lib/awestruct/handler_chain.rb:21:in
> `block in create'
> /usr/lib64/ruby/gems/1.9.1/gems/awestruct-0.4.8/lib/awestruct/handler_chain.rb:20:in
> `each'
> /usr/lib64/ruby/gems/1.9.1/gems/awestruct-0.4.8/lib/awestruct/handler_chain.rb:20:in
> `create'
>
>
> I'll try some luck on #awestruct but if some of you have any clues,
> please ping me.
>
> Thank you
>
>
> Em 29-01-2013 07:47, Dan Allen escreveu:
>> Rafael,
>>
>> We're just about to put out a 0.1.0 gem, which adds the cli among
>> (many) other features and enhancements. Although there is a cli file
>> prior to 0.1.0, it didn't contain any runnable code.
>>
>> The problem with the Rakefile seems to be an issue in how Ruby
>> resolves the Rake version. I have an idea for how to make that
>> failsafe. I'll submit a patch so that under no circumstances will that
>> line cause the build to fail.
>>
>> I'll post back once we have 0.1.0 out and we can work through it from
>> there.
>>
>> -Dan
>>
>> On Mon, Jan 28, 2013 at 4:35 PM, Rafael Benevides
>> <benevides@redhat.com<mailto:benevides@redhat.com>> wrote:
>>
>> Hi Dan,
>>
>> I tried at all cost to install asciidoctor (0.0.7/0.0.9/master) to
>> start this migration.
>>
>> For 0.0.7 and 0.0.9 (from rubygems) I got the same error:
>> $ asciidoctor
>> /usr/lib64/ruby/1.9.1/rubygems/custom_require.rb:36:in `require':
>> cannot load such file -- asciidoctor/cli (LoadError)
>>
>> This error also happens when I built from gem build .gemspec / gem
>> install .gem
>>
>> From git repo (master branch)
>> I CAN use 'bundle exec asciidoctor' BUT when I try to use rake
>> (10.0.3) I got this error:
>> rake aborted!
>> undefined method `markup=' for #<RDoc::Task:0x00000000f1bd50>
>> that is similar to:
>> https://github.com/erebor/asciidoctor/pull/41#issuecomment-11742889 but
>> I couldn't find the solution.
>>
>> Jason Porter give me some help but now I'm stuck again, so
>> basically I want to know if can you contribute with some other
>> help to make asciidoctor run under my environment?
>> RHEL 6.3
>> Ruby 1.9.3
>> Gem 1.8.11
>> asciidoctor 0.0.9
>> rake 10.0.3
>> rdoc 3.12
>>
>> Thank you.
>>
>>
>> Em 24-01-2013 08:15, Dan Allen escreveu:
>>> Pete,
>>>
>>> I head from Jason that you're experimenting with using
>>> Asciidoctor to generate the HTML for some of the guides. I'm
>>> thrilled to here that. It also prompted me to review how
>>> Asciidoctor handles these documents. I processed the following guide:
>>>
>>> https://github.com/jboss-jdf/jboss-as-quickstart/tree/master/guide
>>>
>>> I've come up with some observations and recommendations. But
>>> first, some general advice for using Asciidoctor.
>>>
>>> If you are using Asciidoctor view the API, you'll want to disable
>>> SafeMode (since that's not relevant for builds) and enable full
>>> document output:
>>>
>>> Asciidoctor.render_file('guide.asciidoc', :safe =>
>>> Asciidoctor::SafeMode::UNSAFE, :header_footer => true, :in_place
>>> => true)
>>>
>>> The :in_place option mimics the behavior of AsciiDoc of rendering
>>> to file w/ the same basename as the source file.
>>>
>>> Coming in 0.1.0 is a cli, named asciidoctor. You'll be able to
>>> use that as a drop-in replacement for the asciidoc command.
>>>
>>> Moving on to the feedback.
>>>
>>> * AsciiDoc clips the label of the following xref (because of the
>>> comma in the label), whereas Asciidoctor gets it right:
>>>
>>> <<GettingStarted-on_linux, Installing and starting the JBoss
>>> server on Linux, Unix or Mac OS X>>
>>>
>>> * Asciidoctor does not process the anchor:name[] macro, use
>>> [[name]] instead (best is to put it above a section title)
>>> * Asciidoctor does not render callout numbers as icons (I
>>> recommend we use FontAwesome or CSS to accomplish this markup)
>>> * Use a conditional block to setup the source-highlighter when
>>> using Asciidoctor:
>>>
>>> ifdef::asciidoctor[]
>>> :source-highlighter: highlightjs
>>> :highlightjs-theme: github
>>> endif::asciidoctor[]
>>>
>>> Another option for source highlighting is CodeRay, which is more
>>> or less like Pygments in that it formats the code directly.
>>> You'll need to gem install coderay, then:
>>>
>>> ifdef::asciidoctor[]
>>> :source-highlighter: coderay
>>> endif::asciidoctor[]
>>>
>>> I noticed a couple of places where Asciidoctor was incorrectly
>>> parsing the text. I fixed them and pushed the changes. They will
>>> likely make it into 0.1.0.
>>>
>>> If you have any questions, or have any features you'd like to
>>> see, let me know or just post the feedback in the Asciidoctor
>>> issue tracker [1].
>>>
>>> Cheers!
>>>
>>> -Dan
>>>
>>> [1] https://github.com/erebor/asciidoctor/issues?state=open
>>>
>>> --
>>> Dan Allen
>>> Principal Software Engineer, Red Hat | Author of Seam in Action
>>> Registered Linux User #231597
>>>
>>> http://google.com/profiles/dan.j.allen
>>> http://mojavelinux.com
>>> http://mojavelinux.com/seaminaction
>>>
>>>
>>> _______________________________________________
>>> jdf-dev mailing list
>>> jdf-dev@lists.jboss.org<mailto:jdf-dev@lists.jboss.org>
>>> https://lists.jboss.org/mailman/listinfo/jdf-dev
>>
>>
>>
>> --
>> Dan Allen
>> Principal Software Engineer, Red Hat | Author of Seam in Action
>> Registered Linux User #231597
>>
>> http://google.com/profiles/dan.j.allen
>> http://mojavelinux.com
>> http://mojavelinux.com/seaminaction
4164
days inactive
4171
days old
12 comments
4 participants
participants (4)
-
Dan Allen -
Jason Porter -
Pete Muir -
Rafael Benevides