magpie-ea / magpie-site Goto Github PK

Hi there!

Just wanted to mention some bugs in the example on the multi_dropdown_customized example of the custom views page:

• It incorrectly names one of the arguments answer_container_gen, instead of answer_container_generator
• there's a single quotemark missing after the style='display:none in the first radiobutton (o1), making it a normal radiobutton
• it doesn't seem to create a dropdown menu, but just three buttons instead.

The automagically generated TOCs at the top of subpages of "start" and "docs" start by listing as a first section "basic architecture for browser experiments". This entry is spurious and should not appear here.

It would be nice to have a complete and detailed guide, that leads you through the process of creating a (real) experiment with _babe.

Including screenshots, creating the experiment with at least one custom view, setting up the experiment on the server, deployment and data collection

• Smaller icon picture [Michael]

• Relative path to icon pic (load once, not for every click) [anyone?]

Currently, the notice at the bottom of the page:

"Developed by open scientists for open science under a GNU general public license V3.0."

seems to imply that _babe itself is under GPL3, but I think this is actually pertaining to the website template as I see _babe is licensed under MIT.

The notice should probably be changed to disambiguate the two components.

Favicon provides the small icon image shown on browser tabs. A small version of the _babe logo should suffice.

Quite a lot changed due to the move to npm/modularization of _babe. We have to update the documentation, especially the experiments section.

• Summarize Minimal Template [Michael]

• Summarize ResponseType Template [Obioma]

• Summarize SPR Template [Michael]

• Summarize MentalChronometry [Obioma]

• Summarize SerialExhaustiveSearch [Noa]

• Summarize FeatureIdentification (once it is done)

• Customize design (away from Elixir) [Stela]

• Rethink right-hand navigation in ‘docs’ section (same as on ‘home’?) [Michael]

• Generate list of templates and examples in right-hand navigation automatically [Michael]

It seems like there is some logic, e.g. which element to underline in the style.css file. This should rather be done as class assignment/toggling in the _include/-html files using the jekyll bootstrap API.
See https://stackoverflow.com/questions/8340170/jekyll-automatically-highlight-current-tab-in-menu-bar and http://jekyllbootstrap.com/api/bootstrap-api.html#jbpages_list

in the resource section where templates and example experiments are described, it would be nice to have a screenshot from the template/example, e.g., in a circle on the left side with the opening paragraph of the description wrapped around this small picture
[this screenshot need not be very informative/visible, but it would just serve to differentiate visually the different entries]

insert subsection in 'experiments' with explanation on how to use the progress bar
additionally, provide some explanation as to how it is implemented

Explain where/how to obtain the URL of the server app, for Heroku and local install. Insert this information in the first paragraph of 'serverapp/04use.html'.

See magpie-ea/magpie-backend#6

• Pointer to randomization [Michael]

At the moment all files have non standardized names, e.g. experiments/introduction.markdown, experiments/02filestructure.markdown and overview/introduction.markdown, introduction/advantages.markdown.

Also, some displayed names are not identical to their file names, e.g. resources and reuse on the top level. Or the page title and the sidebar title is not identical, e.g. Introduction and Overview under the experiments tab.

This makes it harder to find files and to navigate the homepage.

• Include deployment info [Michael]

• Document CSV reader [Michael]

after restructuring many links to other places in the text are broken

A bit of my nitpicking but I see the term "data base" used in a lot of places e.g. in some README files as well as in the instructions and description of the iterated narration experiment. The term is "database" not "data base" (which is not a word). Might want to change it so that the passages read a bit better. 😅

If you want to record multiple answers in the answer container, you have to create a custom answer_container_generator. If you use answers including radio buttons, you also have to change the name of the input from name="answer", to something else. In this case, the radio button will show next to the label (and no longer on top of it). In order to get rid of this, you have to include "style='display:none’” in each input radio button. (see e.g.https://github.com/magpie-ea/magpie-statement-manipulation/blob/master/02_custom_functions.js answer_container_gen ,
code : input type='radio' name='answer1' id='rt1o2' style='display:none' value=${config.data[CT].choice_options_1[1]} ) .

The info how to solve this issue should maybe be included in the documentation about defining a custom view from scratch, or more specifically somewhere where you are told how to record multiple responses in the same view.

• start from the minimal template
• it now reads its input data for main and practice trials from *.js files in folder trial_info
• the new example should specify the same information but use the new functionality of the server app
• concretely, let’s supply the info in main_trial.js by uploading it as a csv file, and the info in practice_trials.js by uploading it as a JSON file
• include the files main_trial.csv and practice_trial.json in the new project’s ‘trial_order’ folder
• include a new view at the end of the experiment which shows some information about the previous runs, e.g., how many times which option was selected in the main trials
• so, make the response variable dynamically retrievable and include in this I/O example the functionality to read the previous responses back in

The necessary documentation to realize an experiment is already quite long (sections: experiments, server app, data collection) and is likely to become even longer.

It would be nice to have a quick start guide with just the minimal amount of information and pointers to the documentation.

There appears to be extra horizontal white space around hyperlinked text. This is visible for example on the landing page, e.g., after "getting started guide" and the following full stop.

The "top" button does not take us to the proper landing page in the "getting started" and "docs" sections.

When in a subsection like "server app" the text link in the top navigation line should be underlined. (This worked, but I seem to have ruined it when restructuring the site --- sorry!)

If we are on "home" the button for "home" in the top-level navigation is gray and unclickable, but not so for other chapters/parts of the site.

Minimal Template has a new counter system to work with loops. Users should know about this, if they want to realize non-standard experiments.