Contribution

Todo

Review

This section is dated and needs to be reviewed and rewritten.

Contents:

• Structure
  • Package Structure
  • Structure limitations
  • Artefacts
• HTML
  • W3C
  • Schema
  • DTD
• Packages
  • Name Spaced Packages
• Tools
  • HTML Validation
  • Crimson Editor
• Symbolic Links

Name Spaced Packages discusses how one might distribute common template/data through Python packages. Such packages, and related 3rd party extentions, allow for unhindered contribution, provided all parties adhere to a few conventions. Package Structure outlines the conventions for the web-templates package so that no one overrides or breaks anothers contribution.

Todo

Review

This section is dated and needs to be reviewed and rewritten.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/web-templates/checkouts/latest/docs/contribution.rst, line 5.)

Todo

Review

This section is dated and needs to be reviewed and rewritten.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/web-templates/checkouts/latest/docs/design.rst, line 5.)

Todo

These base files are named base.ENGINE.html; this should be applied for all of the base frameworks. It frees the user up to migrate from some base.html to base.ENGINE.html until they can adopt web templates across their entire site and revert back to base.html. The “Sphinx in Django” section of the documentation also illustrates the utility in having the sphinx_ENGINE themes compile ones documentation to depends upon a base.ENGINE.html template rather then a base.html.

I believe these templates were measnt to ‘passivate’; that is setup the base functionality for the website for a given template engine e.g. include boostrap/material design react etc.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/web-templates/checkouts/latest/docs/design.rst, line 12.)

Todo

Specifically for sphinx the file E:Pythonweb-templatesweb_templatessphinxdjangolayout.html, a copy of E:Pythonweb-templatesweb_templatesbasiclayout.html, may be sued by sphinx to compile documentation that depends upon a base.sphinx.html file; based upon the users base.html which in turn subclasses web-teplates/../skeleton.html. The current E:Pythonweb-templatesweb_templatesbase.sphinx.html seems to duplicate the E:Pythonsphinxsphinxthemesbasiclayout.html from the Sphinx base theme more then anything else; I believe this was to be merged with E:Pythonweb-templatesweb_templatessphinxdjangolayout.html. E:Pythonweb-templatesweb_templatesbase.sphinx.html was probably meant to serve as a bridging template for users to simply copy or extend as necessary.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/web-templates/checkouts/latest/docs/design.rst, line 29.)

Todo

Review

This section is dated and needs to be reviewed and rewritten.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/web-templates/checkouts/latest/docs/extentions.rst, line 5.)

Todo

Review how to show a Software Application, Bread Crumb, FAQ and How T links.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/web-templates/checkouts/latest/docs/seo.rst, line 15.)

Todo

Write

This section needs to be written :

• Main structural blocks
• Main structural elements
• Review Js blocks to be more inline with the tempalates.rst documentation.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/web-templates/checkouts/latest/docs/templates/body.rst, line 7.)

Todo

Write

This section needs to be written :

• CSS Blocks
• Meta Blocks
• JS Blocks

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/web-templates/checkouts/latest/docs/templates/head.rst, line 7.)