Page "BloodhoundWidgets" was changed by gjm Diff URL: <https://issues.apache.org/bloodhound/wiki/BloodhoundWidgets?action=diff&version=2> Revision 2 Comment: Removing smileys and redundant spaces before punctuation as it turns out that these things annoy me that much. Changes: -------8<------8<------8<------8<------8<------8<------8<------8<-------- Index: BloodhoundWidgets ========================================================================= --- BloodhoundWidgets (version: 1) +++ BloodhoundWidgets (version: 2) @@ -20,9 +20,9 @@ === Widget parameters #parameters -Widget visualization may be customized by specifying arguments. For instance, in order to insert a widget displaying the results of a ticket report it is mandatory to provide the identifier of the target report. This is an example of a '''required parameter'''. If a value is not provided for this kind of parameters then an [#error_handling error message] is displayed. On the other hand '''optional parameters''' are those that may be ignored either because they are related to a minor characteristic or a value can be considered by default under certain circumstances. The line between both groups might be fuzzy sometimes because it is possible that an ''optional parameter'' may be required depending on the values set to other parameters, the state of widget rendering context , and maybe other factors. - -All parameters mentioned above have certain meaning for a particular widget. There is another set of parameters used to customize its look and feel and other aspect present in all widgets. They are known as '''meta-parameters'''. At present they are the following : +Widget visualization may be customized by specifying arguments. For instance, in order to insert a widget displaying the results of a ticket report it is mandatory to provide the identifier of the target report. This is an example of a '''required parameter'''. If a value is not provided for this kind of parameters then an [#error_handling error message] is displayed. On the other hand '''optional parameters''' are those that may be ignored either because they are related to a minor characteristic or a value can be considered by default under certain circumstances. The line between both groups might be fuzzy sometimes because it is possible that an ''optional parameter'' may be required depending on the values set to other parameters, the state of widget rendering context, and maybe other factors. + +All parameters mentioned above have certain meaning for a particular widget. There is another set of parameters used to customize its look and feel and other aspect present in all widgets. They are known as '''meta-parameters'''. At present they are the following: - '''altlinks''' is a boolean parameter controlling whether widget alternate download links will be visible or hidden. @@ -56,7 +56,7 @@ === Widgets markup for plugin developers #genshi -Widgets may also be inserted directly in [http://genshi.edgewall.org/wiki/Documentation/templates.html Genshi templates] in order to design user interfaces quickly. Plugin developers should use markup for this purpose. Let's consider the following sample template. If you are not familiar with the subject , please read [http://genshi.edgewall.org/wiki/Documentation/xml-templates.html XML templates reference]. +Widgets may also be inserted directly in [http://genshi.edgewall.org/wiki/Documentation/templates.html Genshi templates] in order to design user interfaces quickly. Plugin developers should use markup for this purpose. Let's consider the following sample template. If you are not familiar with the subject, please read [http://genshi.edgewall.org/wiki/Documentation/xml-templates.html XML templates reference]. {{{ #!xml @@ -84,7 +84,7 @@ </html> }}} -Analyzing sample markup from top to bottom it's possible to notice that the first step is to declare ''Bloodhound'' dashboard XML namespace `http://issues.apache.org/bloodhound/wiki/Ui/Dashboard`. In this case it is represented by the short prefix `bh`. This step is required as well as the second. It consists of including `widget_macros.html` template. It contains all the foundations of widgets agic. If you are interested in learning how everything works under-the-hood maybe that's a good place to start ''';)'''. +Analyzing sample markup from top to bottom it's possible to notice that the first step is to declare ''Bloodhound'' dashboard XML namespace `http://issues.apache.org/bloodhound/wiki/Ui/Dashboard`. In this case it is represented by the short prefix `bh`. This step is required as well as the second. It consists of including `widget_macros.html` template. It contains all the foundations of widgets agic. If you are interested in learning how everything works under-the-hood that should be a good place to start. Now it is a good time to use widgets markup so as to insert some contents in the web page. This is what `<bh:widget>` tag is for. Let's take a look at it. The value assigned to `id` attribute indicates that this widget will have the `active` identifier set when it is rendered. Script code in your template may use it to access its outermost ''div'' element e.g. `jQuery('#active')`. Attribute `urn` is used to specify target widget name. In this case `TicketQuery` widget is basically a table displaying the results of executing a ticket query. All other attributes of `<bh:widget>` tag are considered as meta-parameters. Hence in this case alternate download links (e.g. ''RSS Feed'', ''Comma-delimited Text'', ''Tab-delimited Text'', and so on) will not be available. @@ -94,7 +94,7 @@ == Error handling #error_handling -While rendering widgets there is a chance for errors to happen. If this is the case the parent page still will be displayed. Actually the widget rendering engine will intercept exceptions raised and instead of widget body it will show an informative error message containing : +While rendering widgets there is a chance for errors to happen. If this is the case the parent page still will be displayed. Actually the widget rendering engine will intercept exceptions raised and instead of widget body it will show an informative error message containing: - '''Widget name''' - '''Exception type''' identifying the kind of error @@ -102,7 +102,7 @@ a [TracLogging log entry] with all the details and context information about the error. -Every time you look for support (e.g. by contacting your administrator) you have to provide all these details , especially '''log entry ID'''. +Every time you look for support (e.g. by contacting your administrator) you have to provide all these details, especially '''log entry ID'''. === Getting detailed help #help The list of available macros and the full help can be obtained using the !WidgetDoc widget, as seen [#reference below]. -------8<------8<------8<------8<------8<------8<------8<------8<--------
-- Page URL: <https://issues.apache.org/bloodhound/wiki/BloodhoundWidgets> Apache Bloodhound <https://issues.apache.org/bloodhound/> The Apache Bloodhound issue tracker This is an automated message. Someone added your email address to be notified of changes on 'BloodhoundWidgets' page. If it was not you, please report to .
