| Table of Contents |
|---|
Documentation to do:
Tooltips
HTML
Unique content types
Region: domestic vs international
Uploading images - allow access unrestricted
How to find the asset id of a page
Shared blocks
JSON structures
content-plain
Default content type. Used in most standard cases. Provides a Heading and content block underneath.
| Code Block |
|---|
{
"contentType": "content-plain",
"heading": "Text here",
"content": "Text here."
} |
content-plain-images-triplecrown
used specifically for content to display the triple crown association images. Normally uses a shared object, but sometimes has some variation.
Either use the block below, or link the asset 342525 in the appropriate place.
...
| Table of Contents |
|---|
For information on other aspects of study areas, degrees and postgraduate:
See page
/wiki/spaces/TD/pages/88277761
Documentation to do:
Tooltips
HTML
Unique content types
Region: domestic vs international
Uploading images - allow access unrestricted
How to find the asset id of a page
Shared blocks
JSON structures
content-plain
Default content type. Used in most standard cases. Provides a Heading and content block underneath.
| Code Block |
|---|
{
"contentType": "content-plain",
"heading": "Text here",
"content": "Text here."
} |
content-plain-images-triplecrown
used specifically for content to display the triple crown association images. Normally uses a shared object, but sometimes has some variation.
Either use the block below, or link the asset 342525 in the appropriate place.
| Code Block |
|---|
{
"heading" : "International recognition",
"contentType" : "content-plain-images-triplecrown",
"content" : "Victoria's MBA programme is accredited to the British-based <a href='http://www.mbaworld.com/'>Association of MBAs (AMBA)</a>, an internationally recognised global standard for all MBA programmes.\nVictoria Business School is also one of just 75 business schools worldwide that hold the 'Triple Crown' of international business education accreditations. You can be confident your degree will stand up against the best around the world.\n<a href='http://www.victoria.ac.nz/vbs/about/welcome/accreditation'>Find out more about accreditations and what they mean for you.</a>",
"images" : [{
"imageAssetId" : "340052",
"imageSrc" : "%globals_asset_url:340052^json_encode%",
"altText" : "EQUIS Logo",
"linkTitle" : "",
"link" : "",
"linkUrl": ""
}, {
"imageAssetId" : "340057",
"imageSrc" : "%globals_asset_url:340057^json_encode%",
"altText" : "AMBA Logo",
"linkTitle" : "",
"link" : "",
"linkUrl" : ""
}, {
"imageAssetId" : "340058",
"imageSrc" : "%globals_asset_url:340058^json_encode%",
"altText" : "AASCB Logo",
"linkTitle" : "",
"link" : "",
"linkUrl" : ""
}]
} |
...
For graduate qualifications, you need to specifically include a reference to the internationalApiCode in the content block. For example Graduate Diploma in Science, ID# 373377.
It looks like this:
...
this:
| Code Block |
|---|
{ "contentType" : "postgrad-apply", "heading" : "International fees", "region" : "international", "content" : { "startStudying" : { "contentTypetype" : "postgrad-applystudyLengthTrimester", "heading" : "Start Studying", : "International fees", "content" : [ { "regionstartDate" : "international"%globals_asset_attribute_start_date_short:355524%", "content" : { "startStudyingstartTrimester" : {"%globals_asset_metadata_trimesterNumber:355524%", "type" : "studyLengthTrimesterapplyBy", "heading" : "Start Studying",:"%globals_asset_attribute_start_date_short:365079%" "content" : [ }, { "startDate" :"%globals_asset_attribute_start_date_short:355524%355515%", "startTrimester" :"%globals_asset_metadata_trimesterNumber:355524%355515%", "applyBy" :"%globals_asset_attribute_start_date_short:365079%365077%" }, { "startDate" :"%globals_asset_attribute_start_date_short:355515%355523%", "startTrimester" :"%globals_asset_metadata_trimesterNumber:355515%355523%", "applyBy" :"%globals_asset_attribute_start_date_short:365077%365078%" } ] }, "fees" : { { "contentType" : "fees", "startDateheading" : :"%globals_asset_attribute_start_date_short:355523%", "content" : "startTrimester" :"%globals_asset_metadata_trimesterNumber:355523%", }, "internationalApiCode" : "applyBy"%globals_asset_metadata_ProgrammeId^as_asset:asset_metadata_internationalApiCode^json_encode%" :"%globals_asset_attribute_start_date_short:365078%" } ] }, "fees" : { "contentType" : "fees", "heading" : "", "content" : "" }, "internationalApiCode" : "%globals_asset_metadata_ProgrammeId^as_asset:asset_metadata_internationalApiCode^json_encode%" } } |
related-degrees
Used exclusively on subject pages. Is how the subject links to the degree pages.
For "undergrad" contents:
The asset_assetid, asset_metadata_ProgrammeCode, asset_metadata_LengthOfFulltimeStudy, asset_metadata_WebPath, and asset_name should all use the same asset id value. This is the degree that the subject is linking to, and should always be the asset number of a degree page.
The leadsIntoLink, leadsIntoText, leadsIntoExtraPreText, leadsIntoExtraLink, leadsIntoExtraLinkText are all to do with postgraduate degrees the subject links to.
- If they are all blank, no leads into will be shown.
- If the leadsIntoLink and leadsIntoText are present, then there will be a "Leads to a" piece of content with leadsIntoText as the text, and leadsIntoLink as the url.
- If the leadsIntoExtraPreText, leadsIntoExtraLink and leadsIntoExtraLinkText are present, then there will also be a second link provided in the "Leads to a" element.
This is a bit confusing, so see Architecture>Interior Architecture for a good example of how it is used. (Asset id 309042)
The content element is used to provide extra information about the related degree where necessary. This is just a plain text field. See Economics and Finance>Actuarial Science for a good example of this (asset number 309568).
For "postgrad" contents:
These are used solely for postgrad links. The assetid in asset_assetid and asset_metadata_WebPath should both be the same. Everything else gets edited in the json object.
A good example of this is Biomedical Sciences>Clinical Immunology (asset id 309688).
| Code Block |
|---|
{ "contentType": "related-degrees", "content": {} } |
related-degrees
Used exclusively on subject pages. Is how the subject links to the degree pages.
For "undergrad" contents:
The asset_assetid, asset_metadata_ProgrammeCode, asset_metadata_LengthOfFulltimeStudy, asset_metadata_WebPath, and asset_name should all use the same asset id value. This is the degree that the subject is linking to, and should always be the asset number of a degree page.
The leadsIntoLink, leadsIntoText, leadsIntoExtraPreText, leadsIntoExtraLink, leadsIntoExtraLinkText are all to do with postgraduate degrees the subject links to.
- If they are all blank, no leads into will be shown.
- If the leadsIntoLink and leadsIntoText are present, then there will be a "Leads to a" piece of content with leadsIntoText as the text, and leadsIntoLink as the url.
- If the leadsIntoExtraPreText, leadsIntoExtraLink and leadsIntoExtraLinkText are present, then there will also be a second link provided in the "Leads to a" element.
This is a bit confusing, so see Architecture>Interior Architecture for a good example of how it is used. (Asset id 309042)
The content element is used to provide extra information about the related degree where necessary. This is just a plain text field. See Economics and Finance>Actuarial Science for a good example of this (asset number 309568).
For "postgrad" contents:
These are used solely for postgrad links. The assetid in asset_assetid and asset_metadata_WebPath should both be the same. Everything else gets edited in the json object.
A good example of this is Biomedical Sciences>Clinical Immunology (asset id 309688).
| Code Block |
|---|
{ "contentType": "related-degrees", "content": { "undergrad": [{ "asset_assetid" : "%globals_asset_assetid:339832^json_encode%", "asset_metadata_ProgrammeCode" : "%globals_asset_metadata_ProgrammeCode:339832^json_encode%", "asset_metadata_LengthOfFulltimeStudy" : "%globals_asset_metadata_LengthOfFulltimeStudy:339832^json_encode%", "asset_metadata_WebPath" : "%globals_asset_metadata_WebPath:339832^json_encode%", "asset_name" : "%globals_asset_name:339832^json_encode%", "content" : "undergrad":, [{ "asset_assetidleadsIntoLink" : "%globals_asset_assetidurl:339832^json62170^json_encode%", "asset_metadata_ProgrammeCode"leadsIntoText" : "%globals_asset_metadata_ProgrammeCode:339832^json_encode%", "asset_metadata_LengthOfFulltimeStudy" : "%globals_asset_metadata_LengthOfFulltimeStudy:339832^json_encode%", "asset_metadata_WebPathMaster of Architecture (Professional)", "leadsIntoExtraPreText" : "%globals_asset_metadata_WebPath:339832^json_encode%", "asset_name": "and other", "leadsIntoExtraLink" : "%globals_asset_nameurl:339832^json62166^json_encode%", "contentleadsIntoExtraLinkText" : "postgraduate programmes" }], : "postgrad",: [{ "leadsIntoLinkasset_assetid" : "%globals_asset_urlassetid:62170^json296680^json_encode%", "leadsIntoText"asset_metadata_ProgrammeCode" : "MClinIm", "asset_metadata_LengthOfFulltimeStudy" : "1-2 years (180 points)", "asset_metadata_WebPath" : "Master of Architecture (Professional)%globals_asset_url:296680^json_encode%", "asset_name" "leadsIntoExtraPreText" : "andMaster other",of Clinical Immunology" }] "leadsIntoExtraLink" } } |
related-nonmajor-courses
Used exclusively on subject pages for non-major subjects. (e.g. Linguistics>Text Technologies). Allows the subject to link to the victoria search page with the appropriate subject selected.
| Code Block |
|---|
{ "contentType": "%globals_asset_url:62166^json_encode%related-nonmajor-courses", "leadsIntoExtraLinkText" : "postgraduate programmes""content": { }], "postgrad"undergrad": [{ "asset_assetid" : "%globals_asset_assetid:296680^json_encode%", "asset_metadata_ProgrammeCode""subjectCode":"127", : "content"MClinIm", "asset_metadata_LengthOfFulltimeStudy" : "1-2 years (180 points)", "asset_metadata_WebPath":"Learn more about the undergraduate courses available in Science in Society" }], : "postgrad"%globals_asset_url:296680^json_encode%", "asset_name": [{ "subjectCode":"139", "content":"Learn more about the postgraduate courses :available "Masterin ofScience Clinicalin ImmunologySociety" }] } } |
related-nonmajor-courses
Used exclusively on subject pages for non-major subjects. (e.g. Linguistics>Text Technologies). Allows the subject to link to the victoria search page with the appropriate subject selected.
| Code Block |
|---|
{
"contentType": "related-nonmajor-courses",
"content": {
"undergrad": [{
"subjectCode":"127",
"content":"Learn more about the undergraduate courses available in Science in Society"
}],
"postgrad": [{
"subjectCode":"139",
"content":"Learn more about the postgraduate courses available in Science in Society"
}]
}
} |
slide-show
(architecture has a good example of a slideshow)
See the appropriate confluence page on how to properly form a slideshow. But basically, the heading and caption are displayed above the images.
For the image objects, the caption, altText, and url are all provided via the globals_asset_attribute keyword. So if they are to be changed, it must be done on the details screen of the image asset.
Only the 'heading' is specified here, because the heading on the image asset might be different to what we want to display on the image itself, and in many cases is explicitly left out.
...
slide-show
(architecture has a good example of a slideshow)
See the appropriate confluence page on how to properly form a slideshow. But basically, the heading and caption are displayed above the images.
For the image objects, the caption, altText, and url are all provided via the globals_asset_attribute keyword. So if they are to be changed, it must be done on the details screen of the image asset.
Only the 'heading' is specified here, because the heading on the image asset might be different to what we want to display on the image itself, and in many cases is explicitly left out.
| Code Block |
|---|
{ "heading" : "Designing ideas", "contentType" : "slide-show", "caption" : "", "images" : [ { "heading" : "", "caption" : "%globals_asset_attribute_caption:340296^json_encode%", "altText" : "%globals_asset_attribute_alt:340296^json_encode%", "buttonText" : "", "buttonLink" : "", "buttonTitle" : "", "imageUrl" : "%globals_asset_url:340296^json_encode%", "imagesimageAssetId" : "340296" : [}, { "heading" : "", "caption" : "%globals_asset_attribute_caption:340296^json340276^json_encode%", "altText" : "%globals_asset_attribute_alt:340296^json340276^json_encode%", "buttonText" : "", "buttonLink" : "", "buttonTitle" : "", "imageUrl" : "%globals_asset_url:340296^json_encode%", "imageAssetId" : "340296" }, { "heading" : "", "caption" : "%globals_asset_attribute_caption:340276^json_encode%", "altText" : "%globals_asset_attribute_alt:340276^json_encode%", "buttonText" : "", "buttonLink" : "", "buttonTitle" : "", "imageUrl" : "%globals_asset_url:340276^json_encode%", "imageAssetId" : "340276" } ] } |
video
Embeds a video. Currently only supports youtube videos. Make sure that the videoLink value is only the 'key' part of the video url. For example, https://www.youtube.com/watch?v=NYP5hSRiqBw becomes NYP5hSRiqBw.
The heading2 value was originally provided to supply sub-headings but is not currently used anywhere.
The content value provides a caption to go underneath the video.
videoImage is the image that will be used as the snapshot/preview that will display when the page first loads. Simply replace the ASSETID value in the code with the asset id of the image once it has been loaded into squiz.
| Code Block |
|---|
{ "contentType": "video_asset_url:340276^json_encode%", "imageAssetId" : "340276" } ] } |
video
Embeds a video. Currently only supports youtube videos. Make sure that the videoLink value is only the 'key' part of the video url. For example, https://www.youtube.com/watch?v=NYP5hSRiqBw becomes NYP5hSRiqBw.
The heading2 value was originally provided to supply sub-headings but is not currently used anywhere.
The content value provides a caption to go underneath the video.
videoImage is the image that will be used as the snapshot/preview that will display when the page first loads. Simply replace the ASSETID value in the code with the asset id of the image once it has been loaded into squiz.
| Code Block |
|---|
{
"contentType": "video",
"videoType": "youtube",
"heading1": "Developing managers and leaders",
"heading2": "",
"content": "",
"videoLink": "NYP5hSRiqBw",
"videoImage": "%globals_asset_url:ASSETID^json_encode%"
} |
wellington-promo
Also known as the 'Why Wellington" block. Used to provide a short promotion on why Wellington is such a great place to study. Normally the only thing changing is the content in "content" and sometimes the "heading". If the heading is not supplied, it should be left as "Why Wellington".
Note, for postgrad wellington-promo's, the asset id for the imageId and links might be changing. If so, please get Andrew Bredenkamp to update this part of the documentation.
| Code Block |
|---|
{ "heading" : "Why Wellington", "contentType" : "wellington-promo", "content" : "", "imageLink" : "%globals_asset_url:327370^json_encode%", "videoTypeimageId" : "youtube327370", "links" "heading1": "Developing managers and leaders", : [ { "linkText" :"Why Wellington", "linkTitle" :"Why Wellington", "link" :"%globals_asset_url:248382^json_encode%" "heading2": "", } "content": "", "videoLink": "NYP5hSRiqBw", "videoImage": "%globals_asset_url:ASSETID^json_encode%" } |
wellington-promo
Also known as the 'Why Wellington" block. Used to provide a short promotion on why Wellington is such a great place to study. Normally the only thing changing is the content in "content" and sometimes the "heading". If the heading is not supplied, it should be left as "Why Wellington".
Note, for postgrad wellington-promo's, the asset id for the imageId and links might be changing. If so, please get Andrew Bredenkamp to update this part of the documentation.
| Code Block |
|---|
{ "heading" : "Why Wellington", "contentType" : "wellington-promo", "content" : "", "imageLink" : "%globals_asset_url:327370^json_encode%] } |
Missing content blocks
Please list below any content types that are not covered above, and get Andrew Bredenkamp to write up appropriate documentation on them.
Linking between tabs
If you want to link to a section in a different tab within the same area (e.g. accounting>about linking to accounting>qualifications), you can't just use a regular <a href="../about">. Instead use the following code for the right page type:
Postgraduate programmes (postgraduate-programmes) - tabs = #about #study #requirements #people #apply
| Code Block |
|---|
<a ui-sref='postgrads#people'>link text</a> |
Postgraduate subjects (postgraduate-subjects) - tabs #about #qualifications #people
| Code Block |
|---|
<a ui-sref='postgrad-areas#people'>link text</a> |
Graduate qualifications (graduate-quals) - tabs = #about #study #requirements #people #apply
| Code Block |
|---|
<a ui-sref='graduate-quals#people'>link text</a> |
Undergrad study areas (study-areas) - tabs = #about #study #people
| Code Block |
|---|
<a ui-sref='study-areas#people'>link text</a> |
Undergrad degrees (degrees) - tabs = #about #requirements
| Code Block |
|---|
<a ui-sref='degrees#requirements'>link text</a> |
International and Domestic content
Most of the international content is handled by the app. Including fees, requirements etc.
However there are some blocks which are set to be visible only for international or domestic students. This is set with the "region" value set to either "domestic" or "international".
E.g. asset id 341060
| Code Block |
|---|
{ "contentType" : "content-plain-links", "heading" : "Scholarships", "imageIdregion" : "327370domestic", "links" : [ { "linkText" :"Why Wellington", "linkTitle" :"Why Wellington", "linkcontent" : :"%globals_asset_url:248382^json_encode%" } ] } |
Missing content blocks
Please list below any content types that are not covered above, and get Andrew Bredenkamp to write up appropriate documentation on them.
Linking between tabs
If you want to link to a section in a different tab within the same area (e.g. accounting>about linking to accounting>qualifications), you can't just use a regular <a href="../about">. Instead use the following code for the right page type:
Postgraduate programmes (postgraduate-programmes) - tabs = #about #study #requirements #people #apply
| Code Block |
|---|
<a ui-sref='postgrads#people'>link text</a> |
Postgraduate subjects (postgraduate-subjects) - tabs #about #qualifications #people
| Code Block |
|---|
<a ui-sref='postgrad-areas#people'>link text</a> |
Graduate qualifications (graduate-quals) - tabs = #about #study #requirements #people #apply
| Code Block |
|---|
<a ui-sref='graduate-quals#people'>link text</a> |
Undergrad study areas (study-areas) - tabs = #about #study #people
| Code Block |
|---|
<a ui-sref='study-areas#people'>link text</a> |
Undergrad degrees (degrees) - tabs = #about #requirements
| Code Block |
|---|
<a ui-sref='degrees#requirements'>link text</a> |
International and Domestic content
Most of the international content is handled by the app. Including fees, requirements etc.
However there are some blocks which are set to be visible only for international or domestic students. This is set with the "region" value set to either "domestic" or "international".
E.g. asset id 341060
| Code Block |
|---|
{ "contentType" : "content-plain-links"Scholarships are awarded to hundreds of first-year students each year. They help with tuition fees and accommodation costs at Victoria's halls of residence. There are two types of scholarships for school leavers—Victoria Excellence Scholarships and Victoria Achiever Scholarships.\nYou can also apply for a TeachNZ Scholarship. These scholarships are awarded based on specific areas where teachers are needed.", "links" : [{ "linkText" : "Search scholarships", "heading" "linkTitle" : "ScholarshipsSearch scholarships", "regionlink" : "domestic", "content" : "Scholarships are awarded to hundreds of first-year students each year. They help with tuition fees and accommodation costs at Victoria's halls of residence. There are two types of scholarships for school leavers—Victoria Excellence Scholarships and Victoria Achiever Scholarships.\nYou can also apply for a TeachNZ Scholarship. These scholarships are awarded based on specific areas where teachers are needed.", "links" : [{ "linkText" : "Search scholarships", "linkTitle" : "Search scholarships", "link" : "http://www.victoria.ac.nz/study/student-finance/scholarships" }] } |
By default content will appear to anyone who visits the page. If the region is domestic, it will only show to non-international students. If the region is international, it will only show to international students.
...
http://www.victoria.ac.nz/study/student-finance/scholarships"
}]
} |
By default content will appear to anyone who visits the page. If the region is domestic, it will only show to non-international students. If the region is international, it will only show to international students.
This can be applied to any content block.
Tooltips
There are three kinds of tooltips.
- Standard tooltips that appear in text which has a dotted line under it, where the tooltip will appear when the user hovers over the word.
- Heading tooltips - e.g. on the Study Areas About tab, on the question mark icon by the heading Subjects "Possible area(s) of study within a degree"
- Other tooltips that have ended up being handled by the Angular App.
For standard tooltips, these are managed in each qualification areas sharedAssets folder.
E.g. sharedAssets (Id: #313981) > toolTips (Id: #329802) for study areas.
They are formatted just like any other json object:
| Code Block |
|---|
"word for tooltip to appear" : "Tooltip text that will appear on hover", |
Make sure the last item before the final } doesn't have a , after it so it retains valid json syntax.
it doesn't matter what capitalisation you use for the tooltip word, and it can include spaces and other characters (except " marks). Once the new word is in place, the next time you load the page the tooltips should be appear wherever that word appears.
Note, this is a fairly intensive process on angular end, so it is better if we try to keep this list of tooltips to a minimum wherever possible.
Also, the tooltips generally are broken into 4 parts.
- The opening bracket (can be ignored)
- A container that is exclusive to study areas
- A container that is shared across study areas, undergrad degrees, grad-quals and postgrad programmes
- Closing Bracket (can be ignored)
This allows specific tooltips only to appear in their designated area without adding extra values and processing to other areas. In future it might be worthwhile to regularly do an audit on the tooltips to ensure there are not any extra tooltips that are no longer needed, or if there are tooltips that are only required on postgrad that don't need to be shared.
Squiz keywords. When and how to use them:
...