[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
gnue/gnue-config/base/language classes/language...
|
From: |
Neil Tiffin |
|
Subject: |
gnue/gnue-config/base/language classes/language... |
|
Date: |
Sun, 17 Jun 2001 07:55:37 -0700 |
CVSROOT: /home/cvs
Module name: gnue
Changes by: Neil Tiffin <address@hidden> 01/06/17 07:55:37
Modified files:
gnue-config/base/language/classes: language.gcd
gnue-config/base/language/doc: language.sgml
Log message:
Update language class based on Reinhards comments from IRC and emails,
add user_help class, capture comments in docs.
CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gnue/gnue-config/base/language/classes/language.gcd.diff?cvsroot=OldCVS&tr1=1.6&tr2=1.7&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gnue/gnue-config/base/language/doc/language.sgml.diff?cvsroot=OldCVS&tr1=1.2&tr2=1.3&r1=text&r2=text
Patches:
Index: gnue/gnue-config/base/language/classes/language.gcd
diff -u gnue/gnue-config/base/language/classes/language.gcd:1.6
gnue/gnue-config/base/language/classes/language.gcd:1.7
--- gnue/gnue-config/base/language/classes/language.gcd:1.6 Fri May 18
18:09:58 2001
+++ gnue/gnue-config/base/language/classes/language.gcd Sun Jun 17 07:55:37 2001
@@ -22,7 +22,7 @@
#
# This file originally written by Neil Tiffin (address@hidden).
#
-# $Revision: 1.6 $ $Date: 2001/05/19 01:09:58 $ $Author: ntiffin $
+# $Revision: 1.7 $ $Date: 2001/06/17 14:55:37 $ $Author: ntiffin $
#
# ===========================================================================
@@ -41,10 +41,13 @@
};
# -------------------------------------------------------------------------
- # default language dependent data for use by forms and reports
- # to assist the user.
+ # default system language dependent data for use by forms and reports
+ # to assist the user. This table should not be changed by user forms.
+ # To use this class:
+ # the form should look at sys_help first and only if
+ # user_help exists then the form should look up user_help.whatever.
# -------------------------------------------------------------------------
- class help
+ class sys_help
{
char module_name<25>;
char class_name<25>; # table
@@ -58,6 +61,29 @@
char label<25>; # default label for this data, used for
# both reports and forms.
char default_text<100>; # default text data for new fields.
+
+ language::user_help *user_help; # if a user_help entry exists.
};
+ # -------------------------------------------------------------------------
+ # if a user wants to change the help text then the text is copied to this
+ # table and changed. When help is requested data in this table should
+ # override sys_help.
+ # -------------------------------------------------------------------------
+ class user_help
+ {
+ language::sys_help *sys_help; #pointer to system help messages.
+
+ char company<15>; # place holder until decided how it works in
geas.
+ char user_id<15>; # if empty this change applies to all users.
+ char user_group<15>; # if empty this change applies to all groups.
+
+ char help_text<1000>; # full help text if the user clicks on help.
+ char help_keywords<100>; # keywords to help for searches.
+ char tool_tip<50>; # short help when the user's mouse passes over
+ # the field.
+ char label<25>; # default label for this data, used for
+ # both reports and forms.
+ char default_text<100>; # default text data for new fields.
+ };
};
Index: gnue/gnue-config/base/language/doc/language.sgml
diff -u gnue/gnue-config/base/language/doc/language.sgml:1.2
gnue/gnue-config/base/language/doc/language.sgml:1.3
--- gnue/gnue-config/base/language/doc/language.sgml:1.2 Tue Mar 6
11:53:09 2001
+++ gnue/gnue-config/base/language/doc/language.sgml Sun Jun 17 07:55:37 2001
@@ -1,26 +1,93 @@
<chapter id="language">
- <title>Language Module</title>
+ <title>
+ Language Module
+ </title>
<sect1>
- <title>Requirements</title>
+ <title>
+ Requirements
+ </title>
<para>
- This chapter is $Revision: 1.2 $ $Date: 2001/03/06
19:53:09 $ .
+ This chapter is $Revision: 1.3 $ $Date: 2001/06/17
14:55:37 $ .
</para>
<sect2>
- <title> Business Requirements </title>
+ <title>
+ Business Requirements
+ </title>
<orderedlist>
<listitem>
<para>
Maintain language information
and source information.
</para>
</listitem>
+ <listitem>
+ <para>
+ Maintain information for the
User Interface such as Label, Tooltip and Helptext that will be stored in the
database.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ There will be two tables in the
db. One ("standard") is provided by the module writer and in the other
("individual") the user can fill in what he wants different help information.
When updating a module via a system update, only the standard table gets
overwritten.
+ </para>
+ </listitem>
</orderedlist>
+ <para>
+ There will be a tool that helps importing those
things in the db. Since now those things are handeled like normal data, it can
be the same tool we use for importing standard data like countrycodes etc.
+ </para>
+ <para>
+ There are several arguments for storing help
information in the database and not in ascii files:
+ <orderedlist>
+ <listitem>
+ <para>
+ We can make a form for
that, and the user can easily change the data
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ The data from that
tables can be used in 2-tier mode, too
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Access to db data is
probably faster than access to ascii files (especially when we have big ascii
files we have to search through to find the correct label).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ We make use of the db's
advanced caching mechanisms
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ It is easy to simply
backup a database and have all variable data of gnue saved
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ We don't have to invent
just another file format with just another parser
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ We can use the standard
geas security system to decide which user can change help text and which user
can't
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ We could even have
different labels/help texts for different companies by making the "individual"
table company dependent if we want
+ </para>
+ </listitem>
+ </orderedlist>
+ </para>
+ * we can use the standard geas security system to
decide which user can change help text and which user can't * we could even
have different labels/help texts for different companies by making the
"individual" table company dependent if we want
</sect2>
<sect2>
- <title>Future Requirements</title>
+ <title>
+ Future Requirements
+ </title>
<para>
The following items will be implemented in
future version of this module. They may be implemented in the base module or be
added via an industry specific add on.
</para>
- <itemizedlist mark=bullet>
+ <itemizedlist mark="bullet">
<listitem>
<para>
none
@@ -29,11 +96,13 @@
</itemizedlist>
</sect2>
<sect2>
- <title> Business Objects </title>
+ <title>
+ Business Objects
+ </title>
<para>
The following Business Objects are defined and
maintained by this module.
</para>
- <itemizedlist mark=bullet>
+ <itemizedlist mark="bullet">
<listitem>
<para>
Language
@@ -42,8 +111,10 @@
</itemizedlist>
</sect2>
<sect2>
- <title>External Business Object References</title>
- <itemizedlist mark=bullet>
+ <title>
+ External Business Object References
+ </title>
+ <itemizedlist mark="bullet">
<listitem>
<para>
none
@@ -52,8 +123,10 @@
</itemizedlist>
</sect2>
<sect2>
- <title>Forms</title>
- <itemizedlist mark=bullet>
+ <title>
+ Forms
+ </title>
+ <itemizedlist mark="bullet">
<listitem>
<para>
Add, modify, and delete
languages.
@@ -62,8 +135,10 @@
</itemizedlist>
</sect2>
<sect2>
- <title>Reports</title>
- <itemizedlist mark=bullet>
+ <title>
+ Reports
+ </title>
+ <itemizedlist mark="bullet">
<listitem>
<para>
None
@@ -72,8 +147,10 @@
</itemizedlist>
</sect2>
<sect2>
- <title>Business Rules</title>
- <itemizedlist mark=bullet>
+ <title>
+ Business Rules
+ </title>
+ <itemizedlist mark="bullet">
<listitem>
<para>
none
@@ -82,7 +159,9 @@
</itemizedlist>
</sect2>
<sect2>
- <title>Business Object Definition</title>
+ <title>
+ Business Object Definition
+ </title>
<para>
<programlisting>
&languagecode;
- gnue/gnue-config/base/language classes/language...,
Neil Tiffin <=