Friday 27 January 2012

Markdown

Strangely, Markdown is a markup “language” and was created by John Gruber and Aaron Swartz. The idea is to allow anyone to generate plain text and have that text re-formatted into valid HTML giving it some structure. The basics are very simple to learn and allow anyone applying this technique to add emphasis and style to their words in a very simple manner.

We thought it would be a great idea to allow members of the Sea Kayak Wales web site to post comments using markdown. We encourage our users to comment and discuss items posted to the news page (a social bookmarking facility for sea kayakers). Anyone can just enter their comments as plain text and that is (more or less) how they will be displayed.

Keen observers might note that when a web URL is entered then it is automatically converted into a link to that URL. They might also notice that some attempt is made to organise what is entered into paragraphs and that whitespace is often trimmed. This is all done by the Markdown processing supporting the discussion pages.

Markdown can be used to emphasise text. Putting an asterisk before and after a piece of text will have it rendered in italics [ *display in italics* ].
Put two asterisks before and after a section of text and it will appear bold [ **this will be bold** ].

Lists can be displayed in a “bulleted” format using this markdown:
* List Item 1
*List Item 2
* List Item 3 etc

Headings can be denoted with hashes or in a more literal manner:
### A Level 3 Heading
or
A level two Heading
--------------------------

Full details of Markdown can be found in the Wikipedia article (http://en.wikipedia.org/wiki/Markdown) or on the Daring Fireball web site (http://daringfireball.net/projects/markdown/basics)

Have fun but please don’t overdo it.

Friday 20 January 2012

Bookmarklet

The word Bookmarkelet, correctly,  has all of the hallmarks of being made up. “Book mark” – fine I use those when reading – sometimes the ones bought for me by family and friends but more often just corners of envelopes or till receipts found quickly when needed.  We are also familiar with “bookmarking” web site pages with the co-operation of our browsers so we can find a web resource again without another major search and filter operation. I suppose we have also seen the use of the term “social bookmarking” where we share gems from the web with others. Which certainly brings me along nicely to the Sea Kayak Wales News Page which is just such an Internet resource.


Where though does the “let” bit come from? We at the Sea Kayak Wales project came across the term when we were looking for ways to make it easy for others to post those very web gems (of particular interest to sea kayakers). Turns out that wrapping a line of JavaScript into a smidgeon of HTML creates an object (called a bookmarklet) that can be dragged onto the bookmark bar of a modern web browser. Once there, it can be left in place until the user of this natty little tool comes across a web page or blog post that they would like to add to the Sea Kayak Wales news page. When that happens then all they have to do is click the SKW News bookmarlet  and that line of JavaScript will leap into action and take the user to the Sea Kayak Wales news insertion page and pre-load the web page address (URL) and title into the form there ready for submission. An amazing time saving utility. The “let” presumably indicates that this is not yet a complete bookmark but that it will become one as soon as you let it.

Anyone interested, can find the SKW News bookmarklet  on the SKW News submissions guide page ( www.seakayakwales.com/WhatToPost.aspx ). If you are using a first class browser such as Firefox, Chrome, Safari or Internet Explorer 9 (IE9) then you can make use of this simple but effective widget. You might need to make the bookmark bar visible on your browser, if it has not been previously used, before dragging the SKW News bookmarklet into position.

The bookmark bar can be activated in Firefox from the View/Toolbars menu option list. In Chrome, click the spanner to get the tools menu, click bookmarks and then select the first option “show bookmarks bar”.  In IE9, (simple but harder to find) just right click on a space in the browser top area to the right of an opened tab and select the “Favourites bar” option from the pop-up menu.

Happy bookmarking

Friday 13 January 2012

I Don’t know

I read a Freeakonomics blog entry on “Why is ‘I don’t know’ so hard to say?”   the other day – you can catch it as a podcast as well.

It was pertinent because we were just launching a new facility on the Sea Kayak Wales news page to allow our members to ask questions of the sea kayaking community.  We were aware that for some people asking a question is hard – in some fields and circumstances it is hard to let others know that you don’t know something.

We know from having run a support forum for a product dedicated to a specific field of knowledge that many professional practitioners (in that meadow at least) are reluctant to reveal any chinks in their armour. They would avoid asking questions in a public arena and always try and elicit a private response. 

These experts were very reluctant to ask their peers for help – although (we divined) they were collectively grateful when we published an anonymised answer for all. This always felt strange – we thought not knowing everything was the normal.

I have an almost endless list of things I don’t know. I enjoy finding out though – and then in many instances promptly forgetting the answers again.  Modern technology allows the comfort of just having to remember where you can find a given answer - not the detail of the answers themselves. You might be amazed at the trivial data I just can’t be bothered to commit to memory.

More importantly though – any software developer is very aware that it is impossible to accumulate expertise on everything – in any case “everything” grows at what feels like an exponential rate. People who work with technology (and software in particular) get used to not knowing the answers.

Some Internet Question and Answer sites are of a questionable value – indeed many are simply designed to flood the search engines and to catch up the unwary into a flood of advertising (and worse) – they truly “don’t know”.  Others are supported by a community of users who are happy to share their ideas in the knowledge that others will help them in turn.

We aim to make the Sea Kayak Wales site  just such a resource – not just for Welsh coastal trips but for every aspect of sea kayaking anywhere.  We hope that Sea Kayak Wales (well the site users) will know and will be happy to answer your questions – beginner or expert without prejudice.

We also hope that questions that have no answer are identified by the community as such – we can debate them, perhaps decide on some effective strategy – but if we don’t know, we resolve not to pretend to know.

Sunday 8 January 2012

Standing on the shoulders of giants

This handy expression can be used by anyone shamelessly incorporating the work and experience of others into their latest project – it even sounds a bit humble.

In fact anyone building a modern interactive web site like us at SeaKayakWales is going to be humbled by both the quality of what is already out there and the generosity with which so much skill and experience is shared with those that follow.

We know that we have some unique problems to solve in devising, presenting and then evaluating the sea kayak trips we will be presenting to users during 2012 and beyond. However, many of these problems can be broken down into sub-problems that have been successfully solved elsewhere. While we have to ensure that our style and processes meet the needs of our intended audience we will always be happy to learn from best practice elsewhere. We don’t want to be “the same” but we do aspire to be “as good” as the best.

There is a potential conflict between the aspiration to be as good as we can get and the desire to ship. “Ship early and ship often” is a great mantra for getting things done but it does mean that the polish might get left behind.  We have come up with a new phrase that might cover it – “pragmatic perfectionism”. 

We will keep trying to improve the way everything works but not at the expense of shipping new stuff – we will have to see how we get on.
We will be acknowledging the primary influences on our user interfaces and technology stack decisions in due course – once the bugs and worst errors have been removed from our efforts.

It would not be a great compliment to others to say we built upon some of their ideas if all we had to expose was our incompetence.

In the mean time, if you have some web sites, blog posts, photographs or what have you likely to be of interest to sea kayakers then please pop over to www.seakayakwales.com sign in and add a link to our news page. While you are there, take a look at the other items being posted – they might well entertain you.