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

ASCII art in source files is not helpful #1201

Closed
32 tasks done
chaals opened this issue Feb 9, 2018 · 4 comments
Closed
32 tasks done

ASCII art in source files is not helpful #1201

chaals opened this issue Feb 9, 2018 · 4 comments

Comments

@chaals
Copy link
Collaborator

chaals commented Feb 9, 2018

The source files generally start with a giant ASCII art version of the name, in a comment.

It is not always legible, and in any event it doesn't provide much in the way of value. It would be more helpful to describe the source file, what it contains, and where it ends up in the spec, for example

<!--
This is the source file for https://w3c.github.io/html/introduction.html

All the content is "non-normative". It contains
- a background / potted history of HTML
- a few design notes
- a note on HTML and XML syntax
- information on how the spec is written and how to read it
- some privacy considerations
- an introduction to HTML itself, how to write it, etc.
- non-normative conformance requirements for content
- links to some other specs: charmod, unicode security, and some accessibility specs
-->
  • acknowledgements.include
  • attributes.include
  • browsers.include
  • changes.include
  • dom.include
  • editing.include
  • element-content-categories.include
  • element-interfaces.include
  • elements.include
  • events.include
  • iana.include
  • infrastructure.include
  • introduction.include
  • obsolete.include
  • rendering.include
  • semantics-common-idioms.include
  • semantics-document-metadata.include
  • semantics-edits.include
  • semantics-embedded-content.include
  • semantics-forms.include
  • semantics-grouping-content.include
  • semantics.include
  • semantics-interactive-elements.include
  • semantics-links.include
  • semantics-root.include
  • semantics-scriptings.include
  • semantics-sections.include
  • semantics-tabular-data.include
  • semantics-textlevel.include
  • syntax.include
  • webappapis.include
  • xhtml.include
chaals added a commit that referenced this issue Feb 9, 2018
Remove the ASCII-art version of the filename, and add useful information about the chapter

See also #1201
@arpit7714
Copy link

what to do ??

@chaals
Copy link
Collaborator Author

chaals commented Feb 10, 2018

I filed one PR that covers the introduction chapter - #1202

I am trying to get another one through my temporarily blocked up machine, covering the other items I ticked off the list.

Anyone should feel free to tick something off and file a PR to cover it...

chaals pushed a commit that referenced this issue Feb 10, 2018
This covers some of list in #1201
chaals pushed a commit that referenced this issue Feb 10, 2018
"drive-by" work for #1201 since I am editing this page
@scottaohara
Copy link
Member

@chaals I was going to try to take care of a few of these over the weekend. Would you rather I piggy back off your existing PR, or create a PR of my own changes?

Thanks

@chaals
Copy link
Collaborator Author

chaals commented Feb 10, 2018

Easier if you make your own I think, although I am not that fussed. I started ticking off items as I was about to do them, which might help.

chaals pushed a commit that referenced this issue Feb 10, 2018
Various improvements toward #1201

* Add source header for sections
* Index of Attributes source header
* Index of Elements source header
* Index of Element Content Categories source header
* Index of Events source header
* Index of Element Interfaces source header
* formatting consistency of Index tables
chaals added a commit that referenced this issue Feb 13, 2018
Fix #1158

* Clarify caption end tag can be ommitted
* "drive-by" cleanup for #1201 since I am editing this page
* Add an explanatory note about what happens when the end tag is ommitted.
* Note change
@scottaohara scottaohara self-assigned this Feb 13, 2018
@chaals chaals self-assigned this Feb 13, 2018
chaals added a commit that referenced this issue Feb 13, 2018
scottaohara pushed a commit that referenced this issue Feb 13, 2018
chaals added a commit that referenced this issue Feb 15, 2018
Remove the ASCII-art version of the filename, and add useful information about the chapter

See also #1201
scottaohara pushed a commit that referenced this issue Feb 15, 2018
* Update comments in some source files

This covers some of list in #1201

* fix typo in dom.include
chaals added a commit that referenced this issue Feb 16, 2018
chaals added a commit that referenced this issue Feb 17, 2018
* Update header comment in "embedded content"

See also #1201
scottaohara pushed a commit that referenced this issue Feb 17, 2018
* Update header comment in "embedded content"

See also #1201
chaals pushed a commit that referenced this issue Feb 18, 2018
* link source header comments
* IANA source header comments
* XML source header comments
* make formatting consistent

These changes are for #1201
chaals pushed a commit that referenced this issue Feb 19, 2018
Fix #1217 

* remove the fileAPI monkey patch.
* revise infrastructure comment in header - see #1201
scottaohara added a commit that referenced this issue Feb 19, 2018
* link source header comments
* IANA source header comments
* XML source header comments
* make formatting consistent

These changes are for #1201
scottaohara added a commit that referenced this issue Feb 19, 2018
Fix #1217 

* remove the fileAPI monkey patch.
* revise infrastructure comment in header - see #1201
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants