docs: Update README and TODO
- Better structure for TODOs - Add information about JavaScript to README
This commit is contained in:
parent
0a5bc191d3
commit
759283fd9f
2 changed files with 136 additions and 116 deletions
16
README.md
16
README.md
|
|
@ -44,9 +44,23 @@ Everything has its default style.
|
||||||
|
|
||||||
CSS classes follow a naming scheme of `<object>_<description>`.
|
CSS classes follow a naming scheme of `<object>_<description>`.
|
||||||
|
|
||||||
- *Object* usually is the name of the HTML element. If it is not a elemtn directly it is the thing which receives the styling
|
- *Object* usually is the name of the HTML element. If it is not a element directly it is the thing which receives the styling
|
||||||
- *Description* is a name of the style e.g. what it does, how it looks
|
- *Description* is a name of the style e.g. what it does, how it looks
|
||||||
|
|
||||||
|
### JavaScript (JS)
|
||||||
|
|
||||||
|
The codebase uses ECMAScript 2023 Language Specification (14th edition).
|
||||||
|
However, currently the JSHint configuration only allows 11 as highest version.
|
||||||
|
|
||||||
|
ID values are written in *camelCase*. The scheme further uses parts for specific contexts.
|
||||||
|
|
||||||
|
If the ID is for an interactive element the first part is an abbreviation of the action.
|
||||||
|
|
||||||
|
- `qry` - Query
|
||||||
|
- `set` - Set
|
||||||
|
- `slt` - Select
|
||||||
|
- `tgl` - Toggle
|
||||||
|
|
||||||
## Versioning
|
## Versioning
|
||||||
|
|
||||||
This project uses [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://quelltext.interaktionsweise.de/interaktionsweise/hippie/tags).
|
This project uses [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://quelltext.interaktionsweise.de/interaktionsweise/hippie/tags).
|
||||||
|
|
|
||||||
236
TODO.md
236
TODO.md
|
|
@ -11,120 +11,126 @@
|
||||||
- Add build process for normalize.css from github.com/necolas/normalize.css
|
- Add build process for normalize.css from github.com/necolas/normalize.css
|
||||||
- Add build process for bourbon from https://github.com/thoughtbot/bourbon
|
- Add build process for bourbon from https://github.com/thoughtbot/bourbon
|
||||||
|
|
||||||
|
# CSS
|
||||||
|
|
||||||
|
- Check style for every basic element
|
||||||
|
- Uniform spelling of classes and identifiers
|
||||||
|
|
||||||
# Content
|
# Content
|
||||||
|
|
||||||
- Complete *Intro* with description for all basic elements, according to [HTML Standard - The elements of HTML](https://html.spec.whatwg.org/multipage/semantics.html#semantics)
|
- *Intro*
|
||||||
- Sections
|
- Complete with description for all basic elements, according to [HTML Standard - The elements of HTML](https://html.spec.whatwg.org/multipage/semantics.html#semantics)
|
||||||
- [x] body
|
- Sections
|
||||||
- [x] article
|
- [x] body
|
||||||
- [x] section
|
- [x] article
|
||||||
- [x] nav
|
- [x] section
|
||||||
- [x] aside
|
- [x] nav
|
||||||
- [x] h1-h6
|
- [x] aside
|
||||||
- [x] hgroup
|
- [x] h1-h6
|
||||||
- [x] header
|
- [x] hgroup
|
||||||
- [x] footer
|
- [x] header
|
||||||
- [x] address (put to grouping content)
|
- [x] footer
|
||||||
- Grouping content
|
- [x] address (put to grouping content)
|
||||||
- [x] p
|
- Grouping content
|
||||||
- [x] hr
|
- [x] p
|
||||||
- [x] pre
|
- [x] hr
|
||||||
- [x] blockquote
|
- [x] pre
|
||||||
- [x] ol
|
- [x] blockquote
|
||||||
- [x] ul
|
- [x] ol
|
||||||
- [ ] menu (new)
|
- [x] ul
|
||||||
- [x] li
|
- [ ] menu (new)
|
||||||
- [x] dl
|
- [x] li
|
||||||
- [x] dt
|
- [x] dl
|
||||||
- [x] dd
|
- [x] dt
|
||||||
- [x] figure
|
- [x] dd
|
||||||
- [x] figcaption
|
- [x] figure
|
||||||
- [x] main
|
- [x] figcaption
|
||||||
- [ ] search (new)
|
- [x] main
|
||||||
- [x] div
|
- [ ] search (new)
|
||||||
- Text-level semantics
|
- [x] div
|
||||||
- [x] a
|
- Text-level semantics
|
||||||
- [x] em
|
- [x] a
|
||||||
- [x] strong
|
- [x] em
|
||||||
- [x] small
|
- [x] strong
|
||||||
- [x] s
|
- [x] small
|
||||||
- [x] cite
|
- [x] s
|
||||||
- [x] q
|
- [x] cite
|
||||||
- [x] dfn
|
- [x] q
|
||||||
- [x] abbr
|
- [x] dfn
|
||||||
- [x] ruby
|
- [x] abbr
|
||||||
- [x] rb (deprecated)
|
- [x] ruby
|
||||||
- [x] rt
|
- [x] rb (deprecated)
|
||||||
- [x] rtc (deprecated)
|
- [x] rt
|
||||||
- [x] rp
|
- [x] rtc (deprecated)
|
||||||
- [x] data
|
- [x] rp
|
||||||
- [x] time
|
- [x] data
|
||||||
- [x] code
|
- [x] time
|
||||||
- [x] var
|
- [x] code
|
||||||
- [x] samp
|
- [x] var
|
||||||
- [x] kbd
|
- [x] samp
|
||||||
- [x] sub
|
- [x] kbd
|
||||||
- [x] sup
|
- [x] sub
|
||||||
- [x] i
|
- [x] sup
|
||||||
- [x] b
|
- [x] i
|
||||||
- [x] u
|
- [x] b
|
||||||
- [x] mark
|
- [x] u
|
||||||
- [x] bdi
|
- [x] mark
|
||||||
- [x] bdo
|
- [x] bdi
|
||||||
- [x] span
|
- [x] bdo
|
||||||
- [x] br (mentioned in grouping content)
|
- [x] span
|
||||||
- [x] wbr
|
- [x] br (mentioned in grouping content)
|
||||||
- Edits
|
- [x] wbr
|
||||||
- [x] ins
|
- Edits
|
||||||
- [x] del
|
- [x] ins
|
||||||
- Embedded content
|
- [x] del
|
||||||
- [x] picture
|
- Embedded content
|
||||||
- [x] source
|
- [x] picture
|
||||||
- [x] img
|
- [x] source
|
||||||
- [ ] iframe
|
- [x] img
|
||||||
- [ ] embed
|
- [ ] iframe
|
||||||
- [ ] object
|
- [ ] embed
|
||||||
- [ ] param (deprecated)
|
- [ ] object
|
||||||
- [ ] video
|
- [ ] param (deprecated)
|
||||||
- [ ] audio
|
- [ ] video
|
||||||
- [ ] track
|
- [ ] audio
|
||||||
- [ ] map
|
- [ ] track
|
||||||
- [ ] area
|
- [ ] map
|
||||||
- Tabular data
|
- [ ] area
|
||||||
- [ ] table
|
- Tabular data
|
||||||
- [ ] caption
|
- [ ] table
|
||||||
- [ ] colgroup
|
- [ ] caption
|
||||||
- [ ] col
|
- [ ] colgroup
|
||||||
- [ ] tbody
|
- [ ] col
|
||||||
- [ ] thead
|
- [ ] tbody
|
||||||
- [ ] tfoot
|
- [ ] thead
|
||||||
- [ ] tr
|
- [ ] tfoot
|
||||||
- [ ] td
|
- [ ] tr
|
||||||
- [ ] th
|
- [ ] td
|
||||||
- Forms
|
- [ ] th
|
||||||
- [x] form
|
- Forms
|
||||||
- [x] label
|
- [x] form
|
||||||
- [x] input
|
- [x] label
|
||||||
- [x] button
|
- [x] input
|
||||||
- [ ] select
|
- [x] button
|
||||||
- [ ] datalist
|
- [ ] select
|
||||||
- [ ] optgroup
|
- [ ] datalist
|
||||||
- [ ] option
|
- [ ] optgroup
|
||||||
- [ ] textarea
|
- [ ] option
|
||||||
- [ ] output
|
- [ ] textarea
|
||||||
- [ ] progress
|
- [ ] output
|
||||||
- [ ] meter (new)
|
- [ ] progress
|
||||||
- [x] fieldset
|
- [ ] meter (new)
|
||||||
- [x] legend
|
- [x] fieldset
|
||||||
- Interactive elements
|
- [x] legend
|
||||||
- [ ] details
|
- Interactive elements
|
||||||
- [ ] summary
|
- [ ] details
|
||||||
- [ ] dialog
|
- [ ] summary
|
||||||
- Scripting
|
- [ ] dialog
|
||||||
- [ ] script
|
- Scripting
|
||||||
- [ ] noscript
|
- [ ] script
|
||||||
- [ ] template
|
- [ ] noscript
|
||||||
- [ ] slot
|
- [ ] template
|
||||||
- [ ] canvas
|
- [ ] slot
|
||||||
- Check style for every basic element
|
- [ ] canvas
|
||||||
- Uniform spelling of classes and identifiers
|
- *Clock*
|
||||||
|
- Add overlays to better distinguish day, week and year
|
||||||
Loading…
Add table
Add a link
Reference in a new issue