OpenVPN PC client to Gargoyle OpenVPN server

[ispyisail]

Hi all

just finished a how-to for OpenVPN PC client to Gargoyle OpenVPN server.

https://www.gargoyle-router.com/wiki/do ... pctorouter

As usual corrections welcome

[d3fz]

Thank you for another well-elaborated tutorial, ispyisail.

I've been thinking in a way to help users directly through the UI. The idea is to add a link which will redirect user to the respective online wiki tutorial. That saves time and point users in the right direction right away.

Something like this:


This could apply to a lot others page as well.

Thoughts ?

[ispyisail]

No objections from me

[Lantis]

Like it a lot.
But needs to implemented in a way that makes it easy to update.

Similar to i18n in my eyes.

[d3fz]

Exactly.

Something like (or just like) i18n, create/reuse a single i18n.js file to add/maintain all wiki tutorial links, maybe even some useful tooltips as well ?

Example, using strings.js (currently read by all pages):

Code: Select all

UI.HelpBridgeRepeater="www.gargoyle-router.com/wiki/doku.php?id=bridge_repeater";
UI.HelpMsg="Need help with this ?";

<a href='<%~ HelpBridgeRepeater %>'><%~ HelpMsg %></a>

Or even redirect straight to a specific section:

Code: Select all

<a href='<%~ HelpQoS %>#total_bandwidth_field'><%~ HelpMsg %></a>

The syntax is probably wrong, but you get the idea.

[Lantis]

Yep nice.

I’ll look at this tonight. If I can get the syntax right, I might create a new post and we can get a list together of useful links, and any we think are needed/missing

[ispyisail]

If you put it into a table format (or something like that) I can fill it out for you.

I assume if the table/record is blank the link will be blanked out?

I assume this will be the case for non-English?

Or is every language going to have English?

Do you need to ask Eric first?

[Lantis]

Code: Select all

<span class="ext_help"><a href="<%~ external_help.ggweb %><%~ external_help.hlpBrdgcfg %>"><%~ external_help.HelpText %></a></span>

That's the format i ended up using. I'll add the ability to turn these help messages off as well.

If we can get a list of links to help docs and where you think they should be linked from i can format the rest

e.g.
Link from the heading of the Bridge Config section on Basic.sh
https://www.gargoyle-router.com/wiki/do ... e_repeater

[d3fz]

That's the format i ended up using. I'll add the ability to turn these help messages off as well.

How's the progress so far ? Turning these into optional is great, i wonder if we could do the same to alert panels (or at least make them collapsible) ? This would free up some space in mobile, and gives the average user the ability to just them off, if they want to.

If we can get a list of links to help docs and where you think they should be linked from i can format the rest

ispyisail provided a helpful table to map all the necessary links, i'll use that as a reference to add other ones myself.

And last, should i open a new issue on github regarding this new feature, or is that section only oriented for bug reports ?

If you could please reply this post into the "Helper Links" thread created by ispyisail, that would be great to keep track of all posts/ideas.

Thanks.