Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/more/updating_the_website.html @ 12

Last change on this file since 12 was 12, checked in by landauf, 18 years ago

added boost
  • Property svn:executable set to *
File size: 4.9 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3
4<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
5<head>
6  <title>Updating The Boost Website</title>
7</head>
8
9<body bgcolor="#FFFFFF" text="#000000">
10  <table border="1" bgcolor="#007F7F" cellpadding="2" summary="Quick Links">
11    <tr>
12      <td bgcolor="#FFFFFF"><img src="../boost.png" alt=
13      "boost.png (6897 bytes)" width="277" height="86" /></td>
14
15      <td><a href="../index.htm"><font face="Arial" color=
16      "#FFFFFF"><big>Home</big></font></a></td>
17
18      <td><a href="../libs/libraries.htm"><font face="Arial" color=
19      "#FFFFFF"><big>Libraries</big></font></a></td>
20
21      <td><a href="../people/people.htm"><font face="Arial" color=
22      "#FFFFFF"><big>People</big></font></a></td>
23
24      <td><a href="faq.htm"><font face="Arial" color=
25      "#FFFFFF"><big>FAQ</big></font></a></td>
26
27      <td><a href="index.htm"><font face="Arial" color=
28      "#FFFFFF"><big>More</big></font></a></td>
29    </tr>
30  </table>
31
32  <h1>Making Updates to the Boost Website Content</h1>
33
34  <p>Any boost developer can update the Boost website content between
35  releases.</p>
36
37  <ul>
38    <li>We <em>strongly</em> recommend the use of <a href=
39    "http://tidy.sourceforge.net/">HTML Tidy</a> when editing HTML and XHTML
40    files intented for the website. Using <code>tidy</code> helps in
41    preventing errors in the HTML, in keeping a clear revision history, and
42    in conforming to Web standards to help make the website readable by the
43    majority of people. The Boost web pages currently have a variety of
44    different types of HTML and XHTML content. Each needs to be dealt with
45    differently by <code>tidy</code>. Most pages are regular HTML 3.x/4.x,
46    for these use a <code>tidy</code> invocation of:
47      <pre>
48tidy --tidy-mark no -i -wrap 78 -m <i>some_page.html</i>
49</pre>Other pages are using the more recent XHTML 1.0 and XHTML 1.0 Strict
50standards. Most notably this include the <a href="../index.htm">home
51page</a>. Some additional options are needed to make <code>tidy</code>
52enforce the XHTML standard:
53      <pre>
54tidy --tidy-mark no -i -wrap 78 -m -asxhtml <i>some_page.html</i>
55</pre>That command is also useful if one is converting from HTML to XHTML. To
56have <code>tidy</code> check for the XHTML 1.0 Strict format use:
57      <pre>
58tidy --tidy-mark no -i -wrap 78 -m -asxhtml --doctype strict <i>some_page.html</i>
59</pre>If you have a choice as to what format to use, prefer the XHTML 1.0
60Strict format as that opens the content to the widest audience.
61    </li>
62
63    <li>If the change you are making is intended to be part of a release, you
64    should first make the change in our CVS repository, so it doesn't get
65    lost or overwritten by the next person that updates the page between
66    releases. Of course if you don't check in (say because the change is not
67    supposed to be in the next release), and someone else changes the page
68    after you, the change may be lost. This procedure does not account for
69    that case; you'll have to use your head and figure out what to do.</li>
70
71    <li>You will upload the file(s) by <code>scp</code>'ing to the
72    appropriate subdirectory of
73    <code>shell.sf.net:/home/groups/b/bo/boost/htdocs/</code>. For example,
74    to update the page you are reading, I would issue
75      <pre>
76scp updating_the_website.html david_abrahams@shell.sf.net:/home/groups/b/bo/boost/htdocs/more/
77</pre>
78    </li>
79
80    <li>It is <b>crucial</b> to ensure that you set group write permission on
81    every file you upload. If you don't do that, nobody else will be able to
82    change it, which is particularly deadly at release time. If you are on
83    Unix or Cygwin, you may be able to do that with a <tt>chmod</tt> command
84    before uploading the file. The absolutely failsafe thing to do is to <tt>
85      ssh</tt> into <tt>shell.sf.net</tt> and do the <tt>chmod</tt> there.
86      The files also need to have general read permission, and any
87      directories should have general execute permission and the "set user or
88      group ID on execution" (s) bit should also be set. If you're not
89      touching any directories, you can do it all with one command, e.g.
90      <pre>
91ssh david_abrahams@shell.sf.net "chmod a+r,g+rw /home/groups/b/bo/boost/htdocs/more/updating_the_website.html"
92</pre>
93    </li>
94  </ul>
95  <hr />
96
97  <p>Revised <!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B,
98                            %Y" startspan -->$Date: 2005/07/08 14:46:06 $
99  <!--webbot bot="Timestamp" endspan
100                            i-checksum="38708" --></p>
101
102  <p>&copy; Copyright David Abrahams 2005</p>
103
104  <p>&copy; Copyright Rene Rivera 2005</p>
105
106  <p>Distributed under the Boost Software License, Version 1.0. (See
107  accompanying file <a href="../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or copy
108  at <a href=
109  "http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</p>
110</body>
111</html>
Note: See TracBrowser for help on using the repository browser.