Page 1 of 1

Hollywood.guide: Add a link to the appropriate library node?

Posted: Wed May 02, 2018 2:44 pm
by bitRocky
It would be nice to have a link to the appropriate library section in every function of that library!

For example: the node "AddStr" of the "String Library" currrently looks like this:
@NODE AddStr "Hollywood Guide"

@{b}NAME@{ub}
AddStr -- append substring to a string

@{b}SYNOPSIS@{ub}
var$ = AddStr(string1$, string2$)

@{b}FUNCTION@{ub}
Appends "string2$" to "string1$" and returns the new string.

This function is obsolete and only here for compatibility reasons.
Starting with Hollywood 2.0 you should use the @{"string concatenation" LINK PrgOprStrng}
@{"operator.." LINK PrgOprStrng} for concatenating two strings.

@{b}INPUTS@{ub}
string1$ source string
string2$ string to append

@{b}RESULTS@{ub}
var$ resulting string

@{b}EXAMPLE@{ub}
test$ = AddStr("Hello", " World!")
Print(test$)

This will print "Hello World!"

@ENDNODE
I would like to also have a
@{b}SEE ALSO@{ub}
@{"String library" LINK LibString}
The advantage would be that, if you open the guide directly to show the node "AddStr", you could jump back to other functions of the same library!

Currently, I have to click on "Contents" to show the main node, that scroll down to the link of the "String Library".

Re: Hollywood.guide: Add a link to the appropriate library n

Posted: Sun May 06, 2018 12:09 am
by airsoftsoftwair
Do you mean the AmigaGuide version of the manual? Because the HTML version has a navigation bar...

Re: Hollywood.guide: Add a link to the appropriate library n

Posted: Sun May 06, 2018 12:14 am
by bitRocky
Yes, AmigaGuide.

I have a script in FlowStudio to open the AmigaGuide file showing the node of the function.

Re: Hollywood.guide: Add a link to the appropriate library n

Posted: Sun May 06, 2018 9:43 pm
by airsoftsoftwair
Sounds like a reasonable suggestion, I'll see what I can do.

Re: Hollywood.guide: Add a link to the appropriate library node?

Posted: Sun Jan 06, 2019 9:32 pm
by airsoftsoftwair

Code: Select all

- Change [Doc]: In the AmigaGuide documentation, the manual pages of all library functions have an
  additional "SEE ALSO" entry at the bottom now which links back to the index of functions for the
  specific library

Re: Hollywood.guide: Add a link to the appropriate library node?

Posted: Sun Jan 06, 2019 10:37 pm
by bitRocky
Thanks!