sysapps / runtime

Runtime and Security Model for Hosted Web Applications and Packaged Applications
6 stars 13 forks source link

Indenting and consistant code style in spec #12

Closed marcoscaceres closed 11 years ago

marcoscaceres commented 11 years ago

I'm wondering if we can run the spec over HTML5 tidy to give it consistant indenting, etc. Or is something else being used to indent the markup? This will make editing a lot easier.

Right now, I need to write out new proposed text, move it to a new file, run tidy over the file, and copy the beautified code before sending a pull request. Having the original document alway be "tidy" would save (me, and possible other contributors) a bit of time.

cough cough and moving to anolis would also be awesome cough cough

ming-jin commented 11 years ago

Hi @marcoscaceres,

First of all, please fix a typo and tag mismatch error in index.html:

1374c1374
<             as the first argument is a Function object rather than a string;<il>
---
>             as the first argument is a Function object rather than a string;</li>
1377c1377
<             myElement.onXXX = someFunction;<li>
---
>             myElement.onXXX = someFunction;</li>

And then run html5 tidy with following tidy configuration:

indent: auto
indent-spaces: 2
wrap: 72
markup: yes
output-xml: no
input-xml: no
show-warnings: yes
numeric-entities: yes
quote-marks: no
quote-nbsp: yes
quote-ampersand: no
char-encoding: utf8
break-before-br: no
uppercase-tags: no
uppercase-attributes: no
new-inline-tags: cfif, cfelse, math, mroot, 
  mrow, mi, mn, mo, msqrt, mfrac, msubsup, munderover,
  munder, mover, mmultiscripts, msup, msub, mtext,
  mprescripts, mtable, mtr, mtd, mth, todo
new-blocklevel-tags: cfoutput, cfquery, section
new-empty-tags: cfelse

You will see that the whole runtime spec will get tidy-up properly :)

marcoscaceres commented 11 years ago

Excellent, thanks for the config file! I'll wait till the @mounirlamouri has decided which pull requests are going in before fixing the indenting. That will avoid some potential merge conflicts and make the pull requests easier to review.

marcoscaceres commented 11 years ago

So, I've gone through the options for tidy and all we need in the configuration document is:

char-encoding: utf8
indent: yes
wrap: 80
marcoscaceres commented 11 years ago

closed by #60