macro for todo items

I managed to get this:

:todo-item: pass:normal[icon:wrench[] _TODO:_]

which allows me to do this:

{todo-item} Something that still needs to be done.

The only thing missing is that "Something that still needs to be done." is not in italic like "TODO" itself. Any idea on how to add that?

---

If you reply to this email, your message will be added to the discussion below:

http://discuss.asciidoctor.org/macro-for-todo-items-tp2667p2669.html

To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML

My advice here is to write an inline macro extension that processes syntax similar to this:

[source,asciidoc]
----

todo:[Something that still needs to be done.]

----

I've selected a syntax that closely resembles a footnote.

You can study other inline macro extensions (labeled as such) in the extensions lab.

https://github.com/asciidoctor/asciidoctor-extensions-lab/tree/master/lib

One thing slightly different from existing examples is that you need to indicate you want the short form of the macro. Something like:

[source,ruby]
----

class TodoMacro < Extensions::InlineMacroProcessor

  use_dsl

  named :todo

  using_format :short

 

  def process parent, target, attrs
    ...

  end

end

----

At the moment, inline macros return the replacement string directly...so you can just return the HTML that you want. Of course, if you want to support other backends, you will need to check the backend and return the appropriate markup (for instance, DocBook if the backend is docbook).

I know we desperately need documentation for writing extensions. I promise you that I'm going to get serious about it as soon as a possibly can. However, if someone else wants to start to run with it, please don't hesitate to take the initiative. See https://github.com/asciidoctor/asciidoctor.org/issues/347

-Dan

On Mon, Jan 12, 2015 at 5:36 AM, wimdeblauwe [via Asciidoctor :: Discussion] <[hidden email]> wrote:

I managed to get this:

:todo-item: pass:normal[icon:wrench[] _TODO:_]

which allows me to do this:

{todo-item} Something that still needs to be done.

The only thing missing is that "Something that still needs to be done." is not in italic like "TODO" itself. Any idea on how to add that?

---

If you reply to this email, your message will be added to the discussion below:

http://discuss.asciidoctor.org/macro-for-todo-items-tp2667p2669.html

To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML

--

Dan Allen | http://google.com/profiles/dan.j.allen

---

If you reply to this email, your message will be added to the discussion below:

http://discuss.asciidoctor.org/macro-for-todo-items-tp2667p2677.html

To unsubscribe from macro for todo items, click here.
NAML

Hi,

Thanks for that, but I am afraid that is a bit out of my league. What I have is good enough for my needs for now.

regards,

Wim 

2015-01-19 7:53 GMT+01:00 mojavelinux [via Asciidoctor :: Discussion] <[hidden email]>:

My advice here is to write an inline macro extension that processes syntax similar to this:

[source,asciidoc]
----

todo:[Something that still needs to be done.]

----

I've selected a syntax that closely resembles a footnote.

You can study other inline macro extensions (labeled as such) in the extensions lab.

https://github.com/asciidoctor/asciidoctor-extensions-lab/tree/master/lib

One thing slightly different from existing examples is that you need to indicate you want the short form of the macro. Something like:

[source,ruby]
----

class TodoMacro < Extensions::InlineMacroProcessor

  use_dsl

  named :todo

  using_format :short

 

  def process parent, target, attrs
    ...

  end

end

----

At the moment, inline macros return the replacement string directly...so you can just return the HTML that you want. Of course, if you want to support other backends, you will need to check the backend and return the appropriate markup (for instance, DocBook if the backend is docbook).

I know we desperately need documentation for writing extensions. I promise you that I'm going to get serious about it as soon as a possibly can. However, if someone else wants to start to run with it, please don't hesitate to take the initiative. See https://github.com/asciidoctor/asciidoctor.org/issues/347

-Dan

On Mon, Jan 12, 2015 at 5:36 AM, wimdeblauwe [via Asciidoctor :: Discussion] <[hidden email]> wrote:

I managed to get this:

:todo-item: pass:normal[icon:wrench[] _TODO:_]

which allows me to do this:

{todo-item} Something that still needs to be done.

The only thing missing is that "Something that still needs to be done." is not in italic like "TODO" itself. Any idea on how to add that?

---

If you reply to this email, your message will be added to the discussion below:

http://discuss.asciidoctor.org/macro-for-todo-items-tp2667p2669.html

To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML

--

Dan Allen | http://google.com/profiles/dan.j.allen

---

If you reply to this email, your message will be added to the discussion below:

http://discuss.asciidoctor.org/macro-for-todo-items-tp2667p2677.html

To unsubscribe from macro for todo items, click here.
NAML

---

If you reply to this email, your message will be added to the discussion below:

http://discuss.asciidoctor.org/macro-for-todo-items-tp2667p2678.html

To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML