docs: Update README and TODO

- Better structure for TODOs
- Add information about JavaScript to README
This commit is contained in:
sthag 2026-02-14 12:16:55 +01:00
parent 0a5bc191d3
commit 759283fd9f
2 changed files with 136 additions and 116 deletions

View file

@ -44,9 +44,23 @@ Everything has its default style.
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
### 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
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).

234
TODO.md
View file

@ -11,120 +11,126 @@
- Add build process for normalize.css from github.com/necolas/normalize.css
- Add build process for bourbon from https://github.com/thoughtbot/bourbon
# Content
# CSS
- 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)
- Sections
- [x] body
- [x] article
- [x] section
- [x] nav
- [x] aside
- [x] h1-h6
- [x] hgroup
- [x] header
- [x] footer
- [x] address (put to grouping content)
- Grouping content
- [x] p
- [x] hr
- [x] pre
- [x] blockquote
- [x] ol
- [x] ul
- [ ] menu (new)
- [x] li
- [x] dl
- [x] dt
- [x] dd
- [x] figure
- [x] figcaption
- [x] main
- [ ] search (new)
- [x] div
- Text-level semantics
- [x] a
- [x] em
- [x] strong
- [x] small
- [x] s
- [x] cite
- [x] q
- [x] dfn
- [x] abbr
- [x] ruby
- [x] rb (deprecated)
- [x] rt
- [x] rtc (deprecated)
- [x] rp
- [x] data
- [x] time
- [x] code
- [x] var
- [x] samp
- [x] kbd
- [x] sub
- [x] sup
- [x] i
- [x] b
- [x] u
- [x] mark
- [x] bdi
- [x] bdo
- [x] span
- [x] br (mentioned in grouping content)
- [x] wbr
- Edits
- [x] ins
- [x] del
- Embedded content
- [x] picture
- [x] source
- [x] img
- [ ] iframe
- [ ] embed
- [ ] object
- [ ] param (deprecated)
- [ ] video
- [ ] audio
- [ ] track
- [ ] map
- [ ] area
- Tabular data
- [ ] table
- [ ] caption
- [ ] colgroup
- [ ] col
- [ ] tbody
- [ ] thead
- [ ] tfoot
- [ ] tr
- [ ] td
- [ ] th
- Forms
- [x] form
- [x] label
- [x] input
- [x] button
- [ ] select
- [ ] datalist
- [ ] optgroup
- [ ] option
- [ ] textarea
- [ ] output
- [ ] progress
- [ ] meter (new)
- [x] fieldset
- [x] legend
- Interactive elements
- [ ] details
- [ ] summary
- [ ] dialog
- Scripting
- [ ] script
- [ ] noscript
- [ ] template
- [ ] slot
- [ ] canvas
- Check style for every basic element
- Uniform spelling of classes and identifiers
# Content
- *Intro*
- Complete with description for all basic elements, according to [HTML Standard - The elements of HTML](https://html.spec.whatwg.org/multipage/semantics.html#semantics)
- Sections
- [x] body
- [x] article
- [x] section
- [x] nav
- [x] aside
- [x] h1-h6
- [x] hgroup
- [x] header
- [x] footer
- [x] address (put to grouping content)
- Grouping content
- [x] p
- [x] hr
- [x] pre
- [x] blockquote
- [x] ol
- [x] ul
- [ ] menu (new)
- [x] li
- [x] dl
- [x] dt
- [x] dd
- [x] figure
- [x] figcaption
- [x] main
- [ ] search (new)
- [x] div
- Text-level semantics
- [x] a
- [x] em
- [x] strong
- [x] small
- [x] s
- [x] cite
- [x] q
- [x] dfn
- [x] abbr
- [x] ruby
- [x] rb (deprecated)
- [x] rt
- [x] rtc (deprecated)
- [x] rp
- [x] data
- [x] time
- [x] code
- [x] var
- [x] samp
- [x] kbd
- [x] sub
- [x] sup
- [x] i
- [x] b
- [x] u
- [x] mark
- [x] bdi
- [x] bdo
- [x] span
- [x] br (mentioned in grouping content)
- [x] wbr
- Edits
- [x] ins
- [x] del
- Embedded content
- [x] picture
- [x] source
- [x] img
- [ ] iframe
- [ ] embed
- [ ] object
- [ ] param (deprecated)
- [ ] video
- [ ] audio
- [ ] track
- [ ] map
- [ ] area
- Tabular data
- [ ] table
- [ ] caption
- [ ] colgroup
- [ ] col
- [ ] tbody
- [ ] thead
- [ ] tfoot
- [ ] tr
- [ ] td
- [ ] th
- Forms
- [x] form
- [x] label
- [x] input
- [x] button
- [ ] select
- [ ] datalist
- [ ] optgroup
- [ ] option
- [ ] textarea
- [ ] output
- [ ] progress
- [ ] meter (new)
- [x] fieldset
- [x] legend
- Interactive elements
- [ ] details
- [ ] summary
- [ ] dialog
- Scripting
- [ ] script
- [ ] noscript
- [ ] template
- [ ] slot
- [ ] canvas
- *Clock*
- Add overlays to better distinguish day, week and year