Adding Application Documentation
Adding an Application
In order to add documentation for an NGS UEE application there are a few requirements. The application can be entered into one of more of the existing categories, or a new category can be created for it (see below). Assuming that the category exists, you must create a new page for the application with a url based on the category itself as well as the UEE name for the application. The path must be /applications/category_name/uee-application-name. It would appear that case does not matter, but keeping everthing in lower case is desirable.
After the documentation page for the application is complete, we need to ensure that the application appears in the right category on the "/applications" page. Do this by going to "/applications/category_name" and editing the unordered list near the top of the page to have a link to your new application page. An example line would look like this:
<li><a href="/applications/category_name/uee-application-name">Full Application Name</a></li>
Note that the full name can have spaces etc in it but the category name and the UEE application name shouldn't. If in doubt, have a look at an existing line and base yours off of that.
The main application page refreshes categories and detected applications on a periodic basis. In order to force a refresh once you've made your changes, you can go to /applications?update and see if your added application appears in the correct category. Note that if an application appears in more than one category, there should only be one page for it but there should be multiple links from category pages to multiple aliases (/applications/category1/app-name and /applications/category2/app-name). Aliases can be added for a page from the "Administer" section of Drupal's interface under "Site Building".
Adding a Category
If there isn't a category that fits, you need to create a page at "/applications/category_name". This should contain an unordered list of one or more applications, as described above. Once that is in place editing the /applications page itself should allow you to add an entry to the "$categories" array for your newly added category. Again, this can take a while to propagate through to the page, but can be forced by going to /applications?update
Applications Support
The NGS cannot offer scientific support for applications. However if you require further information or believe there is something wrong with the installation, please contact the NGS support centre.
Acknowledgements
Please note: When publishing work based on use of the NGS, users should acknowledge both the authors of any programs used (see the individual program web sites, or contact the authors directly) and the NGS directly using the following line:
"The authors would like to acknowledge the use of the UK National Grid Service in carrying out this work"
This line must also accompany any use of the NGS logos.
