BGA Website guide

Introduction

This document describes the various aspects of our website, some aspects of how it's constructed and how to create new material for it, including editorial conventions, style guidelines etc. It's intended for people who are maintaining and adding to the general content. Another document is available for those undertaking maintenance of Drupal, templates, monitoring the site and general administrative tasks such as setting up users who can edit the site etc.

The website policies [1] are described in the main Policies document [2].

The pages on this website are maintained by the Webmaster and his team [3].

The web masters would like to take this opportunity to thank those, too many to list, who have already pointed out errors on the website pages, and who have provided new information. These pages would be much sparser and less helpful without their contributions.

About the Website

Host

This web site is hosted by Bytemark [4], on their normal commercial terms. It started in 1998 and was revamped in spring 2008 to operate using Drupal.

Drupal [5] is a free and open source modular framework and content management system (CMS) written in the programming language PHP using MySQL as the database management system. Drupal, like many modern CMSs, makes it easier to create and organise content, allows easy site searching, provides menus and book facilities, an RSS feed and manages site contributors.

Users

People allowed to edit the website will have one or both of the following roles:

Web site contributors
Web site editors

The former can access and edit pages, stories etc., whereas the latter have more comprehensive facilities to administer more of the Drupal system. It is expected that new users will be given the contributor role only.

Note: There are additional levels of administration that the webmasters have.

The user log in page is user [6].

When you complete logging in the navigation menu on the left changes to include an Admin [7] section, if you're authorised to access it, Forums and a Log Out [8] entry at the bottom of the first block. Most people will never need to go to the Admin section unless you are creating some new content, e.g. a new Page or Story.

Whenever you go to a page on the site the top of the page/story, immediately under the header, will have View and Edit buttons (possibly some others for different Drupal features). Click on the Edit button to change the page/story.

If the View and Edit boxes don't appear on the screen when you try and access the britgo.org page you're interested in, then go to the login page and enter your user name and password. You will stay logged in until your browser window closes or you deliberately Log Out.

Style Guide

This section is aimed at contributors to the BGA website. It summarises editorial policy, coding standards and assorted other best practices. It was written for the orginal site and not the new look site from Spring 2008.

However, the section on Composition Tips is new and specifically written for our Drupal environment.

Content is King

The most important thing about this site is the content. Let there be no doubt about that.

So if you have some valuable content, and it is a choice between slapping it up on the site any old how, or trying to obey all of these guidelines and therefore never getting around to it, do the former.

If you want help in making your content meet these guidelines, then by all means ask the webmaster for help.

Most of these guidelines reflect the general consensus for how things should be done in any quality publication. A few of them are, perhaps, coloured by the prejudices of the webmaster. You will just have to live with that.

Editorial Conventions

Most of these are the same as for the British Go Journal [9].

Double quotation marks should be used only to indicate speech.

Use single quotes to indicate textual quotations, unusual terms, names of publications and in any other situation where some form of emphasis is required.

The word Go must have an initial capital. The same applies to the name of any other game.

The words Black and White must be capitalised according to whether the word is used as a noun or an adjective. Thus: “After Black 23, the white group is dead.” Sometimes this can be hard to resolve. If in doubt, refer to a well produced book—such as the Ishida Joseki Dictionary—to see how it should be done.

Japanese terms such as sente or joseki will not normally be emphasised as they are common currency in the Go player’s language. Unusual terms or those being introduced, for example in an article aimed at beginners, should be set within single quotes, for example ‘Katte Yomi’.

When referring to diagrams, the word Figure should be used to refer to a diagram that constitutes part of a game record. The word Diagram should be used in all other cases.

The words Figure and Diagram should always be capitalised.

If letters are used in a Diagram these should be set in uppercase.

Prefer English, for example (note, not ‘e.g.’) ‘that is,’ rather than ‘i.e.’.

Typography

Good typography improves the readability of text.

If you do not yet know typographically correct punctuation and want to learn, there are various [10] tutorials [11] on the web that will help you out.

Once you know what you are trying to achieve - which punctuation characters you should be using - you will need to know how to put them into your HTML code.

The simplest option is to use an editor that understands UTF-8 encoding. Then you can type any Unicode character directly into the document. However, if you can't do that, you will have to type the entity references manually.

With the exception of the two characters ‘&’ and ‘<’, which have to be escaped for reasons of (SG/HT/X)ML syntax, please use numeric character entities.

The table below shows most of the characters that have ever had to used on the BGA site, with their encoding.

Entities for particular characters

Character	Preferred entity reference	Description
&	&	Ampersand.
<	<	Less than.
		Non-breaking space.
£	£	Pound sign.
¥	£	Yen sign.
½	½	Half. For example ‘6½ komi’
×	×	Multiplication sign. For example ‘19×19 go board’
–	–	En-dash. Used for ranges. For example ‘6th May–12th June’
—	—	Em-dash. Used—like this—for parenthetical remarks within a sentence.
‘	‘	Single open quote. Use single quotes to indicate textual quotations, unusual terms, names of publications and in any other situation where some form of emphasis is required.
’	’	Apostrophe/Single close quote. Use single quotes to indicate textual quotations, unusual terms, names of publications and in any other situation where some form of emphasis is required.
“	“	Double open quote. Double quotation marks should be used only to indicate speech.
”	”	Double close quote. Double quotation marks should be used only to indicate speech.
…	…	Ellipsis.
₩	₨	Won sign.
€	€	Euro sign.
_	_	Underscore

The definitive list of character numbers is the Unicode standard [12]. The standard insists on using hexadecimal numbers, whereas the ones above are decimal. It does not really matter whether you use, say, – or –, but so far this site has fairly consistently used decimal entity references, so you might like to continue to do the same.

Composition Tips

The following Drupal Input formats can be used to help you create content:

Filtered HTML:

Web page addresses and e-mail addresses turn into links automatically.

Allowed HTML tags: <a> <em> <strong> <cite> <code> <ul> <ol> <li> <dl> <dt> <dd>

This site allows HTML content. While learning all of HTML may feel intimidating, learning how to use a very small number of the most basic HTML "tags" is very easy. This table provides examples for each tag that is enabled on this site.

For more information see W3C's HTML Specifications [13] or use your favourite search engine to find other sites that explain HTML.

Tag Description	You Type	You Get
Anchors are used to make links to other pages.	`<a href="http://www.britgo.org">British Go Association</a>`	British Go Association [14]
Emphasized	`<em>Emphasized</em>`	Emphasized
Strong	`<strong>Strong</strong>`	Strong
Cited	`<cite>Cited</cite>`	Cited
Coded text used to show programming source code	`<code>Coded</code>`	`Coded`
Unordered list - use the <li> to begin each list item	`<ul> <li>First item</li> <li>Second item</li> </ul>`	First item Second item
Ordered list - use the <li> to begin each list item	`<ol> <li>First item</li> <li>Second item</li> </ol>`	First item Second item
Definition lists are similar to other HTML lists. <dl> begins the definition list, <dt> begins the definition term and <dd> begins the definition description.	`<dl> <dt>First term</dt> <dd>First definition</dd> <dt>Second term</dt> <dd>Second definition</dd> </dl>`	First term First definition Second term Second definition

Most unusual characters can be directly entered without any problems.

If you do encounter problems, try using HTML character entities. A common example looks like & for an ampersand & character. For a full list of entities see HTML's entities [15] page. Some of the available characters include:

Character Description	You Type	You Get
Ampersand	`&`	&
Greater than	`>`	>
Less than	`<`	<
Quotation mark	`"`	"

Lines and paragraphs are automatically recognised. The <br /> line break, <p> paragraph and </p> close paragraph tags are inserted automatically. If paragraphs are not recognised simply add a couple blank lines.
Go board Diagrams

See http://senseis.xmp.net/?HowDiagramsWork [16]

PHP code:
- Using custom PHP code
  
  If you know how to script in PHP, Drupal gives you the power to embed any script you like. It will be executed when the page is viewed and dynamically embedded into the page. This gives you amazing flexibility and power, but of course with that comes danger and insecurity if you do not write good code. If you are not familiar with PHP, SQL or with the site engine, avoid experimenting with PHP because you can corrupt your database or render your site insecure or even unusable! If you do not plan to do fancy stuff with your content then you are probably better off with straight HTML.
  
  Remember that the code within each PHP item must be valid PHP code - including things like correctly terminating statements with a semicolon. It is highly recommended that you develop your code separately using a simple test script on top of a test database before migrating to your production environment.
  
  Notes:
  - You can use global variables, such as configuration parameters, within the scope of your PHP code but remember that global variables which have been given values in your code will retain these values in the engine afterwards.
  - register_globals is now set to off by default. If you need form information you need to get it from the "superglobals" $_POST, $_GET, etc.
  - You can either use the print or return statement to output the actual content for your item.
  A basic example:
  You want to have a box with the title "Welcome" that you use to greet your visitors. The content for this box could be created by going:
```
  print t("Welcome visitor, ... welcome message goes here ...");
```
  If we are however dealing with a registered user, we can customise the message by using:
```
  global $user;
  if ($user->uid) {
    print t("Welcome $user->name, ... welcome message goes here ...");
  }
  else {
    print t("Welcome visitor, ... welcome message goes here ...");
  }
```
  For more in-depth examples, we recommend that you check the existing Drupal code and use it as a starting point, especially for sidebar boxes.
Full HTML:
- Web page addresses and e-mail addresses turn into links automatically.
- Lines and paragraphs are automatically recognised. The <br /> line break, <p> paragraph and </p> close paragraph tags are inserted automatically. If paragraphs are not recognised simply add a couple of blank lines.
- Go board Diagrams
  
  See http://senseis.xmp.net/?HowDiagramsWork [16]
Unfiltered HTML:
Markdown:
- Go board Diagrams
  
  See http://senseis.xmp.net/?HowDiagramsWork [16]
- Quick Tips:
  - Two or more spaces at a line's end = Line break
  - Double returns = Paragraph
  - *Single asterisks* or _single underscores_ = Emphasis
  - **Double** or __double__ = Strong
  - This is [a link](http://the.link.com "The optional title text")
  For complete details on the Markdown syntax, see the Markdown documentation [17].

      <span class="clear"></span>

Styling parts of pages

In general you don't need to use any specific styling for pages as it is all catered for by the general BGA style sheet. This controls how lists, headings etc. are displayed.

Headings

The main heading styles used are H2 and H3, as below:

H2 style - major heading

H3 style - sub heading

Area Style

If you want to style an area of the screen then you can use something like the following:

Multi-column formats

You can use a table such as in http://www.britgo.org/hof/stacey [18], extracted below, although this creates messy HTML:
<table>
<tr><td>
<a href="/files/trophypics/stacey.jpg">
<img src="/files/trophypics/stacey-t.jpg" title="Stacey Trophy" alt="Stacey Trophy"></a></td>
<td>
<h3>Final Points 2009-10</h3> 1. 38 Matthew Macfadyen<br> 2. 34 Yohei Negi<br>
</td>
<td>
<h3>Top Place Getters 1990-2010</h3> 1. Francis Roads<br> 2. Alistair Wall<br> 3. Matthew Macfadyen
</td>
</tr></table>

[19]

Final Points 2009-10

1. 38 Matthew Macfadyen
2. 34 Yohei Negi
3. 22 Sandy Taylor

Top Place Getters 1990-2010

1. Francis Roads
2. Alistair Wall
3. Matthew Macfadyen

Changing <td> to <td valign="top"> in the second and third columns would align the text at the top of the cells.

Note: If you use a table then you'll always get a horizontal line between rows and before/after the table. Also the total widths must be less than 100% to allow for Internet Explorer bugs.

An example of 3 column table format is the BGJ archive page:

<table> <tr>
<td width=40% valign=top>
<p > These pages reproduce a selection of old (see note *below) British Go Journals and articles from them. </p> <br>... </td>
<td valign="top" width=27%> <p align="center"> There is also a list of available <a href="/bgj/bgj_updt.html" > BGJs sorted in order of web updates</a>. </p>
<br>...
</td>
<td valign="top" width=27%> <p align="center">Go to the most recent issues</p> <br>...
</td></tr>
</table>

These pages reproduce a selection of old (see note *below) British Go Journals and articles from them.

...

There is also a list of available BGJs sorted in order of web updates.

...

Go to the most recent issues

...

An alternative using pure CSS bits in a two column format is:

<div style="width: 48%; float: left">
Left hand column
</div>
<div style="width:48%; float:right">
Right hand column
</div>
<div clear=all></div>
<div style="width:100%;float:left">

Right hand column

div style="width:100%;float:left">

See the front page [20] or http://www.britgo.org/hof/trophies.html [21] for an example of this.

However, this doesn't automatically align the various items from side to side as do the table examples above; but the front page shows how to achieve this.

Note: Due to some Drupal issue this must be the last text on the page.

Miscellaneous

Horizontal menu with links

Extract from Forthcoming Tournaments page, note the internal links within the page for key etc.

<p class="navbar">
<a href="#key">Key to the symbols</a> |
<a href="#mobile">The BGA mobile phone</a> |
<a href="#tournorg">To tournament organisers</a> |
<a href="#hostnat">Hosting a national event</a>
</p>
produces

Other BGA styles

<span class="date">Saturday 29th May - Sunday 30th May. Small board rapid on evening of 28th May.</span>
<span class="location>Mason's Hall, Dundee, <a href="http://multimap.co.uk/map/browse.cgi?pc=DD1+1PE&mapsize=big" >DD1 1PE</a>.</span>
<span class="format" >5 round McMahon. 80 minutes without overtime.</span>
<span class="contact" >Contact xxx</span>
<a href="#rating_class" class="rc">A</a>
<a href="#book_shop" class="bk">BOOKS</a>
<a href="/files/Shropshire2012.pdf" class="entry" title="Shrewsbury Go Tournament flyer(PDF)">More Info</a>
produces

Saturday 29th May - Sunday 30th May. Small board rapid on evening of 28th May. Mason's Hall, Dundee, DD1 1PE [22]. 5 round McMahon. 80 minutes without overtime. Contact xxx A BOOKS More Info [23]

Adding content

Drupal, being a CMS, has a number of facilities which enable us to add various kinds of content in ways that don't require extensive knowledge of HTML or even the creation of HTML pages. The guidelines provided here are those that will enable the BGA website to continue in its current format.

It is strongly recommended that these guidelines are used to add content as these not only produce a consistent style of page and website, but also provide facilities, e.g. an RSS feed and the navigation menu, as a by-product.

Note: It is extremely strongly recommended that whenever you're adding or modifying content that you press the Preview button before Submitting your updates. If you do then DON'T hit the back button afterwards to continue editing as you will lose your updates.

Note: When using URLs Drupal does not require that you include an extension, and arguably it's better if we don't use them in future. However, any reference to another page on the site must match exactly the URL that is allocated for the item in question. That is, if an extension is used when the item is created then it must be quoted in the reference. If not, then not.

Note: The PHP script for the News block on the front page shows the latest 5 Story/News items (not pages or other type of entries) that are created on the website.

News, Announcements and Other similar items

These items don't need to be created as separate pages, or even as part of existing pages, and may not need any HTML usage at all, or even assigning a page reference (URL). Using the Drupal Story concept will automatically ensure that each such item will appear as a separate item in the RSS feed. It is assumed that none of these items need to appear in the navigation menu.

In the Administer page go to Create content->Story (or use http://www.britgo.org/node/add/story [24]) and then:

Title
should include the word Tournament or Teaching Event if it is one (this duplicates the News type, but it appears in the RSS feed item)
News Type
Always select the correct one (as this means that you can see all items of the same type together)
Tournament Date
This and the following three fields should not be used except for Tournament Reports and perhaps Diary entries. The To Date should only be entered for a tournament/event over multiple days
Tournament Type
Can be ignored
Venue
Could be omitted, but it's desirable to have at least the town and postcode
Body
Assumes the Input format defaults to Markdown (if not then change it):
- Diary Entries should be entered as (mmm is Month and YY year)
  [Diary Entry added or updated](/tournament/index.html#mmmYY)
- Tournament results should be entered as
  [Results added](/results/year/name.html)
- Other Site Updates should be entered as
  [xxxx added](/page.html)
- Any text can be used for all other News Types, with an internal britgo.org link being entered simply as
  [text](/ref)
All other options should normally be the defaults (URL path settings and Menu settings do not need to be used except in exceptional circumstances).
In the event of doubt the Publishing options should be
Promote to Front Page (creates an RSS entry)
ALWAYS PREVIEW BEFORE SUBMITTING
When you're happy with what it looks like then press SUBMIT

That's it

There's no need to create a URL reference, unless this needs to be referred to from a menu, as Drupal handles all the internal references.
The list of new news items is generated automatically.
If you need to create another kind of link to this item then you can use /node/NNNN as the reference, rather than having to use a .html one.

New Pages

If you're adding a new (static) page to the site, which should happen infrequently now that the vast majority of the site is set up, then you need to consider whether the page should appear in the RSS feed. In general, we wouldn't expect such pages to be in the feed, but if it's a totally new aspect of information then it might be. If so, then look at the News, Announcements section.

Otherwise in the Administer page go to Create content->Page (or use the URL http://www.britgo.org/node/add/page [25]) and then:

Title
If a colon (:) is used in the Title, then any changes won't appear in the Site Updates lists
News Type
Probably irrelevant
Menu settings
link into appropriate place in the menu hierarchy
URL path settings
Only need to be used when this page is to be linked to explicitly from another page. This may not be necessary if it is only used by clicking on the left hand side menu (see below). In any event you could use /node/NNNN as the reference, rather than having to set up a specific path (with possible clashes).
Section 6 provides some guidelines for creating an appropriate URL.
Menu settings
Link into appropriate parent in the menu hierarchy (not to a disabled item)
Note: you may need to change the weight in order for this item to appear in the correct order in the children of this parent. Drupal normally order things in alphabetic order otherwise. You must supply a title that will appear in the menu hierarchy (typically an abbreviation of the page title)

Creating a new URL

The following was written before the usage of URLs (URIs) was much reduced through the use of Drupal's Books, Stories and navigation systems.

The URLs of particular pages are part of the user interface of this web site and should be chosen carefully, if they are needed. Although many users will never manually type a URL, they may see them in the address bar of their web browser, they may copy and paste them into emails to friends, and they may see them in print in articles, for example in the Journal.

URLs should never change. Once a page has been published, it may get bookmarked, linked to from other sites, indexed by search engines, and so on. This means that it is important to get the URL right first time. If in any doubt, please consult with someone else (the webmaster?) for guidance. Having said that, if absolutely necessary, a page can be moved to a different URL, and things can be done to ensure that people trying to visit the old URL get redirected.

Since getting URLs right first time is quite important, the webmaster considered a policy that you must ask every time before creating a new page. However, this was rejected this as unnecessarily draconian. You may still want to ask the webmaster anyway, since he may need to work out where any new page should fit into the site structure, where it should be linked from; and the indexer will need to be informed of the new page's existence. It is not that the webmaster thinks you are likely to make mistakes (at least no more likely than he is), but that correcting a mistake later is painful, and the more pairs of eyes that look at what is proposed before it is set in stone, the more chance there is of any mistakes coming to light when they can be fixed painlessly.

When choosing the URL for a new page, please consider:

People looking at the URL should have a reasonable idea what it points to.
URLs should be as short as possible (URLs longer than one line of a plain text email—about 72 characters—are particularly bad).
Only lower-case letters should be used in URLs. Upper-case letters are perfectly valid, but unusual, and users should not have to think about upper/lower case when they are entering a URL, so keep it all lower-case.
Similarly, avoid all punctuation other than ‘/’ and ‘.’.
When running two words together (don’t, unless you have to) be careful. ‘danpromotion’ is OK. Something like ‘fortypee’ would be ambiguous (forty pee, for type e, OK, you could probably make up a better example yourself), and should be avoided.
The URL should describe the contents of the page identified, and not the technology used to produce it. So avoid URLs like:
- ‘/cgi-big/…’
- ‘/tournaments/index.html’ (Keep the file as /tournaments/index.html on the server, but always refer to it as plain ‘/tournaments/’ in URLs)
- ‘pagename.php’, ‘pagename.shtml’, and so on—the user is not interested in how the page they are viewing was generated. (Even ‘.html’ is arguably bad, however, HTML is the format of the information in the page, not how it was produced, so may convey some useful information. For example you could have pages ‘fred.txt’, ‘fred.html’, ‘fred.pdf’ which present the same information in different formats. And in URLs like ‘image.png’ and ‘image.jpeg’ the information about file format certainly is useful.)
Particular extensions:
- Use ‘.html’, not ‘.htm’
- Use ‘.jpg’, not ‘.jpeg’

Note: Drupal does not require that you include an extension, and arguably it's better if we don't use them in future. However, any reference to another page on the site must match exactly the URL that is allocated for the item in question. That is, if an extension is used when the item is created then is must be quoted in the reference. If not, then not.

All existing pages have their URL recorded on the system with and without .html for ease of access and to preserve existing links. There are additional short-cut URLs that don't have the .html.

Generally the one held on the page is the one without the .html, with the one with the .html declared as an additional alias against the node.

News stories do not have meaningful URLs recorded against them.

Hyperlinks

Linking between pages

The specification (RFC 1808 [26]) is not exactly readable. However, for now you will just have to work from the following examples:

To link from anywhere to the home page, use
href="/".
To link from a page like http://www.britgo.org/tournaments/publicity.html to http://www.britgo.org/tournaments/ use
href=".".
To link from a page like http://www.britgo.org/tournaments/2003/mk.html or http://www.britgo.org/tournaments/2003/ to http://www.britgo.org/tournaments/, use
href="..".
To link from a page like http://www.britgo.org/tournaments/ to http://www.britgo.org/tournaments/publicity.html, use
href="publicity.html"
To link from one part of the site to another, for example, to link from anywhere which is not in the results area, to the results or a particular tournament, use something like
href="/results/2003/mk.html"
(that is, start with a slash to get you to the top level, and work from there).
To link within one part of the site, for example, to link from http://www.britgo.org/results/2003/mk.html to http://www.britgo.org/results/2002/mk.html, use
href="../2002/mk.html"
(that is, work up as few levels as necessary using .., then work down again).

Named anchors within pages

<a name="fred">

<a href="#fred">

<a href="pagename.html#fred">

<a name="fred">

<h2><a name="britc">British Championship</a></h2>

<a name="britc"><h2>British Championship</h2></a>

<h2 id="britc">British Championship</h2>

<a name="britc">

rules for forming names

[27]

name tokens must begin with a letter ([A-Za-z]) and may be followed by any number of letters, digits ([0-9]), hyphens ("-"), underscores ("_"), colons (":"), and periods (".").

Link Text

To find out more about the BGA, click here [20].

There is another page giving the results of British go tournaments [28].

Based on the [29] of 5th May 2004.

The ratings FAQ [30] explains this table, and how to use the information it contains.

[The BGA] also has a selection of promotional material [31] for use by Go clubs and at publicity events.

If you plan to take children to a Go tournament, you should read the BGA policy on working with children and young people [32].

Writing sentences so that there is a sequence of words that can naturally be used as the text of the required link is something of an art. It is not always easy, although it does get easier with practice. Sometimes you have to be prepared to completely reorder the sentence to make it happen. If you are stuck, it often helps to ask another person. I am always happy to be asked about this sort of thing.

Punctuation and links

The rule here is that almost all punctuation goes outside the link. If the link is at the end of the sentence, or before a comma, the full stop, exclamation mark, comma, or whatever, goes outside the link. This applies even if the link forms an entire sentence. If a link is in brackets, then the brackets go outside the link. However, it only a part of link text is bracketed, those brackets go inside the link.

Worked examples

Example A

policies page

[2]

Not so good: (Simon’s comment: Naff repetition.)

3. Working with Children & Young People

See BGA Policy on Working with Children and Young People [32].

Better: (The sentence now at least conveys some other information, the fact that a policy exits as a separate document, as well a repeating the title. That seems unavoidable, since the policy has a good clear name that describes exactly what it is.)

3. Working with Children & Young People

The BGA has a separate Policy on Working with Children and Young People [32].

Example B

The BGA provides facilities for distributing tournament entry forms with the newsletter and hosting them on the BGA web site. These facilities and many other recommendations are described in Publicising Go Tournaments [33].

Better: (Nothing wrong with putting the link at the start of the sentence.)

The BGA provides facilities for distributing tournament entry forms with the newsletter and hosting them on the BGA web site. The page Publicising Go Tournaments [33] explains how this works, alongside other recommendations for tournament organisers.

Example C

The official version of the rules for the British Go Championship, the British Pair Go Championship and the British Youth Championships is the BGA Championships Rules [34] page.

Better:

The BGA Championships Rules [34] page contains the official rules for the British Go Championship, the British Pair Go Championship and the British Youth Championships.

Checking Links

Web sites have an unfortunate habit of changing, which means that links to other people’s web sites that used to work fine have a habit of breaking. Therefore, you should check all the links on the pages you are responsible for periodically.

It would be very boring if you had to go and manually click on all the links yourself. Fortunately, you don’t have to. There are any number of computer programs to automate the process.

The webmaster normally uses the W3C link checker [35]. Go there, type in the URL of the page you want checked, and click on the ‘Check’ button. It is a very thorough checker, so if it finds no problems on your page, you can be happy. However, if it does find some problems, you will discover that it has a bit of an attitude problem! Its error messages are fairly forthright, some might even say rude.

However, if using the checker as above is too much trouble, you can make the process simpler. In your web browser, create a bookmark/favourite called something like ‘Check links’, and with location/address/URL:

javascript:(function(){location.href="http://validator.w3.org/checklink?uri="+escape(location.href)+"&hide_type=all&depth=&check=Check"; return 0;})()

(Don’t worry, you don’t need to understand that. Just copy and paste it into the location/address/URL field of the bookmark). It can be quite difficult to create a bookmark from scratch. The secret is to bookmark a random page, then find that bookmark, open it's properties dialog box, and then edit the various bits.

Once you have set that up, go to any web page you like, then open that bookmark, and you should find that it checks the links of the page you were just looking at. Magic! The webmaster finds this so convenient that he keeps it on his personal toolbar.

Book and Hardware/Software Reviews

These can be added as either Story's or normal Pages (depending on whether or not you want them to appear in the RSS feed), but with the News type of Book Review or Software Review.

In order to ensure they appear in the correct order in the Reviews list you need to enter the date or the review into the Sort field in the form: ccyy-mm.

The start of the review should be in the following format (assuming Markdown input), to ensure consistency and that the correct BGJ is shown in the Review list (note that there is a blank line between the date/picture and the reviewer):

<i>BGJ 154 Winter 2010</i>
<img src="/files/review_winninggo.jpg" class="floatright" width=300>

<i>Reviewer: Glynn Forsythe</i>

In addition a reference should be added to the relevant page about that issue of the BGJ, i.e. /bgj/bgjNNN.html, in the form:

<li>Book Review: <a href="URL (node/NNNN)">TITLE</a></li>

Tournament Results

Tournament results are normally added as new pages with a type of UK Tournament Results or Foreign Tournament Results as appropriate. There will often also be a separate news Story with type of UK Tournament Report or Foreign Tournament Report.

The generation of the results cross-table is an automated process invoked by this page [36].

This will take an email address and a file on your machine, which should be the web file output from the godraw program, e.g. EastMidlands_11.web, convert it and mail back to the email address an email whose body is the converted file.

The page should be created with an appropriate title such as "East Midlands Tournament Results". As well as the type field, enter the Tournament Name field and the Tournament Date in the fomat shown. If it lasts more than one day also enter the End Date.

Paste in the portion of the converted file from the email from below the skeleton date line to the end of the table. You can also add extra paragraphs of information about the event such as location, handicap system used or associated events.

If the event has many rounds you can narrow the width of the Country column by changing its title to "Cy" in order to reduce the width of the table.

Set the url of the page to be eg /results/2011/eastmidlands and later add an additional alias of /results/2011/eastmidlands.html using the Add alias form.

Add the new page to the results index for the year eg /results/2011 (access e.g. via Tournament Results tab, Results for other years, Old format: 2011). The link should be e.g. /results/2011/eastmidlands.html and is normally already there, commented out at the top of the page to allow easy cut and paste, for events that happened the previous year. This list should contain all UK and Ireland events where the results are available.

The winner should be recorded in the Hall of Fame pages: add to the tournament's entry on /hof/past and move the title from the existing holder to the new one in /hof/current (noting entries are sorted by number of titles held).

If it is British Championship event then the /bchamp section will also need updating and possibly also the points tables in the /reps section.

If a youth event or young players have taken part, then the Junior Section may need updating - for a news item, the list of winners, or the Youth Grand Prix Points. Ensure the Junior Section editor is informed.

Documents

When adding a new document that mainly intended to be browsed online, such as this one, the recommended format is as a Book. The BGA Policies is another such an example. Drupal generates a table of contents, browsing within the various pages (back, forward, up and down) and also has a user option to produce a printer-friendly version of the whole document, omitting all the website header/footer etc.

In the Administer page go to Create content->Book Page and then create a page for each section:

Title
It's recommended, but not essential to include a section number (if any) followed by period. (See Weight below)
Parent
All pages except the first page have the first page as their parent (first page = )
News type is probably irrelevant
Body
If you need a sub-section heading then encase it in <h2>...</h2>
Weight
Probably not needed to be used if you use section numbers and there are less than 10 sections as Drupal will automatically sort the other sections into the correct order and create a menu of subsequent pages on the first one.
In other conditions use a number between -15 and 15 to sort pages into the order you want (lower numbers are first).
Note: it may be easier to get it into the correct order by going to the Administer Page->Books and editing the outline screen after all the sections have been entered.
Menu settings
For first page only link into appropriate place in the menu hierarchy if appropriate (not to a disabled item)
URL path settings
Only need to be used when this page is to be linked to explicitly from another page. This is probably necessary only for the first page. In any event you could use /node/NNNN as the reference, rather than having to set up a specific path.
Publishing options
Promoted to front page should be OFF, except for the First Page WHEN you're happy that the whole document is correct and notification of it is to be published via RSS notification.

Our Drupal system is configured so that the Book Navigation Block appears to the right of every book page. It is recommended that when you create the first page of a Book that you configure this block to exclude the first page of the book, as otherwise this will duplicate the automatically generated table of contents at the bottom of the page.

Note: There is a list of all created Books available from the Administration System.

Uploading Files

Files that are only likely to be referenced from a single page can be added at the same time as you enter the page or news item. You do this by using the File Attachment option and selecting the local file for uploading. However, please note that all these images will be loaded into the /file directory, so if the local file name is already in use then Drupal will automatically load the file using a slightly different name. You can reference the image using
<a img src="/files/xxx.extension ...
(see more in section 5) or a document using
<a href="/files/xxx.extension>document name or title</a>

Files that are likely to be used more widely, or that should be part of a more organised folder structure, e.g. the British Go Journal, can be uploaded by FTP. Contact the webmaster for help and advice on this.

In general files should be uploaded in a neutral format and proprietary formats should be avoided. It's also desirable that formats that prevent the inclusion of viruses should also be avoided - this means that we don't recommend the use of Microsoft Office formats (no matter what software produces them).

For photos and other images the recommended format is JPEG - extension jpg
For documents in a printable format this is Adobe's PDF - extension pdf
For editable documents the main suggestion is Rich Text Format - extension rtf, but other formats are also acceptable since this format doesn't necessarily support the desired content/format

The system holds a list of valid file extensions and the maximum file size for upload; these can be changed if need be (the last changeable for each user).

But, in any event if this sounds too prescriptive, remember that our mantra is Content is King, so upload the content even if you break these rules.

Adding Images

Photographs can be used to liven up pages where what they add to the page outweighs the extra download time.

People

Photographs in which individuals are identifiable should only be added to the site after the people pictured have been asked whether this is OK.

We will not normally add identifiable photographs of people under the age of 18 to this site.

File size

Pictures inline in a page should be quite small thumbnails, a reasonable limit would be 10kB for images that are mainly decorative, but often you will be able to get them under 5kB. For pictures that convey significant information, more is fine. They say a picture is worth a thousand words. A thousand words of text in HTML format will average about 7kB!

If it is necessary to show a large image, consider putting a small thumbnail inline, which links to the large image. The British Go Association Picture Gallery [37] is a good example of this.

File format

Photographs, and similar images, should be in JPEG format, with a ‘.jpg’ file extension.

Diagrams, with large areas of solid colour and sharp outlines, should be in PNG format, with a ‘.png’ extension. However, if you can't avoid it, use GIF format.

File names and places

The name of the file should be the surname followed by the first initial (that he/she's known by) and the extension in lower case, e.g. hitchensb.jpg. Thumbnails are probably not needed anymore: Where you have both a high-resolution image, and a corresponding thumbnail image, then the thumbnail image should have the same name as the full-sized image, with ‘-t’ added at the end of the name and before the file extension. For example ‘th.jpg’ and ‘th-t.jpg’ in the picture gallery.

In general pictures of people should be added to the directory /files/people and then referenced from there, as in done of the People involved in running the BGA [38] page. To get a picture added to the gallery, ask the webmaster.

Pictures that go only with a particular page can be added to that page as a file attachment in which case they will be loaded into the /files directory. Only to be used in exceptional circumstances now.

If there are a lot of pictures with the same theme, for instance photos of a particular tournament, then a gallery can be created and the photos added to that with appropriate captions. For instance, see a WMSG gallery [39].

Alternatively photographs that were intimately related to a particular part of the site can be put in a relevant subdirectory within /files using FTP. For example /files/people on the BGA People [38] page.

alt and title text

If you look at the specification for adding images to HTML [40], you will see that all images should have some ‘alt text’. This is text that can be displayed if the image is not used. This might happen for several reasons: the person reading the page may be blind or partially sighted; they may be using a browser that cannot display images; or the may have chosen not to display them. Therefore, the alt text should be an alternative to the image. It should convey the same information. A good rule of thumb is this: imagine that you are dictating the web page to someone else over the telephone. What mention, if any, would you make of the image. That would probably be suitable alt text. For mainly decorative images, you might not think them worth mentioning. In that case, you should specify
alt="". You should also specify the size of the image in the HTML, so the template HTML for an image is:
<img src="..." width="..." height="..." alt="..."> You should also specify some text that is displayed as a tool-tip when the user mouses-over the image. The correct way to do this is to specify a

title="[some more information about the
image]"

attribute on the image. Some people abuse the alt="" attribute for this purpose. This is a serious sin. Do not copy it. It does not work in all web browsers anyway.

Image positioning

Unless you take special precautions all images will be displayed inline with the text, i.e. left aligned as if it were a separate paragraph. The most common alternative for positioning is to make it appear to the right of some text. To do so use the following CSS reference that we've set up for you as part of the <img reference:
class="floatright" Another alternative is to use a table if you have a series of images that need to be displayed vertically in a separate column. See Pictures [37] for an example of this.

Tournament Entry Forms

We don't have a standard entry form available, but you can create your own using this one as a template and cloning it: British Open [41]

Clicking on the Submit button at the bottom will send an email to the address in value in the <input type="hidden" name="recipient" value="?@?.uk" /> line.

You must also change the URL on the <input type="hidden" name="return_link_url" value="/britishopen/form.html" /> line.

You will undoubtedly need to make other changes and don't forget to test it before announcing it publicly!

Editing existing content

You can edit existing content simply, by logging in, going to the page you want to edit and clicking on the Edit link at the top of the page.

This will show you the page in edit mode and you can simply edit the text etc as you need to.

Before you save the page you should ensure that the Revision information is set appropriately. For most pages this should be Create revision is ticked and there's some text to the Log message to indicate why the revision was made. Simple spelling corrections etc do not need a revision and/or a Log message, but please use this feature with care as we can always roll-back a page to a specific revision.

If you click on the Revisions link at the top of the page you can see who/why previous edits were made to the page (and see the differences between them).

If you want to delete the page click on the Delete button at the bottom of the page.

Note: Do not delete a Story as this will affect the RSS feed that has already been generated.

Front Page

If you want to change most of the changeable information on the Front Page in the left and right hand borders, such as BGJ and Council dates, you need to do so differently, using Drupal Blocks. See the Website Management Guide for more information.

The News items, Last Site and Tournament Calendar update dates shown on the Front Page are automatically generated, so are automatically updated.

Clubs Maintenance

If you are a club secretary you can apply for a login so you can follow the instructions below. Without a login you can submit changes for the web team to implement on your behalf.

Adding a New Club

The basic information about Clubs that is used for listing them, and the UK club map, is entered as a new content type, similar to the Page content type, called Club. In the Drupal Admin page, click on Club in the Create Content area. If you don't have access to the Admin page then use the following link: http://www.britgo.org/node/add/club [42]

The only major constraint is that if the Club meets at more than one location, then you will need to enter the club information multiple times, creating a new Club entry for each venue.

Multiple days per week and multiple contacts are handled automatically within a single Club entry.

A typical entry is (note that this is the display format - when you click on the Edit button you'll see it reformatted as a form):

Title: Anytown Wed, 09/02/2011 - 12:09 — JonDiamond Body: Meets weekly. Beginners welcome Meets: Friday 18:15 to about 22:30 Venue: Black and White coffee shop, Stone Street, Anytown Postcode: AT11 1GO Latitude: 55.167432 Longitude: -1.104740 Web site: http://games.groups.yahoo.com/group/anytown-go/ Contact: Andy Capp 01361-361361 Email: anytown-go-club@yahoogroups.com Region: South Active: Active

Title is the club name
You don't need to enter Last Updated, as this is automatically maintained by Drupal
See is not shown above, but is used to make a reference to another club rather than set up a separate club entry. You should set this club up first and then need to add the URL of that here as well as the club title. If an entry is made in this field then the Club will not appear in the Club listing.
The Meets field should alway start with the day of the week to ensure that the map generates the right colour pin
The Venue is the normal address of the place you meet, if there is one. It shows on the club list page
The Postcode field is essential if you have a Venue as it is used for the Google map display of the club location from the Club List page. If you don't have a postcode, such as in Ireland, then enter Longitude,Latitude (e.g. 59.5678,-1.2345)
Latitude and Longitude are used for the Club Map. These should always be entered, even if only approximately - for instance the town centre - when there is no Meeting location, as otherwise the Club will not appear on the map. If your club has two meeting locations on different days then you may wish to change the lat/long of one location, so that two pins appear on the Club Map rather than one be hidden behind the other.
If you want to make your Email addresses sort of non-spamable then enter REMOVE. at the beginning of the host name, i.e. after the @
The Active field is used to control which club entries are displayed in the Club List - it should always be ticked unless it's known that the club is dormant or dead. There's a special list of Inactive Clubs http://www.britgo.org/clubs/inactive [43]

There's no need to create a specific URL for a Club entry - all Active ones will automatically appear in the Clubs List immediately and on the Clubs Map (http://www.britgo.org/clubs/map) [44]

Note: These entries are NOT the same as the individual club websites/pages that we host, such as Oxford and Milton Keynes. These are held totally separately as Pages and edited in the normal way.

Clubs can also ask the BGA to host members' emailing lists on their behalf.

Amending a club entry

Log in to Drupal and then you will normally edit these entries by locating them on the Clubs List (http://www.britgo.org/clubs/list) [45] and clicking on the name, then clicking on the Edit button.

When you've finished making your changes click on the Submit button. (It's probably a good idea to click on Preview to see if it looks OK first.)

Club web pages

If you want more pages than this single one, then you'll need additional permissions if you're going to edit them yourself. Contact the webmaster for help with this.

Other Club Listings

There are some other listings of the Club entries that are useful, mostly for maintenance purposes. Note:If you don't have the correct access level then you may not be able to view them all:

Changes list [46]
Changes list, includes inactive clubs [47]
Club names + email addresses [48]
Email addresses only [49]
Full details list [50]
Inactive clubs [43]
Club List by Region [51]
Listing for use in generating our map [52]
Draft of BGJ listing [53]

People and BGA Organisation

Content types

Three new Drupal Content Types have been created to handle this maintenance activity:

Person
This holds the basic information about a person:

Name, Phone - two possible, Email only shown in edit mode, so the real one must be entered, Address, Photo = the file name used in /files/photos (this needs to be in the format surnameinitial.jpg e.g. diamondj.jpg, Grade - Dan certificate awarded by the BGA, Active - Status must be Active to appear in the standard People's information/picture gallery, Profile

Note: It is most important to upload photos via FTP in the above name format as it's used in sorting People into surname order!. Even if there isn't an actual file the expected file name should still be entered.
Committee
This defines the overall Committee structure. There are two specific ones which are not normally seen, but are used to make the Views structure work: COUNCIL and OTHER which contains the names of those with Honorary positions plus the Auditor.

Title = name, Chairman, Body = Description
Position
Role = Officials title, Committee, Person andJob Description

Adding a person, committee or position

Use the URLs

http://www.britgo.org/node/add/person [54],
http://www.britgo.org/node/add/committee [55] or
http://www.britgo.org/node/add/position [56]

Don't forget if you're adding a new position to make sure that the person already exists first!

Peoples' photos should be added to the directory /files/people using FTP. This can be done before or after adding the person data.

Maintenance

Person: click on the name in the People [57] page and then on Edit.
Committee: click on the Committee name in the Council [58] page and then on Edit.
Position: click on the role in the Official by Committee [59] page and then on Edit.

British Go Journals

When the issue has been printed

Set up an initial template page with a URL like /bgj/bgj157.html and Title British Go Journal 157 and consisting of:

<h2>Autumn 2011</h2>
<p>Editor: Pat Ridley</p>
<h2>Not yet published</h2>
<ul>
<li>PDF not yet available</li>
<!--
<li><a href="/bgj/issue157/">SGF game records</a></li>
-->
</ul>
<hr align="center" width="80%" size="3">
<center>
This is one of a <a mce_href="/bgj/bgj.html" href="/bgj/bgj.html">series</a> 
of back issues now available on the web.
</center>
<hr align="center" width="80%" size="3">

Remove the comment bits when you create the SGF page below

When the necessary game and problem diagram records (sgf files) are available create another page with a URL like /bgj/issue157/index.html and Title BGJ 157 - Autumn 2011

<h2 >Game Records</h2>
<p>Page 8 - 
<a href="/files/157game1.sgf" >Iyama v Lee</a> commentary by David Ward. 
</p>
<h2 >Problem Diagrams</h2>
<p><a href="/files/problemcorner157.sgf" >Diagram for David Ward's Problem Corner</a></p>
<ol >
<li ><a href="/files/157a.sgf" >Diagram for Problem 1</a></li>
</ol>
<H2>Problem Answers</H2>
<p><a href="/files/problemcorner157x.sgf" >Answers for David Ward's Problem Corner</a></p>
<OL>
<LI><a href="/files/157ax.sgf">Answer to Problem 1</A></LI>
</OL>

and add to the bottom:

<hr>
<p ><a href="/bgj/issue156/">BGJ 156</a></p>
<p ><a href="/bgj/recent.html" >Up a level</a></p>

Add an alias /bgj/issue156 to point to the new page node.
Add to the BGJ index page /bgj/bgj.html the line at the end of the entries:
```
<li > <a href="/bgj/bgj157.html">BGJ 157</a> Autumn 2011 </li>
```
You may want to move the mostrecent anchor a bit further down also.
Add to the SGF index page /bgj/recent.html the line at the beginning of the entries:
```
<li ><a href="/bgj/issue157/" >BGJ 157</a> - Autumn 2011.</li>
```
Amend the alias /bgj/current to point to the new page node.
If there are Book or Software Reviews then do what it says on that subsection in the Adding Content section of this document and ensure the relevant references are added into the /bgj/bgj157.html page, e.g.:
```
<li>Book Review: <a href="/node/3409">The Chinese Lake Murders</a></li>
<li>Software Review: <a href="/node/3413">GoGoD Re-Reviewed</a></li>
```

One year after publishing

Using SFTP upload the full PDF which the Editor has produced for the printers to /files/bgj/bgjNNN.pdf You'll need to use SFTP since the file will probably be larger than the limit for attaching of files to pages and attached files only go into /files.
Modify /bgj/bgjNNN.html to replace the Not Available line with
```
<li><a  href="/files/bgj/bgjNNN.pdf">Complete Journal (PDF)</a></li>
```
If this file is more than 10Mb it is recommended that you split the file into two, with the necessary changes to the above.

Website index

The BGA website index is not just a collection of links (often called an ‘index’) to sites other than the BGA's. It is a proper, human-generated index of all the material on the site. Its entries and subentries lead to specific information (no mere passing mentions) within the BGA website. It is maintained by Jochen Fassbender [60], who provided most of the information below.

Non-BGA websites and pages are included as entries/subentries if there is some relevance to British Go (for example, results of a tournament hosted elsewhere, a Go club’s home page, Go topics which are discussed on BGA web pages, and so on).

To keep the index up to date, it is important to inform him of any changes to indexable material. Normally, changes of that magnitude would automatically be included in the http://www.britgo.org/updates [61] page. If they're not, or if you're modifying a Book page that doesn't have a URL, then inform Jochen directly.

Indexable material

The indexer should be informed of all additions, deletions, changes, and updates to:

all articles in general (including major contributions like handbooks, rules, etc. as well as instalments);
reviews (books, software, etc.);
BGA aspects (officers, policies, membership, etc.);
clubs;
results and/or reports of individual tournaments and other events;
BGJ online back issues;
software items and Go servers; and
external links (especially on http://www.britgo.org/links/brits.html [62] and http://www.britgo.org/links/others.html [63]).

The general rule when indexing is that a particular chunk of information has to be significant in order to be indexable. Tiny items, or passing mentions in paragraphs, tables and lists might not get indexed.

Transient information that is not indexed

most announcements and entry forms of individual tournaments and other events (for an overview see http://www.britgo.org/tournaments/ [64]);
current title-holders (for an overview see http://www.britgo.org/hof/current.html [65]);
current ratings of individual players (for an overview see http://www.britgo.org/current.html [66]);
current points of candidate representatives to international events (for an overview see http://www.britgo.org/reps/ [67]); and
recent news items (for an overview see http://www.britgo.org/views/news/ [68]).

BGA Website guide

Introduction

About the Website

Host

Users

Style Guide

Content is King

Editorial Conventions

Typography

Entities for particular characters

Composition Tips

Go board Diagrams

Using custom PHP code

Go board Diagrams

Go board Diagrams

Styling parts of pages

Headings

H2 style - major heading

H3 style - sub heading

Area Style

Multi-column formats

Final Points 2009-10

Top Place Getters 1990-2010

Miscellaneous

Horizontal menu with links

Other BGA styles

Adding content

News, Announcements and Other similar items

New Pages

Creating a new URL

Hyperlinks

Linking between pages

Named anchors within pages

Link Text

Punctuation and links

Worked examples

Example A

3. Working with Children & Young People

3. Working with Children & Young People

Example B

Example C

Checking Links

Book and Hardware/Software Reviews

Tournament Results

Documents

Uploading Files

Adding Images

People

File size

File format

File names and places

alt and title text

Image positioning

Tournament Entry Forms

Editing existing content

Front Page

Clubs Maintenance

Adding a New Club

Amending a club entry

Club web pages

Other Club Listings

People and BGA Organisation

Content types

British Go Journals

When the issue has been printed

One year after publishing

Website index

Indexable material

Transient information that is not indexed