improving online documentation

Robert McWilliam rmcw at allmail.net
Wed May 2 05:56:56 UTC 2007


On Wed, 2 May 2007 05:37:22 +0530
"shirish agarwal" <shirishag75 at gmail.com> wrote:
> 
> Hi all,
>      I may have misunderstood the link "[:PageName:page name]" Is
> this how it should appear
> https://help.ubuntu.com/community/%5b%3aFsckhowto%3aFsck_howto%5d#preview
> or no?
> When I look both at the heading as well as the hyperlink at the URI
> address it looks bad. Please lemme know the correct way of writing
> it. Cheers!

That format is for making links to pages not naming pages. In the
example "[:PageName:page name]" Pages should still be called something
like PageName (e.g. FsckHowto) but then when linking to them from other
pages you use the construct to get proper text links rather than
PageName (e.g. [:FsckHowto:fsck howto] will create a link to the page
FsckHowto with the link text "fsck howto").

Note you can use this construct to give any arbitrary text for the link
to show up as, there is no need for it to be related to the page name
you are linking to.

________________________________________________________
Robert McWilliam     rmcw at allmail.net    www.ormiret.com

Press any key to continue or any other key to quit...




More information about the ubuntu-doc mailing list