Difference between revisions of "Dictionary Edit Procedures"

From International Dictionary of Marine Aids to Navigation
Jump to navigation Jump to search
(Approving new (and existing) terms)
(Dictionary Procedures)
Line 26: Line 26:
 
== Dictionary Procedures ==
 
== Dictionary Procedures ==
  
There is a need for a procedure for approving both new and existing terms in the dictionary.
+
==1 BACKGROUND==
 +
For many years a paper version of the Dictionary was maintained by editors such as Peter Kent.
 +
The original 1970-89 IALA Dictionary Edition, was digitised through a semi-automated OCR process in February 2009. New terms were added or revised in 2009 – 2011 in March 2009 and further terms or revisions were added in October 2012.
 +
 +
It was noted at that time that there was a need to check the quality of the digitising process. Therefore there was a plan for Dictionary Editors to work their way through the digitised part of the Dictionary, marking each term appropriately  and terms which need further editing to be added to Category 'Needs Editing'. Little progress was made with this. No updating of the terms in the Dictionary occurred between 2012 and 2016. There was very limited awareness or use of the Dictionary in the Committees and therefore there was a risk of terms being redefined in IALA documents without reference to the Dictionary and of new terms not being added.
  
At PAP19 this procedure for approving dictionary terms was discussed (Was discussed and changed during PAP22).
+
The ENG Committee Task 5.3.3 (work period 2014-2018) requested the ENG Committee to develop the IALA Dictionary to keep the Dictionary maintained and updated. At a meeting during ENG3 it was proposed that a Dictionary Working Group (DWG) be set up as a working group of the PAP for this purpose. The DWG was formed in December 2015 with the inaugural meeting on 15 December 2015.
 +
==2 DICTIONARY REQUIREMENTS==
 +
===2.1 Purpose===
 +
The International Dictionary of Marine Aids to Navigation (Dictionary) provides a definitive definition of terms used in IALA documents and a list of acronyms commonly used in IALA.
 +
===2.2 Usage===
 +
The Dictionary is a valuable resource available to all. It is available without restriction on the internet.
 +
===2.3 Scope===
 +
The Dictionary will include definitions of terms and acronyms as deemed appropriate by the DWG.
 +
===2.4 Shared terms===
 +
There are many terms used commonly in IALA documents that originate from other organisations. If these are replicated in the IALA Dictionary, there is a risk that updates by the “parent” organisation will not be updated in the IALA Dictionary. Such definitions should be provided as links via the IALA Dictionary rather than replicating the definition.
 +
===2.5 Languages of the IALA Dictionary===
 +
IALA policy is that IALA documentation should be provided in the three major languages English, French and Spanish. This will be applied to the Dictionary also.
 +
==3 Dictionary Working Group (DWG) TERMS OF REFERENCE==
 +
===3.1 Purpose===
 +
The Dictionary Working Group (DWG) has the responsibility to:
 +
*Maintain the Dictionary of Marine Aids to Navigation (Dictionary) in good order to ensure that the terms are up to date and accurate;
 +
*Approve the addition, amendment or removal of Dictionary terms  and acronyms following scrutiny for accuracy;
 +
*Promote the use of the Dictionary in IALA Committees and IALA Membership and in IALA documentation;
 +
*Delete obsolete or non-relevant entries;
 +
*Review the entries over time to provide an on-going update.
 +
===3.2 Authority===
 +
The Dictionary Working Group reports to the Policy Advisory Panel (PAP) and takes its authority from the PAP.
 +
While striving for consensus, decisions will be by majority of the DWG members.
 +
===3.3 Membership===
 +
The membership of the DWG is the Chairs and Vice Chairs of the VTS, ARM, ENAV and ENG Technical Committees, Committee Secretaries, Technical Operations Manager. The IALA Technical Operations Manager will chair the DWG.
 +
===3.4 Secretarial support===
 +
Support with administration will be provided by the Secretariat Technical Operations Manager and the ENG Committee Secretary.
 +
Editing of the Dictionary will be carried out by the IALA Secretariat.
 +
===3.5 Meetings===
 +
The DWG is expected to meet twice per year after each round of Committee meetings. Meetings will be convened by the Technical Operations Manager.
 +
 +
The work of the DWG will be overseen by the PAP.
 +
.
 +
==4 DICTIONARY AMENDMENT PROCEDURE==
 +
The following procedure for developing, maintaining and promoting the IALA Dictionary will be used:
 +
*The Dictionary will be managed by an IALA Dictionary Working Group (DWG) of the PAP.
 +
*Proposals for updating or adding Dictionary term definitions and acronyms will be submitted using a template form which will be an input paper to all Committee meetings;
 +
*The proposal for addition or amendment will be assessed and approved by the DWG;
 +
*The Secretariat will maintain a list of proposed and approved changes/ additions;
 +
*The IALA Dictionary Working Group (DWG) will meet at half year intervals by GoToMeeting after each round of Committee meetings to review / approve Dictionary changes;
 +
*The IALA Secretariat Web Master will do actual edits of Dictionary.
 +
==5 TEMPLATE FOR DICTIONARY AMENDMENT PROPOSAL==
 +
The Dictionary Amendment Proposal Form will be used to propose any addition, amendment or removal of a term or acronym in the Dictionary.
 +
The Dictionary Amendment Proposal Form will be provided to all Committee meetings as a template.
 +
==6 DICTIONARY AMENDMENT REGISTER==
 +
The Dictionary Amendment Register will be used to maintain a record of additions, amendments or removals in the Dictionary.
 +
==7 DICTIONARY TERMS NUMBERING SYSTEM==
 +
A numbering system will be retained in the Dictionary to facilitate multiple language versions of definitions.
 +
A sequential five digit numbering system will be implemented for all terms in the Dictionary and the old numbers will be retained for reference. Numbering format will be
 +
New number, example 10030
 +
Old number, example (previously 2-2-190)
  
This topic needs to be discussed further
 
 
[[File:20091027 IALA Dictionary Procedure.jpg|600px]]
 
  
  
 
[[Category:Other Pages]]
 
[[Category:Other Pages]]

Revision as of 13:12, 20 January 2016

From the PAP22 report we have:

Progress has been made in the drafting of an input paper (Paper PAP22/7/1), for which grateful thanks were expressed to Marie-Hèléne Grillet. The document was reviewed and minor changes made to the Table at paragraph 3.2.

A discussion then followed about roles, which included IALAs information management process. It was agreed that, ideally, the task of maintaining the dictionary should move away from the Committees to a dictionary editor and might be combined with the role of IT manager, when funding permits and depending on the skill sets of the person involved.

This led to the suggestion that the aim should be to first locate an editor and an assistant editor; the latter could be someone recently retired.

It was agreed that definitions should continue to be allocated to the relevant Committee, for review / verification. It was also emphasised that the Committees should be diligent in using existing definitions and that where an error is detected it should be corrected, rather than a new definition being invented.

In considering terms not used within IALA documents, it was noted that many of the existing definitions come from non-IALA sources. Where the source is known, however, it was accepted that the resources are not available to verify their continuing validity.

It was agreed that if an editor can be identified and funded, then the Dictionary group should meet with him / her to decide how to proceed.


Original 1970-1989 IALA Dictionary Edition - Quality Control[edit]

The original 1970-89 IALA Dictionary Edition, was digitized through a semi-automated OCR process. There is a need to check the quality of the digitizing process. Therefore Dictionary Editors are working their way through the this part of the Dictionary, marking each term appropriately as follows:

  • Terms which need further editing are added to Category 'Needs Editing'

Dictionary Procedures[edit]

1 BACKGROUND[edit]

For many years a paper version of the Dictionary was maintained by editors such as Peter Kent. The original 1970-89 IALA Dictionary Edition, was digitised through a semi-automated OCR process in February 2009. New terms were added or revised in 2009 – 2011 in March 2009 and further terms or revisions were added in October 2012.

It was noted at that time that there was a need to check the quality of the digitising process. Therefore there was a plan for Dictionary Editors to work their way through the digitised part of the Dictionary, marking each term appropriately and terms which need further editing to be added to Category 'Needs Editing'. Little progress was made with this. No updating of the terms in the Dictionary occurred between 2012 and 2016. There was very limited awareness or use of the Dictionary in the Committees and therefore there was a risk of terms being redefined in IALA documents without reference to the Dictionary and of new terms not being added.

The ENG Committee Task 5.3.3 (work period 2014-2018) requested the ENG Committee to develop the IALA Dictionary to keep the Dictionary maintained and updated. At a meeting during ENG3 it was proposed that a Dictionary Working Group (DWG) be set up as a working group of the PAP for this purpose. The DWG was formed in December 2015 with the inaugural meeting on 15 December 2015.

2 DICTIONARY REQUIREMENTS[edit]

2.1 Purpose[edit]

The International Dictionary of Marine Aids to Navigation (Dictionary) provides a definitive definition of terms used in IALA documents and a list of acronyms commonly used in IALA.

2.2 Usage[edit]

The Dictionary is a valuable resource available to all. It is available without restriction on the internet.

2.3 Scope[edit]

The Dictionary will include definitions of terms and acronyms as deemed appropriate by the DWG.

2.4 Shared terms[edit]

There are many terms used commonly in IALA documents that originate from other organisations. If these are replicated in the IALA Dictionary, there is a risk that updates by the “parent” organisation will not be updated in the IALA Dictionary. Such definitions should be provided as links via the IALA Dictionary rather than replicating the definition.

2.5 Languages of the IALA Dictionary[edit]

IALA policy is that IALA documentation should be provided in the three major languages English, French and Spanish. This will be applied to the Dictionary also.

3 Dictionary Working Group (DWG) TERMS OF REFERENCE[edit]

3.1 Purpose[edit]

The Dictionary Working Group (DWG) has the responsibility to:

  • Maintain the Dictionary of Marine Aids to Navigation (Dictionary) in good order to ensure that the terms are up to date and accurate;
  • Approve the addition, amendment or removal of Dictionary terms and acronyms following scrutiny for accuracy;
  • Promote the use of the Dictionary in IALA Committees and IALA Membership and in IALA documentation;
  • Delete obsolete or non-relevant entries;
  • Review the entries over time to provide an on-going update.

3.2 Authority[edit]

The Dictionary Working Group reports to the Policy Advisory Panel (PAP) and takes its authority from the PAP. While striving for consensus, decisions will be by majority of the DWG members.

3.3 Membership[edit]

The membership of the DWG is the Chairs and Vice Chairs of the VTS, ARM, ENAV and ENG Technical Committees, Committee Secretaries, Technical Operations Manager. The IALA Technical Operations Manager will chair the DWG.

3.4 Secretarial support[edit]

Support with administration will be provided by the Secretariat Technical Operations Manager and the ENG Committee Secretary. Editing of the Dictionary will be carried out by the IALA Secretariat.

3.5 Meetings[edit]

The DWG is expected to meet twice per year after each round of Committee meetings. Meetings will be convened by the Technical Operations Manager.

The work of the DWG will be overseen by the PAP. .

4 DICTIONARY AMENDMENT PROCEDURE[edit]

The following procedure for developing, maintaining and promoting the IALA Dictionary will be used:

  • The Dictionary will be managed by an IALA Dictionary Working Group (DWG) of the PAP.
  • Proposals for updating or adding Dictionary term definitions and acronyms will be submitted using a template form which will be an input paper to all Committee meetings;
  • The proposal for addition or amendment will be assessed and approved by the DWG;
  • The Secretariat will maintain a list of proposed and approved changes/ additions;
  • The IALA Dictionary Working Group (DWG) will meet at half year intervals by GoToMeeting after each round of Committee meetings to review / approve Dictionary changes;
  • The IALA Secretariat Web Master will do actual edits of Dictionary.

5 TEMPLATE FOR DICTIONARY AMENDMENT PROPOSAL[edit]

The Dictionary Amendment Proposal Form will be used to propose any addition, amendment or removal of a term or acronym in the Dictionary. The Dictionary Amendment Proposal Form will be provided to all Committee meetings as a template.

6 DICTIONARY AMENDMENT REGISTER[edit]

The Dictionary Amendment Register will be used to maintain a record of additions, amendments or removals in the Dictionary.

7 DICTIONARY TERMS NUMBERING SYSTEM[edit]

A numbering system will be retained in the Dictionary to facilitate multiple language versions of definitions. A sequential five digit numbering system will be implemented for all terms in the Dictionary and the old numbers will be retained for reference. Numbering format will be New number, example 10030 Old number, example (previously 2-2-190)

International Association of Marine Aids to Navigation and Lighthouse Authorities - AISM

second

Information Technology

Number of cells

Aids to Navigation Engineering and Sustainability Committee (IALA)

Dictionary Working Group (IALA)

nertia of the water plane

Vessel Traffic Services

Aids to Navigation Requirements and Management Committee (IALA)

e-Navigation Committee (IALA)