Author: deryck Date: 2004-09-03 19:19:31 +0000 (Fri, 03 Sep 2004) New Revision: 307
WebSVN: http://websvn.samba.org/websvn/changeset.php?rep=samba-web&path=/trunk&rev=307&nolog=1 Log: This adds a set of templates in each directory to help with updating the site. Also, the README file offers a set of guidelines for working with the new xhtml/css design. Sorry if I covered things in too great a detail. I didn't know how much people had dealt with xhtml yet. I assumed only experience with html. --deryck Added: trunk/README trunk/devel/devel_template trunk/docs/docs_template trunk/download/download_template trunk/support/country_template trunk/team/team_template Modified: trunk/history/rnotes_template trunk/top_level_template Changeset: Added: trunk/README =================================================================== --- trunk/README 2004-09-03 17:06:13 UTC (rev 306) +++ trunk/README 2004-09-03 19:19:31 UTC (rev 307) @@ -0,0 +1,81 @@ +Here are some guidelines for updating samba.org: + +XHTML + +The new design for samba.org uses xhtml 1.0 Transitional. +xhtml is different from html<=4.0 in several ways. The +difference is minimal in terms of syntax, but major in +terms of its implications on the page. A rundown of each: + +***Case Sensitive*** + +xhtml is case sensitive, and all tags are lowercase. +<ul> != <UL> Therefore, mixing case is bad, too. +You can't do <a HREF="...">. + +***Closed Tags*** + +xhtml requires all tags be closed. Most notably, this +affects the former <br>, <hr>, and <img> tags; these should +now be written as <br />, <hr />, and +<img src="..." alt="..." />. The img tag is the one that +catches people most often, especially in the following syntax: +<a href="..."><img src="..." alt="..." /></a>. Even though +the anchor tags are closed, the image tag must still be closed. + +***Proper Nesting*** + +Tags must close in the proper nesting order. An example: +<tag1><tag2></tag2></tag1>. This is a simple example, but +in nesting lists it can get confusing. Also, within forms +using other tags can get sticky. I'm still learning some +of the nuances of this myself, so be careful with this +one. Use an online validator to check if you're not sure. + +***Why You Should Care*** + +html is *very* forgiving. xhtml is not. If you miss one of +the above in your web page, there's no telling what it will +look like in different browsers. In fact, most of the wild +page display problems during the move to the new design were +due to xhtml validation problems. And there's no telling how +a browser may handle an error. We still have several html +hold-overs, but none of them are critical, at least in terms of +page display. + + +ADDING NEW PAGES + +If you have to add a completely new page to a directory, +templates have been provided in each directory. Adding +a page should simply be a matter of opening the template +and adding in the info you want. Make sure you follow +the xhtml rules above and be sure to add a title between +the title tags. The two-header system was built to allow +for page specific titles. This is a help in browser bookmarks +and search engine indexing. + + +PAGE FORMAT + +Page formatting is handled by css. This is another important +consideration in xhtml sites versus html sites. This means that +you should not use a bunch of attribute tags to style a page. +For example, <table border="3" width="30" height="100"> is +not used in xhtml/css sites. The stylesheet rules control +the look of each element. If you use just normal <h3> tags for +headings and <p> tags for paragraphs, styles are already in place. + +Also, see </samba/styles/common.css> for a number of built in +styles. Simply declare a style as an attribute of a tag to use +a particular style. So if you want to use the headline style, +write <p class="headline">YOUR_INFO_HERE</p>. Stylesheets +distinguish classes with a "." and ids with a "#". Using the logo +style would require <p id="logo">CONTENT_HERE</p>. + + +ADDING STYLES + +If you need styles added or have special formatting requirements, +please email me (deryck[at]samba[dot]org). Questions and comments +are also welcome. Added: trunk/devel/devel_template =================================================================== --- trunk/devel/devel_template 2004-09-03 17:06:13 UTC (rev 306) +++ trunk/devel/devel_template 2004-09-03 19:19:31 UTC (rev 307) @@ -0,0 +1,9 @@ +<!--#include virtual="/samba/header.html" --> + <title>PAGE_SPECIFIC_TITLE_GOES_HERE</title> +<!--#include virtual="header_devel.html" --> + + +PLACE_YOUR_CONTENT_HERE + + +<!--#include virtual="/samba/footer.html" --> Added: trunk/docs/docs_template =================================================================== --- trunk/docs/docs_template 2004-09-03 17:06:13 UTC (rev 306) +++ trunk/docs/docs_template 2004-09-03 19:19:31 UTC (rev 307) @@ -0,0 +1,9 @@ +<!--#include virtual="/samba/header.html" --> + <title>PAGE_SPECIFIC_TITLE</title> +<!--#include virtual="header_docs.html" --> + + +PLACE_YOUR_CONTENT_HERE + + +<!--#include virtual="/samba/footer.html" --> Added: trunk/download/download_template =================================================================== --- trunk/download/download_template 2004-09-03 17:06:13 UTC (rev 306) +++ trunk/download/download_template 2004-09-03 19:19:31 UTC (rev 307) @@ -0,0 +1,9 @@ +<!--#include virtual="/samba/header.html" --> + <title>PAGE_SPECIFIC_TITLE_HERE</title> +<!--#include virtual="header_download.html" --> + + +PLACE_YOUR_CONTENT_HERE + + +<!--#include virtual="/samba/footer.html" --> Modified: trunk/history/rnotes_template =================================================================== --- trunk/history/rnotes_template 2004-09-03 17:06:13 UTC (rev 306) +++ trunk/history/rnotes_template 2004-09-03 19:19:31 UTC (rev 307) @@ -7,6 +7,6 @@ </head> <body> - +RELEASE_NOTES_PASTED_IN_HERE </body> -</html> \ No newline at end of file +</html> Added: trunk/support/country_template =================================================================== --- trunk/support/country_template 2004-09-03 17:06:13 UTC (rev 306) +++ trunk/support/country_template 2004-09-03 19:19:31 UTC (rev 307) @@ -0,0 +1,9 @@ +<!--#include virtual="/samba/header.html" --> + <title>Samba Support--COUNTRY_NAME_HERE</title> +<!--#include virtual="header_support.html" --> + + +PLACE_SUPPORT_INFO_HERE + + +<!--#include virtual="footer_support.html" --> Added: trunk/team/team_template =================================================================== --- trunk/team/team_template 2004-09-03 17:06:13 UTC (rev 306) +++ trunk/team/team_template 2004-09-03 19:19:31 UTC (rev 307) @@ -0,0 +1,8 @@ +<!--#include virtual="/samba/header.html" --> + <title>The Samba Team</title> +<!--#include virtual="header_team.html" --> + +PLACE_YOUR_CONTENT_HERE + + +<!--#include virtual="/samba/footer.html" --> Modified: trunk/top_level_template =================================================================== --- trunk/top_level_template 2004-09-03 17:06:13 UTC (rev 306) +++ trunk/top_level_template 2004-09-03 19:19:31 UTC (rev 307) @@ -1,10 +1,9 @@ <!--#include virtual="/samba/header.html" --> - <title>Page Specific Title Goes Here</title> + <title>PAGE_SPECIFIC_TITLE_GOES_HERE</title> <!--#include virtual="/samba/header2.html" --> -Place your content between the includes. +PLACE_YOUR _CONTENT_HERE - -<!--#include virtual="/samba/footer.html" --> \ No newline at end of file +<!--#include virtual="/samba/footer.html" -->
