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

Feature requests for future versions of Hollywood can be voiced here
Post Reply
bitRocky
Posts: 104
Joined: Fri Nov 14, 2014 6:01 pm

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

Post by bitRocky » Wed May 02, 2018 2:44 pm

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".

User avatar
airsoftsoftwair
Posts: 2912
Joined: Fri Feb 12, 2010 2:33 pm
Location: Germany
Contact:

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

Post by airsoftsoftwair » Sun May 06, 2018 12:09 am

Do you mean the AmigaGuide version of the manual? Because the HTML version has a navigation bar...

bitRocky
Posts: 104
Joined: Fri Nov 14, 2014 6:01 pm

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

Post by bitRocky » Sun May 06, 2018 12:14 am

Yes, AmigaGuide.

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

User avatar
airsoftsoftwair
Posts: 2912
Joined: Fri Feb 12, 2010 2:33 pm
Location: Germany
Contact:

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

Post by airsoftsoftwair » Sun May 06, 2018 9:43 pm

Sounds like a reasonable suggestion, I'll see what I can do.

User avatar
airsoftsoftwair
Posts: 2912
Joined: Fri Feb 12, 2010 2:33 pm
Location: Germany
Contact:

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

Post by airsoftsoftwair » Sun Jan 06, 2019 9:32 pm

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

bitRocky
Posts: 104
Joined: Fri Nov 14, 2014 6:01 pm

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

Post by bitRocky » Sun Jan 06, 2019 10:37 pm

Thanks!

Post Reply