Add section about the task element #233

[dariavladykina]

This PR aims to add a subsection about the task element to the Structure and Markup chapter #233

[dariavladykina]

Hi @tomschr , could you please have a look? I get strange output in the example, although I tried to copy the structure that you used in your example.

[tomschr]

Yes, that's to be expected. 🙂 The task element is only partially supported by the stylesheets. There is still an open issue for that, see openSUSE/suse-xsl#307. I haven't worked on this since Nov 2022.

Maybe my memory is wrong, but we haven't discussed it in the SLE Writer's call, have we?

As such, before we describe it, we should first define when and how we use it. Additionally, task comes also with some limitations so we should be aware of those:

• A task is NOT a replacement for an article or a topic. The latter are division elements, the former is a block element.
• As task is a block element, you can't insert (sub)sections inside.

Therefore, it might be useful for a smaller task or if you split a huge task into small sub-tasks. However, that could impose some structural changes that is not always wanted.

On the other side, it could be beneficial is you want to enforce a specific structure.

Therefore, I'd suggest to discuss this in a broader audience if we want to live with the restrictions and use it, or if the existing structures are enough for us.

[jfaltenbacher]

I have worked a lot with tasks elements before and never felt limited. I am in favor of having it

[janajaeger]

I'm fine with our without it. It might be an additional crutch for writers to come up with a decent structure. Those who feel limited, can still opt to go without ;)

[cwickert]

+1 for having it. I think it could be applied to 99% of our topics and will further unify them (if used consistently). And if the structure doesn't fit, well, you can still go without it.

[tomschr]

@dariavladykina I have added a minor question.

[tomschr]

Should we require a <title> for <tasksummary> and <taskprerequisites>?

[jfaltenbacher]

in my experience <tasksummary> is only a repetition of the title itself in most cases, having it as an optional element is sufficient

<taskprerequisites> should have a default title like 'Prerequisites'

[dariavladykina]

I don't think so. "Requirements" are rendered as a headline by the style sheets, and the summary does not really need another title.