This topic is locked
[SOLVED]

 help file

6/9/2020 8:04:09 PM
PHPRunner General questions
N
Nir Frumer author

Hi all

I have decided to add help file to my phprunner, using phprunner with 1 or more tables - haven't decided yet.

has anyone tried it?

Any tips or recomendations are welcome.
thanks in advance,

Nir.

Sergey Kornilov admin 6/10/2020

What does it mean - "add help file to my phprunner"?

N
Nir Frumer author 6/10/2020



What does it mean - "add help file to my phprunner"?



hi,

help file = operation manual for end users,

A bit like what you do with "Manual Premium Pack"

hope this clears my intention.
Nir.

Sergey Kornilov admin 6/11/2020

It all depends on how exactly you need to integrate it. In the simplest form, you can just add a link to the manual to your main menu.

N
Nir Frumer author 6/11/2020

hi

I was expecting some ideas like:

. should I use 1,2 or may be 3 tables?

. should I add filter panel for search?

. would it be a good idea to present it on a 2 or 3 part dashboard etc...
thanks in advance

Nir.

Sergey Kornilov admin 6/12/2020

I can possible link any of these questions with "adding help file to PHPRunner application". Just have no idea.
You really need to explain what this all means.

N
Nir Frumer author 6/12/2020

hi

I'm creating a manual, integrated to my project.

What I have in mind is something (quite) similar to the phprunner online manual in functionality,

With 1 difference, The client's administrators will be able to add/remove/modify the manual.
Right now I'm working on the content in Excel

My columns Id, Chapter, Topic , Description (html content), Order (Int), keywords (comma seperated)
what I have in mind:

Opt 1. using list page with fixed 'search panel' or 'filter panel'...

Opt 2. using dashboard
I was trying to open a discussion about this topic. As I hope that someone who has done it before would be interested to share..

Or just give me and the community some ideas on what/how to do it
as I believe that this could be a great addition to any comercial implementation using Xlinesoft's products.
hope I made myself clear.

M
MikeT 6/12/2020

Don't know if you've seen this, but there's an older blog entry with some ideas (not by me): http://paulirvine.com/2015/06/02/making-a-context-sensitive-help-app-in-phprunner/

N
Nir Frumer author 6/12/2020

hi Michael

I haven't seen it before, but read it quite carefully.

But:

  1. my approach is of a Manual hence, context sensitive is not part of it..

  • although (in my opinion) it would be a lot easier doing it by retrieving the active page from its $_SESSION variable...
  • or establishing an F1 call from javascriptOnLoad on all pages.
    What really interests me is: what would be the "nicest" way to display tha n¡manual to the end user..
    thanks for your reply.

Sergey Kornilov admin 6/16/2020

Just for inspiration, this is how we do it in PHPRunner live demo:

https://xlinesoft.com/blog/2020/06/16/context-help-in-your-web-applications/