This section shows you how to create a manual and add sub sections to it. When creating a Manual you first need to create a Top Level ‘header’ section and then add new sub sections to it. Once you create the top level header you can then add content.
To create a new manual, go to ‘Manuals, Forms & Checklists’ – ‘Manage Manuals and Profiles’
Creating the Top Level Header
Click the ‘New Manual’ button at the top of the page.
On this page you will need to enter:
- Title – The title of the manual
- Category – The manuals category, such as safety management or crew management. The category you select here determines where the Manual will be located in the sub account ‘Manuals’ menu. So If you select Safety Management, the vessel user will go to ‘Manuals’ – ‘Safety Management’ to find the Manual. To see how create new caegories, please click here.
- Display Order – The order of the manual in relation to the other manuals
- Node Type – Header. If this is anything else, change it to Header
- Accounts – Which accounts this manual applies to
For the time being, ignore the header and footer fields on this page. Once all the details have been entered click ‘Submit and Check In’. This will create the Top level header and return you to the main page.
Once you have created this top level header we would strongly recommend you create a new/updated alert against it. Do this click the ‘View details’ icon for the top level Manual you have just created.
Go to the ‘Master New/Updated Alert’ tab and click ‘Create New/Updated Alert’. You can then set the alert as described here.
Once you have created the top level header you can then add content to the manual. To add a sub section to the manual click the ‘Add Child Node’ icon next to the manual.
You will then be able to enter the title and display order in the same way as the top level header. You also have the following fields:
Node Type – For the node type you have the following options:
- Content – You can upload a word document with the actual content of the manual. If you select this you will then be able upload a .docx file
- Header – You can add a header, such as a Chapter title page, which will not have any content.
- Form – This will contain a link to create a new e-form directly from the manual. If you select this you will be able to select the form template to insert
- Link – This will insert a URL hyperlink into the manual to direct the user to an external website. If you select this you will be able enter the URL.
Please note: Once you have checked in a manual section you will not be able to amend the node type again.
Accounts – By default this is set to ‘inherit from parent’ which means it will automatically be available to the accounts you selected in the top level section. This is useful as you will not need to amend each section of the manual if you want to amend the accounts this manual applies to. You can also change this so that only certain accounts can a particular section.
Once you have entered all the information you then have the following buttons:
Submit and Check In – Clicking this button will save the section and also send out any alerts you have set up
Submit and Preview – This will save the section as a draft, not send out an alert, and also let you preview how the section will look. You will then be able to return and make changes.
Submit – This will save the section as a draft but keep it checked out and in the possession of the editor. This means that no alerts are generated.
Undo and Check Out – This will not save the section and revert back to the previous version. Please note: if this is the first version and you are creating it for the first time this will delete the entire section.
Pro Tip: Before you enter any content you should create the structure of the Manual. As an example You create the top level header, add some sub header as Chapter titles and then you can add content under each Chapter. Your manual will then end up looking like this:
You will note that in the above picture we added multiple levels to the manual. This is easy to do by clicking the ‘Add Child Node’ to any section that you have submitted into the system. As an example, we added ‘1.2 Definitions’ by clicking the ‘Add Child Node’ button next to ‘Chapter 1 – Introduction’.