Difference between revisions of "ICalico Development 2014 BMC"
From IPRE Wiki
Cole Harbeck (Talk | contribs) (→Tuesday, July 8th, 2014) |
Cole Harbeck (Talk | contribs) (→Tuesday, July 8th, 2014) |
||
| Line 102: | Line 102: | ||
** 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) | ** 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 | * Successfully generated section numbering for Mattie's Reference Guide | ||
| + | |||
Completed Raw Implementation of Table of Contents Generator: | Completed Raw Implementation of Table of Contents Generator: | ||
| Line 110: | Line 111: | ||
Known Bugs: | Known Bugs: | ||
* Making a markdown link that contains ")?)" forms some sort of escape and will not link properly. Cause unknown. | * Making a markdown link that contains ")?)" forms some sort of escape and will not link properly. Cause unknown. | ||
| + | |||
Doc Writing Update (from Mattie): | Doc Writing Update (from Mattie): | ||
Revision as of 22:05, 8 July 2014
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)
Contents
Monday, June 30, 2014
Documentation:
- http://daringfireball.net/projects/markdown/ - Original definition of "markdown"
- http://en.wikipedia.org/wiki/Markdown - General overview of markdown
- https://github.com/chjj/marked/tree/master/test/tests - Marked tests, should document all features/variations
- https://help.github.com/articles/github-flavored-markdown - Additional syntax allowed with "marked"
Source:
Spelling Checking:
- http://mail.scipy.org/pipermail/ipython-dev/2014-June/014159.html
- https://github.com/ipython/ipython/issues/3216
Miscellaneous:
- https://www.gitbook.io/ - Publish Markdown book (has foot notes)
- https://github.com/chjj/marked/pull/431 - footnote patch for marked
Tuesday, July 1, 2014
Wednesday, July 2, 2014
JavaScript libraries:
- http://timeline.knightlab.com/ - Time Line
ICalico Notebooks with Visualizations:
- http://nbviewer.ipython.org/urls/bitbucket.org/ipre/calico/raw/master/notebooks/Python/Google%20Charts.ipynb
- http://nbviewer.ipython.org/urls/bitbucket.org/ipre/calico/raw/master/notebooks/Python/GeoChart.ipynb
- http://nbviewer.ipython.org/urls/bitbucket.org/ipre/calico/raw/master/notebooks/Python/Travelling%20Salesperson.ipynb
Bugs:
- No vertical bar escape
Thursday, July 3, 2014
Hints on spelling checking:
- https://github.com/ipython/ipython/pull/3102/files - Changes to turn spell check off. What happens if it is on?
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:
- JavaScript:
- Number Sections
- Completed July 7th. Has not been tested extensively. Code is located in "Labeling Headers" notebook on Dropbox.
- RenameLinks
- Number Sections
- JavaScript:
- Table of Contents
- JavaScript Hints:
- https://github.com/minrk/ipython_extensions/blob/master/nbextensions/toc.js
- https://github.com/ipython/ipython/tree/master/IPython/html/static/notebook/js - IPython Javascript, see notebook.js and cell.js
- JavaScript Hints:
- Remove Old One?
- Table of Contents
- Timeline
- JSON
- Documentation
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:
- 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.
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.
