[xiph-cvs] r6723 - websites-ngen

[comatoast at xiph.org]

Author: comatoast
Date: 2004-05-18 18:32:26 -0400 (Tue, 18 May 2004)
New Revision: 6723

Modified:
   websites-ngen/readme.txt
   websites-ngen/style.txt
Log:
Readme and style guide updates.

<p>Modified: websites-ngen/readme.txt
===================================================================
--- websites-ngen/readme.txt	2004-05-18 18:49:40 UTC (rev 6722)
+++ websites-ngen/readme.txt	2004-05-18 22:32:26 UTC (rev 6723)
@@ -14,11 +14,19 @@
 Run wrapup.py right in the directory it's in. If nothing failed, you should see a new .html
 file for every .markdown file.
 
-Assumptions
------------
+Apache Setup
+------------
 
-All URLs are to be in the style of /foo/bar/, for reasons described on [Slash Forward][].
-I may break this for content-negotiated language-specific variants (say, for /foo/bar/es for
-"/foo/bar/ in Spanish"), but this is the way it's set up now.
+I try to keep as much configuration stuff in the .htaccess file as I possibly can
+(running apachectl is a pain), but there are a couple of things you need to have in the main
+httpd.conf or wherever you store your apache setup:
 
-	[Slash Forward]: http://www.alistapart.com/articles/slashforward/
+	<?>
+		# The following may be okay without Includes. You also might be able to chuck Indexes,
+		# but I never do that.
+		# FollowSymLinks is an absolute must for the non-English versions, since mod_rewrite
+		# needs it as a security check or something.
+		Options Indexes Includes FollowSymLinks
+
+		AllowOverride All
+	</?>

Modified: websites-ngen/style.txt
===================================================================
--- websites-ngen/style.txt	2004-05-18 18:49:40 UTC (rev 6722)
+++ websites-ngen/style.txt	2004-05-18 22:32:26 UTC (rev 6723)
@@ -6,7 +6,6 @@
 
 *	Four-column tabs for indentation.
 
-
 *	Keep lines to 100 columns or fewer.
 
 *	Use UTF-8. In particular, use proper apostrophes and quotes (U+2018–U+201E) and
@@ -19,26 +18,23 @@
 *	Close tags that need closing. <p>-as-paragraph-separator has gone the way of the dodo.
 
 *	Prefer the equals-sign-underline for h1 to the single #. The latter method doesn't offer
-	a good way to get around BOMs that may sneak in from Notepad and TextEdit...unless you
-	have the heading on the second line, and that looks ugly. Your call as to whether to use
-	-----style h2 headings, though. I recommend against.
+	a good way to get around BOMs that may sneak in from Notepad and TextEdit. However, prefer
+	## to ------ for marking up second-level headings.
 
 *	Directories generally not shown to users should start with a capital letter.
         Prime examples of this are the */CSS/ directories and /Error/.
 
 
 Spelling, Grammar, and Punctuation
------------
-*	For em dashes, in English, leave no space between the dash and the words—like this.
-
-*	For the love of all that’s holy, leave no space between a question mark and its
-	preceding sentence.
-
+----------------------------------
 *	Do not write "CODEC" in all caps.
-
 *	"Copyright © 2004 Xiph.Org" and "Copyright (c) 2004 Xiph.Org" are redundant;
-	prefer "© 2004 Xiph.Org" to both. Failing that, drop the "(c)".
+	prefer "© 2004 Xiph.Org" to both. Failing that, use "Copyright 2004 Xiph.Org".
 
+### English-Specific Considerations
+*	For em dashes, leave no space between the dash and the words—like this.
+*	For the love of all that’s holy, leave no space between a question mark and its
+	preceding sentence. Same for exclamation points, periods, commas, and colons.
 
 URLs and Linkage
 ----------------
@@ -50,7 +46,13 @@
 
 *	Redirect to <http://www.xiph.org/>. Not to, for example, <http://xiph.org/>.
 
+*	Page URLs are to be in the style of /foo/bar/baz/quux/ for reasons described on
+	[Slash Forward][].
 
+*	Non-US English versions of pages have their language code tacked on the end, as in
+	<http://www.xiph.org/vorbis/download/es> or <http://www.xiph.org/about/fr-CA>.
+
+
 Open Questions
 --------------
 *	Tone: How should we write? I’d like to display a visible sense of humor on the site.

--- >8 ----
List archives:  http://www.xiph.org/archives/
Ogg project homepage: http://www.xiph.org/ogg/
To unsubscribe from this list, send a message to 'cvs-request at xiph.org'
containing only the word 'unsubscribe' in the body.  No subject is needed.
Unsubscribe messages sent to the list will be ignored/filtered.