#294 Added support for literal line and task lists

[zeldigas]

Resolves #294

[maikheene]

Please merge that PR! I really need that feature 👍

Thanks for this PR!

[cstettler]

Hi @maikheene, thank you for the voting for this feature. Before proceeding, I would like to better understand your use case. Since the Confluence Publisher aims to support a "docs-as-code" approach, I see a mismatch between managing your documentation in a source repository and have mutable state (i.e. the state of the task) on a published Confluence page. Whenever a user would check an open task, this change would not be reflected in the source documentation.

I can see a use case for supporting the read-only rendering of tasks, but this could also be done using the AsciiDoc rendering (i.e. using icons) instead of using the Confluence task macro.

Thank you for sharing your use case and opinion on this.

[maikheene]

Hi @cstettler,

thanks for your reply.

My use case is to indicate if we have implement a feature or not in our documentation. The use case "read-only rendering of tasks" is the right one for me and to render icons to show the state of the task would be fine to me.

But to use the Confluence task macro would be nice for the UX. The users are used to the styling of theses checkboxes. This would be +1 for this feature.

Can we show icons that look like the confluence task macro checkboxes?

[cstettler]

Thanks @maikheene for the feedback. Unfortunately, the Confluence task macro does not provide the option to set a task to read-only.

It would be possible to render the corresponding markup (ul with the "inline-task-list" style class) in the Confluence Publisher template which would make the task checkbox appear in Confluence-style while being read-only, but that would rely on Confluence-internal style classes. Also, it might be confusing for the user to see a task checkbox, but have it behaving differently compared to every other task (e.g. not appearing in any task report list).

If you just need the task checkbox to indicate a status (done / not done, implemented / pending), would using explicit icons in your documentation be an option? AsciiDoc supports icons using the icon: macro, unfortunately, the Confluence Publisher does not yet (see #228). But that could be a reason to investigate into supporting icons, but in "image" and "font" mode.

[zeldigas]

No longer applicable, text2confl has support for asciidoc: https://github.com/zeldigas/text2confl/commit/af61a5facb45aa6a08block_q846314684c2f4d6d68b2be