Documentation links

15 Nov 2010

When creating a Wiki page in the handbook it's possible to embed a link to a project. However, even doing just a minor update means all handbook pages have to be editted again to reflect the newly released version of the project.

Is there a way to embed a link that always points to the latest version of a project to save having to continually edit the handbook?

16 Nov 2010

Hi Andy,

If you change the version hash in the url to "latest", then it'll always pull in the latest version. For example:

<<library http://mbed.org/users/simon/libraries/Servo/le3jpb/docs/classServo.html>> for a specific version
vs.
<<library http://mbed.org/users/simon/libraries/Servo/latest/docs/classServo.html>> for the latest version

The next version of the site will have an "embed" box to make it easy to copy the wiki text/url. We've currently made it default to the specific version so if you documented something it'd be correct at the time of writing. I wonder if making it "latest" by default would be better, as someone can always enter the specific url to document specific versions when and where they needed to.

Simon

16 Nov 2010

Simon,

Thanks, that's just what I needed

example:-

http://mbed.org/users/AjK/libraries/MODMAX7456/lhwlxw/docs/group__MAX7456__API.html

is now:-

http://mbed.org/users/AjK/libraries/MODMAX7456/latest/docs/group__MAX7456__API.html

so it even works for @defgroup pages! :)

--Andy

16 Nov 2010

Oh, sorry to trouble you again. One more thing, As an example:-

When I put this library together, I used @ingroup API on all of the API methods. This works fine, the @defgroup page can be found here:-

http://mbed.org/users/AjK/libraries/MODGPS/latest/docs/group__API.html

However, when you go to the library's main page here:-

http://mbed.org/users/AjK/libraries/MODGPS/latest/docs/classGPS.html

There's no "easy link" to groups. I only found that the "group page" existed by accident when I clicked one of the methods that led me to it. Is it possible to show defined groups as part of the "Classes and structs, file list and functions" links to the left hand side? That way people can go straight to the page where the library author intended to want people to start out. Most libraries export an API of some sort and having "easy links" to @defgroups would be a useful feature, esp when writing cookbook pages.