Skip to content

Commit ca23f66

Browse files
committed
Propose and describe a new structure for the repo.
1 parent 9fc7f9d commit ca23f66

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

README.md

+53
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,56 @@ Upon the first discussion, this would be something like:
1212
* National name
1313

1414
More details on the related wiki page: [Catalogue of INT Charts](http://wiki.openseamap.org/wiki/OpenSeaMap-dev:Catalogue_of_INT_Charts)
15+
16+
# IHO Publication S-11 and structure
17+
18+
Many (all?) of the above details can be found as PDF documents provided by the
19+
IHO as [PUB S-11](http://www.iho.int/iho_pubs/standard/S-11/S-11.htm) in *Part
20+
B*. The structure of this repository therefore reflects the one currently given
21+
by the IHO.
22+
23+
## Structure of `IHO_PUB_S-11`
24+
25+
This is the top-level directory containing all the chart information. Its
26+
contents are described in the file `0_INDEX.csv` that corresponds to the table
27+
on the IHO website. It therefore contains exactly three columns:
28+
29+
* `File` - the region name (e.g. *Region F*).
30+
* Each entry reflects the name of a sub-directory that is located within
31+
the top-level directory. Those will be referred to as the "*Region
32+
directories*" below.
33+
* `Area` - the region's description (e.g. *Mediterranean & Black Seas*).
34+
* `Comment` - the last update (e.g. *Edition 2.0.4 - December 2012*).
35+
36+
## Structure of *Region* directories
37+
38+
Each directory is required to have a `0_INDEX.csv` file of its own. They have
39+
exactly two columns:
40+
* The index number:
41+
* An internal number assigned by the OpenSeaMap project that corresponds to
42+
the sequence of sections listed in the different Region PDF files.
43+
* The number corresponds to a file of the same name (appended by the suffix
44+
`.csv`), further down referred to as the "*Section*" files.
45+
* The section name:
46+
* The (english!) name of the section as given in the PDF. Examples:
47+
* *FROM COASTS OF THE CHANNEL AND OF THE NORTH SEA TO ICELAND*
48+
* *WESTERN ENGLISH CHANNEL*
49+
* This is purely descriptive (a "human readable name") and not reflected in
50+
any file or directory name.
51+
52+
## Structure of *Section* files
53+
54+
The *Section* CSV files directly correspond to the tables in the various
55+
*Region* PDF files. They contain 11 columns with the content as follows:
56+
57+
* INT No.
58+
* Prod.
59+
* National No.
60+
* Title
61+
* Southern limit
62+
* Northern limit
63+
* Western limit
64+
* Eastern limit
65+
* Date
66+
* Scale
67+
* Lat

0 commit comments

Comments
 (0)