{"id":620,"date":"2013-05-09T11:20:38","date_gmt":"2013-05-09T11:20:38","guid":{"rendered":"http:\/\/ri.itservices.manchester.ac.uk\/csf-apps\/?page_id=620"},"modified":"2018-11-19T12:28:14","modified_gmt":"2018-11-19T12:28:14","slug":"authorhelp","status":"publish","type":"page","link":"https:\/\/ri.itservices.manchester.ac.uk\/csf-apps\/software\/authorhelp\/","title":{"rendered":"Help for Authors"},"content":{"rendered":"

Editing a new Application Page<\/h2>\n

New application pages will be initially created by the RI team. This will include common section headings. <\/p>\n

Logging in to WordPress<\/h3>\n

The csf-apps<\/em> WordPress site is a standalone WP site (even though it looks like part of the entire CSF documentation site). We can give you Author<\/em> rights to this site enabling you to edit WordPress pages<\/em>.<\/p>\n

    \n
  1. Log in to this site by following the log in<\/em> link in the bottom right corner of any page. You will be presented the same page but this time with the editing menus along the top in a dark grey bar.<\/li>\n<\/ol>\n

    Finding and Editing an Application’s Page<\/h3>\n
      \n
    1. If you are currently on the page you wish to edit, simply click on Edit Page<\/em> in the grey bar at the top.\n
    2. Otherwise, navigate to the required apps page using the site’s menus<\/li>\n
    3. In the grey WordPress bar click on “Edit Page”.<\/li>\n
    4. You will now be in the WordPress editor<\/li>\n<\/ol>\n

      Writing HTML<\/h3>\n

      WordPress does not use wiki-style markup. Instead you can use the “Visual” Editor for wysiwyg-style editing or use the “Text” Editor to write the usual HTML tags (look at the top-right of the edit box – there are two little tabs to switch between the different styles of editor). I prefer the “Text” editor so I can see exactly which tags are being used and where. <\/p>\n

      New Application Template Text<\/h4>\n

      Paste the following in to the editor<\/p>\n

      \r\n<h2>Overview<\/h2>\r\n\r\n<a href=\"\">APP<\/a> is a program to\r\n\r\nVersion N.M is installed on the CSF.\r\n\r\n<h2>Restrictions on use<\/h2>\r\n\r\nDetails of the licence, restrictions, links to licence docs etc\r\n\r\n<h2>Set up procedure<\/h2>\r\n\r\nTo access the software you must first load the modulefile:\r\n\r\n<pre>\r\nmodule load apps\/path\/to\/module\/n.m\r\n<\/pre>\r\n\r\n<h2>Running the application<\/h2>\r\n\r\nPlease do not run XXX on the login node. Jobs should be submitted to the compute nodes via batch.\r\n\r\n<h3>Serial batch job submission<\/h3>\r\n\r\nMake sure you have the modulefile loaded then create a batch submission script, for example:\r\n\r\n<pre>\r\n#!\/bin\/bash\r\n#$ -S \/bin\/bash\r\n#$ -cwd             # Job will run from the current directory\r\n#$ -V               # Job will inherit current environment settings\r\n\r\nAPP arg1 arg2 > out.log\r\n<\/pre>\r\n\r\nSubmit the jobscript using: \r\n\r\n<pre>qsub <em>scriptname<\/em><\/pre>\r\n\r\nwhere <em>scriptname<\/em> is the name of your jobscript.\r\n\r\n<h3>Parallel batch job submission<\/h3>\r\n\r\nGiven an example parallel jobscript, including suitable PE\r\n\r\n<h2>Further info<\/h2>\r\n\r\n<ul>\r\n  <li><a href=\"\">APP website<\/a><\/li>\r\n<\/ul>\r\n\r\n<h2>Updates<\/h2>\r\n\r\nNone.\r\n\r\n<\/pre>\n
      HTML hints<\/h4>\n
      However, there are some rules to simplify things:<\/p>\n
      Links – we automatically add an icon to external links. There are two styles:<\/p>\n
        \n
      1. Icons on external links\n