GENUKI Maintainers' Pages
Managing Your Folders And Files
As a maintainer, it is recommended that you hold a copy of your GENUKI files locally on your personal computer or on a server local to you. This applies particularly to county and parish folders and files, and will provide a means to check all pages for readability and link integrity before you upload them to the server on which they will reside for public use.
To allow such checks to be realistic you will need a skeleton copy of the folders and files which provide the context within which they operate publicly. In what follows, the terms folder and directory are interchangeable.
The web page structure of folders and files used on GENUKI is based on a four/five-level hierarchy corresponding to locality. The first (top) level corresponds to the British Isles as a whole. The second level consists of England, Ireland, Scotland, Wales, the Channel Islands and the Isle of Man. The third level corresponds to counties, equivalently the separate islands comprising the Channel Islands. The fourth level corresponds to towns and parishes within such counties. Those parishes within a larger town or city, form a fifth level of the hierarchy.
Folder and file names
Although not all servers are sensitive to the case of folder and file names, you should assume that all, like genuki.org.uk, are. The MS Windows system is not sensitive to the case of folder and file names and you might find that something which works on your local Windows system doesn't work when uploaded - similar problems can occur with the Apple Mac. So, when creating folders and files on your personal computer or local server, always use the correct naming convention.
In addition, MS Windows systems contain a legacy from the days of DOS (Disk Operating System) in that folder and file names may not consist of the reserved DOS device names CON, PRN, AUX, NUL, COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8, COM9, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, and LPT9. Note: this means that the Chapman Code for Cornwall (CON) cannot be used as a folder name on a Windows system and the alternatives of CWL or Cornwall should be used instead. It is also recommended that the reserved DOS device names should not be used as a file name followed immediately by an extension; for example, NUL.txt is not recommended.
Relative references in a URL
Many advantages accrue if GENUKI web page maintainers use only relative references in URLs wherever possible. A relative reference is one that defines the location of the resource being sought relative to the location of the page containing the URL. In a relative reference, use is made of the dot symbol (.) to represent folders above and below the level in the folder structure in which the URL resides.
The symbols are:
- "../" which represents the folder immediately above the current folder, i.e., its parent folder.
- "./" which represents the current folder, and can therefore be used in the form "./daughter" to refer to a daughter folder.
Relative referencing can be applied iteratively:
- "../../../" represents the folder 3 levels above the current folder.
Care is needed when using this form of referencing to avoid inadvertent use of the reference to root. If you omit the dot symbols (.) and start the reference with a slash, it is interpreted as a folder in the root. Hence,
- "../images/" refers to a folder called images found as a daughter of the folder immediately above the current folder, and,
- "/images/" refers to a folder called images found in the root of the current folder hierarchy.
A skeleton structure
Most counties already have a folder structure and at least a set of rudimentary parish pages. Maintainers taking over a county will therefore not have to create such a structure, and can continue to develop the county structure which exists already.
This section is intended to provide documentation which defines the standard folder structure, acts as a reference for maintainers, and supports new maintainers who are taking over a county without an adequate folder structure. It might also prove useful for a maintainer taking over a county and having to move existing pages to a different folder structure on another local computer or server.
At the first (top) level, equivalent to the genuki.org.uk website home page, you should create a directory or folder to act as a placeholder for the lower level folders and files. You can name this folder whatever is meaningful to you (it will not exist outside your own computer). In the examples to follow it is named Genuki_Home.
Subordinate to Genuki_Home, create folders called big, css and images (all lower case names). Subordinate to big, create a folder corresponding to the country in which your county resides, i.e., England, Ireland, Scotland, Wales, the Channel Islands and the Isle of Man. The folders for each are named eng, irl, sct, wal, chi, and iom (all lower case). In the examples to follow it is named xxx. Subordinate to xxx, create a folder with the name of your county, using the 3-character, upper case, Chapman county code. In the examples to follow it is named CCC.
Subordinate to CCC, create folders with the names of the towns and parishes in your county. The folder name should be the town or parish name in full, omitting spaces and with the first character of each word capitalized. Thus the folder for Ruyton-in-the-Eleven-Towns (in Shropshire) should be named RuytonInTheElevenTowns. In the examples to follow it is named pppppp.
If parishes exist within larger towns or cities, create subordinate folders within the relevant town or city folder, again using the same naming convention as above. In the examples to follow such parishes are named qqqqqq.
Each file should be placed in the folder at the lowest level in the hierarchy relevant to its information content.
The primary web page for each county or town or parish is named "index.html" or "index.shtml".
There will be such a file at the county level of the structure, to hold information relevant to the county as a whole. It's full name will be Genuki_Home/big/xxx/CCC/index.html.
There will be such a file at the town or parish level of the structure, to hold information relevant to the town or parish. It's full name will be Genuki_Home/big/xxx/CCC/pppppp/index.html.
If a town or city has subordinate parishes, there will be a file at the final, fifth, level of the structure, to hold information relevant to the parish. It's full name will be Genuki_Home/big/xxx/CCC/pppppp/qqqqqq/index.html.
Other files referred to from "index.html" at either county or town or parish level can be named as you see fit, but must be stored at the level of the hierarchy relevant to the information contained.
Gazetter and church database files
If you decide to update entries in the gazetteer or church database, you will also need the files CCCplaces.csv and CCCchurches.csv respectively. See the pages on updating gazetteer entries and updating the church database for details of these files.
If you hold a copy of your county and parish folders and files locally on your personal computer or on a server local to you, it is recommended that you create a folder, using any name meaningful to you, to hold your XXXplaces.csv and XXXchurches.csv files. This folder should be at the parish or town level in the hierarchy and therefore directly subordinate to the county folder.
Changes to gazetteer or church database entries will only be activated after the XXXplaces.csv and XXXchurches.csv files are uploaded to the location specified by the system administrator for the county. See the pages on updating gazetteer entries and updating the church database for how this process works.
There are a number of graphic images available for your use, and already used by the skeleton pages to reflect the mandatory technical standards. These images are stored in the folder named images subordinate to Genuki_Home (see above). You can download a copy of these images for storage in your skeleton GENUKI structure, in order that your pre-upload checks are more realistic. A relative URL should be used to refer to the images. Depending on the location of the referring page in the structure, the URL for the "info" image would be "../../images/info.gif" or "../../../images/info.gif" (or possibly more iterations depending on the depth of the folder relationship).
There are a number of styles available for your use, and already used by the skeleton pages to reflect the mandatory technical standards. These styles are stored in cascading style sheets in the folder named css subordinate to Genuki_Home (see above). You can download a copy of these styles for storage in your skeleton GENUKI structure, in order that your pre-upload checks are more realistic. A relative URL should be used to refer to the styles. Depending on the location of the referring page in the structure, the URL for the "genuki.css" stylesheet would be "../../css/genuki.css" or "../../../css/genuki.css" (see "Images" above).