Creating online help based on external documentation

Hi there
I am in the process of writing a "handbook" for one application I have built. I will write it using MS Word, and it will have detailed information on how to use the app, including screenshots, arrows and other drawing objects.
I would like to add some online help to the app also, but instead of re-entering the same information manually in Apex (that would be limited to text only) I would like to re-use the document I will create in Word. Has anyone implemented anything like this?
One solution for this that I am considering is to break down the handbook file into a number of smaller files, one for each page, and upload them into Oracle as BLOBs (in a table with app_alias and page_id as PK). Then the help page would download and display these files (in some way, not sure how yet).
Ideally, the whole document should be uploaded as a BLOB and somehow the program should be able to extract only the bit that is relevant to the current page and display it.
Any comments/suggestions?
Thanks,
Luis

Hi
I don't think it is possible to know that (except if you ask the Apex dev team directly I suppose).
The solution I used was to create a Word document with the application help and export it as HTML. Then copied the HTML to a directory in the server and created a link in the app to open that HTML in a popup window.
I hope this helps.
Luis

Similar Messages

Need to Create Search Help Based on Condtions from one table to another tab

Hi All,
I have a table like ZGROUP Which contains the data below
Filed name Filed Name Filed Name
ZGROUP ZTYPE ZTEXT
Entries
ABC P TEXT FOR
C P SDFNSDFKLN
DDDD PSG TEPRTPERERTWERT
DEF P TEST
FFFFF PSG
SEF PS SDFSDFLASLDFNASDLFN
XYZ PS TESTING
Whree P is Product , PS- Point of Sales, PSG-Sales Group
Now i am going to crate another ZPROUDCT TABLE
FIELDNAME FIELDDESCRITPON
PRODUCT PROD_DESC
Entry
abc pRELATED ENTRY
My Questions
1) ZGROUPS table has 3 kinds of data P, PSG, PS type records,
1) In Table ZPROUDCT , I want to create search help only P records for Table Zproduct of the field Product FROM zGROUPS table
2) In Table Zsales , I want to create search help only PS records from ZGROUPS table
3) In Table ZPSG, I want to create search help only PSG records from table ZGROUPS
is it possible to create search help from One Master Table(ZGROUPS) table to other tables based on conditions.
Please help me.
very urgent
Regards,
Raju

if <condition>
AT SELECTION-SCREEN ON VALUE-REQUEST FOR <field>
SELECT <field>
         FROM <table>
         INTO TABLE i_tab
CALL FUNCTION 'F4IF_INT_TABLE_VALUE_REQUEST'                  "function module to provide f4 help to sold-to-party
    EXPORTING
      retfield        = "XXXX"
      dynpprog        = sy-repid
      dynpnr          = sy-dynnr
      dynprofield     = '<field name>'
      value_org       = 'S'
    TABLES
      value_tab       = i_tab
endif.
lkike this u can check the condition and selec the data from table and assign it into one internal table and then call the FM it will give the f4 help to particular field
reward if helpful
regards,
Khan.

FIND -error in HTMLDB ONLINE HELP

Hi,
When i click on "Help" link in HTMLDB development environment i am able to see the online help page. the "Contents" and "Index" hyperlink are working but when i click on "Find" i get the following error:
Error creating online help index.
ORA-29855: error occurred in the execution of ODCIINDEXCREATE routine ORA-20000: Oracle Text error: DRG-10700: preference does not exist: CTXSYS.DEFAULT_LEXER
But Oracle Text and Oracle XML are properly installed in the database and they are valid.
Can someone help please,
Thanks,
Philip.

Hi,
there should be a problem in your context-install.
If Oracle TEXT is installed, perhaps only the default language install is missing:
run as ctxsys
@drdefXX for us: @drdefus for german:@drdefd
in the documentation for install htmldb2.0 I assume is an error:
c:\> sqlplus sys/SYS_password as sysdba
SQL> @c:\oracle\product\10.2.0\db_1\ctx\admin\defaults\drdefus.sql
you have to run your @drdefXX as CTXSYS not as "SYS AS SYSDBA"
metalink.oracle.com:->Note:280713.1
I have made a forum-entry at metalink too, you will find both if searching in metalink for: catctx.

APEX 3.0 - Online Help Search Error on Text Index

When I click on Help and then Find and attempt to search the online help the following error is returned
ORA-29855: error occurred in the execution of ODCIINDEXCREATE routine ORA-20000: Oracle Text error: DRG-10700: preference does not exist: CTXSYS.DEFAULT_LEXER
Error creating online help index.
We are running:
Application Express 3.0 on Oracle 10g Enterprise Edition Rel 10.2.0.3.0 - 64 bit with partitioning, OLAP and Data Mining Options
Message was edited by:
CFrishett

Hi CFrishett,
Try searching the forum for DRG-10700. It sounds like there is a problem with your Oracle Text installation.
Regards Pete

How to build online help for froms

dear colleague,
i need to build an on online help based on word file, meanwhile i need to facilate the search ability in this help and table of content also, can anyone help in how to devlope this function??

<p>Maybe this solution could help you.</p>
Francois

FM12-XML online help files

How do I find original source files for an XML-generated online help system created in FM12? What are POM files?
I must take over from previous tech writer to fix the files and regenerate them and I haven't a clue how to do it in FM 12.
I've created online help in the past, using RoboHELP without any coding.
HELP PLEASE. I am under the gun and struggling.
Thanks.

A quick search on the 'Net suggests that .pom may be
File used by Maven, a Java program used to build Java applications and manage their dependencies; contains build information, such as required software dependencies, dependency scope, and packaging information. […] NOTE: POM files are more commonly seen with an .XML file extension. They most commonly use the filename pom.xml.
Another post says
Maven POM files are not eBooks. They are configuration files for the Maven software dependency management system for building Java software. […] If the files you have downloaded are indeed Maven POM files, then they are a type of XML text file. You should be able to open them in a web browser or a text editor like Wordpad.
As for how to start from FM and get to .pom files, I'm afraid I have absolutely no idea. I'll watch this thread with interest … and sympathy :-}

Need suggestions for proofreading online help files

I have created online help docs off an on for many years...
and have contemplated this issue several times and never come up
with a really good answer.
Right now, the product manager is tryiing to proof one of the
online help files that i've COMPLETELY revamped and he's
complaining about the time this is taking and how difficult it is
because not all topics are in the TOC...
so I suppose i could regnerate the TOC and include EVERY
SINGLE topic... but I was wondering if anyone else had any other
suggestions for best practices when it comes to reviewing online
help files.
THANKS for any input you might have.

Umm!. I have to admit that I find your approach of adding ALL
topics to the TOC works as well as any. However it does cause
problems where one or more popup topics appear in the same topic.
This causes a bit of uncertainty unless there is a clear indication
in the topic where a popup exists and an understanding of what TOC
topic to look at. What I tend to do is have a piece of text (e.g.
see popup titled xxxxx) which has a conditional build tag on it.
Then you include the build tag when you compile. I also tend to
have all the popups in a separate book in the TOC. You can then
easily remove all the popups from the finalised output. It means a
bit of tossing and turning between TOC chapters but seems to work
reasonably well. You could also produce two printed copies, one
containing the popups and another containing the main topic
content. Hope this helps solve your conumdrum.

Online help index error w.r.t oracle text

Hi,
Error creating online help index.
ORA-29855: error occurred in the execution of ODCIINDEXCREATE routine ORA-20000: Oracle Text error: DRG-10700: preference does not exist: CTXSYS.DEFAULT_LEXER
when i click on help on htmldb and then when i click on find. i get this following error.
how do i fix this error.
Can someone help me please.
THanks,
Philip.

Steps to resolve the domian index creation problem:
Step 1: Ensure the schema CTXSYS does not exist, if exists ignore the execution of “step 2”.
Step 2: Add the below mentioned statement above the existing statement(also mentioned below) in the catctx.sql file which is in the $ORACLE_HOME/ctx/admin" location.
Existing statement : Rem CTXDEF.sql - ctx default object creation
Statement to be added: grant execute on CTX_DDL to ctxsys ;
     In SYS user login, execute the script to create CTXSYS schema and its related objects after confirming below parameters to this script
     ctxsys           - password of CTXSYS schema
     SYSAUX     - default tablespace
     TEMP           - default temp tablespace (Replace if your database default temporary tablespace is different)
SQL>@$ORACLE_HOME/ctx/admin/catctx.sql ctxsys SYSAUX TEMP NOLOCK
Step 3: In SYS user login execute the below script to recompile user objects
     SQL>@$ORACLE_HOME/rdbms/admin/utlrp.sql
Step 4: In CTXSYS user login, execute the below script to create default preference for language ENGLISH
     SQL>@$ORACLE_HOME/ctx/admin/defaults/drdefus.sql
Step 5 : In SYS User login ,execute the below script to give grant permission
SQL>grant ctxapp to DBusername identified by Password;
SQL>grant select on ctxsys.dr$preference to DBusername;
SQL>grant execute on CTX_DDL to DBusername;
Step 5: Login as DB user and execute the below drop index script if any already exists in same name
     SQL>DROP INDEX LEI_CATALOG_SEARCH_SFIELD
Step 6: Login as DB user and create the below domain index
     SQL>CREATE INDEX LEI_CATALOG_SEARCH_SFIELD ON LET_CATALOG_SEARCH (SEARCH_FIELD) INDEXTYPE IS CTXSYS.CONTEXT;
Regards,
Kamal.C
Edited by: 871818 on Jul 12, 2011 2:17 AM

Benefits of Online Help vs. Interactive PDF?

Can someone provide me a list of good reasons to create
online help rather than create an interactive pdf? In general this
would be for any type of project. Specifically, the projects would
be for software support.
Thanks!

Hi Cindi,
Thank you for your thoughts. I'm glad you believe online help
is the way to go, because I feel the same way and I am trying to
justify my job. But I am having a hard time putting together a
definative list of reasons. For all of your great ideas, I can come
up with ways to handle this with a pdf that may sound reasonable to
my management (see below). You said the list goes on and on. Can
you please expand on your list? Thanks!
1. Quick access to up-todate info without having to email,
etc (We would have the pdf accessable from the Web server, Intranet
or Internet and therefore would also be quick and easy to update
and ensure customer is accessing current version.)
2. Colors, and hyperlinks, and map ids, etc (Pdfs can handle
colors and hyperlinks. We currently aren't using map ids. The ones
here that I think are valuable are pop-up, drop-down, and expanding
links, as well as map ids, which we will potentially use.)
3. You can add pdfs to an online help system but you can't
add pdfs to a pdf file. (You can link from a pdf to another pdf. A
pdf can also launch a Captivate movie right inside the pdf.)
4. Document preservation - easy to keep a backup of what a
database instance was at a certain date. (This is only if you have
this feature on your HATT - we currently don't. We source control
outside of our HATT. This would be no different for pdfs.)
Thanks again!
Lynn

German Online Help?

Hello Community,
we are using APEX 3.0.1 within Oracle Database 10gR2. Basically everything works fine.
I did set up the german application translation for APEX so that the websites are all translated to the german language. Also i activated Oracle Text so that i can use the Online Help for APEX.
Is there any way to translate the APEX Online Help to german? Or: is there any german Online Help for APEX available anyway?
When i click on the appropiate link ("Klicken Sie hier, um Informationen zu den ersten Schritten anzuzeigen") it opens the help, but the content is all english.
Anything would help,
André

Hi André,
Item-level help is translated. But the online help sourced from the documentation is only available in English (and in Japanese in some releases).
I realize this isn't exactly the kind of help you're looking for, but I can point you to some sites which discuss APEX in detail:
http://htmldb-de.blogspot.com/
http://www.oracle.com/global/de/community/index.html
Mit freundlichen Grüßen,
Joel

Online help doesn't work

I have just installed HTML DB stand alone release on my W2000 9.2.0.5 database.
The install process worked fine.
But the HTML DB online help doesn't work. when i click on the help icon the popup is there but with no contents.
When i click on the link:
Find (initial index creation may take several seconds)
This errors appears:
Error creating online help index.
ORA-29273: HTTP request failed ORA-06512: at "SYS.UTL_HTTP", line 1022 ORA-12545: Connect failed because target host or object does not exist
I thought that my oracle text was not or improperly installed because the CTXSYS account was locked. So i decided to reinstall it but with no success.
I decided to reinstall HTML DB (local install this time)but again it doesn't work
I searched in the forum, but it seems that nobody had meet the same issue, except HTMLDB.com (reinstall of oracle text was the solution)
I would like to try this new product but with the online help
Thanks in advance

Just to clarify why this is happening this way.
The online help contents are not loaded nor indexed at installation time. In a new installation, the very first time the help window is displayed and you click the 'Find' link, the help contents will be fetched and indexed using Oracle Text. They are fetched via HTTP by GETting them from the Oracle HTTP Server (they are static files under the images hierarchy, after all).
The URLs to fetch the help documents are constructed using the SERVER_NAME CGI environment variable as a component of the URL. So at indexing time, the database will issue HTTP GET requests to a specific URL, and if this URL cannot be located or the name not resolved, then issues will arise like you have witnessed.
Joel

Creating an online help screen?

I am creating documentation for my company, and the ideal way to present it would be through an online help screen. When users are connected to the website, they would click a link, and a help screen would pop up.
I can make the various pages in Dreamweaver CS5, no problem there. There will be at least 40 or 50 pages when I'm done.
But I need to do more than simply present a bunch of pages. The help screen needs a table of contents. It needs to be searchable (so users can insert a word, and be taken to any pages that contain that word). And it would be great if it could include an index and/or a glossary.
HTML Help Workshop from Microsoft would have been the perfect program to create a compiled .CFM file. I made a test file with it, and it looks great, but apparently, it's no longer possible to access this kind of file over the web, at least not in Windows.
So, I'm wondering if it would be possible to create this in Dreamweaver. Are there any tutorials that address this specific application? Does anyone know of any templates or examples that I could see?
If at all possible, I'd like to do it entirely in Dreamweaver, rather than purchasing a license for Robohelp.

HTML Help Workshop from Microsoft would have been the perfect program to create a compiled .CFM file. I made a test file with it, and it looks great, but apparently, it's no longer possible to access this kind of file over the web, at least not in Windows.
It is possible as long as your server runs ColdFusion, and that can happen in either Windows or *nix.

HP Enterprise - Use Cloud-based HP Online Help to Troubleshoot Printing

HP LaserJet Enterprise printers and HP Officejet Enterprise printers have cloud-based Online Help available to troubleshoot printing issues. HP Online Help users can scan a QR code on the printer display using a mobile phone or tablet, or click an error-specific link in the Event Log of the Embedded Web Server, to automatically retrieve the most relevant and up-to-date information or video to help resolve the issue at the control panel.
Use Cloud-based HP Online Help to Troubleshoot Printing c04672002
Setup and Configure Cloud-based HP Online Help c04671899
https://www.youtube.com/watch?v=IZyuyDz0Nz0

Hi @Sunshyn2005
I timed-out waiting for advice, and contacted HP Support, who helped me get the printer back on the air. While we didn't manage to root-cause it, in the course of trying various things, the tech disabled Norton 360's firewall, which then allowed connecting to the printer, and restoring print service, which remains up after re-enabling the firewall.
The timing of the disconnection doesn't neatly corellate with any Windows updates. My own theory is that it was caused by a 360 update, but am unable to find a smoking gun, since 360 doesn't provide update history. The exact root-cause remains a mystery, but at least provides another thing for folks to try should they find themselves in similar straits.
I really appreciated your hint that a Windows update might be the root cause, and your pointing out how to review the history and back-out updates: this morning, I found that Windows had installed a batch of updates overnight, and found that no browsers worked. Using your advice, I rolled back the update, restoring browsing.
Thanks,
-rjs

How to get online help when creat new filter files in EDS?

I want to creat some my own filter files in order to get Event report from network management station when some special situations appear.
I have run /opt/CSCOpx/bineds -filter,and the Named Filter window appears,I select new a file,later select "add Generic events",during this course I tried to get online help with Help Icon, but the messages:"could not run netscape to display help netscape:not found."appears.
But I have install the netscape in the directory /opt/netscape, why it can't be found?I want to know whether there is some conf file in some place that has named a path name for the netscape diffrent from /opt/netscape.Is ther any such files?Thanks very much!

Since there has been no response to your post, it appears to be either too complex or too rare an issue for other forum members to assist you. If you don't get a suitable response to your post, you may wish to review our resources at the online Technical Assistance Center (http://www.cisco.com/tac) or speak with a TAC engineer. You can open a TAC case online at http://www.cisco.com/tac/caseopen
If anyone else in the forum has some advice, please reply to this thread.
Thank you for posting.

Providing online Help for Flex-based applications

I have been asked to provide online Help for a Flex application. As I have never done this before, I have a few questions:
- What is the format for the Help topics?
- Are there control-type files (e.g., TOC, index, project file) that need to be created? If so, what is the format for these?
- Is the Help compiled? If so, which compiler is used?
- How is context-sensitive Help created?
I'd also like to know if there are any resources I could look at that covers these Help issues. Thanks.

Hi,
You can acheive the same by the addition of [USER-COMMAND fcode].
RADIOBUTTON GROUP group [USER-COMMAND fcode] - The addition USER-COMMAND can be used to assign a function code fcode to the first parameter in a radio button group. The function code fcode must be specified directly, and have a maximum length of 20 characters. When the user selects any radio button of the radio button group on the selection screen, the runtime environment triggers the event AT SELECTION-SCREEN and transfers the function code fcode to the component ucomm of the interface work area sscrfields.
So you code should be altered as
PARAMETERS: rb_appl RADIOBUTTON GROUP rad
                     USER-COMMAND radclick    "Addition which you have to make.
                     DEFAULT 'X',
            rb_pres RADIOBUTTON GROUP rad ,
            p_file   TYPE ibipparms-path.
AT SELECTION-SCREEN ON VALUE-REQUEST FOR p_file.
IF rb_appl = 'X'.
    PERFORM f_applictn_server_filenm.
ELSEIF rb_pres = 'X'.
    PERFORM f_presentation_filenm.
ENDIF.
Thanks & Regards,
Harish

Creating online help based on external documentation

Similar Messages

Maybe you are looking for