ICalico Development 2014 BMC

From IPRE Wiki
Revision as of 20:00, 9 July 2014 by Cole Harbeck (Talk | contribs) (Wednesday, July 9th, 2014)

Jump to: navigation, search

Goals:

  • be able to use ICalico via a server for fall 2014 courses (Programming Languages, and ESEM)
  • documentation
  • examples
  • JavaScript visualizations
  • JavaScript SpreadSheet interface
  • spelling checker
  • bibliography support
  • commenting by others
  • grading support
  • other functionality as needed
  • clicker-style feedback
  • question/answer widget
  • wiktionary (in-notebook word look-up)

Monday, June 30, 2014

Documentation:

Source:

Spelling Checking:

Miscellaneous:

Tuesday, July 1, 2014

Wednesday, July 2, 2014

JavaScript libraries:

ICalico Notebooks with Visualizations:

Bugs:

  • No vertical bar escape

Thursday, July 3, 2014

Hints on spelling checking:

ICalico documentation:

  • ICalico - the only docs we have so far


Mattie's Wishlist:

  • Being able to make the lines of tables invisible
  • Being able to have reference-style links be defined in any cell in the notebook

Monday, July 7th, 2014

Goals for the week:

Tuesday, July 8th, 2014

Testing and added functionality of automatic section numbering:

  • Discussed several new features with Mattie to make section numbering more user-friendly, including:
    • Added alerts that warn user when missing intermediate headers
    • Added additional alerts warning users when the first header cell in their Notebook is not a Header 1 cell
    • Determining when parts of certain user-defined titles should/should not be replaced
  • Tested more extensively, removing several bugs with replacing already existing headers
    • Users cannot name sections of their notebook titles that match the defined section numbering pattern (i.e. naming a section "1.5 Pies" will delete '1.5' and replace it with the correct section number for that section, even if '1.5' was intended to be part of the title)
  • Successfully generated section numbering for Mattie's Reference Guide


Completed Raw Implementation of Table of Contents Generator:

  • Code is labeled "Table of Contents Code" on Dropbox
  • Mostly working with few bugs
  • Several design questions that can be discussed in the future
  • Put a new copy of the reference guide (Title: "Reference Guide Plus Code") in the Dropbox folder which demonstrates both Section Numbering and Table of Contents Generation!

Known Bugs:

  • Making a markdown link that contains ")?)" forms some sort of escape and will not link properly. Cause unknown. EDIT: Fixed 7/9/2014


Doc Writing Update (from Mattie):

  • Finished explanation of toolbar, with exception to the restart kernel tool and the cell toolbar drop down menu, both of which I am trying to figure out the function of
  • Fix internal links so that they don't open up a new window (with Cole's help)
  • Introduced several new sections to the whole guide, including one that hopefully will link to Cole's automatic section numbering program
  • Currently trying to write a section on how to turn your Notebook into a slideshow, but I'm still figuring out how to do it for myself.

Wednesday, July 9th, 2014

Bug Fixes:

  • Added a fix to remove trailing spaces from links for the table of contents generator
  • Added a fix to replace all parentheses with their encodings (%28 and %29 respectively) fixing the bug causing links with parentheses to render incorrectly.


Potential New Bugs For Discussion:

  • Unordered lists do not render if the indentation level increases by more than one tab at a time. Notebooks with headers that are inconsistent in this way (i.e. jumping from header 1 to header 3) will not render their table of contents correctly. However, this could warn users of potential errors within their notebook.


Timeline Work: