diff --git a/doc/ChangeLog b/doc/ChangeLog index 311f619e4..e715cc33b 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,7 @@ +2005-05-04 John Luke + + * en/Gtk/AboutDialog.xml: doc + 2005-05-04 Dan Winship * en/GLib/GType.xml: update, and remove a bunch of examples of how diff --git a/doc/en/Gtk/AboutDialog.xml b/doc/en/Gtk/AboutDialog.xml index 99d11afa4..cc57e1b51 100644 --- a/doc/en/Gtk/AboutDialog.xml +++ b/doc/en/Gtk/AboutDialog.xml @@ -9,8 +9,19 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Display information about an application + + +The offers a simple way to display information about a program like its logo, name, copyright, website and license. It is also possible to give credits to the authors, documenters, translators and artists who have worked on the program. An about dialog is typically opened when the user selects the About option from the Help menu. All parts of the dialog are optional. + + +About dialogs often contain links and email addresses. supports this by offering global hooks, which are called when the user clicks on a link or email address, see and . Email addresses in the authors, documenters and artists properties are recognized by looking for <user@host>, URLs are recognized by looking for http://url, with url extending to the next space, tab or line break. + + + Gtk.Dialog @@ -78,9 +89,9 @@ - To be added + Default constructor a - To be added + @@ -104,9 +115,9 @@ - To be added + The license of the program. a - To be added + This string is displayed in a text view in a secondary dialog, therefore it is fine to use a long multi-paragraph text. Note that the text is not wrapped in the text view, thus it must contain the intended linebreaks. @@ -117,9 +128,11 @@ - To be added + The name of the program. a - To be added + + + @@ -130,9 +143,9 @@ - To be added + Copyright information for the program. a - To be added + @@ -143,9 +156,9 @@ - To be added + Credits to the translators. a - To be added + This string should be marked as translatable. The string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details. @@ -156,9 +169,11 @@ - To be added + A named icon to use as the logo for the about box. a - To be added + This property overrides the property. + + @@ -169,9 +184,9 @@ - To be added + The label for the link to the website of the program. a - To be added + If this is not set, it defaults to the URL specified in the property. @@ -182,9 +197,9 @@ - To be added + A logo for the about box. a - To be added + If this is not set, it defaults to . @@ -195,9 +210,9 @@ - To be added + The URL for the link to the website of the program. a - To be added + This should be a string starting with "http://". @@ -208,9 +223,9 @@ - To be added + Comments about the program. a - To be added + This string is displayed in a label in the main dialog, thus it should be a short explanation of the main purpose of the program, not a detailed list of features. @@ -221,9 +236,9 @@ - To be added + The version of the program. a - To be added + @@ -236,10 +251,10 @@ - To be added - a - a - To be added + Installs a global function to be called whenever the user activates an email link in an about dialog. + a to call when an email link is activated. + a , the previous email hook. + @@ -252,10 +267,10 @@ - To be added - a - a - To be added + Installs a global function to be called whenever the user activates a URL link in an about dialog. + a to call when a URL link is activated. + a that is the previous URL hook. +