[xiph-cvs] r6695 - in websites-ngen: . xiph.org xiph.org/CSS xiph.org/codecs xiph.org/contact xiph.org/donate xiph.org/forusers/recommendations xiph.org/paranoia xiph.org/speex xiph.org/speex/compare xiph.org/speex/roadmap xiph.org/subversion xiph.org/subversion/windows xiph.org/tools xiph.org/vorbis

comatoast at xiph.org comatoast at xiph.org
Fri May 14 17:13:39 PDT 2004



Author: comatoast
Date: 2004-05-14 20:13:38 -0400 (Fri, 14 May 2004)
New Revision: 6695

Modified:
   websites-ngen/style.txt
   websites-ngen/wrapup.py
   websites-ngen/xiph.org/CSS/all.css
   websites-ngen/xiph.org/codecs/index.markdown
   websites-ngen/xiph.org/contact/index.markdown
   websites-ngen/xiph.org/donate/index.markdown
   websites-ngen/xiph.org/forusers/recommendations/index.markdown
   websites-ngen/xiph.org/index.es.markdown
   websites-ngen/xiph.org/index.markdown
   websites-ngen/xiph.org/paranoia/index.markdown
   websites-ngen/xiph.org/speex/compare/index.markdown
   websites-ngen/xiph.org/speex/index.markdown
   websites-ngen/xiph.org/speex/roadmap/index.markdown
   websites-ngen/xiph.org/subversion/index.markdown
   websites-ngen/xiph.org/subversion/windows/index.markdown
   websites-ngen/xiph.org/tools/index.markdown
   websites-ngen/xiph.org/vorbis/index.markdown
Log:
* Added in a BOM stripper. Catch: It doesn't work when the first line of the file has a 
"#" right after the BOM (it'll confuse Markdown into thinking that's a normal line when, 
in fact, it should be a header). Workaround: Use =-underlines to denote h1 elements. 
Like I did for all the files.

* fiddled around with p text-indent properties.

* More phrasing tweaks for /subversion/.

<p>Modified: websites-ngen/style.txt
===================================================================
--- websites-ngen/style.txt	2004-05-14 21:11:06 UTC (rev 6694)
+++ websites-ngen/style.txt	2004-05-15 00:13:38 UTC (rev 6695)
@@ -6,6 +6,7 @@
 
 *	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
@@ -15,7 +16,13 @@
 
 *	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.
 
+
+
 Spelling, Grammar, and Punctuation
 -----------
 *	For em dashes, in English, leave no space between the dash and the words—like this.

Modified: websites-ngen/wrapup.py
===================================================================
--- websites-ngen/wrapup.py	2004-05-14 21:11:06 UTC (rev 6694)
+++ websites-ngen/wrapup.py	2004-05-15 00:13:38 UTC (rev 6695)
@@ -183,7 +183,19 @@
                 ret = fh.read()
         finally:
                 fh.close()
+	
+	return snipBom(ret)
+
+def snipBom(s):
+	BOM = '\xef\xbb\xbf'
+	ret = ''
+	bomBegin = s.find(BOM)
+	if bomBegin > -1:
+		ret = s[:bomBegin] + s[bomBegin+3:]
+	else:
+		return s
         return ret
+		
 
 def getParallelFile(where, what):
         """

Modified: websites-ngen/xiph.org/CSS/all.css
===================================================================
--- websites-ngen/xiph.org/CSS/all.css	2004-05-14 21:11:06 UTC (rev 6694)
+++ websites-ngen/xiph.org/CSS/all.css	2004-05-15 00:13:38 UTC (rev 6695)
@@ -67,9 +67,14 @@
 }
 
 p	{
-	margin: .125em 0;
+	margin: .25em 0;
+	text-indent: 1em;
 }
 
+h1+p, h2+p, h3+p, h4+p, h5+p, h6+p {
+	text-indent: 0;
+}
+
 code, kbd {
         font: 100% Monaco, "Lucida Console", monospace;
 }

Modified: websites-ngen/xiph.org/codecs/index.markdown
===================================================================
--- websites-ngen/xiph.org/codecs/index.markdown	2004-05-14 21:11:06 UTC (rev 6694)
+++ websites-ngen/xiph.org/codecs/index.markdown	2004-05-15 00:13:38 UTC (rev 6695)
@@ -1,4 +1,5 @@
-# Codecs
+Codecs
+======
 
 We do codecs. Behold:
 * [Vorbis][], a general-purpose audio compression codec

Modified: websites-ngen/xiph.org/contact/index.markdown
===================================================================
--- websites-ngen/xiph.org/contact/index.markdown	2004-05-14 21:11:06 UTC (rev 6694)
+++ websites-ngen/xiph.org/contact/index.markdown	2004-05-15 00:13:38 UTC (rev 6695)
@@ -1,4 +1,5 @@
-# Contact
+Contact
+=======
 
 ## E-mail
 

Modified: websites-ngen/xiph.org/donate/index.markdown
===================================================================
--- websites-ngen/xiph.org/donate/index.markdown	2004-05-14 21:11:06 UTC (rev 6694)
+++ websites-ngen/xiph.org/donate/index.markdown	2004-05-15 00:13:38 UTC (rev 6695)
@@ -1,4 +1,5 @@
-# Donate
+Donate
+======
 
 Xiph.Org is a 501(c)(3) non-profit, so contributions are tax deductible.
 

Modified: websites-ngen/xiph.org/forusers/recommendations/index.markdown
===================================================================
--- websites-ngen/xiph.org/forusers/recommendations/index.markdown	2004-05-14 21:11:06 UTC (rev 6694)
+++ websites-ngen/xiph.org/forusers/recommendations/index.markdown	2004-05-15 00:13:38 UTC (rev 6695)
@@ -1,4 +1,5 @@
-# Software Recommendations
+Software Recommendations
+========================
 
 Many open-source projects just love to show off how many other projects use their stuff. We’re no
 exception; we enjoy it quite a bit when a new project, either open-source or otherwise, announces

Modified: websites-ngen/xiph.org/index.es.markdown
===================================================================
--- websites-ngen/xiph.org/index.es.markdown	2004-05-14 21:11:06 UTC (rev 6694)
+++ websites-ngen/xiph.org/index.es.markdown	2004-05-15 00:13:38 UTC (rev 6695)
@@ -1,4 +1,5 @@
-# ¡Bienvenidos a Xiph.Org!
+¡Bienvenidos a Xiph.Org!
+========================
 
 <!-- perdóneme porque he olvido todo de mis clases de español… -->
 

Modified: websites-ngen/xiph.org/index.markdown
===================================================================
--- websites-ngen/xiph.org/index.markdown	2004-05-14 21:11:06 UTC (rev 6694)
+++ websites-ngen/xiph.org/index.markdown	2004-05-15 00:13:38 UTC (rev 6695)
@@ -1,7 +1,6 @@
-# Welcome to xiph.org!
+Welcome to xiph.org!
+====================
 
-<!-- this stinks. -->
-
 Xiph.org develops multimedia codecs and tools to protect the foundations of Internet multimedia
 from control by private interests.
 

Modified: websites-ngen/xiph.org/paranoia/index.markdown
===================================================================
--- websites-ngen/xiph.org/paranoia/index.markdown	2004-05-14 21:11:06 UTC (rev 6694)
+++ websites-ngen/xiph.org/paranoia/index.markdown	2004-05-15 00:13:38 UTC (rev 6695)
@@ -1,4 +1,5 @@
-# Paranoia
+Paranoia
+========
 <div class='tagline'>
         “Use your CD-ROM drive to read audio tracks…and have it actually work right!”
 </div>

Modified: websites-ngen/xiph.org/speex/compare/index.markdown
===================================================================
--- websites-ngen/xiph.org/speex/compare/index.markdown	2004-05-14 21:11:06 UTC (rev 6694)
+++ websites-ngen/xiph.org/speex/compare/index.markdown	2004-05-15 00:13:38 UTC (rev 6695)
@@ -1,4 +1,5 @@
-# Codec Comparison
+Codec Comparison
+================
 <table border="2" cellpadding="2" width="100%">
         <thead>
                 <tr>

Modified: websites-ngen/xiph.org/speex/index.markdown
===================================================================
--- websites-ngen/xiph.org/speex/index.markdown	2004-05-14 21:11:06 UTC (rev 6694)
+++ websites-ngen/xiph.org/speex/index.markdown	2004-05-15 00:13:38 UTC (rev 6695)
@@ -1,4 +1,5 @@
-# Speex
+Speex
+=====
 
 ## Overview
 Speex is an [Open Source/Free Software][osfs], patent-free audio compression format

Modified: websites-ngen/xiph.org/speex/roadmap/index.markdown
===================================================================
--- websites-ngen/xiph.org/speex/roadmap/index.markdown	2004-05-14 21:11:06 UTC (rev 6694)
+++ websites-ngen/xiph.org/speex/roadmap/index.markdown	2004-05-15 00:13:38 UTC (rev 6695)
@@ -1,4 +1,5 @@
-# Roadmap
+Roadmap
+=======
 
 ## What We’re Doing
 We’re implementing and debugging new features such as a denoiser, echo canceller, and a

Modified: websites-ngen/xiph.org/subversion/index.markdown
===================================================================
--- websites-ngen/xiph.org/subversion/index.markdown	2004-05-14 21:11:06 UTC (rev 6694)
+++ websites-ngen/xiph.org/subversion/index.markdown	2004-05-15 00:13:38 UTC (rev 6695)
@@ -1,14 +1,23 @@
-# Accessing our Subversion Repository
+Accessing our Subversion Repository
+===================================
 
 If you just want to browse our [Subversion][] repository, head on over to <http://svn.xiph.org/>.
-If you want to have a proper copy on your own computer, you’ll probably find that it’s easier to
-keep up with our development efforts with <kbd>svn co</kbd> than with <kbd>wget -m -np</kbd>.
+If you want to have a proper copy of our stuff on your own computer, you’ll probably find that
+it’s easier to keep up with our development efforts with <kbd>svn co</kbd> than with
+<kbd>wget -m -np</kbd> since you won’t get the Subversion metadata with the latter method.
 
 The stock client is fine in both Unix-style OSs and on Windows, although you may want to consider
 using [TortoiseSVN][] with [our Windows-specific instructions][win] if you’re using the latter.
 
-An example initial checkout:
+## Getting Your Bearings
 
+This section will make a lot more sense if you’re browsing <http://svn.xiph.org/> as you read this.
+In particular, have a look at <http://svn.xiph.org/trunk/>; that’s where most of our stuff is.
+
+If you want to build oggenc, you’ll need to check out the <kbd>vorbis-tools</kbd> directory,
+along with the <kbd>ogg</kbd>, <kbd>vorbis</kbd>, and <kbd>ao</kbd> directories. To do this, open
+up a terminal and type: 
+
 <div><code>
         ~ $ mkdir xiphstuff <br>
         ~ $ cd xiphstuff <br>
@@ -19,6 +28,8 @@
                                                         http://svn.xiph.org/trunk/ao/
 </code></div>
 
+If you’re using Windows, the above won’t work unless you remove the backslashes.
+
 ## If You Have Commit Access
 
 Briefly:
@@ -40,3 +51,7 @@
         [/trunk/]:		http://svn.xiph.org/trunk/
         [win]:			./windows/
         [PuTTY]:		http://www.chiark.greenend.org.uk/~sgtatham/putty/
+	[ogg]:			http://svn.xiph.org/trunk/ogg/
+	[vorbis]:		http://svn.xiph.org/trunk/vorbis/
+	[ao]:			http://svn.xiph.org/trunk/ao/
+	[vorbis-tools]:	http://svn.xiph.org/trunk/vorbis-tools/

Modified: websites-ngen/xiph.org/subversion/windows/index.markdown
===================================================================
--- websites-ngen/xiph.org/subversion/windows/index.markdown	2004-05-14 21:11:06 UTC (rev 6694)
+++ websites-ngen/xiph.org/subversion/windows/index.markdown	2004-05-15 00:13:38 UTC (rev 6695)
@@ -1,4 +1,6 @@
-# Windows-Specific Notes for Subversion Access
+Windows-Specific Notes for Subversion Access
+============================================
+
 If you want to use a Subversion client on Windows, there are two clients that we’ve used:
 the [official command-line client][svn.exe] and [TortoiseSVN][]. It’s possible to use both
 to work on the same checked-out repository and it’s rather nice to have both clients around;

Modified: websites-ngen/xiph.org/tools/index.markdown
===================================================================
--- websites-ngen/xiph.org/tools/index.markdown	2004-05-14 21:11:06 UTC (rev 6694)
+++ websites-ngen/xiph.org/tools/index.markdown	2004-05-15 00:13:38 UTC (rev 6695)
@@ -1,4 +1,5 @@
-# Tools
+Tools
+=====
 
 We don’t make just audio and video codecs; we make tools, too. Behold:
 

Modified: websites-ngen/xiph.org/vorbis/index.markdown
===================================================================
--- websites-ngen/xiph.org/vorbis/index.markdown	2004-05-14 21:11:06 UTC (rev 6694)
+++ websites-ngen/xiph.org/vorbis/index.markdown	2004-05-15 00:13:38 UTC (rev 6695)
@@ -1,3 +1,4 @@
-# Ogg Vorbis
+Ogg Vorbis
+==========
 
 Vorbis rocks.

--- >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.



More information about the commits mailing list