You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I think this is an easy one, we should enclose the content in a <p> element.
<p><!-- content --></p>
Role
I think we shouldn't add a default role on paragraph blocks but rather always use specific roles when a <p> element is used in other contexts.
Title
In AsciiDoc, you can assign a title to a paragraph:
.Famous intro
A long time ago in a galaxy far, far away.
strong element
I think we should avoid enclosing the paragraph element in a meaningless container (such as <div>).
Since a <p> element only permits phrasing content, I believe that <strong> is a good choice.
In publishing, the formal name for this construct is a "run-in heading". See:
A run-in heading is a heading positioned upon the very same line as the text. Frequently this text is put in either italic or bold type.
The advantage of strong is that it comes prestyled (compared to span).
<p><strongclass="title">Famous intro</strong> A long time ago in a galaxy far, far away.</p>
In the above example, the strong element has a default role "title".
Instead, we could also use the name "head" but I feel like "title" is probably more obvious.
Alternatives
heading element
While it may seem like the right solution, my concern is that we would use the same construct for level 6 section titles and block titles. Also, keep in mind that:
Researches from @mojavelinux about title on paragraph:
What I discovered is that in publishing, there is no such thing as a title on a paragraph. There is only a run-in heading. Not a single book I could find ever did anything different, and there is no reference to being able to add a caption to a paragraph in any official manual of style (Chicago, New York, MLA, etc). So we can only reasonably conclude that a title on a paragraph as defined in AsciiDoc is, in fact, a run-in heading. (And even then, they are extremely rare).
The two main uses for them are:
To emphasize text at the start of the paragraph (think of it like the primary subject)
As the deepest heading level, with the intent that it is hidden from the outline/toc; almost like a discrete heading
I want to cite some occurrences of existing approaches for reference.
The Asciidoctor EPUB3 converter implements the proposed structure (the strong element), but assigns to it the class name "head" rather than "title". However, I don't think "head" is the right choice here as it's too easily confused with "running head", which is something entirely different.
The XHTML output from the DocBook toolchain also uses the strong element (so we're definitely seeing a pattern), but does not assign a class name to it at all. Without a class name, it cannot be distinguished from a strong/bold phrase at the start of the paragraph, so I don't think that's the right choice either. In the DocBook structure, the element is designated using the term "title". See https://tdg.docbook.org/tdg/5.1/formalpara.html.
The closest thing in DITA is the fig element, which can be used to assign a caption to an arbitrary element (e.g., fig > title + p). Again, we see the term "title" come up. But now we're looking at a something fundamentally different because it's presenting the paragraph as an exhibit. Since a caption is not really the same thing as a run-in heading, we may decide to use a different structure in AsciiDoc (a fig block) to handle that use case.
Having looked at these approaches, I'd say unless there's a really compelling example of using another term to use that we don't know about, I think "title" is the right choice here and we should proceed with it.
This issue will be addressed as part of: #242
Paragraph
I think this is an easy one, we should enclose the content in a
<p>
element.Role
I think we shouldn't add a default role on paragraph blocks but rather always use specific roles when a
<p>
element is used in other contexts.Title
In AsciiDoc, you can assign a title to a paragraph:
strong element
I think we should avoid enclosing the paragraph element in a meaningless container (such as
<div>
).Since a
<p>
element only permits phrasing content, I believe that<strong>
is a good choice.In publishing, the formal name for this construct is a "run-in heading". See:
The advantage of strong is that it comes prestyled (compared to span).
In the above example, the strong element has a default role "title".
Instead, we could also use the name "head" but I feel like "title" is probably more obvious.
Alternatives
heading element
While it may seem like the right solution, my concern is that we would use the same construct for level 6 section titles and block titles. Also, keep in mind that:
So it would mean that block titles will be part of the document outline.
In addition, an heading element is not a phrasing content so the heading element will inevitably be outside of the paragraph element:
The text was updated successfully, but these errors were encountered: