Tag Archives: Documentation

Sequelize for Dash

While getting one’s hands dirty with Sequelize, it can be useful to have access to the documentation, so even it’s relatively simple I decided to wrap the documentation for Sequelize in a docSet for Dash…

sequelize

Here is the link for the feed file…
Direct Link

…and here is the link for the custom URL for adding the feed to your Dash…
Add Feed Automatically

 

Tagged , , ,

AngularJS NVD3 Directives for Dash

Most recent addition for Dash is the documentation for the AngularJS NVD3 Directives by Christian Maurer

angularjs-nvd3-directives

Add the documentation from here… Direct Link

Tagged , , , , ,

Bookshelf for Dash

In addition to the recent Moment and Async docSet for Dash, I have created a third docSet distribution, this time for the cool library Bookshelf which is pretty cool Node.js ORM for PostgreSQL, MySQL and SQLite3 in the style of Backbone.js.

bookshelf

Created by Tim Griesser, its just one project in the line of many which is solving every day issues with elegance and efficiency… Currently its the same approach as with Moment and Async, where its merely an embedded version of the online documentation…

bookshelf-dash

Add the documentation from here… Direct Link

Tagged , , ,

Async for Dash

In addition to the recent Dash docSet for Moment.js, I have created a second docSet distribution, this time for the popular JavaScript library Async by Caolan McMahon.

async

It can be installed from here: Direct URL
or via a custom URL for DashFeed’s here: Custom DashFeed URL

Tagged , , ,

Moment.js for Dash

I have decided to add all the documentation I’m using to my setup for offline access, for this I’m using Dash (Dash is an API Documentation Browser and Code Snippet Manager).

Image

Dash is the same docSet standard used by Zeal (“…a simple offline API documentation browser inspired by Dash (OS X app), available for Linux and Windows”, http://zealdocs.org/).

Image

For my first docSet I chose to make the documentation for Moment.js available (a javascript date library for parsing, validating, manipulating, and formatting dates).

Image

Since the most laborious part of generating a docSet is adding all entries to the searchIndex database (an embedded SQLLite database), I opted for simply embedding the online documentation in an archive and expose it as the docSet in a single resource.

To install the docSet, simply client the link below and it will automatically add the reference to Dash (or Zeal):
Custom DashFeed URL for adding the docSet

If you prefer you can also add it manually by adding the following link to the list of docSets:
Direct URL to the docSet definition

Next step would be to create a script that would allow me to extract the different documentation points from the online documentation and add it to the searchIndex, however for now it fullfills my need to have an easy and structured way to access the documentation when offline.

Tagged , , ,

Introducing Web Platform Docs… a unified approach

On the 8. October 2012 something historically happened… W3C, in collaboration with Adobe, Facebook, Google, HP, Microsoft, Mozilla, Nokia, Opera, and others, announced the alpha release of Web Platform Docs (docs.webplatform.org), a new community-driven site that aims to become a comprehensive and authoritative source for web developer documentation.

In the past, developers who use HTML5, CSS and other technologies of the Open Web Platform have had to consult multiple sites to understand how to use these technologies in a way that works across browsers, operating systems and devices. This was time-consuming and in many cases increased development costs.

With Web Platform Docs, the vision is that web professionals will save time and resources by consulting a single site for current, cross-browser and cross-device coding best practices, including:

  • How to use each feature of the Open Web Platform, with syntax and examples;
  • The interoperability of various technologies across platforms and devices;
  • The standardization status of each technology specification;
  • The stability and implementation status of features.

The project is implemented as a Wiki, which means that anyone can contribute content to Web Platform Docs. The organizations mentioned above – collectively known as the “stewards” – have launched this new site with initial documents contributed as raw material for the community to shape. The W3C will serve as the site’s convener. As the Open Web Platform evolves, the entire community, including the original stewards and new stewards, will help maintain and improve the content. All materials on the site will be freely available and licensed to foster sharing and reuse.

“People in the web community — including browser makers, authoring tool makers, and leading edge developers and designers — have tremendous experience and practical knowledge about the web,” said Tim Berners-Lee, W3C Director. “Web Platform Docs is an ambitious project where all of us who are passionate about the web can share knowledge and help one another.”

The W3C and the stewards envision webplatform.org as the home of future collaboration with developers and designers. Those interested in contributing to this effort as a steward or as an editor can visit docs.webplatform.org

Tagged ,

by popular demand: The SkinnablePopUpContainer

A frequent question is how to open PopUp windows in a target platform neutral way and in compliance with strict Flex4 coding practices…

Here is a quick sample of how to do that…

<?xml version="1.0" encoding="utf-8"?>
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
			   xmlns:s="library://ns.adobe.com/flex/spark"
			   xmlns:mx="library://ns.adobe.com/flex/mx">

	<fx:Declarations>
		<fx:Component className="MyAlert">
			<s:SkinnablePopUpContainer>
				<s:TitleWindow title="Launching World Domination..." close="close()">
					<s:VGroup horizontalAlign="center" width="100%">
						<s:Label text="World Domination failed. Sorry!"/>
						<s:Button label="OK, nevermind" click="close()"/>
					</s:VGroup>
				</s:TitleWindow>
			</s:SkinnablePopUpContainer>
		</fx:Component>
	</fx:Declarations>

	<s:Button label="Launch World Domination" click="(new MyAlert()).open(this, false)"/>

</s:Application>
Tagged ,

Introducing Adobe "Blueprint"

Blueprint is a plugin for Adobe Flash Builder that allows users to query for Adobe Flex and Adobe Flash code examples found on the Web directly inside of the development environment. The purpose of this preview is to assess the level of community interest in this type of customized search interface for code examples.

blueprint_screen_345x160

I have installed it and have already found it to be an interesting addition to the existing documentation… check it out…
http://labs.adobe.com/technologies/blueprint/

Tagged , ,

Adobe Flex : MXML 2009 Specification

The MXML 2009 (Adobe Flex 4, Gumbo) specification is made available in an “as is” version…

Check it out…
http://opensource.adobe.com/wiki/display/flexsdk/MXML+2009

Tagged ,

Adobe Flex : Documentation for Gumbo (Flex 4)

The Adobe Flex 4 (Gumbo) documentation is made available in an “as is” state…

Check it out…
http://livedocs.adobe.com/flex/gumbo/langref/

Tagged ,
Follow

Get every new post delivered to your Inbox.

Join 522 other followers