Post on 17-Jul-2020
COMPETITIVENESS AND INNOVATION FRAMEWORK PROGRAMME
ICT Pol i cy Support Programme ( ICT PSP)
Multilingual Web Objective 5.3: Multilingual Web content management: methods,
tools and processes
CIP‐ICT PSP‐2009‐3 Grant agreement for: PILOT TYPE B
Project Acronym: MORMED Project Full Title: Multilingual Organic Information Management in the
Medical Domain Grant agreement no.: 250534
MORMED Platform User Documentation
Deliverable D 3.3
D3.3 – Platform User Documentation
MORMED Consortium page 2
WORK PACKAGE: 3
LEADING PARTNER: LTC SECURITY CLASSIFICATION: PU
DATE 2012‐03‐27 VERSION 1.2
Document History Version Date Modification Reason Modified By
0.0 2011‐03‐17 Document Structure Phil McConnell, Nadia Portera‐Zanotti (LTC)
0.1 2011‐07‐05 Structure & begin 1st draft Phil McConnell (LTC)
0.2 2011‐08‐10 Chapter 4 & 5 Haider Al‐Saadi (LTC)
0.3 2011‐08‐19 Add content Haider Al‐Saadi (LTC)
0.4 2011‐08‐31 Add content Laura Canedo, Phil McConnell (LTC)
0.5 2011‐09‐05 Added section about User System Requirements. Added content in section about search.Rephrased some parts.
Konstantinos Bratanis, Dimitris Bibikas (SEERC)
0.6 2011‐09‐08 Restructure, add/change screenshots, add content in Groups section
Laura Canedo, Phil McConnell Haider Al‐Saadi (LTC)
0.7 2011‐09‐21 Rephrased content in the introduction Konstantinos Bratanis, Dimitris Bibikas (SEERC)
0.8 2011‐09‐22 Restructure and add content to automatic translation section, minor corrections
Konstantinos Bratanis (SEERC), Haider Al‐Saadi (LTC)
0.9 2011‐09‐26 Added content to the executive summary, corrected various layout issues, added Annex 1
Konstantinos Bratanis, Dimitris Bibikas (SEERC)
Laura Canedo (LTC)
1.0 2012‐03‐16 Update sections according to the new MORMED interface
Kabilan Ganesh, Kis Hajnalka (LTC)
D3.3 – Platform User Documentation
MORMED Consortium page 3
1.1 2012‐03‐23 Added screenshots of the new MORMED interface
Kabilan Ganesh, Kis Hajnalka (LTC)
1.2 2012‐03‐27 Minor editing and an explanation of the new tagging functionality
Konstantinos Bratanis, Dimitris Bibikas (SEERC)
D3.3 – Platform User Documentation
MORMED Consortium page 4
Table of Contents
1 INTRODUCTION ...................................................................................................................... 7
1.1 AIMS AND FEATURES OF MORMED .......................................................................................... 7 1.2 INTRODUCTION TO THE MORMED PLATFORM ............................................................................. 7
2 USER SYSTEM REQUIREMENTS ............................................................................................ 9
3 ROLES & USER ACCOUNTS ................................................................................................. 10
4 USER REGISTRATION AND LOGGING ON ............................................................................ 12
4.1 LOGGING ON ...................................................................................................................... 13
5 MY ACCOUNT .................................................................................................................... 14
5.1 ACCOUNT SETTINGS ............................................................................................................. 15 5.2 ‘NOTIFICATIONS’ TAB ...................................................................................................... 16 5.3 SAVING CHANGES ................................................................................................................ 16
6 CREATING CONTENT .......................................................................................................... 17
6.1 BLOG ENTRY ....................................................................................................................... 17 6.2 FORUM TOPIC ..................................................................................................................... 20 6.3 GROUP ............................................................................................................................. 21 6.4 WIKI PAGE ......................................................................................................................... 24
7 FINDING AND EDITING CONTENT ...................................................................................... 26
7.1 SEARCHING FOR CONTENT ...................................................................................................... 26 7.2 EDITING CONTENT ................................................................................................................ 27 7.3 TAG RECOMMENDATIONS ...................................................................................................... 28
8 COMMENTS ...................................................................................................................... 30
8.1 ENTERING A NEW COMMENT .................................................................................................. 30
9 AUTOMATIC TRANSLATION ............................................................................................... 31
D3.3 – Platform User Documentation
MORMED Consortium page 5
9.1 EDITING TRANSLATED CONTENT ............................................................................................... 31 9.2 TRANSLATING COMMENTS ..................................................................................................... 32
10 LOGGING OUT ................................................................................................................. 33
11 SUMMARY ...................................................................................................................... 34
12 APPENDIX A: LINGUISTIC GUIDELINES FOR THE MORMED PLATFORM ............................. 35
D3.3 – Platform User Documentation
MORMED Consortium page 6
Executive Summary
The document is a user manual that comprises instructions for interacting with the MORMED Platform. The document contains detailed documentation, enriched with lists of terms, screenshots, and step‐by‐step guides for the MORMED Platform. This manual assumes the reader has basic knowledge of using web browsers and social networking sites.
The manual describes the minimum and recommended software and hardware requirements for the user’s system. The manual introduces the user to the front‐end layout of the platform, in order to provide an initial understanding of the user interface. The role‐based authorisation system is described, together with the account management features, providing information to the user for creating and managing his account in the platform.
The user manual continues by describing the features associated with the content creation and management. It provides step‐by‐step instructions for creating blogs posts, wiki pages, and managing groups and the content of the groups. The interaction with the content feedback systems, such as comments and rating, is described. Moreover, the manual comprises instructions for searching semantically related content across the four supported languages of the platform. Also, the automated translation features are described.
A user of the MORMED Platform can refer to this document in order to get guidelines related to the use of the various features offered by the MORMED Platform. It is important to remember that the content management system that MORMED is based on is constantly evolving, so some of the steps described in this manual are likely to change. This user guide will be posted on the MORMED platform and constantly updated accordingly.
D3.3 – Platform User Documentation
MORMED Consortium page 7
1 Introduction
This guide describes how to get started using the MORMED platform and covers topics such as registering for an account, logging in, changing account settings, creating and accessing content on the MORMED platform (http://mormed.ltcinnovates.com).
MORMED has been configured to allow users to contribute and edit content or administer various aspects of the site, depending on the user roles defined to them by the site administrators. Very little technical knowledge is assumed, the basic process involves these steps:
• registering with MORMED • logging in by entering the user name and password • creating and searching content such as forums and wikis
This deliverable will explain these steps and familiarise the reader with the basic information needed to use MORMED successfully.
1.1 Aims and features of MORMED
The MORMED project attempts to address the challenge of bringing together people with a wealth of knowledge to share, and willingness to participate, particularly those interested in topics where information is very scarce, such as rare diseases, by developing a multilingual social networking and content management platform. MORMED will be piloted in the community interested in Lupus or Antiphospholipid Syndrome, involving researchers, medical doctors, general practitioners, patients and support groups.
1.2 Introduction to the MORMED platform
The MORMED Platform is a web‐based system, which can be accessed using a web browser. The user interface of the platform reminds of an advanced web site; however, it comprises much more advanced features including social networking apps.
A pilot instance of the MORMED platform has been deployed at http://mormed.ltcinnovates.com. This instance is dedicated for the community interested in rare diseases, and therefore the content is relevant to this specific domain.
The figure bellow illustrates the main page of the MORMED Platform, known as the ‘Dashboard’. The layout of the platform comprises five different sections. In the main region of the page, four boxes are present. On the top left is a short introduction to MORMED platform, to the right of that displays the groups users have joined and below that are two boxes showing recent activity on the platform and recent comments only in the groups a user belongs to.
D3.3 – Platform User Documentation
MORMED Consortium page 8
The following subsections outline the main elements of the user interface of the MORMED Platform, in order to provide a brief explanation of the layout and establish a basic understanding of how to interact with the platform.
Figure 1: The main page of the MORMED Platform (the dashboard)
1.2.1 Menus
The main navigation menu of the MORMED platform appears on the top region. From this menu a user can access the functionalities of the platform. The “Dashboard” menu leads the user to the main page of the platform. The “Groups” menu displays all available interactive platforms for collaboration and the “Members” shows other active users of the site.
D3.3 – Platform User Documentation
MORMED Consortium page 9
2 User System Requirements
An instance of the MORMED Platform can be accessed using a web browser. There are some software and hardware requirements for accessing the MORMED Platform, in order to guarantee a good user experience. Below you will find two tables, which summarise the minimum and recommended requirements for accessing the MORMED Platform. Hardware Requirements CPU 800Mhz RAM Memory 512MB Monitor 15” Internet Connection Dial‐up 56kbpsSoftware RequirementsOperating System Windows XP and later / Linux 2.6.x based distribution and later Browser Internet Explorer 7.x and later / Firefox 2.x and later with JavaScript
enabled Table 1: The minimum system requirements for accessing the MORMED Platform
Hardware Requirements CPU 1.5Ghz RAM Memory 1GB Monitor 17” Internet Connection ADSL 1mbpsSoftware RequirementsOperating System Windows 7 / Ubuntu / Fedora / OpenSUSEBrowser Firefox 6
Table 2: The recommended system requirements for accessing the MORMED Platform
We provide two sets of system requirements. The minimum requirements indicate the minimum possible software and hardware compatibility for being possible to access the platform. However, we strongly suggest following the recommended system requirements, which indicate the necessary software and hardware for a good user experience in the MORMED Platform.
D3.3 – Platform User Documentation
MORMED Consortium page 10
3 Roles & User Accounts
The MORMED Platform implements a role‐based authorisation system, which comprises roles assigned with a set of permissions, i.e. actions that a user is able to perform or access to platform features. There is a one‐to‐many relationship between a user and roles, i.e. a user can have multiple roles and the set of actions that he/she can perform is the sum of permissions the user is inheriting from his/her roles. Below we briefly present the set of roles available in the MORMED Platform.
Figure 2: The role management functionality
As can be seen in the above screenshot, ‘anonymous user’ and ‘authenticated user’ are provided with the default installation of Open Atrium. The other roles were added to the MORMED platform and can be modified by an administrator.
• Anonymous user: this role is given for users that don't have a user account or that are not authenticated (this option is disabled in MORMED; all users have to be authenticated).
• Authenticated user: this role is automatically granted to all logged in users. An authenticated user can view content in the members’ area, post blogs and create other types of content.
• Admin user: has the highest level of privilege. Administrators can add/edit/delete all content, and can manage components like menus and user accounts. An administrator has complete access to all the site functions and Drupal components, which are accessible through the site administration menu.
D3.3 – Platform User Documentation
MORMED Consortium page 11
• Localisation manager: can submit translations to localisation server, use on‐page translation, administer languages and translate interfaces.
• Moderator user: can delete other users’ content or prevent it from appearing on the site.
• Translation manager: can control the ICanLocalize module and can manage translation jobs.
• Translator: can only translate required translation jobs.
D3.3 – Platform User Documentation
MORMED Consortium page 12
4 User Registration and Logging on
The MORMED Platform fully supports extensive authentication and user management features. Anyone can easily register for an account on the MORMED Platform by clicking the ‘Create new account’ link on the homepage of the platform (http://mormed.ltcinnovates.com). However, it should be noted that after submitting a request to register, an administrator will have to review and approve the registration request, in order to grant access to the MORMED Platform.
Figure 3: The login screen
To register for an account on MORMED, visitors will have to click ‘Create new account’ in the MORMED home page. They will be redirected to a new page (see below screenshot) where they have to enter a username of their choice and their email address, select the groups they want to join and click the ’CREATE NEW ACCOUNT’ button. The site administrators will then have to approve the account and, if approved, will then e‐mail the new user their username and password. Unless otherwise stated, users will have ‘authenticated user’ roles.
Figure 4: The new account screen
D3.3 – Platform User Documentation
MORMED Consortium page 13
4.1 Logging on
Before users can add or edit content, they need to log in by entering their user name and password on the login page and click ‘LOG IN’. If the login is successful, a new page will load showing the user’s profile.
Figure 5: The user profile screen
4.1.1 Forgotten passwords
On the login page there is a ‘Request new password’ link underneath the login button. By clicking on it and entering the username or e‐mail address, the system will send the user a new temporary password by e‐mail along with a web link to change it. This web link will only be valid for 24 hours from sending the e‐mail and will expire afterwards. If only a username is entered, the password will be sent to the e‐mail address that the system has associated with that username.
D3.3 – Platform User Documentation
MORMED Consortium page 14
5 My Account
Registered users have the option of changing their account settings to control information about themselves and also their use and experience of the MORMED site. The account settings can be accessed by clicking the username button in the top navigation block and clicking on ‘Account Settings’:
Figure 6: The user account settings selection menu
This will take the user to the account settings page:
Figure 7: The user account screen
D3.3 – Platform User Documentation
MORMED Consortium page 15
5.1 Account Settings
Once a user has clicked on “Account Settings”, they will see the below options.
5.1.1 Account information
The users’ passwords will have been set by the site administrators, so it is recommended that users change their passwords to something that they can easily remember. To change a password, simply enter a new password in the field and confirm it.
5.1.2 Language settings
All users’ account settings are set to English to be the default language. This option allows the user to change his/her default language to any of the supported languages.
5.1.3 Messaging and Notifications settings
The user has the option of being notified either by ‘E‐mail’ or ‘Web’.
5.1.4 Locale settings
Changing a user’s time zone will cause all dated content on the site to be displayed in the user’s local time, according to the offset entered here.
D3.3 – Platform User Documentation
MORMED Consortium page 16
5.2 ‘NOTIFICATIONS’ Tab
The options listed under the ‘NOTIFICATIONS’ tab allow users to be notified about specific occurrences. The below screenshot shows this tab, the table below lists the tabs under the menu and their description.
Figure 8: The notifications management screen
5.3 Saving changes
If any changes were made the user will have to click the ‘SAVE’ button at the bottom of the page for the changes to take effect.
D3.3 – Platform User Documentation
MORMED Consortium page 17
6 Creating Content
Logged in users have the ability to start posting new content onto MORMED by clicking on the ‘CREATE CONTENT’ tab at the top. A list of allowable content types is displayed, which is reflected depending on the privileges assigned to the individual user’s account. The nature of Open Atrium dictates that users can only create content within the group functionality. After navigating to a group (in this case ‘Patients’), users will be able to create content as per the below screenshot:
Figure 9: The content creation selections
The creatable content types are:
• Blog entry • Forum topic • Wiki page
The following sections explain how to create each of these types of content.
6.1 Blog entry
A blog entry is a single post to an online journal or blog. Each user account is provided a blog, somewhat like a diary in which they can post to MORMED.
D3.3 – Platform User Documentation
MORMED Consortium page 18
6.1.1 How to create a blog entry
Users can create a new blog entry by clicking on ‘CREATE CONTENT’ — ‘Blog entry’, the following page will appear:
Figure 10: The blog post screen
• Title: enter the title for the blog.
• ‘Body’ field: Enter the text of the blog. Note that it allows formatting and can be used similarly to other typical text editors, like Microsoft Word. If the user prefers entering a
D3.3 – Platform User Documentation
MORMED Consortium page 19
plain‐text entry, this can be done by clicking the ‘Disable rich‐text’ link underneath the text box.
• Input format: Content for web sites is based on HTML (Hypertext Mark‐up Language). When, for example, copying text from other applications (such as MS Word or Internet Explorer) into the ‘Body’ field of a wiki, the HTML produced may cause some irregularities with the created page. As a result, MORMED provides input format options:
o Filtered HTML: This option filters out some of the tags which may make a website unreadable.
o Messaging plain text: This option filters out all tags, leaving the text in plain format.
o Wiki syntax:1 Also known as Wiki text language, or wiki mark‐up, is a lightweight mark‐up language used to write pages in wiki websites, such as Wikipedia, and is a simplified alternative/intermediate to HTML. Its ultimate purpose is to be converted by wiki software into HTML, which in turn is served to web browsers2.
o It is advised to use the ‘Filtered HTML’ option. The Input Formats are also configurable to add/remove HTML tags that will be filtered by Drupal.
• File attachments: users can choose to upload a file as an attachment to the blog entry by clicking on ‘File attachments’, selecting the file to be uploaded, then clicking ‘ATTACH’. The maximum file size allowed is 8MB and only files with the following extensions are accepted: jpg, jpeg, gif, png, txt, doc, xls, pdf, ppt, pps, odt, ods, odp.
Figure 11: Attaching files to a blog post
• ‘SAVE’ and ‘PREVIEW’ buttons o The user can preview the newly created entry by clicking the ‘PREVIEW’ button.
The user will still be able to edit the entry. o Once saved, the new blog will be published in the group. In case one or more
required fields were not filled in as is required by the system, the ‘Create Blog entry’ page will reappear listing the errors inside a red box in addition to asterisks on the fields with the missing information. The user will have to correct these errors before they can save the entry.
1 http://en.wikipedia.org/wiki/Wikitext
D3.3 – Platform User Documentation
MORMED Consortium page 20
6.2 Forum topic
‘CREATE CONTENT’ — ‘Forum topic’
A forum topic is the initial post to a new discussion thread within a forum. Within Open Atrium, the groups are the forums. Users can therefore create forum topic within groups for discussion
New forum topics can be created by clicking on ‘CREATE CONTENT’ — ‘Forum topic’. The subject of the forum topic needs to be entered in the ‘Subject’ field.
Once the text of the forum topic is entered in the ‘Body’ field it can be saved or previewed. Similarly to creating a blog, the author has the option of choosing the input format, audience and attaching documents.
Figure 12: Creating a new forum
D3.3 – Platform User Documentation
MORMED Consortium page 21
6.3 Group
‘GROUPS ICON’ – ‘Add Group’
Groups enable users to create and manage their own 'groups'. At Present, only ‘Trusted Users’ can create groups in order to prevent the site appearing cluttered. Each group can have subscribers, and can maintain a group home page where subscribers communicate amongst themselves by posting the usual content types: blogs, forum topics and wikis.
Groups may be selective or not, or even invitation‐only. Selective groups require approval in order for users to become members. Content posted within a group will not be visible to users who are not members of that group (except for site administrators).
6.3.1 How to create groups
Click on ‘GROUPS ICON’ — ‘Add Group’
• ‘Title’ field: Enter a name for the new group to be created. • Mission statement: In the ‘Mission statement’ text box some descriptive text about the
group can be entered. • Input format: same as Blogs and Forum topics outlined previously • Language: leave as Language neutral unless you want to specify all content within this
group to a certain language. • Membership requests:
o Open – any user has the option of adding him/herself to the group. o Moderated – users can request to be added to the group, but will have to be
approved by a group administrator. o Invite only – the group administrator can invite users (the user would have to
accept the invitation to be included in the group). o Closed – only a group administrator can add/delete users to the group.
• List in groups directory: if checked, the group will be included in the groups list. If the
group was set to ‘private’ this option will be disabled. • Group language: The group administrator (or creator) can specify a language for the
interfaces, controls and e‐mails. Alternatively, it can be set as language neutral, in which case the interface will be displayed in the individual group member’s default language.
D3.3 – Platform User Documentation
MORMED Consortium page 22
• Private group: If checked, the group will only be visible to its members. This option will be disabled if the group was set to ‘List in Directory’ or ‘Membership request’ was set to ‘Open’
After saving the newly created group, the group will appear in the ‘My Groups’ section of the dashboard.
6.3.2 Editing groups and adding members
Once the group is created, the group name will be listed in the ‘My Groups’ section of the user’s dashboard as well as in the ‘Groups Directory’.
Figure 13: The directory of groups
D3.3 – Platform User Documentation
MORMED Consortium page 23
Clicking on one of the groups will take the user to that group’s ‘Dashboard’ listing the content that has been posted specifically to that group. The group options allow the user to create content within the group, see a list of its members, and the option of opting out of this group by clicking ‘Membership’.
6.3.2.i Adding members
The group manager can add members to the group by clicking on ‘members’, which will take them to the following page:
Figure 14: The users’ directory
It lists the members of the group and also allows the group creator to change the privileges of chosen group members to group administrator by clicking the ‘Admin: Create’ link, or removing them from the group by clicking ‘Remove membership’.
• ‘Add Existing Users’ block: allows the group manager to add members manually to his/her group by entering their usernames into the field and clicking ‘Add to Group’. The field is auto‐populated if the user exists within the MORMED platform.
Figure 15: Adding users to a group
D3.3 – Platform User Documentation
MORMED Consortium page 24
6.3.2.i i Approving members
If the group was set to appear in the new user’s registration form, users will be able to request to join this group. These requests will have to be decided by the group creator or group manager. Depending on the group manager’s notification settings, these requests will either be e‐mailed to the group administrator’s e‐mail address or appear in the notifications list (if ‘Web’ was chosen).
The below example shows a request from the user test_researcher to join the ‘Specialists’ group, the request was e‐mailed to the group manager, administrator:
Subject: Membership request for 'Specialists' from 'test_researcher'
Greetings, administrator. To instantly approve this request, visit http://mormed.ltcinnovates.com/en/og/approve/167/9. You may deny this request or manage members at http://mormed.ltcinnovates.com/en/og/users/167.
Personal message from test_researcher: ------------------
I would like to join the group please.
-- This is an automatic message from Mormed Consortium Site To manage your subscriptions, browse to http://mormed.ltcinnovates.com/en/user/1/notifications
Figure 16: Approving users
6.4 Wiki page
‘CREATE CONTENT’ — ‘Wiki page’
A wiki is a page that allows the creation and editing of a number of interlinked pages and enables users to write documents collaboratively. A wiki is essentially a database for creating, browsing, and searching through information and allows for non‐linear, evolving, complex and networked text, argument and interaction. Wikis can be displayed on individual pages, like a 'Page', but can also be displayed as a tabled list of story titles (like a Book) sorted by topic or date.
To create a wiki:
1. Click on ‘CREATE CONTENT’ — ‘Wiki page’. 2. You will now be taken to the ‘Create Wiki’ page where you can start writing your new
wiki:
3. Like when creating a blog, begin by giving the new item a title.
D3.3 – Platform User Documentation
MORMED Consortium page 25
4. Enter the content of the wiki into the Body field. 5. Choose the Input format.
Figure 17: Creating a Wiki article
The following options are unique to wikis:
6. Book Outline: When creating a wiki you have the choice of including it in a ‘Book’, which will make the wiki appear under a specific Book title, which in turn can be made up of a collection of wikis. This can be done by choosing an existing book from the drop‐down list or creating a new book altogether, in which case this wiki will be the top‐level page in this new book. Otherwise, choose ‘<none>’. If a book was chosen, a Weight can be assigned to it as well.
7. Revision Information: Wikis make collaborative editing possible, where different users can work on the same wiki remotely. Previous versions of the wiki are stored, and in the ‘Revision information’ field, the user can enter some information about the latest addition/changes done to the wiki.
D3.3 – Platform User Documentation
MORMED Consortium page 26
7 Finding and Editing Content
Logged in users are able to navigate to any page in their menus and view articles within their given privileges and groups.
7.1 Searching for content
The MORMED Platform implements sophisticated searching functionality, which allows for searching content created in different languages, as well as discovering content that has been tagged with words that are semantically related to the keywords used for search. So if a German user has posted a blog post related to Apnia in German, you will be able to find the English version of this post using the English keyword ‘Apnia’. In addition if you are searching using the term ‘rare diseases’, the search mechanism of the MORMED Platform will be able to find content, which has been tagged with terms which are related to rare diseases, i.e. articles that have been tagged with the term ‘Lupus’.
Figure 18: Searching for content in the MORMED platform
The search feature can be used from the side block illustrated in the screenshot above. A user has to enter their search keywords and press the search button, and after few seconds they will be transferred to a page, which will display the search results sorted by relevance to the search terms used for the search.
D3.3 – Platform User Documentation
MORMED Consortium page 27
7.2 Editing content
Once a user has created content, they can always click on the title of the article and edit it. This section covers making changes to existing content on MORMED.
Note: Users can only edit content created by them, unless it is a wiki – which can be edited by any registered user within the scope of the wiki’s audience.
7.2.1 Making changes to existing content
1. Navigate or search for the content you would like to change. Click on the title of the story, and then click on the ‘EDIT’ tab at the top of the web page.
2. Use the content editing page to make your changes.
Figure 19: Editing content in the MORMED platform
D3.3 – Platform User Documentation
MORMED Consortium page 28
7.3 Tag Recommendations
In order to provide tag recommendations, the MORMED platform processes the submitted content, such that it extracts meaningful terms that can be used for annotating your content.
7.3.1 Using tag recommendations
The following example illustrates the use of tag recommendations during a wiki page creation.
1. The user enters the title and the text for the article that she/he wants to create. Once the user clicks on the ‘TAGS’ field, MORMED automatically suggests relevant keywords according to the written article.
Figure 20: The tag recommendation functionality
D3.3 – Platform User Documentation
MORMED Consortium page 29
The suggested tags are not selected by default. Only the user will decide whether the suggested tags are appropriate and whether she/he wants to include more keywords not originally prompted by the system. This is implemented at the next step.
2. The user selects the most appropriate terms by clicking on them. Selected tags are automatically included in the ‘TAGS’ field and are marked by red colour in the suggestion list.
Figure 21: The recommended tags are selected by the user
3. The last step is the publication (or the preview) of the article according to instructions presented at section 6.4 (Wiki page). The user can accomplish that by clicking on ‘Save’ (or ‘Preview’) on the bottom of the page.
The tags accompanying each content structure (e.g. blog, wiki page, etc) will be available in all languages of the MORMED platform, making cross‐language content more easy to find and users more connected than ever before.
D3.3 – Platform User Documentation
MORMED Consortium page 30
8 Comments
Registered users can enter comments on visible content posted in MORMED. An ‘Post new comment’ link is available underneath each content entry.
8.1 Entering a new comment
1. Click on the specific content you with to comment on 2. Enter the text in the text field box. 3. Click on ‘PREVIEW’. 4. If you’re happy with the comment, click ‘SAVE’ (available only after clicking ‘PREVIEW’),
otherwise make the changes before saving the comment. 5. Saved comments will appear in hierarchical order.
Figure 22: Entering a new comment by the user
D3.3 – Platform User Documentation
MORMED Consortium page 31
9 Automatic Translation
The MORMED Platform is enhanced with automatic content translation. New content is automatically translated to the other three languages as soon as it is published. Translated content will show the language flags underneath the content:
Figure 23: Using automatic translation
In the translation process, the MORMED Platform will consider as source language the default language of the user who has created the new content, unless otherwise specified by the user when he/she writes the new content in the ‘Language’ filed.
Note: Attachments are not translated automatically.
9.1 Editing translated content
Once a specific content has been translated it is possible to edit the translated or original version (only by the author, unless it is a wiki). To edit a translated version of a piece of content, simply open it, click the ‘EDIT’ tab, make the changes, and then save. Please note that once published, edited content or their edited translated versions will not be re‐translated. Should a user need to update or correct an entry, it is advised that the user creates a new content or alternatively responds to the original content with a new piece of content. Once this new content is saved and published, it will be automatically translated.
D3.3 – Platform User Documentation
MORMED Consortium page 32
9.2 Translating comments
The translation of comments is handled differently to other types of content on MORMED; their translations are not saved; only the original comment is saved in the language that it was created in. To have a written comment translated, all a user has to do is click on the language of their choice and the comment will be automatically translated into that language.
D3.3 – Platform User Documentation
MORMED Consortium page 33
10 Logging Out
Once you have finished all of your site updates and work, log out of the system. The ‘Log Out’ link is in the menu bar that appears when you click on your username. Click ‘LOG OUT’ and the system will log you out.
Figure 24: Logging out of MORMED
D3.3 – Platform User Documentation
MORMED Consortium page 34
11 Summary
This document provides a step‐by‐step user guide to assist MORMED users in making the most of what the platform has to offer. It explains in details the steps a user has to follow, covering topics such as registering for an account and logging on to the platform, changing a user’s account settings, creating and editing content, searching for specific criteria and eventually logging out. Functions such as the intelligent search, automated translation of new content, and messaging and notifications are also explained.
Since the MORMED platform is based on a continuously evolving content management system the steps explained in this user manual are likely to vary with time. MORMED’s technical partners will continuously update this manual and will make it available on the MORMED platform for users to review.
D3.3 – Platform User Documentation
MORMED Consortium page 35
12 Appendix A: LINGUISTIC GUIDELINES FOR THE MORMED PLATFORM
This section provides a series of guidelines to follow so that you can get the most out of the multilingual translation feature of the MORMED platform. For each general guideline, examples are provided for English (EN), German (DE) and Spanish (ES).
As a general rule, bear in mind that if you don’t do your part of the work properly (i.e. if you don’t write correctly), you will be making it difficult for the automatic translation system to work (i.e. it will not provide an understandable output).
The objective is to produce unambiguous and machine translatable text. In order to achieve this:
1. Write in lower case, except acronyms, proper nouns, etc.
2. Use accents and/or special characters (ö, ä, ß, ñ, á, é, ü, etc).
3. Use a full stop at the end of a sentence.
4. Avoid colloquialisms.
5. Avoid abbreviations, such as:
EN txt (for text), u (for you), btw (for by the way), e.g. (for for example)
DE z.B. (for zum Beispiel), o.g. (for oben gennante)
ES x (for por), dsd (for desde), p.ej. (for por ejemplo), vs. (for versus)
6. Avoid typos such as:
EN efen (for even), I can sent emails (for I can send emails)
DE Kardilogie (for Kardiologie)
ES cradiopatía (for cardiopatía)
7. Write acronyms in capital letters.
8. Avoid using “custom” acronyms. Try to stick to the universally accepted/used acronyms.
9. Avoid separating words at the end of a line; keep them together.
EN understanding instead of under‐standing
DE Vereinbarung instead of Verein‐barung
ES compromiso instead of com‐promiso
10. In the case of uploaded files, proofread the text and, where possible, run a spell check before saving it.
11. Use a space after punctuation signs such as full stops, commas, colons and semicolons.
D3.3 – Platform User Documentation
MORMED Consortium page 36
12. Avoid complex and deeply embedded sentences, such as:
EN – Too complex: This means that after the selection of a certain number of addresses I can send an e‐mail to each of these addresses.
EN – Better: I select a certain number of addresses, and then I send an email to each address. DE – Too complex: In Zusammenarbeit mit der Fa.TeraSystems GmbH ist es uns gelungen ein bzw. das Problem der Fa. TeraSystems GmbH bei der Anruferkennung zu lösen.
DE – Better: CAS arbeitet mit der Firma TeraSystems GmbH zusammen. CAS hat das Problem der Fa. Terasystems bei der Anruferkennung gelöst.
ES – Too complex: Después de abrir el compartimento de la parte superior del equipo se pueden extraer los accesorios.
ES – Better: En la parte superior del equipo se encuentra el compartimento. Primero abrimos el compartimento y entonces extraemos los accesorios.
13. Avoid impersonal constructions, such as:
EN – Not recommended: Install test version and enter license number in the user administration screen.
EN – Better: User installs test version; user enters license number in the user administration screen.
DE – Not recommended: Testversion installieren und Lizenznummer nachträglich in der Benutzerverwaltung eintragen.
DE – Better: Der Benutzer installiert die Testversion. Benutzer trägt dann die Lizenznummer in die Benutzerverwaltung ein.
ES – Not recommended: Instalar la versión de prueba e introducir el número de licencia en la pantalla del administrador.
ES – Better: El usuario debe instalar la versión de prueba. El usuario debe introducir el número de licencia en la pantalla del administrador.
14. Avoid the passive voice whenever possible:
EN – Not recommended: In any case, why is it allowed to actually have the same information open in several windows?
EN – Better: Why can we have the same information open in several windows?
DE – Not recommended: Nach Bestätigung der Meldung kann allerdings weitergearbeitet werden.
DE – Better: Nach Bestätigung der Meldung kann man weiterarbeiten.
ES – Not recommended: Se puede tener acceso a la información en diferentes ventanas.
ES – Better: Podemos acceder a la información en diferentes ventanas.
15. Avoid semantic ambiguity:
In English, the same word may have several meanings. The word “client” can used in the IT sense (“client” as opposed to “server”), and also in the sense of “customer”. It would help to use
D3.3 – Platform User Documentation
MORMED Consortium page 37
“customer” for the person/company buying the software, and reserve the term “client” for the software. Avoid metaphors, such as “kill two birds with one stone”.
16. Specifically for German, write nouns properly starting with a capital letter.
DE – Not recommended: die katze sitzt auf dem dach.
DE – Better: Die Katze sitzt auf dem Dach.
17. Specifically for Spanish, words starting with ps‐ also admit the version without p (e.g. psicología–sicología, pseudo–seudo, etc.). However, always write them with the p, as this is how terms are coded in the customised translation system.
18. Separate clauses with commas.
19. Avoid pronouns and other placeholders, and replace them with the nouns they represent wherever possible.
EN – Not recommended: current solution is that we switch the database and switch it back again.
EN – Better: Our current solution is: we switch the database. Then we switch the database back again.
DE – Not recommended: Das bedeutet für den Arzt folgendes: Kranke Menschen mit einer bestimmten Art von Auto‐Antikörpern müssen unter ununterbrochener Beobachtung stehen. Das liegt daran, dass die Auto‐Antikörper nicht miteinander verwandte Anti‐Gene bekämpfen. Dadurch findet man Veränderungen in Körperteilen. Diese Veränderungen waren vorher vielleicht noch nicht bekannt.
DE – Better: Das bedeutet für den Arzt: Kranke Menschen mit einer bestimmten Art von Auto‐Antikörpern müssen unter ununterbrochener Beobachtung stehen. Denn die Auto‐Antikörper bekämpfen nicht verwandte Anti‐Gene. Dadurch findet man Veränderungen in Körperteilen. Diese Veränderungen waren vorher vielleicht noch nicht bekannt.
ES – Not recommended: Extraer el dispositivo y colocarlo según se indica.
ES – Better: Extraer el dispositivo. Colocar el dispositivo tal y como se muestra en la figura.