resolves #37 document strong span in specification
This MR serves two purposes:
- provides the initial content for the strong span in the specification document
- shows the element structure and content guidelines proposed in #34
Comments regarding both the actual content regarding the strong span as well as about the structure and language used in relation to the writing guidelines can be made on this MR or the related issues.
Merge request reports
Activity
- Resolved by Sarah White
I've got questions about the following areas in this MR before I finish it:
- In the Description section, do we want to put any kind of even casual output hints into the non-normative sections such as I did in the first sentence? Do we need to / want to describe the output "tags" (e.g.,
<strong>, etc.) when talking about any of the inline marked text in the non-normative or normative sections, or should this be strictly off limits? - Under Context, there's
As a child of an inline element that accepts inline markup. We've also proposed "Inlines" or "Compound Inline Markup". What ever we choose, it needs to be consistent for all of the inline elements. - Note that under Content model, I've stated the variant with the content model (the paragraph didn't have a variant, so this is new). And then I listed the forms (something the paragraph also didn't have) before listing the accepted elements. I may also see if this looks a little neater or clearer in a table versus lists.
- In the Description section, do we want to put any kind of even casual output hints into the non-normative sections such as I did in the first sentence? Do we need to / want to describe the output "tags" (e.g.,
- Last reply by Sarah White
mentioned in issue #37 (closed)
- Resolved by Sarah White
In the Description section, do we want to put any kind of even casual output hints into the non-normative sections such as I did in the first sentence?
I think we should follow what MDN does in this case. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/strong. They use the phrasing "browsers usually render". In our case, documents may be rendered outside a browser environment, so we need a word such as "document viewers". We could also cite HTML as a reference format. For example, we might say, when converting to HTML, this element will likely be represented using a
<strong>tag.Compound Inline Markup
Perhaps we can follow the terminology used for lists here and say "Nested Inline Markup". There is an implied recursion being allowed.
the paragraph didn't have a variant, so this is new
As far as we know now, it doesn't. It's possible a variant will emerge in the future, so its reserved, but unused in this context.
I listed the forms (something the paragraph also didn't have)
Actually, the paragraph does have a form. It's just implied in the ASG. The form is paragraph. A paragraph is its own form ;) But we are also thinking that when a literal paragraph is demoted to a paragraph, it's form will be "indented". So the form does come in to play at some point. See https://gitlab.eclipse.org/eclipse/asciidoc-lang/asciidoc-lang/-/blob/main/asg/schema.json#L277
- Last reply by Sarah White
added 51 commits
-
187b40be...f5e61240 - 50 commits from branch
eclipse/asciidoc-lang:main - 7f445c4b - resolves #37 (closed) document strong span in specification
-
187b40be...f5e61240 - 50 commits from branch
added 1 commit
- 1a15ca48 - add draft syntax examples, grammar, and ASG schema and examples to strong span...
One thing we're going to need to be careful about is capitalization in the technical summary table. This could be a source of confusion. For example, if we say the name is "Span", then people could be confused as to why this is "span" in the ASG. Same for variant ("Strong" vs "strong"). I think it might be best just to use lowercase words in the technical summary unless the word is supposed to be capitalized (like the DOM interface).
added 1 commit
- cc6c5b56 - add draft syntax examples, grammar, and ASG schema and examples to strong span...
added 1 commit
- 80f5ea85 - add draft syntax examples, grammar, and ASG schema and examples to strong span...
added 1 commit
- a78f4ef6 - add draft syntax examples, grammar, and ASG schema and examples to strong span...
added 1 commit
- 8ab6405c - add draft syntax examples, grammar, and ASG schema and examples to strong span...
added 1 commit
- 8b3cc589 - add draft syntax examples, grammar, and ASG schema and examples to strong span...
added 1 commit
- c2bd61e9 - add draft syntax examples, grammar, and ASG schema and examples to strong span...
added 1 commit
- a85271c4 - add draft syntax examples, grammar, and ASG schema and examples to strong span...
added 1 commit
- 55a08e16 - add draft syntax examples, grammar, and ASG schema and examples to strong span...
added 1 commit
- 09abed1e - add draft syntax examples, grammar, and ASG schema and examples to strong span...
