incubator-ooo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ksch...@apache.org
Subject svn commit: r1206943 - in /incubator/ooo/ooo-site/trunk/content/ui/knowledge: ./ DialogSpecificationandGuidelines.odt help_ids.html index.html not_again.html
Date Mon, 28 Nov 2011 00:42:46 GMT
Author: kschenk
Date: Mon Nov 28 00:42:44 2011
New Revision: 1206943

URL: http://svn.apache.org/viewvc?rev=1206943&view=rev
Log:
kls -- added ui/knowledge


Added:
    incubator/ooo/ooo-site/trunk/content/ui/knowledge/
    incubator/ooo/ooo-site/trunk/content/ui/knowledge/DialogSpecificationandGuidelines.odt
  (with props)
    incubator/ooo/ooo-site/trunk/content/ui/knowledge/help_ids.html   (with props)
    incubator/ooo/ooo-site/trunk/content/ui/knowledge/index.html   (with props)
    incubator/ooo/ooo-site/trunk/content/ui/knowledge/not_again.html   (with props)

Added: incubator/ooo/ooo-site/trunk/content/ui/knowledge/DialogSpecificationandGuidelines.odt
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/ui/knowledge/DialogSpecificationandGuidelines.odt?rev=1206943&view=auto
==============================================================================
Binary file - no diff available.

Propchange: incubator/ooo/ooo-site/trunk/content/ui/knowledge/DialogSpecificationandGuidelines.odt
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: incubator/ooo/ooo-site/trunk/content/ui/knowledge/help_ids.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/ui/knowledge/help_ids.html?rev=1206943&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/ui/knowledge/help_ids.html (added)
+++ incubator/ooo/ooo-site/trunk/content/ui/knowledge/help_ids.html Mon Nov 28 00:42:44 2011
@@ -0,0 +1,139 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
+<html>
+<head>
+  <meta http-equiv="CONTENT-TYPE"
+ content="text/html; charset=windows-1252">
+  <title>Help IDs in OpenOffice.org</title>
+  <style>
+      <!--
+    code { font:fixed !important; color:#0000C0; }
+    --></style>
+</head>
+<body lang="en-US">
+<h2>Help IDs in OpenOffice.org</h2>
+<p>In OpenOffice.org, ever user interface element (a dialog control, a
+menu item, whatever), needs to have a unique help id. To some extent,
+you as the developer are responsible for ensuring this ...</p>
+<h3>Content</h3>
+<table>
+  <tbody>
+    <tr>
+      <td colspan="2"><a href="#why">Why your controls need help ids</a></td>
+    </tr>
+    <tr>
+      <td colspan="2"><a href="#dialogs">Dialogs, Tab pages, and the
+like</a></td>
+    </tr>
+    <tr>
+      <td width="20"> <br>
+      </td>
+      <td><a href="#resources">Resources</a></td>
+    </tr>
+    <tr>
+      <td width="20"> <br>
+      </td>
+      <td><a href="#programmatic">Programmatic element creation</a></td>
+    </tr>
+    <tr>
+      <td colspan="2"><a href="#menus">Menus and toolbars</a></td>
+    </tr>
+    <tr>
+      <td colspan="2"><a href="#manually">Manually declaring help ids</a></td>
+    </tr>
+  </tbody>
+</table>
+<h3><a name="why"></a>Why your controls need help ids</h3>
+<ul>
+  <li> Every visible "item" in the UI must have a unique help id, so
+help content can be created for it</li>
+  <li> Automated testing using the <a
+ href="http://qa.openoffice.org/qatesttool/index.html"> QA test tool</a>
+needs help ids to address certain UI elements within the test scripts.</li>
+</ul>
+<h3><a name="dialogs"></a>Dialogs, Tab pages, and the like</h3>
+<h4><a name="resources"></a>Resources</h4>
+<p>If you declare your dialogs (which from now on will be a placeholder
+for Dialog, ModalDialog, TabPage, and other such "control containers")
+using resources, some things are done automatically. For instance,
+let's consider the following resource:</p>
+<pre>    ModalDialog RID_DLG_IDENTIFIER<br>    {<br>        // ... some
stuff<br>        Text = "the dialog";<br><br>        FixedText FT_LABEL<br>
       {<br>            // Pos/Size/etc. ...<br>            Text = "the label";<br>
       };<br>        Control CTL_CONTROL<br>        {<br>            //
Pos/Size/etc. ...<br>        };<br>        OKButton PB_OK<br>        {<br>
           // Pos/Size/etc. ...<br>        };<br>        CancelButton PB_CANCEL<br>
       {<br>            // Pos/Size/etc. ...<br>        };<br>    };<br>
   </pre>
+<p>Here, you don't have to care about the fixed text, and the buttons
+(and even the dialog itself). Simply forget about them: HelpIDs will be
+generated automatically for them, both for usage with the help system,
+and for usage with the QA test tool.</p>
+<p>However, you need to care for the Control. For this "generic" type
+(as opposed to the concrete types you usually encounter), you need to
+manually ensure that it gets a help id, and that this help id is usable
+for others. See "<a href="#manually"> Manually declaring help ids</a>"
+below for how you do this.</p>
+<h4><a name="programmatic"></a>Programmatic element creation</h4>
+<p>If you create your UI elements programmatically (e.g. within the C++
+source code at runtime), then you also need to <a href="#manually">declare
+help ids manually</a>.</p>
+<h3><a name="menus"></a>Menus and toolbars</h3>
+<p><em>(Yet to come)</em></p>
+<h3><a name="manually"></a>Manually declaring help ids</h3>
+If you have an UI element which needs a manually declared help id, the
+following is necessary:
+<ul>
+  <li>
+    <p><em>Find a number</em>: Usually, the project you live in has a
+file <code>*help*.hrc</code> (or so) where help ids for this project
+are declared. Find a free place therein, and add a new define such as </p>
+    <pre>    #define HID_MY_PERSONAL_HELP_ID         ( base + offset )<br>  
       </pre>
+Here, <code>base</code> is usually a project-wide base id, and offset
+an incrementing number within this project. For instance, if you're
+within the project <code>svx</code>, base would be <code>HID_SVX_START</code>.
+    <p></p>
+    <p>However, care must be taken: Every project does not only have a
+start for its help ids, but also an <b>end</b>. It's really a
+project-relative <b>range</b> of ids you are allowed to use. If you
+leave this range, bad (and hard to notice) things will happen at
+runtime. In <code>svx</code>, for example, the range you have to
+respect ends with <code>HID_SVX_END</code>.</p>
+    <p>Now how can you determine this range, and what do you do when
+the range is used up? Look at <a
+ href="http://ooo.ximian.com/lxr/source/util/svtools/inc/solar.hrc">
+svtools/solar.hrc</a>: This is where all help id ranges (and for that
+matter, other id ranges such as for resource ids) are defined. If you
+want to know where your particular range ends, or if you need a new
+range: Use this file.</p>
+    <p>To stay with our example: You will find that <code>svtools.hrc</code>
+defines two ranges for <code>svx</code>, one from <code>HID_SVX_START</code>
+to <code>HID_SVX_END</code> and one from <code>HID_SVX_EXT0_START</code>
+to <code>HID_SVX_EXT0_END</code> ... </p>
+  </li>
+  <li>
+    <p><em>Assign this number</em>: Set the new help id at your UI
+element. In a resource file, you may do this with </p>
+    <pre>    HelpId = HID_MY_PERSONAL_HELP_ID;<br>        </pre>
+In C++, you'd do this with
+    <pre>    m_aMyControl.SetHelpId( HID_MY_PERSONAL_HELP_ID );<br>        </pre>
+  </li>
+  <li>
+    <p><em>Export the number</em>: With the previous steps, the help id
+is already available to the online help. However, your QA engineer will
+tell you that s/he cannot test the new dialog/tabpage/whatever, because
+the <a href="http://qa.openoffice.org/qatesttool/index.html">QA test
+tool</a> does not have access to your control(s). This is because you
+need to <em>export</em> the help ids which you declared manually (in
+opposite to the ones which where declared implicitly during the build).</p>
+    <p>Every project should have a <code>hidother.src</code> file,
+usually located in the <code>util</code> directory. Grab it, and add
+your new id there as follows: </p>
+    <pre>    hidspecial HID_MY_PERSONAL_HELP_ID { HelpId = HID_MY_PERSONAL_HELP_ID;
};<br>        </pre>
+    <p>If your project does not yet have a <code>hidother.src</code>
+file just create one. To get it built you also have to insert the
+following line in your <code>makefile.mk</code> just somewhere below
+the TRAGET= line: </p>
+    <pre>    GEN_HID_OTHER=TRUE<br>        </pre>
+Now, build the project, and deliver it. When you (now or later) build
+the <code>instsetoo</code> project, a file called <code>hid.lst</code>
+will be generated, and placed in <code>&lt;platform&gt;/bin.&lt;minor&gt;</code>
+(e.g. <code>unxlngi5.pro/bin.m38/hid.lst</code>). This should make
+your QA engineer happy .... </li>
+</ul>
+<hr>
+<p align="right">Last modified: $Date: 2004/09/01 12:14:46 $</p>
+</body>
+</html>

Propchange: incubator/ooo/ooo-site/trunk/content/ui/knowledge/help_ids.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: incubator/ooo/ooo-site/trunk/content/ui/knowledge/index.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/ui/knowledge/index.html?rev=1206943&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/ui/knowledge/index.html (added)
+++ incubator/ooo/ooo-site/trunk/content/ui/knowledge/index.html Mon Nov 28 00:42:44 2011
@@ -0,0 +1,70 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
+<html>
+  <head>
+    <meta http-equiv="CONTENT-TYPE" content="text/html; charset=windows-1252">
+    <title>Knowledge</title>
+    <style>
+    <!--
+    tr.inner_header { background-color:#99CCFF !important; color:#00315A !important; font-weight:bold
!important; }
+    tr.outer_header { background-color:#00315a !important; }
+    -->
+    </style>
+  </head>
+  <body lang="en-US">
+  <div align="right">
+   <p><i>Last modified <csobj w="108" h="16" t="DateTime" locale="00000809"
format="LongDate" region="0">28 November 2006</csobj></i></p>
+  </div>
+  <h2>Knowledge Base</h2>
+  <table border="0" cellpadding="2" cellspacing="1" bgcolor="#dddddd">
+   <tbody>
+    <tr>
+     <th align="left" bgcolor="#dddddd"><b>Date</b></th>
+     <th align="left" bgcolor="#dddddd"><b>Title</b></th>
+     <th align="left" bgcolor="#dddddd">Abstract</th>
+    </tr>
+    <tr>
+     <td bgcolor="white">Sep 20. 2002</td>
+     <td bgcolor="white"><a href="not_again.html">Do not show this again"-dialogs</a></td>
+     <td bgcolor="white">
+            In some situations, OpenOffice.org warns or informs the user about something
using a modal dialog, with the option to permanently
+            switch off this special warning or info ....</td>
+    </tr>
+    <tr>
+     <td bgcolor="white">Sep 1, 2004</td>
+     <td bgcolor="white"><a href="help_ids.html">The HelpID system</a></td>
+     <td bgcolor="white">In OpenOffice.org, ever user interface element (a dialog control,
a menu item, whatever), needs to have a unique help id.
+          To some extent, you as the developer are responsible for ensuring this ...
+</td>
+    </tr>
+    <tr>
+     <td bgcolor="white">Jan 9, 2004</td>
+     <td bgcolor="white"><a href="http://framework.openoffice.org/files/documents/25/1335/CommonUI.sxw">loading
common UI on demand</a> (sxw)</td>
+     <td bgcolor="white">This document describes an architecture for loading common
user interface (dialogs, tab pages) on demand,
+            instead of placing them in shared libraries to link against.
+</td>
+    </tr>
+    <tr>
+     <td bgcolor="white"><nobr>Jul 7, 2004</nobr></td>
+     <td bgcolor="white"><a href="http://specs.openoffice.org/ui_in_general/api/ProgrammaticControlOfMenuAndToolbarItems.sxw">Programmatic
Control of Menu and Toolbar Items</a> (sxw)</td>
+     <td bgcolor="white">This feature should enable 3rd party developers to adapt menu
bar and toolbar layouts to their needs.
+          It will make menus and toolbars accessible to UNO developers and provide access
to interfaces to insert/remove
+          and modify menu items, popup menus and toolbar items during Office runtime.
+</td>
+    </tr>
+    <tr>
+     <td bgcolor="white"><nobr>Nov. 28, 2006</nobr></td>
+     <td bgcolor="white"><a href="DialogSpecificationandGuidelines.odt">Dialog
Specification and Guidelines</a> (odt)</td>
+     <td bgcolor="white">This documents describes the visual guidelines of dialog design
in OpenOffice.org
+</td>
+    </tr>
+    <tr>
+     <td bgcolor="white"></td>
+     <td bgcolor="white"></td>
+     <td bgcolor="white"></td>
+    </tr>
+   </tbody>
+  </table>
+  <h3>FAQ</h3>
+  <p>Please have a look into this <a href="../howto/index.html">faq list</a>.
It is a slackly collection of frequently asked questions, plus their answers of course ...</p>
+ </body>
+</html>

Propchange: incubator/ooo/ooo-site/trunk/content/ui/knowledge/index.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: incubator/ooo/ooo-site/trunk/content/ui/knowledge/not_again.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/ui/knowledge/not_again.html?rev=1206943&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/ui/knowledge/not_again.html (added)
+++ incubator/ooo/ooo-site/trunk/content/ui/knowledge/not_again.html Mon Nov 28 00:42:44 2011
@@ -0,0 +1,152 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
+<HTML>
+<HEAD>
+	<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=windows-1252">
+	<TITLE></TITLE>
+	<META NAME="GENERATOR" CONTENT="StarOffice 6.1 EA2 (Win32)">
+	<META NAME="AUTHOR" CONTENT="Frank Sch&ouml;nheit">
+	<META NAME="CREATED" CONTENT="20011221;10104626">
+	<META NAME="CHANGED" CONTENT="20020920;14022584">
+	<STYLE>
+	<!--
+		A:visited { color: #444488 }
+		A:link { color: #444488 }
+	-->
+	</STYLE>
+</HEAD>
+<BODY LANG="en-US" LINK="#444488" VLINK="#444488" BGCOLOR="#eeeeff">
+<TABLE WIDTH=100% BORDER=0 CELLPADDING=4 CELLSPACING=0 STYLE="page-break-before: always">
+	<COL WIDTH=256*>
+	<TR>
+		<TD WIDTH=100% BGCOLOR="#666699">
+			<H1 ALIGN=CENTER><A HREF="http://www.openoffice.org/"><IMG SRC="../images/open_office_org_logo.gif"
NAME="Grafik1" ALT="OpenOffice" ALIGN=RIGHT WIDTH=109 HEIGHT=54 BORDER=0></A><FONT
COLOR="#ffffff"><FONT FACE="Arial"><FONT SIZE=5>Do
+			Not Show This Message Again</FONT></FONT></FONT></H1>
+		</TD>
+	</TR>
+</TABLE>
+<HR SIZE=3 NOSHADE>
+<TABLE WIDTH=100% BORDER=0 CELLPADDING=4 CELLSPACING=0>
+	<COL WIDTH=33*>
+	<COL WIDTH=223*>
+	<TR>
+		<TD COLSPAN=2 WIDTH=100%>
+			<P STYLE="margin-bottom: 0cm">In some situations, OpenOffice.org
+			warns or informs the user about something using a modal dialog,
+			with the option to permanently switch off this special warning or
+			info. This option is usually implemented by a checkbox in this
+			dialog.</P>
+			<P STYLE="margin-bottom: 0cm">OpenOffice.org does not have a
+			generic approach how to switch <I>on</I> such messages, again.
+			There may be reasons for the user to do so, the most simple that
+			the user simply did not read what OOo presented her, and just
+			clicked away it with a &quot;don't wanna know this&quot;-attitude.
+			We all know this happens from time to time :).</P>
+			<P STYLE="margin-bottom: 0cm"><BR>
+			</P>
+			<P STYLE="margin-bottom: 0cm">This document is a collection of the
+			current dialogs we have, and the current solutions (or a note
+			about the inexistence of such a solution) to switch them on once
+			they have been switched off.</P>
+			<P><BR>
+			</P>
+		</TD>
+	</TR>
+	<TR>
+		<TD COLSPAN=2 WIDTH=100% BGCOLOR="#ccccff">
+			<P><B>OpenOffice.org Calc</B></P>
+		</TD>
+	</TR>
+	<TR>
+		<TD WIDTH=13% VALIGN=TOP>
+			<P>copying cells</P>
+		</TD>
+		<TD WIDTH=87%>
+			<P STYLE="margin-bottom: 0cm"><I>How to reach</I>: In a Calc
+			document, fill two cells, copy one of them, paste it onto the
+			other one.</P>
+			<P STYLE="margin-bottom: 0cm"><I>message</I>: You are pasting data
+			into cells that already contain data. Do you really want to
+			overwrite the existing data?</P>
+			<P><I>switch-on</I>: Tools/Options/Spreadsheet/Common/Show
+			overwrite warning when pasting data</P>
+		</TD>
+	</TR>
+	<TR>
+		<TD COLSPAN=2 WIDTH=100% BGCOLOR="#ccccff">
+			<P><B>OpenOffice.org Impress</B></P>
+		</TD>
+	</TR>
+	<TR>
+		<TD WIDTH=13%>
+			<P>changing page layout</P>
+		</TD>
+		<TD WIDTH=87%>
+			<P STYLE="margin-bottom: 0cm"><I>How to reach</I>: In a
+			presentation, do some actions so that the Undo list is filled, and
+			chose a different page layout</P>
+			<P STYLE="margin-bottom: 0cm"><I>message</I>: This action deletes
+			the list of actions that can\nbe undone. .....</P>
+			<P><I>switch-on</I>: configuration only. Location:
+			/org/openoffice/Office/Impress/Misc/ShowUndoDeleteWarning</P>
+		</TD>
+	</TR>
+	<TR>
+		<TD COLSPAN=2 WIDTH=100% BGCOLOR="#ccccff">
+			<P><B>Common</B></P>
+		</TD>
+	</TR>
+	<TR>
+		<TD WIDTH=13%>
+			<P>printing transparent objects</P>
+		</TD>
+		<TD WIDTH=87%>
+			<P STYLE="margin-bottom: 0cm"><I>How to reach</I>: In any of the
+			major application's documents, insert a rectangle with a
+			semi-transparent fill color. Print the document</P>
+			<P STYLE="margin-bottom: 0cm"><I>message</I>: Your document
+			contains transparent ....</P>
+			<P><I>switch-on</I>: not known, still to clarify</P>
+		</TD>
+	</TR>
+	<TR>
+		<TD COLSPAN=2 WIDTH=100% BGCOLOR="#ccccff">
+			<P><B>OpenOffice.org Writer</B></P>
+		</TD>
+	</TR>
+	<TR>
+		<TD WIDTH=13%>
+			<P>Bibliography &ndash; column assignment</P>
+		</TD>
+		<TD WIDTH=87%>
+			<P STYLE="margin-bottom: 0cm"><I>How to reach</I>: In the
+			Bibliography component, change the data source to a table which
+			does not contain all columns which by default are needed for a
+			Bibliography.</P>
+			<P STYLE="margin-bottom: 0cm"><I>message</I>: The following column
+			names could not be assigned: ...</P>
+			<P><I>switch-on</I>: configuration only. Location:
+			/org/openoffice/Office/DataAccess/Bibliography/ShowColumnAssignmentWarning</P>
+		</TD>
+	</TR>
+	<TR>
+		<TD COLSPAN=2 WIDTH=100%>
+			<HR SIZE=1 NOSHADE>
+		</TD>
+	</TR>
+	<TR>
+		<TD COLSPAN=2 WIDTH=100% BGCOLOR="#666699">
+			<P ALIGN=LEFT><FONT COLOR="#ffffff">Author: </FONT><A HREF="mailto:fs@openoffice.org"><SPAN
STYLE="background: transparent"><FONT COLOR="#ffffff">Frank
+			Sch&ouml;nheit</FONT></SPAN></A><A HREF="mailto:ibo@system-entwicklung.de"><FONT
COLOR="#444488"><BR></FONT></A><FONT COLOR="#ffffff">Last
+			Modified: $Date: 2002/09/20 13:36:55 $<BR><I>Copyright &copy; 2001
+			OpenOffice.org</I></FONT></P>
+		</TD>
+	</TR>
+	<TR>
+		<TD COLSPAN=2 WIDTH=100%>
+			<HR SIZE=1 NOSHADE>
+		</TD>
+	</TR>
+</TABLE>
+<HR SIZE=3 NOSHADE>
+</BODY>
+</HTML>
\ No newline at end of file

Propchange: incubator/ooo/ooo-site/trunk/content/ui/knowledge/not_again.html
------------------------------------------------------------------------------
    svn:eol-style = native



Mime
View raw message