Difference between revisions of "Knowledgebase"
| (56 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
This is the ImpVis knowledge base; it contains all of the information ImpVis has accumulated as a community in order to design and develop effective interactive visualisations for education. | This is the ImpVis knowledge base; it contains all of the information ImpVis has accumulated as a community in order to design and develop effective interactive visualisations for education. | ||
| Line 5: | Line 4: | ||
== Getting started == | == Getting started == | ||
These are the suggested steps to take if you wish to know all about how to get involved in the ImpVis project. | |||
# Read a brief overview of [[our design and development process]] (ensure to take the first step: connecting with our community). | |||
# Find out how to [[Getting involved|get involved]] with a visualisation project. | |||
# Understand what it means to [[Working in partnership|work in partnership]]. | |||
You can follow the links in the pages above to find out more information. Below are listed all the pages in the 'Getting Started' category in alphabetical order.<categorytree mode="pages">Getting Started | |||
</categorytree> | |||
==Visualisation design guidance== | |||
To create an interactive visualisation for education, you will need to consider the design of your visualisation carefully from several angles. The ImpVis template implements some of our ideas so that you do not need to design your visualisation entirely from scratch. Suggested steps to follow: | |||
# Carefully phrase the visualisation's aim, learning outcomes, and intended implementation. Read [[Scaffolding concepts]] for guidance. Document these in your own project's Wiki page. If you haven't yet created your own project Wiki page, do so now by copying the [[Wiki Template for new project|template Wiki]] and filling in the sections. Have a look at [[Solid Angles Design|this example]] of a finalised design. | |||
# Familiarise yourself with the [https://impvis.co.uk/launch/impvis-layouts-v2/page1.html?collection=39 ImpVis visualisation template] (hosted on the ImpVis website) so you understand how it can support your visualisation design and read the [[ImpVis template description|description of the ImpVis template]]. | |||
#Check out the [[Organising content]] page to consider how to populate the visualisation template with your own visualisation's content. | |||
#Decide on what the visualisation will look like and how it will work. Peruse the design guidance documents listed below to help you. | |||
#Insert a design sketch, including the visual and interactive elements of the visualisation, in your visualisation's dedicated Wiki project page. Explain the rationale of your decisions. | |||
#Once all staff partners are happy with the design, they need to formally confirm their agreement on the website to move their project to the development stage (read [[Managing your project on the ImpVis website#Changing the progress status of your project|here]] about how to do this). | |||
Below we list all our design guidance documents alphabetically, split up into three different categories: education, graphic, and interaction design. Note that we have only just started collating our experience in this section, so it is sparsely populated - we aim to incorporate all knowledge generated by the ImpVis module students in this Wiki going forward.<categorytree mode="pages">Design Guidance | |||
</categorytree> | |||
==Guidance for coding up visualisations== | == Guidance for coding up visualisations== | ||
'''Before you start coding, ensure the visualisation design is well documented on your Wiki project page and all partners have agreed on the design!''' If you haven't done this yet, revisit [[Our design and development process#Visualisation design based on aims and learning outcomes|the steps to take in the design process]] to find out how to do this. | |||
The sections below contain technical guidance to support you with the coding side of ImpVis. | |||
=== Setting up=== | |||
When starting coding, these are the suggested steps to follow: | |||
# [[Programming languages|Read about our programming languages]] and where to find some training resources. | |||
# [[Tutorial for setting up the coding environment|Follow this tutorial]] to set up your coding environment. | |||
#[[Getting connected on Github|Learn]] about getting started on GitHub. | |||
All our pages with guidance for setting up are listed below in alphabetical order.<categorytree mode="pages">Setting Up</categorytree> | |||
===The ImpVis visualisations template=== | |||
Here you can find information about the ImpVis template created in 2020, using vue.js. You should already have familiarised yourself with the ImpVis template during the design phase. However, before you proceed with the coding, make sure you have an in-depth understanding of the template and its components, including how to include the components in your code. Suggested steps to take: | |||
# See the template in action here: [https://impvis.co.uk/launch/impvis-layouts-v2/page1.html?collection=39 ImpVis template]. | |||
# Read the [[ImpVis template description]]. | |||
#Follow the [[Basic Component Tutorial|basic tutorial]] on how to include components in your code and/or take the [[introduction to Vue workshop]]. | |||
# Find technical documentation on all ImpVis [[Vue Components|Vue components]]. | |||
Below are all our guidance pages for the ImpVis and the associated components, in alphabetical order.<categorytree mode="pages">ImpVis Template | |||
</categorytree> | |||
===The coding process=== | |||
Look here for tips and help on issues that may come up while you're coding. Here are some pages to get your started: | |||
# [[Structuring your code]] | |||
# [[Help on HTML, CSS, JS and JS libraries]] | |||
#[[JavaScript packages for graphics|Javascript packages for graphics]] | |||
#[[Introduction to Vue workshop]] | |||
#[[Tips for the developer]] | |||
All our coding tips pages are listed alphabetically below.<categorytree mode="pages">Tips Whilst Coding | |||
</categorytree> | |||
==Review and publication of your visualisation== | |||
When you have completed coding up your visualisation, it is time to upload it to the ImpVis website. It will then need to be reviewed before it can be published in 'Teach' environment. You should also create a Collection so your intended learners will easily be able to access your visualisation. Suggested reading: | |||
# [[Uploading a new visualisation]] | |||
# [[Managing your visualisation]] | |||
# The [[review]] process | |||
# The [[Visualisation status|status]] of your visualisation | |||
# [[Uploading a new version of your visualisation]] | |||
# [[Creating a Collection]] | |||
# [[Managing your Collection]] | |||
You can find all pages related to the ImpVis website functionality in the [[Knowledgebase#Website guidance|relevant section below]]. | |||
== Maintaining ImpVis == | |||
Maintaining ImpVis involves moving old visualisations to the new template, updating or creating new components, improving the ImpVis CLI, etc. | |||
Below are listed all the pages in this category in alphabetical order.<categorytree mode="pages">Maintaining ImpVis | |||
== | </categorytree> | ||
== Website guidance == | |||
Everything about the functionality on the website and its design. Relevant pages listed in alphabetical order below.<categorytree mode="pages">ImpVis Website Guidance | |||
</categorytree> | |||
[[Category:Everything]] | |||
Latest revision as of 12:32, 16 February 2022
This is the ImpVis knowledge base; it contains all of the information ImpVis has accumulated as a community in order to design and develop effective interactive visualisations for education.
The structure of this page follows the steps of our design and development process closely.
Getting started
These are the suggested steps to take if you wish to know all about how to get involved in the ImpVis project.
- Read a brief overview of our design and development process (ensure to take the first step: connecting with our community).
- Find out how to get involved with a visualisation project.
- Understand what it means to work in partnership.
You can follow the links in the pages above to find out more information. Below are listed all the pages in the 'Getting Started' category in alphabetical order.
Visualisation design guidance
To create an interactive visualisation for education, you will need to consider the design of your visualisation carefully from several angles. The ImpVis template implements some of our ideas so that you do not need to design your visualisation entirely from scratch. Suggested steps to follow:
- Carefully phrase the visualisation's aim, learning outcomes, and intended implementation. Read Scaffolding concepts for guidance. Document these in your own project's Wiki page. If you haven't yet created your own project Wiki page, do so now by copying the template Wiki and filling in the sections. Have a look at this example of a finalised design.
- Familiarise yourself with the ImpVis visualisation template (hosted on the ImpVis website) so you understand how it can support your visualisation design and read the description of the ImpVis template.
- Check out the Organising content page to consider how to populate the visualisation template with your own visualisation's content.
- Decide on what the visualisation will look like and how it will work. Peruse the design guidance documents listed below to help you.
- Insert a design sketch, including the visual and interactive elements of the visualisation, in your visualisation's dedicated Wiki project page. Explain the rationale of your decisions.
- Once all staff partners are happy with the design, they need to formally confirm their agreement on the website to move their project to the development stage (read here about how to do this).
Below we list all our design guidance documents alphabetically, split up into three different categories: education, graphic, and interaction design. Note that we have only just started collating our experience in this section, so it is sparsely populated - we aim to incorporate all knowledge generated by the ImpVis module students in this Wiki going forward.
Guidance for coding up visualisations
Before you start coding, ensure the visualisation design is well documented on your Wiki project page and all partners have agreed on the design! If you haven't done this yet, revisit the steps to take in the design process to find out how to do this.
The sections below contain technical guidance to support you with the coding side of ImpVis.
Setting up
When starting coding, these are the suggested steps to follow:
- Read about our programming languages and where to find some training resources.
- Follow this tutorial to set up your coding environment.
- Learn about getting started on GitHub.
All our pages with guidance for setting up are listed below in alphabetical order.
The ImpVis visualisations template
Here you can find information about the ImpVis template created in 2020, using vue.js. You should already have familiarised yourself with the ImpVis template during the design phase. However, before you proceed with the coding, make sure you have an in-depth understanding of the template and its components, including how to include the components in your code. Suggested steps to take:
- See the template in action here: ImpVis template.
- Read the ImpVis template description.
- Follow the basic tutorial on how to include components in your code and/or take the introduction to Vue workshop.
- Find technical documentation on all ImpVis Vue components.
Below are all our guidance pages for the ImpVis and the associated components, in alphabetical order.
The coding process
Look here for tips and help on issues that may come up while you're coding. Here are some pages to get your started:
- Structuring your code
- Help on HTML, CSS, JS and JS libraries
- Javascript packages for graphics
- Introduction to Vue workshop
- Tips for the developer
All our coding tips pages are listed alphabetically below.
Review and publication of your visualisation
When you have completed coding up your visualisation, it is time to upload it to the ImpVis website. It will then need to be reviewed before it can be published in 'Teach' environment. You should also create a Collection so your intended learners will easily be able to access your visualisation. Suggested reading:
- Uploading a new visualisation
- Managing your visualisation
- The review process
- The status of your visualisation
- Uploading a new version of your visualisation
- Creating a Collection
- Managing your Collection
You can find all pages related to the ImpVis website functionality in the relevant section below.
Maintaining ImpVis
Maintaining ImpVis involves moving old visualisations to the new template, updating or creating new components, improving the ImpVis CLI, etc.
Below are listed all the pages in this category in alphabetical order.
Website guidance
Everything about the functionality on the website and its design. Relevant pages listed in alphabetical order below.