Experience Config

The experiences config file lists out what your past experiences are. These can be anything from education milestones such as a graduation to a new job to a big project you released. They will be displayed on the Experiences Page. This entire file is optional, but should it not be filled out then you will be left with an empty Experiences Page (the link will still be available unless you manually remove it).

Properties

The file defines a list of timeline items, default icons for different types of items, and some basic settings for the page as well. Again, much of this can be left empty if you so desire, but things listed as required are necessary in the case of you putting at least one item into the list of items.

settings

• Type: Settings Object
• Default Value: Empty
• Description: Contains a few settings to be used by the page. Detailed below.

default_icons

• Type: Dictionary of Strings and URLs
• Default Value: Empty
• Description: A list of key-value pairs of different timeline object types and the associated default icons for them.

items

• Type: List of Timeline Objects
• Default Value: Empty
• Description: Contains a list of Timeline Objects to display. The details of the Timeline Object can be found below.

Settings Object

Simple settings object, defines a few things to be used by the Experiences Page.

Properties

chronological

• Type: Boolean
• Default Value: false
• Description: Whether to display the items in chronological order or not.

description

• Type: String
• Default Value: Empty
• Description: The description to use for the page.

Timeline Object

An item to display in the timeline. Contains several properties, some of which can be left out.

Properties

date

• Type: DateTime
• Default Value: Empty
• Required: Yes
• Description: The date that this occurred. Can be in one of several formats: YYYY, YYYY-MM, or YYYY-MM-DD.

time

• Type: Enum with values of: "start", "mid", or "end"
• Default Value: Empty
• Required: Yes
• Description: Used to determine the color to use for the object. This helps signify differences between starting something or completing something. Colors can be customized in the CSS file for the Experiences Page.

title

• Type: String
• Default Value: Empty
• Required: Yes
• Description: The title of the timeline object to show.

subtitle

• Type: String
• Default Value: Empty
• Required: No
• Description: A subtitle to display on the timeline object. Appears below the title.

type

• Type: Enum with values from the "default_icons" property.
• Default Value: Empty
• Required: Yes
• Description: Used to determine the color to use for the object. This helps signify differences between starting something or completing something. Colors can be customized in the CSS file for the Experiences Page.

image

• Type: URL
• Default Value: Empty
• Required: No
• Description: A custom image to use in place of the default icons. Can be stored locally or in another location.

description

• Type: HTML
• Default Value: Empty
• Required: Yes
• Description: A description of what the event was and why it was important. Can be formatted with HTML to include links, highlighting, etc.

Example Configuration

{
    "settings": {
        "chronological": false,
        "description": ""
    },
    "default_icons": {
        "education": "images/svg/mortar-board.svg",
        "experiment": "images/svg/beaker.svg"
    },
    "items": [
        {
            "date": "2010-06",
            "time": "end",
            "title": "High School Graduation",
            "subtitle": "Mount Vernon High School",
            "type": "education",
            "description": "On this date, I graduated from Mount Vernon High School in Mount Vernon, Virginia. I finished with a GPA of 3.55 and an Advanced Diploma."
        },
        {
            "date": "2014-04",
            "time": "mid",
            "title": "Computer Science Capstone",
            "subtitle": "Christopher Newport University",
            "type": "experiment",
            "image": "images/custom/cnu-icon.jpg",
            "description": "Completed and presented my computer science capstone project for the completion of my computer science degree. This project was called <a href=\"http://www.projectvirtua.com/\" target=\"_blank\">Project Virtua</a> and was a project to create a library for using the Microsoft Kinect 1.0 and an Oculus DK1."
        },
        {
            "date": "2014-12-01",
            "time": "mid",
            "title": "Computer Engineering Capstone",
            "subtitle": "Christopher Newport University",
            "type": "experiment",
            "image": "images/custom/cnu-icon.jpg",
            "description": "Completed and presented my computer engineering capstone project for the completion of my computer science degree. This project made use of a Microsoft Kinect 2.0 sensor to track how the device moved, attempting to track the position of the device in realtime ."
        },
        {
            "date": "2014-12-02",
            "time": "end",
            "title": "University Graduation",
            "subtitle": "Christopher Newport University",
            "type": "education",
            "image": "images/custom/cnu-icon.jpg",
            "description": "On this date, I completed my undergraduate degrees in <b>Computer Engineering</b> and <b>Computer Science</b> at Christopher Newport University."
        },
        {
            "date": "2010-08",
            "time": "start",
            "title": "Began Undergraduate Degrees",
            "subtitle": "Christopher Newport University",
            "type": "education",
            "image": "images/custom/cnu-icon.jpg",
            "description": "On this date, I began my undergraduate degrees in <b>Computer Engineering</b> and <b>Computer Science</b> at Christopher Newport University."
        }
    ]
}