Robert Shiplett's Blog

2 Posts tagged with the documentation tag
3

The Curl Developer Utilities have not yet moved up to Curl 7, but if you want to install the docs in your Curl 7.0 Documentation Viewer, the step to follow are easy.

 

Start by making a copy of the CDU code folder in one of your curl8 working directories. Then make a copy of the manifest. Use the Curl IDE to create a new EMPTY project in that code directory. Paste back in the contents of the old manifest (the IDE will warn that the manifest.mcurl is being over-written) but edit the resulting manifest.mcurl file to flip up to 7.0 and maybe set the version metadata to 0.3.

 

Now the IDE should show a project with 3 packages. Dbl-click on each package and use the editor to flip the version number in the package expression up from 6.0 to 7.0. Usually you also would have to repeat the same for any .curl or .dcurl file with an applet expression as its header.

 

Right-click on the top pkg and set the component target settings to generate documentation and apply to all packages. Now hit F7 to deploy.. Next use the IDE to select Help | Install Docs. Click the install button on the dialog pane which opens and then navigate to the directory named deploy-default under this new project. Select the manifest.mcurl file. And you now have CurlUnit documentation back in your Curl 7.0 Documentation Viewer.

 

Installing the BlazeDS, SQLite and XML package documentation from sourceforge is just as easy as unzip, then use the IDE F1 | Help | Install Docs and then a click on the install button with navigation to folders named docs-install for each package. Packages usually include example code which is still zipped within the unzipped documentation folders. To try out the BlazeDS examples you are going to want a running Apache application server such as Tomcat.

3 Comments 0 References Permalink
1

If you have a Curl NITRO project and you want to have, say, the documentation for the Curl opensource web toolkit available as a library which you can search when working in Curl7, just add 7.0 to the WSDK docs manifest.mcurl  file.

 

 

For example, I unzipped the 1.0.6 WSDK zip into a Curl7 folder and then went to my

 

 

 

C:\Curl7\WSDK_071120\docs-install\WSDK

 

 

 

and changed the manifest header to

 

 

 

{curl 6.0, 7.0 manifest}

 

 

 

This only means that I can search across those Curl 6 API docs when doing a Curl 7 project without the documentation viewer complaining about a version inconsistency.

 

 

 

If you haven't added documentation before, it is very straight-forward: just open the HELP menu of the doc viewer (the 'help' window of the Curl IDE.)  You will want to select a manifest.mcurl that is in a folder designated as being the 'documentation' version of a package such as the WSDK.

 

 

 

The nice thing about the viewer is that if you close it, close your project and then open a Curl 5 project, the documentation in HELP will now be whatever you have selected (i.e. installed) as your Curl 5 documentation.

 

 

 

Documentation for your own code can be improved by using the macro's   and {doc-next } which are detailedin the Contents menu of the Curl Documentation Viewer in the section

 

 

 

Curl IDE User's Guide

 

 

 

under the heading

 

 

 

Documenting Your Application

 

 

 

Of course, as you may recall, COBOL programmers document best while sleeping.

 

 

1 Comments 0 References Permalink