Thursday, 15 October 2015

Week 11: Digital Prototype in class test

Here are the result of the Digital Protoype test session we ran in our contact session this week.  We aim to conduct the same test with real users in the next week.

Number of users: 5

Task 1: Login stress test and workflow test


  • Would like log in to autofill after sign-up
  • align font awesome icons

Task 2: Working panel and accessing help

Did you read the instructions on the home page?

  • no but prior knowledge of product x2
  • yes x2

Would you expect further instructions at this point?
  • as a dev, would rather play first
  • small tutorial maybe?
  • no
  • instructions didn’t cover working panel windows, this is what each bit is, need to understand layout

Do you know what to do on this page?
  • yes
  • where can i type?  looks a bit scary?


What would make the errors easier to read?
  • grouped together, space between each error, numbering would be good, bullet points, checkmarks
  • they are fine to read
  • multi-line erros, where does one error end and another start, gaps between each error, alternting line colours, wrap in container


If you didn't understand an error, where would you look for help?
  • google problem, not go to internal help
  • help should not be at the bottom
  • help should be modal or pop-out
  • difficult to see help button, add '?' help to error panel
  • put help with errors
  • google, stack overflow is industry standard on how to look for help


For each web page, there are multiple modules (e.g. Cricket Australia has 8 modules) that all pertain to the one page.  When you add CSS to the CSS editor and save, would you expect to see your saved CSS when you progress to the next module (i.e. Module 1 to Module 2)?
  • blank, prefer to start fresh each module
  • carry over if part of same website
  • frustrating to start over
  • would copy and paste if not automatic
  • yes, definetly

    Task 3: Use the working panel


    • would like ability to upload own images 
    • html editor text small x 2
    • html editor wrap text rather than scroll x2
    • rather than make panels movable, put content in tabs, either
      • errors thin at top, 2 tabs: html editor and css side by side; viewer, OR
      • separate html/css/viewer separate tabs and errors visible all the time


    (Originally posted on our team blog: Restoring the web)

    Week 11: Digital Protoype Test procedure

    This is the procedure we used in the digital protoyping session in class and will repeat with real users in the next week.  Sessions are run a one-on-one, in-situ interviews and usability tests.  Encourage users to talk aloud as they participate.  Remember - it is the system being tested, not the user.

    Pitch the concept:

    Explain concept but don't give any specific instructions on how to use site.

    Web standards are important to ensure that web pages display correctly in all browsers. Learning current web standards and how to comply with them are an essential part of learning how to write HTML and CSS. As web standards change over time, they depreciate old tags and introduce new tags and new features. One of the problems with archiving old websites (e.g. Trove, Pandora, Wayback Machine) is that even as web standards change, the archived websites still use the old, out-dated HTML tags.
    Web Historians provides HTML/CSS beginners with a practical, interactive web application to familiarise them with correct syntax and layout, the concept of web standards, the process of validating code against the latest standard, in context use of HTML and CSS, and basic editing.

    Task 1: Login stress test and workflow test

    Ask users to familiarise themselves with the home page (index.php) and when they are ready, sign up, log in, and log out.
    (tests the login system, workflow of log in/out and set-ups for the next task to see if the instructions/information on the home page are read)

    Task 2: Working panel and accessing help

    Ask users to log in with test account (tester/tester) and navigate to the test module for Cricket Australia. (tests navigation to working panel)

    Questions:

    • Did you read the instructions on the home page?
    • Would you expect further instructions at this point?
    • Do you know what to do on this page?
    • What would make the errors easier to read?
    • If you didn't understand an error, where would you look for help?
    • For each web page, there are multiple modules (e.g. Cricket Australia has 8 modules) that all pertain to the one page.  When you add CSS to the CSS editor and save, would you expect to see your saved CSS when you progress to the next module (i.e. Module 1 to Module 2)?

    Task 3: Use the working panel

    Ask users to have a play with the working panel, they can edit HTML, add CSS, and re-validate.  Ask if they have any comments or feedback.

    (Originally posted on our team blog: Restoring the web)

    Saturday, 10 October 2015

    Week 10: Modules

    This was a little more of the same.  Once I got the api/images/angular working for the sport category I then repeated the process for all the other categories, checking nothing broke as I copy-and-pasted code.  

    I also started into php for the first time for this project.  Lyndon had created log-in and sign-up pages in php and I edited them and styled them to look like the rest of our site.

    The other large change was to simplify the html content that users edit and validate.  Some of the feedback we had was that the errors panel was too complicated and the easy level wasn't that easy.  To counteract how complicated it is, we decided to break down each website into smaller modules.  I took our cricket website (which we seem to use as our test case for everything) and broke it down into 8 different modules.  I tried to pick obvious break points in the module and had to edit the code a little to make sure all tags in each module had both opened and closed.

    By changing the website into modules, we also had to change the easy/hard approach.  Instead of each website having easy or hard mode, now, depending on how modular each website is, it is now easy OR hard.  And we added more instructions to the website hover, 'begin restorations'.

    Sunday, 4 October 2015

    Mid-semester break: style updates and more angular

    I used the break to work on CSS/SASS and spend time with trove and the Wayback Time-machine.

    Styles

    • fixed some style inconsistencies with p and h styles
    • fixed the logotype: h1 size ration (logotype in now larger)
    • looked at the design of the page and changed from the 'indigo' colour palette to 'blackboard green' to match the infographic
    • crop the category image using CSS


    CSS Crop


    Page design



    Trove/Wayback machine

    My next task for the break was sourcing material for our site.  We had already decided on the four categories (sport, arts, education, government) and my task was to find approx 3 websites per category and source appropriate illustrative images from Trove, and web historical content from the Wayback Time-machine.  I search a combination of Pandora and Wayback Time-machine to find good examples of sites for each categories.  I concentrated on local sites (Brisbane, Queensland, Australia).

    Once I had selected the sites and made a list of the Wayback Machine addresses, I then went to Trove to find good search queries for each site.  Some were definitely easier than others.  I had AFL listed as one of the sport categories but was unable to find any images that were copyright free/retrievable with the Trove API.  I then proceeded to make the API calls, found the work IDs I needed, checked the calls work, and added the image URLs to an array to access for home.html.  

    Problems and solutions

    I used Plnkr to test adding real images to angular using a hard-coded array.  I then applied that to our real code but changed the hard coded array to the dynamic one constructed using API calls to Trove.

    The complicated part of using this array is the combination of Angular and Trove loading times.  The angular repeat happens much quicker than the Trove API calls.  Given that a lot of the information about the website (the link, website name, alt text, etc) the order of the images in the image array is important. The first step was then to direct each API call to a specific place in the array that corresponded to the data in the angular file.  

    e.g. imageArraySport[1]=olympicsImg;

    Where imageArraySport is the array to store the images for the sports tab and olympicsImg is the variable storing the image for the Sydney Olympics website.

    The next problem I had adding the images to the html generated by Angular.  I wrote a jQuery function that worked in plnkr that targeted a class and added the image source link from the links in the array.  This worked fine but wouldn't work when I used the real API calls instead of the hardcoded array.  I realised this was because the API calls came back at different times and when the function iterated over the array, it was not always full and returned a src link of nothing.

    To counteract this, I ran the function in each AJAX API calland added an if statement to check if the array had the number of images.

    e.g. if(imageArraySport.length == 3)

    Where the sport category has 3 websites and the if statement checks this first before running the rest of the function.

    Tuesday, 22 September 2015

    Week 9: update and angularjs

    This week I completed more work on styles and set-up html for the other pages we will be including on our project.  It was a lot of 'busy' work.

    Headers

    We had feedback that the header/nav wasn't consistent across the site so I tidied that up, updated the logo from an image to a text-only logotype.  Using the fonts Rena had used when creating the infographic, I created two options for our group to consider and vote on.  We all agreed that the first option looked best.





    Structural elements

    I set-up the following pages/sections:
    • breadcrumbs on all pages
    • profile page (editing feature to come later)
    • footer on all pages with copyright info (+ footer styles)
    • separated the landing page (index.html) where users log-in/sign-up from the home page (home.html) where users browse and select websites to restore
    • style log-in/sign-up box on index.html
    • moved save/publish to bottom of page (from feedback) on working_panel.html
    • created gallery page with lightbox
    • used bootstrap's modal to get the lightbox working
    • created 'who we are page'
    • created a help page and filled with intro content
    • created 'getting started' page and filled with dummy content

    Home.html/categories

    To set-up the categories and websites to choose from on the home page, we looked at a tab layout provided in bootstrap and considered different ways to incorporate images from trove.  Rather than repeating the content within html, I looked into using AngularJS repeating function.  I used stock images from http://www.fillmurray.com/ and http://www.placecage.com/ to populate the content and took a screen recording of the two category tab options to present to the team.


    We decided to go with the second option in the video with the long image taking up the width of the container. After we tested this format, I then made a few style changes (3 col layout, tabs more readable).

    Angular JS

    I created a controller file with all the information to be repeated and then put the div block to be repeated in the html file.

    HTML


    Controller JS


    Thursday, 17 September 2015

    Week 8: SASS how-to

    Initial set-up

    1. Download the source files from Bootstrap 
    2. Unzip them into the folder where you will be using them (in our case, I have set-up a 'SASS' folder in our git repo)
    3. Follow the instructions on tooling set-up on Bootstrap (repeated below)
      1. Download and install Node.js
      2. Using the command line (Terminal, iTerm, Powershell, what-have-you), install Grunt with npm install -g grunt-cli
      3. After a quick refresher in command line, navigate to the Bootstrap folder that you unzipped (for us: 'SASS' as above).  OK, so now you're using the command line and you're in the Bootstrap folder.  If you type ls it should look similar to this:

      4. Install the local dependencies listed in package.json by running npm install
      5. Next up is Ruby.  If you are on a mac, you should have it already installed but can check by typing ruby -v into the command line.  If you need to download or update there is info here and here.  But, if you need to install on Windows, we ran into a few problems and used this tutorial from Forward HQ to sort it out.
      6. Almost there! Two-parter for Bundler: 1) install in the command line by running gem install bundler and then 2) run bundle (for all the Ruby dependencies you will need).
    4. Last step, install SCSS Lint by running gem install scss_lint
    Phew, you still with me?  You may (or hopefully not) have any errors.  You may need to prefix the command line with sudo (I know, I know, lots of people say you shouldn't), or might get other random errors (google is your friend), but hopefully you have the things installed.  Now for the fun part :)

    Using SASS

    In your Bootstrap folder (for our team 'SASS') is a folder called 'scss' which is filled with many, many .scss files.  Being Bootstrap, it is all fairly logically named so it shouldn't be too hard to find any CSS you need to change.  '_variables.scss' has all the colours and typography (amongst other things), etc, etc. Have a look at the SASS documentation for how to use variables, nesting, other syntaxy-things.

    Once you've changed the things you need to, how do you get it to be a CSS (and JS) file to use on the website?  Back to the command line!

    To compile the CSS/JS files:
    1. Using command line, navigate to the bootstrap folder we were working in before.  You may still be there :)  (I'm a broken record but "For our team it is the 'SASS' folder")
    2. run grunt dist and fingers crossed, 0 errors!
    For our purposes, that's about it but there is more info on grunt commands in the Bootstrap documentation.

    Notes for team

    • No need to copy/paste files or folders, the CSS and JS import links are now up to date!
    • Remember: sync git, make changes, sync git
    • The Bootstrap 4 documentation has lots of great info, start with Layout, Content, Components
    • Bootstrap also has a slack channel - a great place to go for help!


    Week 8: Prep for Part B

    Our team met this week to discuss the division of tasks ahead of Part B being due next week.  Part of my task list was having a look at the header again and styling.  We decided as a group not to pursue web components at this time.  There are some cross-browser issues and ultimately it came down to time available vs core functionality we need to do first.  Web components hasn't been ruled out, just put in the 'nice to have' basket.

    Part of the feedback we got from the paper prototype we tested last week was to make all our header/nav the same across all pages.  While updating the header (and taking it out of its own HTML import), I had a look at the bootstrap framework we were using  the material design theme.  I decided to ditch the theme in an effort to make the design more our own and instead build on vanilla Bootstrap.

    I had a look into the newly released Bootstrap 4 and thought this would be a good option, but it is only available as source files (not pre-compiled code), which means setting up SASS for our project.

    Today in our workshop I went through how to set-up SASS with my team and how to edit and compile.  In my next post I will document the how-tos for our team to refer back to if necessary.

    I also wrote a set of success criteria for our Part B report based on the interactions we want our users to have with our web app.  We will discuss these as a group next week.