Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove static phrasing content #42

Merged
merged 1 commit into from
Jun 15, 2023
Merged

Remove static phrasing content #42

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 16 additions & 38 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,6 @@ The latest released version is [`4.0.0`][latest].
* [`Content`](#content)
* [`ListContent`](#listcontent)
* [`PhrasingContent`](#phrasingcontent)
* [`StaticPhrasingContent`](#staticphrasingcontent)
* [`TransparentContent`](#transparentcontent)
* [Extensions](#extensions)
* [GFM](#gfm)
* [Frontmatter](#frontmatter)
Expand Down Expand Up @@ -517,7 +515,7 @@ Yields:
```idl
interface Emphasis <: Parent {
type: 'emphasis'
children: [TransparentContent]
children: [PhrasingContent]
}
```

Expand All @@ -526,7 +524,7 @@ contents.

**Emphasis** can be used where [**phrasing**][dfn-phrasing-content] content is
expected.
Its content model is [**transparent**][dfn-transparent-content] content.
Its content model is [**phrasing**][dfn-phrasing-content] content.

For example, the following markdown:

Expand Down Expand Up @@ -558,7 +556,7 @@ Yields:
```idl
interface Strong <: Parent {
type: 'strong'
children: [TransparentContent]
children: [PhrasingContent]
}
```

Expand All @@ -567,7 +565,7 @@ or urgency for its contents.

**Strong** can be used where [**phrasing**][dfn-phrasing-content] content is
expected.
Its content model is [**transparent**][dfn-transparent-content] content.
Its content model is [**phrasing**][dfn-phrasing-content] content.

For example, the following markdown:

Expand Down Expand Up @@ -664,7 +662,7 @@ Yields:
```idl
interface Link <: Parent {
type: 'link'
children: [StaticPhrasingContent]
children: [PhrasingContent]
}

Link includes Resource
Expand All @@ -674,7 +672,7 @@ Link includes Resource

**Link** can be used where [**phrasing**][dfn-phrasing-content] content is
expected.
Its content model is [**static phrasing**][dfn-static-phrasing-content] content.
Its content model is also [**phrasing**][dfn-phrasing-content] content.

**Link** includes the mixin [**Resource**][dfn-mxn-resource].

Expand Down Expand Up @@ -737,7 +735,7 @@ Yields:
```idl
interface LinkReference <: Parent {
type: 'linkReference'
children: [StaticPhrasingContent]
children: [PhrasingContent]
}

LinkReference includes Reference
Expand All @@ -748,7 +746,7 @@ association, or its original source if there is no association.

**LinkReference** can be used where [**phrasing**][dfn-phrasing-content] content
is expected.
Its content model is [**static phrasing**][dfn-static-phrasing-content] content.
Its content model is also [**phrasing**][dfn-phrasing-content] content.

**LinkReference** includes the mixin [**Reference**][dfn-mxn-reference].

Expand Down Expand Up @@ -951,27 +949,12 @@ type ListContent = ListItem
### `PhrasingContent`

```idl
type PhrasingContent = Link | LinkReference | StaticPhrasingContent
type PhrasingContent = Break | Emphasis | HTML | Image | ImageReference
| InlineCode | Link | LinkReference | Strong | Text
```

**Phrasing** content represent the text in a document, and its markup.

### `StaticPhrasingContent`

```idl
type StaticPhrasingContent =
Break | Emphasis | HTML | Image | ImageReference | InlineCode | Strong | Text
```

**StaticPhrasing** content represent the text in a document, and its
markup, that is not intended for user interaction.

### `TransparentContent`

The **transparent** content model is derived from the content model of its
[parent][dfn-parent].
Effectively, this is used to prohibit nested links (and link references).

## Extensions

Markdown syntax is often extended.
Expand Down Expand Up @@ -1186,7 +1169,7 @@ or indeterminate or not applicable (when `null` or not present).
```idl
interface Delete <: Parent {
type: 'delete'
children: [TransparentContent]
children: [PhrasingContent]
}
```

Expand All @@ -1195,7 +1178,7 @@ accurate or no longer relevant.

**Delete** can be used where [**phrasing**][dfn-phrasing-content] content is
expected.
Its content model is [**transparent**][dfn-transparent-content] content.
Its content model is [**phrasing**][dfn-phrasing-content] content.

For example, the following markdown:

Expand Down Expand Up @@ -1259,11 +1242,10 @@ type RowContent = TableCell
type ListContentGfm = ListItemGfm
```

#### `StaticPhrasingContent` (GFM)
#### `PhrasingContent` (GFM)

```idl
type StaticPhrasingContentGfm =
FootnoteReference | Delete | StaticPhrasingContent
type PhrasingContentGfm = FootnoteReference | Delete | PhrasingContent
```

### Frontmatter
Expand Down Expand Up @@ -1355,10 +1337,10 @@ Yields:
}
```

#### `StaticPhrasingContent` (footnotes)
#### `PhrasingContent` (footnotes)

```idl
type StaticPhrasingContentFootnotes = Footnote | StaticPhrasingContent
type PhrasingContentFootnotes = Footnote | PhrasingContent
```

### MDX
Expand Down Expand Up @@ -1661,10 +1643,6 @@ projects!

[dfn-phrasing-content]: #phrasingcontent

[dfn-static-phrasing-content]: #staticphrasingcontent

[dfn-transparent-content]: #transparentcontent

[gfm-section]: #gfm

[gfm-footnote]: https://github.blog/changelog/2021-09-30-footnotes-now-supported-in-markdown-fields/
Expand Down