TELEMAC-MASCARET Forum: FYI - Sync'ing Reference Manual, Example Data and Source Code (1/1)

Welcome, Guest

TOPIC: FYI - Sync'ing Reference Manual, Example Data and Source Code

FYI - Sync'ing Reference Manual, Example Data and Source Code 3 months 6 days ago #45405

a.barton
OFFLINE
Moderator
Posts: 683
Thank you received: 178

A little FYI... I am working on improving Blue Kenue's Reference Manual in a few specific ways.

For those that don't know, a number of years ago the manual was migrated to LaTeX by a co-op student that we had and the manual is now under strict version control. Therefore, the manual's LaTeX files can be easily searched using CLI tools. This means, among other things, I can now automatically do all of the following:

check that all File Keywords (e.g. :AttributeName) that are in the manual are also used in the source code
check that all File Keywords that are in the manual are also used within at least one example data set. Note that the example data set contents are also fully displayed within the manual and are available for download.
check that all glossary entries are defined and used at least once in the main body of at least one LaTeX file. i.e. that all glossary entries are used and that all uses are defined.
check that all deprecated file keywords are not used in any example data files

I've already found and fixed a few things in the manual because of these new checks. More to come in the future...

Kindly... Alan

The administrator has disabled public write access.

The following user(s) said Thank You: Renault