Skip to content
This repository has been archived by the owner on Jul 30, 2019. It is now read-only.

Update comments in some source files #1203

Merged
merged 2 commits into from
Feb 15, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions sections/browsers.include
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
<!--

BROWSERS

This source produces chapter 6: https://w3c.github.io/html/browsers.html

It covers Window and WindowProxy objects,
concepts including Origin, Browsing Context, Navigating between pages
(and when it is allowed), the effect of sandboxing on navigating, and the like.

@chaals is trying to maintain it.

-->

Expand Down
24 changes: 16 additions & 8 deletions sections/dom.include
Original file line number Diff line number Diff line change
@@ -1,14 +1,22 @@
<section>
<!--
████████ ███████ ██ ██
██ ██ ██ ██ ███ ███
██ ██ ██ ██ ████ ████
██ ██ ██ ██ ██ ███ ██
██ ██ ██ ██ ██ ██
██ ██ ██ ██ ██ ██
████████ ███████ ██ ██
DOM

This source produces chapter 3: "Semantics, structure, and APIs of HTML documents"
https://w3c.github.io/html/dom.html

It covers
- the "Document" object, significantly extending what is defined in the DOM specification
including attributes of it like document.cookies, document.referrer, document.head, document.forms, etc
- The HTMLElement interface
- How elements and attributes are described in the spec
- Content models - used in element descriptions
- Global attributes
- .innerText
- Some requirements for the Bidi algorithm
- Some requirements for the role and aria-* attributes

-->
<!-- This section ostensibly kept up to date by travil@microsoft.com -->

<h2 id="dom">Semantics, structure, and APIs of HTML documents</h2>

Expand Down
8 changes: 5 additions & 3 deletions sections/editing.include
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
<section>
<!--

Editing:
EDITING

This source produces Chapter 5: "User Interaction" https://w3c.github.io/html/editing.html
- "hidden" attribute
- focus and focus changes
- accesskey and user shortcuts
- "contenteditable" (being redefined by the editing Task Force) and "designmode"
- "accesskey" and user shortcuts
- "contenteditable" (which is currently being redefined by the editing Task Force) and "designmode"
- drag and drop

-->
Expand Down
9 changes: 0 additions & 9 deletions sections/iana.include
Original file line number Diff line number Diff line change
@@ -1,13 +1,4 @@
<section>
<!--
████ ███ ██ ██ ███
██ ██ ██ ███ ██ ██ ██
██ ██ ██ ████ ██ ██ ██
██ ██ ██ ██ ██ ██ ██ ██
██ █████████ ██ ████ █████████
██ ██ ██ ██ ███ ██ ██
████ ██ ██ ██ ██ ██ ██
-->
<h2 id="iana">IANA considerations</h2>

<h3 id="text-html"><code>text/html</code></h3>
Expand Down
14 changes: 13 additions & 1 deletion sections/infrastructure.include
Original file line number Diff line number Diff line change
@@ -1,7 +1,19 @@
<section>
<!--

INFRASTRUCTURE
INFRASTRUCTURE

This section produces chapter 2: Common Infrastructure https://w3c.github.io/html/infrastructure.html

It covers
- Terminology
- How Conformance Requirements are described
- Case sensitivity and comparing strings
- Common "micro" syntaxes
- URLs and Fetching resources, including referrer and nonce attributes
- Reflection of attributes
- DOM collections
- De/serialising to pass structured objects

-->

Expand Down
22 changes: 14 additions & 8 deletions sections/obsolete.include
Original file line number Diff line number Diff line change
@@ -1,14 +1,20 @@
<section>
<!--
███████ ████████ ██████ ███████ ██ ████████ ████████ ████████
██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
██ ██ ████████ ██████ ██ ██ ██ ██████ ██ ██████
██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
███████ ████████ ██████ ███████ ████████ ████████ ██ ████████

OBSOLETE

This section produces Chapter 11: Obsolete Features https://w3c.github.io/html/obsolete.html

It covers features which are deprecated and should or must not be used in conforming HTML content,
but which user agents need to handle because there is a body of legacty content using them.
Examples include
- appcache
- applet
- keygen
- marquee
- Plugins

-->
<!-- This section ostensibly kept up to date by arronei@microsoft.com -->

<h2 id="obsolete">Obsolete features</h2>

Expand Down
3 changes: 1 addition & 2 deletions sections/rendering.include
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
<section>
<!--

RENDERING
RENDERING

-->
<!-- This section ostensibly kept up to date by **TBD** -->

Rendering {#rendering}
=========
Expand Down
16 changes: 16 additions & 0 deletions sections/semantics-common-idioms.include
Original file line number Diff line number Diff line change
@@ -1,4 +1,20 @@
<section>
<!--

COMMON IDIOMS

This source produces section 4.13: Common Idioms without Dedicated Elements
https://w3c.github.io/html/common-idioms-without-dedicated-elements.html

It covers
- Subheadings and taglines
- "breadcrumb" navigation information
- Tag Clouds
- Conversations
- Footnotes

-->


<h3 id="common-idioms-without-dedicated-elements">Common idioms without dedicated elements</h3>

Expand Down
16 changes: 16 additions & 0 deletions sections/semantics-document-metadata.include
Original file line number Diff line number Diff line change
@@ -1,4 +1,20 @@
<section>
<!--

DOCUMENT METADATA

This source produces section 4.2: Document Metadata https://w3c.github.io/html/document-metadata.html

It covers elements in the head of the document:
- head
- title
- base
- meta
- link
- style

-->


<h3 id="document-metadata">Document metadata</h3>

Expand Down