GitHub - toddb/jquery.taskpaper: This is a jquery port of the taskpaper application for the mac to demonstrate the usage of bdd for javascript

toddb / jquery.taskpaper Public

Notifications You must be signed in to change notification settings
Fork 2
Star 16

This is a jquery port of the taskpaper application for the mac to demonstrate the usage of bdd for javascript

GPL-2.0, MIT licenses found

Licenses found

16 stars 2 forks Branches Tags Activity

Star

Notifications

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 64 Commits
build/packer		build/packer
lib		lib
src		src
tests		tests
GPL-license.txt		GPL-license.txt
MIT-license.txt		MIT-license.txt
Makefile		Makefile
README		README
changelog.txt		changelog.txt
jquery.taskpaper.tmproj		jquery.taskpaper.tmproj
test-src.html		test-src.html
todo		todo

Repository files navigation

taskpaper : jQuery feed parser plugin
Copyright (C) 2008 toddb
Dual licensed under the MIT (MIT-license.txt)
and GPL (GPL-license.txt) licenses.

Introduction
============

Taskpaper is a browser version of "Taskpaper" for the mac (http://www.hogbaysoftware.com/products/taskpaper). This project is an exercise to explore jQuery for doing this job using BDD. The current version has bugs on data entry. This is because using content editable elements in the DOM is generally hard. The current version is certainly not production ready but should give an idea on the extent to which we can produce test-first jQuery-based GUI on the browser.

Dependencies
============

* JQuery

Usage
=====
<html>
<head>

<link rel="stylesheet" href="lib/treeview/jquery.treeview.css" />
<link rel="stylesheet" href="css/storyq.treeview.css" />
<link rel="stylesheet" href="css/storyq.screen.css" />

<script src="lib/jquery/jquery.js" type="text/javascript"></script>
<script src="lib/jquery/jquery.cookie.js" type="text/javascript"></script>
<script src="jquery.taskpaper.js" type="text/javascript"></script>

</head>
<body>

<div id="tree">

<script type="text/javascript">

$(function() {

    $('#tree').taskpaper({
        url: 'my.taskpaper'
    });
});

</body>
</html>


    jQuery.taskpaper(options); 
    
    options:
    
    * url: the feed URL (required).
    * data: the jQuery DOM selector id.
    * load: a pre-processing callback function that can be overridden for populating the tree (object -> list).
    * tagsControl: the element that the tags list is populated int
    * success: a function to be called if the request succeeds.
      The function gets passed one argument: the taskpaper object.
    
    Example:
    
    $('#tree).taskpaper({
        url: 'results.taskpaper',
        success: function(feed) {
            alert(feed.version);
        }
    });
    
Basic structure of object as hierarchical tree:
  project > tasks >
		  > notes > tags
Compared to taskpaper representation	  
		  project:
          - tasks @tags
    		  notes
      
Taskpaper properties
================

    * feed.version
    * feed.items: an array of Projects
    
Taskpaper properties
====================

    * item.type: project, task, note, tag
    * item.text
    * item.items: an array of children

Please see the provided examples and units/spec tests for more information. Run from /test-src.html