Skip to content

Adding a new project

Harsha K edited this page May 26, 2021 · 3 revisions

In order to create a new website page for a project the following details are necessary. Please provide the same to create the appropriate page. A new project page is created with the following file-name format "yyyy-mm-dd-project-name.md" in the "_posts/projects" folder. This is a YAML file with some basic entries for the design, project name etc., which is used by Jekyll to generate the relevant HTML files. The following are mandatory entires that the YAML should have. This generates the required page and the entry in the "projects" page automatically.

  1. Title: This is the title of the project.
  2. Intended Audience: Intended audience for the project.
  3. Keywords: Keywords that best describes the project.
  4. Introduction: A one line introduction about the project. This shows up in italics in the project page.
  5. Description: Description of the project not 600 – 800 words max.
  6. Collaborations: Collaborators and acknowledgements if any for the project. This is usually funders or teams that helped in development of the project.
  7. image-thumb: In the "img" folder, please create a image for the icon image on the “projects” section that will lead to the project page. Notice the name of the file in img folder has to be "project-name"-thumb.jpg. The project name is indicated in the permalink and ide values in the project mark-down file. File dimensions is 500x500 pixels. Put a grey overlay with 60% opacity. Text at 54 pt Bebas Neue Bold.
  8. layout: "project-layout" is the value to be set. This is as per the design specified in the "_layouts" folder and will remain constant for all project types.
  9. bg-url: "/img/background-project10.png" is set to the background image to be used for this project. A set is provided in the "img" folder with a file name prefix of "background".
  10. permalink: "/projects/project-name/" is the format to set this value. Note that this will be used by Jekyll internally and thus set to the project title.
  11. ide: "project-title" is the format to set this. Note that this is used for both Jekyll build and to locate URLS as well as the project icon in the img folder. Note the requirement in the previous section.

Media content for the project page

  1. img1: Image on the page
  2. img2: Image on the page
  3. img3: Image on the page
  4. video: URL for the video link in case video for the project is available.
  5. brochure: location of project brochure pdf

For internal site purposes

The following is used by Jekyll to generate cross-links and other meta-data.

  1. type: In case the project is a game, this specifies the type of game. The options are Table-top, Web - based or Paper-based.
  2. duration: Duration of game/workshop. This can be hours, months, days, etc.,
  3. players: In case the project is a game, teams, no of players etc.,
  4. thread: Based on our discussion projects fall under one or more of these categories; Policy Lab, School of Policy, Policy in Play.
  5. tag: description of the project type, usually falls under the following; game, product, wscourses, simulation

Including the icon image in the projects page

The icon image with the title is automatically placed by placing an image file with the name "-thumb.jpg" in the "img" folder of the website. That is, the image file should be a jpg file and should be named with the same name as the ide of the project specified in the previous project page, which is usually the project title. Jekyll automatically picks up the image as a icon for that particular project and create the necessary hyperlink.

The image file should have the following properties.

  • jpeg file with extension "jpg"
  • Size of 500x500 px
  • Font Bebas Neue, 54Pt, Bold, Center Aligned

In case of a normal image, one can use the preview tool or GIMP to apply a grey layer with 70% transparency to it. The text can then be written on it to produce the necessary image.

Misc. purpose:

  1. play: link to game sessions page under game events.
  2. notitle: Title in case there is no intended audience, etc., (For example, refer to Unpack Play layout).

Clone this wiki locally