Design Log (Cuttlefish)

Question

Design Log (Cuttlefish)

Closed this issue 8 years ago · 9 comments

The following is a list of the design decisions made during the development of the HTML5 Template Generator.

Note: Backwards compatibility with older standards and/or browsers is not a consideration as part of the project's aim is to promote the use of HTML5 and the latest web standards.

Supported charsets are only UTF-8 and ISO-8859-1 as they are widely used. For anything else, you will have to manually edit the page. Standard templates only use UTF-8.
tags that are not supported:
- application-name - Seems like clutter and it can be easily added when needed.
- http-equiv - content-type is deprecated in HTML5, default-style seems like clutter and refresh should be used carefully. As stated in W3Schools: Using "refresh" will cause a failure in W3C's Web Content Accessibility Guidelines.
will always refer to this project's live page ~~and cannot be removed unless manually deleted from the final template.~~
Certain popular libraries are not yet supported. Some of them will never be supported, due to being outdated and/or not HTML5-compatible. If you are interested in the topic, check out issue #1. If you want a specific library to be supported, please submit an issue with your request.

Answer 1 · 2016-07-14T20:16:50.000Z

<!DOCTYPE> will only actively support html, which refers to HTML5. Older standards will not be supported. Same policy applies for the generated JSFiddles. Also, xhtml will not be supported currently. Plans might change in the future.

Answer 2 · 2016-07-28T09:20:02.000Z

Self-closing tags will now be generated without a / before closing as the character is mostly syntactic sugar and doesn't serve any practical purpose in most cases (i.e. <br/> will now be generated as <br>).

Answer 3 · 2016-07-29T10:10:21.000Z

x-ua-compatible will not be supported as legacy browsers are not a concern of this generator.
Old browser warnings are supported, but not on by default.

Answer 4 · 2016-08-09T07:28:58.000Z

Generator indentation will be 2 whitespaces for one indent. The html open and close tags will be on the same level as the DOCTYPE declaration.

Answer 5 · 2016-08-09T12:08:42.000Z

The viewport tag is added by default as it is vital to creating modern, responsive web pages. This option can be turned off.
The generator tag is now added by default and can be removed if the user desires it. this is in order to allow for more modular pages and give the user more power, as well as removing unnecessary clutter from the generated pages.

Answer 6 · 2016-08-11T07:29:27.000Z

Cuttlefish will partially format user's custom body input to have 4 whitespaces in the front (2 indents), however it will not remove any extra whitespaces both at the front and end of each line. This might be implemented in a later version.

Answer 7 · 2016-08-16T10:03:15.000Z

As far as Bootstrap is concerned, support was added for viewport locking, but is not suggested. It will only be applied if Bootstrap is enabled, the corresponding flag is enabled and the corresponding metadata tag is included.

Answer 8 · 2016-08-16T10:15:00.000Z

All generated forms have autocomplete="off" by default. This is in order to make sure no forms are automatically completed by default as this can cause some security issues. Users can always remove this by changing their code later (next version should include a toggle switch for this if people deem it necessary).

Answer 9 · 2016-08-17T12:00:03.000Z

As of commit cd477df, v1.0.0 (Cuttlefish) is no more marked as production, but rather as release. Some final changes have to be made, but no new design changes will be made. Thus, this issue is closed.