Monday, 12 August 2013

Using Lishman Source for Code Examples

I thought it was high time that I started using lishman source to produce some online code examples of my own. So here goes.

My first attempt looks at Form Validation with Spring MVC, and I will add these in the coming weeks.

One reason for doing this is to experiment with embedding lishman source into existing content, for example, using an iframe:

It's still a bit clunky, and I will need to find a way to condense the information because of the limited width of many blogs, but it's a start.

Thursday, 1 August 2013

New Look Home Page for Lishman Source

lishman source has a new home page.

Hopefully this will convey a little better what the website is all about.

Getting Started with Lishman Source

This entry explains how to upload a project and create a guide in lishman source.

Upload the Source Code

First, create a zip file containing the source code that you wish to upload, then sign in, enter the details of the project, add the zip file and upload.

Create a Guide

Select your new project from the list and you will be taken to the main source page. Here you will see an 'add guide' link in the header.

Click the link and enter details of the guide and the first card in the dialog box.
You can continue adding cards to the guide, up to a maximum of ten.

Going Public

Projects and guides are private by default. To make them public, click on the 'edit' link next to the item on the home page and you will see this screen.

Check the 'Public' box and the project or guide can be seen by the rest of the world.

The Finished Result

The finished result is a guide that makes it easy for users to navigate around the source code of your application.

Wednesday, 17 July 2013

Explaining Source Code with a Guide

lishman source is a platform which allows registered users to upload their own source code and add one or more guides to explain how the source code works.

This walkthrough of a Spring MVC project illustrates how users can easily navigate though the complexities of an application.

Adding a Guide

Adding a guide is simple.

Here, we add some information about the @Valid annotation.

We also indicate that the word @Valid should be highlighted by surrounding it with tildes (~).

Note: there is also an option to highlight text in the source code other than that which is displayed in the guide.

Viewing the Guide

Now, when the guide is displayed, a user can zero in on the area of source code that is being discussed, by simply clicking on the highlight term.

Early Adopters?

lishman source is still under development but if there are any 'early adopters' out there who fancy giving it a try, email me and I will set up a free account for you.

Highlighting Source Code from a Guide

In lishman source, if a word or phrase is underlined in the guide, we can click on it to highlight an area of the source code.

The Introductory guide includes an example of source code highlighting.

Wednesday, 12 June 2013

Source Code Guide

lishman source includes a feature called a guide. The guide consists of a number of steps which help you navigate through the source code.

For example, this guide introduces the guide concept, and this one provides a walkthrough of a simple Spring MVC application.

Tuesday, 28 May 2013

Highlighting Text in Source Code

lishman source allows sections of the source code to be highlighted by specifying the hl fragment in the URL.

From lishsource
For example: