You can link to different types of content on MAGICapp
You can link to:
- Sections in guidelines
- Specific recommendations
- You can link to specific recommendation tabs by using a suffix (see below)
- A PICO widget (that can also be embedded, or used as a pop-up)
- A Recommendation widget (that can also be embedded, or used as a pop-up)
The links uses specific IDs and shortCodes, to enable the links to work no matter if content is updated or order of content within a guideline is shuffled. Below is an explanation of the different parts of the link string, so you understand more how it is built and how it can be used.
In general about specific IDs and shortCodes
All guidelines, Recommendations and Widgets have a version- specific ID and an across-version shortCode ID.
The shortCode stays the same throughout all versions, so we use that in the link when we want to send users/display the most recent version.
The version specific ID can be used when you want to show a specific version of a guideline, recommendation, section or PICO.
If you use the specific ID in a guideline link, or a recommendation link, and there is a more recent version available, the user will get a message: «There is a more recent version available, do you want to go to it instead.» If user clicks yes, he/she will be taken to the most recent version.
It is however quite annoying to the user if the goal is to always take them to the most recent, so you should think about which link to use.
For the PICO widgets, we don’t yet have this forwarding mechanism, so if you use the specific ID, that is what the user will see, no matter if there is a newer version.
The links to the most recent version of a guideline and Widgets have the string /public/ in the link, while the link to a specific guideline does not have the string /public/
All links to public guidelines should work, both when you use the link with the shortCode that has the /public/ string in it (example https://www.magicapp.org/public/guideline/VLpr5E) or if you use the link with the specific ID that does not have the /public/ string it (example: https://www.magicapp.org/app#/guideline/1840
The /public/ is put in so that our servers know they will not get a user-access code from you, and will not try to get it, so that link might work a little bit faster. You find the Link to the always most recent version by clicking Options on the guideline on the main guideline listingThe link to the specific version would be the address you see in the browser window when you have accessed the guideline
The links to Recommendations and sections have the string /goto/ in them
The links to Recommendations and sections have the string /goto/ in them, they do not have /public/
(This is due to the routing mechanism used in the system)Links to recommendations and sections are found by clicking the link-icons on the Recommendations and Sections
An overview of the different link syntax's:
A public link to a public guideline, that will be used by users we do not expect to log in, and will take users to the most recent version has this syntax:
A link to a recommendation in a public guideline, and will take users to the most recent version has this syntax:
The recommendation links opens up in Key information tab as default (if it has content, if not it opens up in the Rationale tab, Summary of findings, Practical information or Adaptation- tab)
If you add a specific tab suffix, you can force the recommendation to open in a specific tab when user clicks the link:
/sof = Summary of Findings/Evidence tab
/da = Decision aids tab
/key = Key information tab
/rationale = Rationale tab
/practical = Practical information
/adaptation = Adaptation tab
Example: https://www.magicapp.org/goto/guideline/VLpr5E/rec/jXpZdj/da - will take user to this recommendation with the Decision aids tab open.
A link to a Section in a public guideline, and will take users to the most recent version has this syntax:
Summary of Findings widgets
A link to a Widget in a public guideline, and will take users to the most recent version, has this syntax:
The openOnLoad=1 means that the PICO is presented to users with the outcomes showing. =0 would show it as closed.
If you use the Widget pop-up code, you can see the width and hight of the popup in the code, these can be adjusted to whatever you want:
Recommendation widgetsThey work the same way as the Summary of findings widgets.