INTERACTIVE DOCUMENTATION SYSTEM FOR DATABASE PARAMETERS
Help documentation for the application may include a discussion of parameters in the application. Parameters for an application may be displayed through a web-based interface along with information for each of the parameters. Additional information may be obtained regarding the parameters by allowing interactive access with databases supporting the application. For example, when a user clicks a parameter name in the help documentation, a value for the parameter and additional data may be retrieved from the parameter database and displayed to the user in a pop-up window.
1 . A method, comprising:
accessing a first database to retrieve documentation;
accessing a second database to retrieve at least one value for the at least one parameter in a first database; and
displaying the documentation and at least one parameter value to the user.
2 . The method of claim 1 , further comprising displaying a help file before accessing the first database, the help file comprising information corresponding to the parameter.
3 . The method of claim 2 , in which the help file comprises documentation regarding the parameters.
4 . The method of claim 2 , further comprising receiving a request from a user for information about one parameter before the step of accessing the first database and the step of accessing the second database.
5 . The method of claim 4 , in which the step of receiving the request comprises receiving a notification that a user has clicked on the parameter.
6 . The method of claim 2 , in which the step of displaying the help file comprises transmitting a hypertext markup language (HTML) document and the step of displaying the values and the documentation comprises transmitting an extensible markup language (XML) document.
7 . A computer program product, comprising:
a non-transitory computer readable medium comprising:
code to access a first database to retrieve documentation;
code to access a second database to retrieve at least one value for the parameter in a first database; and
code to display the documentation and the at least one parameter value to the user.
8 . The computer program product of claim 7 , in which the medium further comprises code to display a help file before accessing the first database, the help file comprising information corresponding to the parameter.
9 . The computer program product of claim 8 , in which the help file comprises documentation regarding the parameters.
10 . The computer program product of claim 8 , in which the medium further comprises code to receive a request from a user for information about one parameter before the step of accessing the first database and the step of accessing the second database.
11 . The computer program product of claim 10 , in which the code to receive the request comprises code to receive a notification that a user has clicked on the one parameter.
12 . The computer program product of claim 8 , in which the code to display the help file comprises code to transmit a hypertext markup language (HTML) document and the code to display the values and the documentation comprises code to transmit an extensible markup language (XML) document.
13 . A system, comprising:
a parameter database;
a documentation database; and
a processor coupled to the parameter database and coupled to the documentation database, in which the processor is configured:
to access a first database to retrieve documentation;
to access a second database to retrieve at least one value for the at least one parameter in a first database; and
to display the documentation and the parameter values to the user.
14 . The system of claim 13 , in which the processor is further configured to display a help file before accessing the first database, the help file comprising information corresponding to the parameter.
15 . The system of claim 14 , in which the processor is further configured to receive a request from a user for information about one parameter before the step of accessing the first database and the step of accessing the second database.
16 . The system of claim 13 , in which the processor is further configured to receive a notification that a user has clicked on the one parameter.
17 . The system of claim 13 , in which the help file comprises a hypertext markup language (HTML) document and the display of the documentation and parameter comprises an extensible markup language (XML) document.