-
Notifications
You must be signed in to change notification settings - Fork 83
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.
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
docs: Describe relations with and between specs #211
Merged
Merged
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
28da4df
docs: Document relation with and between specs
karfau ee42afe
docs: Add java option to docs/puml.sh
karfau 832f2ea
Merge remote-tracking branch 'upstream/master' into 119/203/document-…
karfau 90c1514
docs: Add Infra Standard to the mix
karfau d30495e
docs: Removed confusing link to architecture diagram.
karfau 95a25c9
Merge branch 'master' into 119/203/document-specs
karfau a591a8d
Merge remote-tracking branch 'upstream/master' into 119/203/document-…
karfau 218f8be
docs(readme): Apply suggestions for improved wording
karfau efea6db
docs: Update plantuml version
karfau File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,3 +4,5 @@ | |
/node_modules | ||
/reports | ||
/test/error/reported.json | ||
|
||
docs/*.jar |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
@startuml | ||
'https://plantuml.com/component-diagram | ||
'to update the SVG after changing this file run | ||
'docs/puml.sh | ||
skinparam componentStyle rectangle | ||
|
||
frame "lib/dom.js" { | ||
cloud "Spec:DOM" { | ||
[DOMException] | ||
[DOMImplementation] | ||
interface Document | ||
interface Element | ||
interface Node | ||
} | ||
component XMLSerializer [ | ||
XMLSerializer | ||
Spec:DOM-Parsing | ||
] | ||
} | ||
|
||
frame "lib/dom-parser.js" { | ||
component DOMParser [ | ||
DOMParser | ||
Spec:HTML | ||
] | ||
|
||
component DOMHandler [ | ||
DOMHandler | ||
Spec:SAX | ||
] | ||
} | ||
|
||
frame "lib/sax.js" { | ||
component XMLReader [ | ||
XMLReader | ||
Spec:SAX | ||
] | ||
[ParseError] | ||
} | ||
|
||
DOMParser -d-> DOMHandler: new | ||
DOMParser -r-> XMLReader: new | ||
XMLReader --> DOMHandler: using | ||
XMLReader --> ParseError: throw | ||
DOMHandler --> DOMImplementation: new | ||
DOMHandler --> Document: using | ||
DOMImplementation -d-> Document: new | ||
Document -r-> Node: new | ||
Document -l-> Element: new | ||
Document -d-> DOMException: throw | ||
XMLSerializer -u-> Node: visit | ||
|
||
@enduml |
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
#!/bin/bash | ||
set -eu | ||
if [[ ! -d docs ]] ; then | ||
echo "execute from the root directory!" && exit 1 | ||
fi | ||
|
||
export PLANTUML_VERSION=1.2021.4 | ||
|
||
function svg { | ||
if [[ -f "docs/$1.puml" ]] ; then | ||
echo "updating docs/$1.svg" | ||
if [[ -f docs/plantuml.jar ]] ; then | ||
# for using java, download plantuml.jar into the docs folder from https://plantuml.com/download | ||
< "docs/$1.puml" java -jar docs/plantuml.jar -pipe -tsvg -nometadata > "docs/$1.svg" | ||
else | ||
< "docs/$1.puml" docker run --rm -i karfau/plantuml:$PLANTUML_VERSION -pipe -tsvg -nometadata > "docs/$1.svg" | ||
fi | ||
else | ||
echo "missing file 'docs/$1.puml'" | ||
fi | ||
} | ||
|
||
svg architecture | ||
svg specs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
@startuml | ||
'https://plantuml.com/object-diagram | ||
'to update the SVG after changing this file run | ||
'docs/puml.sh | ||
|
||
title "References between relevant specs" | ||
|
||
note "About spec status: [[https://www.w3.org/2020/Process-20200915/#rec-track The W3C Recommendation Track]]" as status | ||
|
||
map "W3C DOM Parsing and Serialization [[https://www.w3.org/standards/history/DOM-Parsing history]]" as DOMParsing { | ||
[[https://w3c.github.io/DOM-Parsing/ latest]] => Editors Draft | ||
**[[https://www.w3.org/TR/2016/WD-DOM-Parsing-20160517/ 2016]]** => Working Draft | ||
[[https://www.w3.org/TR/2014/CR-DOM-Parsing-20140617/ 2014]] => Outdated Candidate Recommendation | ||
} | ||
|
||
map "Document Object Model (DOM) [[https://www.w3.org/standards/history/dom history]]" as DOM { | ||
[[https://dom.spec.whatwg.org/ latest]] => Living Standard | ||
**[[https://dom.spec.whatwg.org/review-drafts/2019-06/ Level 4 (2020)]]** => DOM Recommendation | ||
[[https://www.w3.org/TR/DOM-Level-3-Core/ Level 3 Core (2004)]] => Recommendation (**[[https://dom.spec.whatwg.org/#historical has outdated parts!]]**, [[https://www.w3.org/standards/history/DOM-Level-3-Core history]]) | ||
**[[https://www.w3.org/TR/DOM-Level-2-HTML/ Level 2 HTML (2003)]]** => Superseded Recommendation | ||
**[[https://www.w3.org/TR/DOM-Level-2-Core/ Level 2 Core (2000)]]** => Superseded Recommendation | ||
} | ||
|
||
map "Hyper Text Markup Language (HTML)" as HTML { | ||
[[https://html.spec.whatwg.org/ latest]] => Living Standard | ||
[[https://html.spec.whatwg.org/review-drafts/2020-01/ HTML5 (2020)]] => Recommendation [[https://www.w3.org/standards/history/html history]] | ||
[[https://www.w3.org/TR/html401/ HTML4.01 (1999)]] => Recommendation [[https://www.w3.org/standards/history/html401 history]] | ||
[[https://www.w3.org/TR/html401/ HTML4.01 (1999)]] => Superseded Recommendation [[https://www.w3.org/standards/history/html401 history]] | ||
[[https://www.w3.org/TR/xhtml1/ XHTML 1.0 (2002)]] => Superseded Recommendation [[https://www.w3.org/standards/history/xhtml1 history]] | ||
[[https://www.w3.org/TR/xhtml1/ XHTML 1.0 (2002)]] => Superseded Recommendation [[https://www.w3.org/standards/history/xhtml1 history]] | ||
|
||
} | ||
|
||
map "Extensible Markup Language (XML)" as XML { | ||
[[https://www.w3.org/TR/xml11/ 1.1 (2006)]] => Recommendation [[https://www.w3.org/standards/history/xml11 history]] | ||
[[https://www.w3.org/TR/xml/ 1.0 (2008)]] => Recommendation [[https://www.w3.org/standards/history/xml history]] | ||
} | ||
|
||
map "Namespaces in XML" as XMLNS { | ||
[[https://www.w3.org/TR/xml-names11/ 1.1 (2006)]] => Recommendation | ||
[[https://www.w3.org/TR/REC-xml-names/ 1.0 (2009)]] => Recommendation | ||
} | ||
|
||
map "WebIDL [[https://www.w3.org/standards/history/WebIDL-1 history]]" as WebIDL { | ||
[[https://heycam.github.io/webidl/ latest]] => Editors Draft | ||
[[https://www.w3.org/TR/WebIDL-1/ Level 1 (2016)]] => Recommendation | ||
} | ||
|
||
map "[[http://www.saxproject.org/ Simple API for XML (SAX)]]" as SAX { | ||
} | ||
|
||
map "[[https://infra.spec.whatwg.org/ Infra Standard]]" as Infra { | ||
} | ||
|
||
|
||
|
||
DOM <--> HTML | ||
DOM --> Infra | ||
DOM --> WebIDL | ||
DOM --> XML | ||
|
||
DOMParsing --> DOM | ||
DOMParsing <--> HTML | ||
DOMParsing --> XML | ||
DOMParsing --> WebIDL | ||
|
||
HTML --> Infra | ||
HTML --> XML | ||
HTML --> XMLNS | ||
|
||
SAX --> XML | ||
SAX --> XMLNS | ||
|
||
XMLNS --> XML | ||
|
||
@enduml |
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
<3