What is the Dokuwiki folder in OI10 install for (OpenInsight 64-bit) [Revelation On-Line Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
{{tag>category:"OpenInsight 64-bit" author:"Nick Stevenson" author:"bshumsky" author:"Karl Pozmann"}}

[[https://www.revelation.com/the-works|Join The Works program to have access to the most current content, and to be able to ask questions and get answers from Revelation staff and the Revelation community]]


==== What is the Dokuwiki folder in OI10 install for (OpenInsight 64-bit) ====
=== At 10 JAN 2024 11:33:27AM Nick Stevenson wrote: ===
 
 
<QUOTE>
Just preparing to deploy an upgrade from 9.4.4 to 10.2.1 and noticed a folder within OI10 called Dokuwiki. What is this for, is it required for dev/runtime?
</QUOTE>
----

=== At 10 JAN 2024 11:50AM bshumsky wrote:  ===

<QUOTE>
<QUOTE>Just preparing to deploy an upgrade from 9.4.4 to 10.2.1 and noticed a folder within OI10 called Dokuwiki. What is this for, is it required for dev/runtime?</QUOTE>



Hi, Nick.  When running OpenInsight, the on-line help accesses copies of the OI manuals in your OI folder to provide you the relevant information - for example, if you are in the stored procedure editor, and you press F1 while the mouse cursor is on a keyword, OI will bring up a help page with documentation on that keyword if it can find it.



As you may have read earlier in the Works forum, we've created a wiki that contains all the OpenInsight documentation, as well as additional community information.  Right now, that wiki is available for viewing on the web site, but our plan is to make the wiki the default source for the on-line help in your OI system as well.  Towards that end, we have provided in 10.2.1 a "pre release feature" for those who wish to try out the wiki, versus the old style manual, help.  The wiki source, and required helper routines, are in that dokuwiki folder.



We anticipate moving to the wiki as the default on-line help with OpenInsight 10.2.2 or OpenInsight 10.3.



In the interim, certainly for runtime systems, and in dev systems where you don't wish to try out the wiki version of the on-line help, you can delete that folder.  Conversely, if you (or other readers of this thread) do use the on-line help and wish to try the wiki version, you can enable it in an application by going to System Monitor and typing in:



RTI_ENABLE_WIKI_HELP <option>



where <option> is "0" to disable the wiki help (the current default), "1" is to enable the wiki help using the version on the revelation.com/wiki server, and "-1" is to enable the wiki help using the local version provided in the "dokuwiki" subfolder.



So, if you wanted to use the new, local dokuwiki for on-line help, you would issue the command:



RTI_ENABLE_WIKI_HELP -1



And to return to the "classic" on-line help, you would issue the command:



RTI_ENABLE_WIKI_HELP 0



For anyone who [i]does[/i] try it, please let us know if you have any questions or problems...



Hope that helps,



- Bryan Shumsky

[url=https://www.revelation.com]Revelation Software, Inc.[/url]

</QUOTE>

----

=== At 10 JAN 2024 12:02PM Nick Stevenson wrote:  ===

<QUOTE>Thanks Bryan, that's extremely helpful.

</QUOTE>

----

=== At 10 JAN 2024 01:13PM Karl Pozmann wrote:  ===

<QUOTE>OK got it to work locally.  What is the recommended way (if any) to add/edit our own content?  What is the "Login" for on the main page?

</QUOTE>

----

=== At 10 JAN 2024 02:06PM bshumsky wrote:  ===

<QUOTE>Hi, Karl.  Glad it's working for you.



There's really no provision for you to update the information in the dokuwiki folder directly, if for no other reason that each time you run an update from Revelation, we are likely to provide a new folderful of information.  In addition, we've concentrated on making sure that OpenInsight can _view_ these pages; I don't know if all the additional helper routines will work for updating them.



However, if you wanted to create and add your own content, I imagine you could do so by doing the following:

- install dokuwiki on your own PC - you will probably want to use "dokuwiki on a stick" which provides everything you need to get it running.  Read more about it (including where to get it) [url=https://www.dokuwiki.org/install:dokuwiki_on_a_stick]from this link[/url];

- create your own content in your own DokuWiki - I'd suggest putting it in your own "namespace" - you'll see that we have put things into namespaces like "arev", "forums", etc.  You'll find it easier if you start everything with your own namespace;

- When you wish to make your wiki pages available in the OpenInsight instance, you can copy the relevant pages into the proper location in your OI folder.  Dokuwiki is a document-based wiki - each page is its own .txt document.  You'll find your pages in the folder <dokuwiki>\data\pages and (if there is any media, such as images, associated with your wiki pages) <dokuwiki>\data\media.  Your namespace will be a folder under that (or those) directories - each "namespace" is its own folder, or subfolder under the one above.



So, if you installed dokuwiki on a stick to c:\dokuwikistick, and you had a namespace called "PersonalPages", with wiki pages named "Page1", "Page2", and "Page3", you'd find text documents page1.txt, page2.txt, and page3.txt in the folder c:\dokuwikistick\dokuwiki\data\pages\personalpages.  Note that the folders and page names should all be lower case, since that's how DokuWiki addresses them.



You would then copy from c:\dokuwikistick\dokuwiki\data\pages\personalpages to your OI folder, in the dokuwiki subdirectory, creating a new folder (or series of subfolders) under data\pages (and data\media, if required).  So long as you don't use the same "namespace" as something that is provided in the update, I believe applying subsequent updates from Revelation Software to that copy of OpenInsight would maintain your existing content.



Please be sure to read more about DokuWiki and how to manage it [url=https://www.dokuwiki.org/dokuwiki]on the DokuWiki "start" page[/url].



Hope that helps,





- Bryan Shumsky

[url=https://www.revelation.com]Revelation Software, Inc.[/url]

</QUOTE>

----

=== At 10 JAN 2024 03:30PM Karl Pozmann wrote:  ===

<QUOTE>Thanks!  I will give it a shot!

</QUOTE>

----

=== At 10 JAN 2024 04:35PM Karl Pozmann wrote:  ===

<QUOTE>Haven't read the docuwiki docs yet but will it be possible to bring up specific pages/topics from the application to make it context sensitive?

</QUOTE>

----

=== At 12 JAN 2024 03:17PM bshumsky wrote:  ===

<QUOTE>
<QUOTE>Haven't read the docuwiki docs yet but will it be possible to bring up specific pages/topics from the application to make it context sensitive?</QUOTE>



Hi, Karl.  I'm not certain I understand your question here.  Are you asking if, in (for example) the stored procedure editor, you hit F1 on a keyword - will it bring up the wiki for that keyword?  If so, then yes, that's what we just optionally turned on with the RTI_ENABLE_WIKI_HELP.



Or are you asking if you can hook other parts of OI - for example, an OI form - to the wiki for help?  The fields of  your OI form support a "help" event, and I think you should be able to call the RTI_DSN_HELP routine with the appropriate parameters to have it bring up the relevant page.  Note that I haven't tried this yet, and it might take a few more tweaks to make it happen, but I can see it being supported (if that's what you're asking about).



Or maybe I've misunderstood you completely...?



- Bryan Shumsky

[url=https://www.revelation.com]Revelation Software, Inc.[/url]

</QUOTE>

----

=== At 12 JAN 2024 03:42PM Karl Pozmann wrote:  ===

<QUOTE>Yes - tying it to a form is what I was thinking about doing.



Thanks!

</QUOTE>

----

=== At 12 JAN 2024 03:46PM Karl Pozmann wrote:  ===

<QUOTE>Yes - tying it to a form is what I was thinking about doing.



Thanks!

</QUOTE>


[[https://www.revelation.com/revweb/oecgi4p.php/O4W_HANDOFF?DESTN=O4W_RUN_FORM&INQID=WORKS_READ&SUMMARY=1&KEY=4EC202AB65750446ACA12E59662B8272|View this thread on the Works forum...]]