columcross / chooseyourchoo Goto Github PK

Writing Data:
	1. Store all choices in XML files in <type> tags using their NAME.
	2. Name the file the name of the ID of the previous choice.
	3. Store all XML files flat in a folder with the same ID as your INITIAL choice.
	
ID vs NAME and INITIAL
	The NAME refers to the what the user sees. It can be writen however you want. Ex: "This is an incredible-example choice"
	The ID refers to the back end name. It is used for ids and file names. It HAS to be written in the following way:
		1. Lower camel case.
		2. Hyphens and numbers are allowed.
		3. Capitalize ONLY after spaces.
		Ex: "thisIsAnIncredible-exampleChoice"
	INITIAL refers to the first choice, or top most selection. Try and keep it to one word, lower case. Ex: "choices"
		
Images:
	1. Store all images as ".jpg".
	2. Name them the ID of the choice they refer to.
	3. Store them in a folder with the ID of their direct parent choice.
	4. Store that folder in a folder called INITIALImages. Ex: "choicesImages"
	
Using the Dataset:
	1. Store all the INITIAL folders and INITIALImages folders flat with the other files.
	2. Change the "initial" variable located in assets/initialize.js to whatever data set your want to start with.
	3. Change the "dataSet" variable located in assets/initialize.js to whatever you want the data set you start with to be called. Ex: "Choose Your Choices"
	4. Add all data sets you want to include in the select menu in the header div located in index.html with the value being INITIAL