expo/expoweb
1
0
Fork 0
mirror of https://expo.survex.com/repositories/expoweb/.git/ synced 2024-11-21 23:01:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Better info on downloading website changes

Browse Source
This commit is contained in:
expo 2014-07-18 03:27:28 +01:00
parent dda4444e94
commit ebee3c5390
1 changed files with 27 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
handbook/update.htm
View File

@ -112,13 +112,14 @@ the files from the server to local expoimages directory:</p>
<h3><a id="editingthewebsite">Editing the website</a></h3>
<p>To edit the website, you need a mercurial client. If you are using Windows, [1] is highly recommended. Lots of tools for Linux and mac exist too [2], both GUI and command-line:</p>
<p>To edit the website fully, you need a mercurial client. Some (static text) pages can be edited directly on-line using the 'edit this page link' which you'll see if you are logged into troggle. DYnamically-generated pages can not be edited in this way.</p>
<p>For Ubuntu dummies and GUI lovers, from Debian 6 or Ubuntu 11.04
onwards you can just install mercurial and tortoisehg from synaptic,
then restart nautilus (<tt>nautilus -q</tt>). If it works, you'll be able to see the menus of Tortoise within your Nautilus windows. </p>
<p>Mercurial can be used from the command line, but if you prefer a GUI, tourtoisehg is highly recommended on all OSes (available on Linux from Debian 6 and Ubuntu 11.04 onwards).</p>
<p>Once you've downloaded and installed a client, the first step is to create what is called a checkout of the website or section of the website which you want to work on. This creates a copy on your machine which you can edit to your heart's content. The command to initially check out ('clone') the entire expo website is:</p>
<p>Linux: Install mercurial and tortoisehg-nautilus from synaptic,
then restart nautilus <tt>nautilus -q</tt>. If it works, you'll be able to see the menus of Tortoise within your Nautilus windows. </p>
<p>Once you've downloaded and installed a client, the first step is to create what is called a checkout of the website. This creates a copy on your machine which you can edit to your heart's content. The command to initially check out ('clone') the entire expo website is:</p>
<p><tt>hg clone ssh://expo@expo.survex.com/expoweb</tt></p>
@ -146,7 +147,7 @@ then restart nautilus (<tt>nautilus -q</tt>). If it works, you'll be able to see
<p><tt>hg merge</tt></p>
<p>None of your changes will take effect, however, until the server checks out your changes and runs the expoweb-update script.</p>
<p>Simple changes to static files will take effect immediately, but changes to dynamically-generated files (cave descriptions, QM lists etc) will not take effect, until the server runs the expoweb-update script.</p>
<h3><a id="mercurialinwindows">Using Mercurial/TortoiseHg in Windows</a></h3>
@ -156,14 +157,16 @@ then restart nautilus (<tt>nautilus -q</tt>). If it works, you'll be able to see
<p><tt>ssh://expo@expo.survex.com/expoweb</tt></p>
<p>or similar for the other repositories. In the Destination box type whatever destination you want your local copies to live in. Hit Clone, and it should hopefully prompt you for the usual beery password. (to be continued) --Zucca 14:25, 25 January 2012 (UTC)</p>
<p>or similar for the other repositories. In the Destination box type whatever destination you want your local copies to live in. Hit Clone, and it should hopefully prompt you for the usual beery password.
<p>The first time you do this it will probably not work as it does not recognise the server. Fix this by running putty, and connecting to the server 'expo@expo.survex.com' (on port 22). Confirm that this is the right server. If you succeed in getting a shell prompt then ssh connection are working and tortoisehg should be able to clone the repo, and send changes back.</p>
<h3><a id="expowebupdate">The expoweb-update script</a></h3>
<p>The script at the heart of the website update mechanism is a makefile that runs the various generation scripts. It (along with an update from the repository) is run every 15 minutes as a cron job (at 0,15,30 and 45 past the hour), but if you want to force an update more quickly you can run it here: [Wooknote - this is</p>
<p>The script at the heart of the website update mechanism is a makefile that runs the various generation scripts. It is run every 15 minutes as a cron job (at 0,15,30 and 45 past the hour), but if you want to force an update more quickly you can run it he</p>
<p>The scripts are generally under the 'noinfo' section of the site just because that has some access control. This will get changed to something more sensible at some point</p>
<p>The scripts are generally under the 'noinfo' section of the site just because that has (had) some access control. This will get changed to something more sensible at some point</p>
<h3><a id="cavepages">Updating cave pages</a></h3>
@ -193,10 +196,12 @@ superseded in 2012).</p>
<p>Logbooks are typed up and put under the years/nnnn/ directory as 'logbook.html'.</p>
<p>Do whatever you like to try and represent the logbook in html. The only rigid structure is the markup to allow troggle to parse the files into 'trips':</p>
<pre>
&lt;div class="tripdate" id="t2007-07-12B"&gt;2007-07-12&lt;/div&gt;
&lt;div class="trippeople"&gt;&lt;u&gt;Jenny Black&lt;/u&gt;, Olly Betts&lt;/div&gt;
&lt;div class="triptitle"&gt;Top Camp - Setting up 76 bivi&lt;/div&gt;
&lt;div class="timeug"&gt;T/U 10 mins&lt;/div&gt;
</pre>
<p>Note that the ID's must be unique, so are generated from 't' plus the trip date plus a,b,c etc when there is more than one trip on a day.</p>
<hr>
@ -206,11 +211,13 @@ superseded in 2012).</p>
<p>So the format should be:</p>
<p><tt>===2009-07-21|204 - Rigging entrance series| Becka Lawson, Emma Wilson, Jess Stirrups, Tony Rooke===</tt></p>
<pre>
===2009-07-21|204 - Rigging entrance series| Becka Lawson, Emma Wilson, Jess Stirrups, Tony Rooke===
<p>&lt;Text of logbook entry&gt;</p>
&lt;Text of logbook entry&gt;
<p>T/U: Jess 1 hr, Emma 0.5 hr</p>
T/U: Jess 1 hr, Emma 0.5 hr
</pre>
<hr>
<h3><a id="tickingoff">Ticking off QMs</a></h3>
@ -220,7 +227,7 @@ superseded in 2012).</p>
<h3><a id="surveystatus">Maintaining the survey status table</a></h3>
<p>At [3] there is a table which has a list of all the surveys and whether or not they have been drawn up, and some other info.</p>
<p>There is a table in the survey book which has a list of all the surveys and whether or not they have been drawn up, and some other info.</p>
<p>This is generated by the script tablizebyname-csv.pl from the input file Surveys.csv</p>
@ -234,8 +241,7 @@ superseded in 2012).</p>
<p>After expo 2009 the VCS was updated to hg, because a DVCS makes a great deal of sense for expo (where it goes offline for a month or two and nearly all the year's edits happen).</p>
<p>The site was moved to Julian Todd's seagrass server, but the change
from 32-bit to 64-bit machines broke the website autogeneration code,
<p>The site was moved to Julian Todd's seagrass server (in 2010), but the change from a 32-bit to 64-bit machine broke the website autogeneration code,
which was only fixed in early 2011, allowing the move to complete. The
data has been split into 3 separate repositories: the website,
troggle, the survey data, the tunnel data. Seagrass was turned off at
@ -245,6 +251,8 @@ university since Feb 2014.</p>
<h3 id="automation">Automation on cucc.survex.com/expo</h3>
<p>Ths section is entirely out of date (June 2014), and awaiting deletion or removal</p>.
<p>The way things normally work, python or perl scripts turn CSV input into HTML for the website. Note that:</p>
<p>The CSV files are actually tab-separated, not comma-separated despite the extension.</p>
<p>The scripts can be very picky and editing the CSVs with microsoft excel has broken them in the past- not sure if this is still the case.</p>
@ -256,35 +264,21 @@ Script location Input file Output file Purpose
</br>/svn/trunk/surveys/tablize-csv.pl /svn/trunk/surveys/tablizebyname-csv.pl
/svn/trunk/surveys/Surveys.csv
http://cucc.survex.com/expo/surveys/surveytable.html http://cucc.survex.com/expo/surveys/surtabnam.html
http://expo.survex.com/expo/surveys/surveytable.html http://expo.survex.com/surveys/surtabnam.html
Survey status page: "wall of shame" to keep track of who still needs to draw which surveys
Prospecting guide
<p>Mercurial is a distributed revision control system. On expo this means that many people can edit and merge their changes with each other either when they can access the internet. Mercurial is inefficient for scanned survey notes, which are large files that do not get modified, so they are kept as a plain directory of files.</p>
<p>Mercurial is a distributed revision control system. On expo this means that many people can edit and merge their changes with each other either when they can access the internet. Mercurial is over the top for scanned survey notes, which do not get modified, so they are kept as a plain directory of files.</p>
<p>If you run windows, you are recommended to install <a href="http://bitbucket.org/tortoisehg/stable/wiki/Home">Tortoise Hg</a>, which nicely interfaces with windows explorer.</p>
<h2>Get the repositories</h2>
<h3>Mercurial</h3>
<h4>Linux</h4>
<p>hg clone RepositoryURL</p>
<h4>Windows</h4>
<p>Install<a href="http://bitbucket.org/tortoisehg/stable/wiki/Home">Tortoise Hg</a>. In windows explorer right click, select Tortoise Hg .. and click Clone repository. <br />Set the source path to RepositoryURL <br />Set the destination to somewhere on your local harddisk. <br />Press clone.</p>
<h3>RSync</h3>
<h4>Linux</h4>
<tt>rsync -av expoimages expo@expo.survex.com:</tt>
<h4>Windows</h4>
<p>Not sure yet</p>
<h2>The website conventions bit</h2>
<p>This is likely to change with structural change to the site, with style changes which we expect to implement and with the method by which the info is actually stored and served up.</p>
<p>... and it's not written yet, either :-)</p>
<ul>
<li>Structure</li>
<li>Info for each cave &ndash; automatically generated by <tt>make-indxal4.pl</tt></li>
<li>Contents lists &amp; relative links for multi-article publications like journals. Complicated by expo articles being in a separate hierarchy.</li>
<li>Contents lists &amp; relative links for multi-article publications like journals. Complicated by expo articles being in a separate hierarchy from journals.</li>
<li>Translations</li>
<li>Other people's work - the noinfo hierarchy.</li>
<li>Style guide for writing cave descriptions: correct use of boldface (<em>once</em> for each passage name, at the primary definition thereof; other uses of the name should be links to this, and certainly should not be bold.) </li>