Subject: [Boost-commit] svn:boost r70851 - website/public_html/beta/development
From: dnljms_at_[hidden]
Date: 2011-04-02 06:29:45
Author: danieljames
Date: 2011-04-02 06:29:44 EDT (Sat, 02 Apr 2011)
New Revision: 70851
URL: http://svn.boost.org/trac/boost/changeset/70851
Log:
Website: Upddate the site updating page.
Text files modified:
website/public_html/beta/development/website_updating.html | 154 +++++++++++++++++++++------------------
1 files changed, 83 insertions(+), 71 deletions(-)
Modified: website/public_html/beta/development/website_updating.html
==============================================================================
--- website/public_html/beta/development/website_updating.html (original)
+++ website/public_html/beta/development/website_updating.html 2011-04-02 06:29:44 EDT (Sat, 02 Apr 2011)
@@ -62,16 +62,23 @@
<h2><a name="ExistingPage" id="ExistingPage"></a>Existing
Page</h2>
+ <p>Several pages on the site (e.g. the home page, release
+ notes, the download page, the version history page, possibly
+ others) are generated by scripts, if you wish to edit these,
+ see below. The should all contain a comment explaining that
+ they're generated by a script.<br /></p>
+
<p>The web content is structured to be as simple as possible to
make generic editing possible. At minimum only a text editor
- and <a href="http://tidy.sourceforge.net/" class=
- "external">HTML Tidy</a> are needed to edit content. The
- content uses <a href="http://www.w3.org/TR/xhtml1/" class=
- "external">XHTML 1.0 Strict</a> for various reasons, the most
- important being to increase accessibility and to enforce the
- separation of style from content. After getting the content you
- want to edit as above, make the changes you want and run the
- result through HTML Tidy with these options:</p>
+ and <a class="external" href=
+ "http://tidy.sourceforge.net/">HTML Tidy</a> are needed to edit
+ content. The content uses <a class="external" href=
+ "http://www.w3.org/TR/xhtml1/">XHTML 1.0 Strict</a> for various
+ reasons, the most important being to increase accessibility and
+ to enforce the separation of style from content. After getting
+ the content you want to edit as above, make the changes you
+ want and run the result through HTML Tidy with these
+ options:</p>
<pre>
tidy --tidy-mark no -i -wrap 78 -m -asxhtml --merge-divs no --merge-spans no --doctype strict <i>fname</i>
</pre>
@@ -92,8 +99,9 @@
Removing the unavailable options is possible and will work. But
we recommend installing the latest <tt>tidy</tt> if possible.
You can obtain up to date Windows binaries, and sources from
- the <a href="http://tidy.sourceforge.net/" class=
- "external">HTML Tidy Library Project</a>.</p>
+ the <a class="external" href=
+ "http://tidy.sourceforge.net/">HTML Tidy Library
+ Project</a>.</p>
<p>The pages should be viewable in most browsers. If possible
test you changes in as many as possible. Preferably at least
@@ -108,49 +116,51 @@
at:</p>
<table summary="Website Locations">
- <tr>
- <th>Site</th>
-
- <th>URL</th>
-
- <th>Subversion</th>
- </tr>
-
- <tr>
- <td>Beta</td>
-
- <td><a href=
- "http://beta.boost.org/">http://beta.boost.org/></td>
-
- <td><a href=
- "https://svn.boost.org/svn/boost/website/public_html/beta/">
- https://svn.boost.org/svn/boost/website/public_html/beta/></td>
- </tr>
-
- <tr>
- <td colspan="3">This is the experimetal version of the
- website. Changes should be made here first and then merged
- to the live website.</td>
- </tr>
-
- <tr>
- <td>Live</td>
-
- <td><a href=
- "http://www.boost.org/">http://www.boost.org/></td>
-
- <td><a href=
- "https://svn.boost.org/svn/boost/website/public_html/live/">
- https://svn.boost.org/svn/boost/website/public_html/live/></td>
- </tr>
-
- <tr>
- <td colspan="3">The website the general public will
- see.</td>
- </tr>
+ <tbody>
+ <tr>
+ <th>Site</th>
+
+ <th>URL</th>
+
+ <th>Subversion</th>
+ </tr>
+
+ <tr>
+ <td>Beta</td>
+
+ <td><a href=
+ "http://beta.boost.org/">http://beta.boost.org/></td>
+
+ <td><a href=
+ "https://svn.boost.org/svn/boost/website/public_html/beta/">
+ https://svn.boost.org/svn/boost/website/public_html/beta/></td>
+ </tr>
+
+ <tr>
+ <td colspan="3">This is the experimetal version of the
+ website. Changes should be made here first and then
+ merged to the live website.</td>
+ </tr>
+
+ <tr>
+ <td>Live</td>
+
+ <td><a href=
+ "http://www.boost.org/">http://www.boost.org/></td>
+
+ <td><a href=
+ "https://svn.boost.org/svn/boost/website/public_html/live/">
+ https://svn.boost.org/svn/boost/website/public_html/live/></td>
+ </tr>
+
+ <tr>
+ <td colspan="3">The website the general public will
+ see.</td>
+ </tr>
+ </tbody>
</table>
- <h2><a name="NewPage" id="NewPage"></a>New Page</h2>
+ <h2><a id="NewPage" name="NewPage"></a>New Page</h2>
<p>To make adding new pages easier there is a <a href=
"http://svn.boost.org/svn/boost/website/workplace/template.html">
@@ -213,16 +223,19 @@
to change to one of:</p>
<ul>
- <li>Introduction: <tt>/style-v2/section-boost.css</tt></li>
+ <li>Introduction:
+ <tt>/style-v2/section-boost.css</tt></li>
- <li>Community: <tt>/style-v2/section-community.css</tt></li>
+ <li>Community:
+ <tt>/style-v2/section-community.css</tt></li>
<li>Development:
<tt>/style-v2/section-development.css</tt></li>
<li>Support: <tt>/style-v2/section-support.css</tt></li>
- <li>Documentation: <tt>/style-v2/section-doc.css</tt></li>
+ <li>Documentation:
+ <tt>/style-v2/section-doc.css</tt></li>
</ul>
</li>
@@ -273,7 +286,7 @@
needs to add an entry to the page so it can be accessed from
the sidebar and index. See below...</p>
- <h2><a name="Menus" id="Menus"></a>Menus, Sidebars, and
+ <h2><a id="Menus" name="Menus"></a>Menus, Sidebars, and
Index</h2>
<p>The various navigation elements are structured to make
@@ -298,37 +311,36 @@
<li>Documentation: <tt>/common/menu-doc.html</tt></li>
</ul>
- <h2><a name="Feeds" id="Feeds"></a>Feeds</h2>
+ <h2><a id="Feeds" name="Feeds"></a>Generated Pages</h2>
- <p>There are various section of the web site that correspond to
- RSS feeds: news, downloads, and the version history. Even
- though they are displayed in various locations on the site the
- source feed documents are in the <tt>/feed</tt> directory. The
+ <p>There are various sections of the web site that are
+ generated by a python script from quickbook source files: the
+ home page, news, downloads, version history and feeds. The
content is not directly editable, but instead is generated from
- source Quickbook documents. For example to add a news item one
+ source Quickbook documents. For example, to add a news item one
would:</p>
<ol>
<li>Create a new file in the <tt>/feed/news</tt> directory,
say <tt>/feed/news/gui_review_ends.qbk</tt>.</li>
- <li>In a shell, go to the <tt>/feed</tt> directory, and run
- <tt>bjam --boost-build=/path/to/tools/build/v2</tt>, or
- <tt>bjam --boost=/path/to/boost-root</tt>. This will generate
- the BoostBook XML for the new news item and regenerate the
- <tt>/feed/news.rss</tt> file.</li>
+ <li>In a shell, go to the <tt>/site-tools</tt> directory, and
+ run <tt>python site-tools.py update</tt>. This will generate
+ the page for the new news item, regenerate the
+ <tt>/feed/news.rss</tt> file to include it, update pages
+ which link to the new item and update the file
+ <tt>/site-tools/state/feed-pages.txt</tt> which tracks the
+ current state of generated files.</li>
<li>Add the new files to the SVN repository, and commit.</li>
</ol>
<p>The same procedure applies to the other feeds, but keep in
mind that some feeds may combine entries from more than one
- feed subdirectory. Currently this requires Quickbook be
- precompiled and preconfigured in your <tt>user-config.jam</tt>.
- And also requires Python, in the path, to do the BoostBook to
- RSS translation.</p>
+ feed subdirectory. Currently this requires Quickbook and Python
+ in your path.</p>
- <h2><a name="Local_Server" id="Local_Server"></a>Local
+ <h2><a id="Local_Server" name="Local_Server"></a>Local
Server</h2>
<p>Even though the web site is designed so that one only needs