Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Fully mavenized the docs build

  • Loading branch information...
commit b81ea2d5cd975835b73ffdad908a714e773557ce 1 parent 676b46f
@bleathem bleathem authored
View
10 Component_Reference/pom.xml
@@ -15,7 +15,7 @@
<properties>
- <docname>Component_Reference.asciidoc</docname>
+ <docname>Component_Reference</docname>
<bookname>Component Reference</bookname>
</properties>
@@ -26,10 +26,10 @@
<groupId>org.jboss.maven.plugins</groupId>
<artifactId>maven-jdocbook-plugin</artifactId>
</plugin>
- <!--<plugin>-->
- <!--<groupId>org.asciidoctor</groupId>-->
- <!--<artifactId>asciidoctor-maven-plugin</artifactId>-->
- <!--</plugin>-->
+ <plugin>
+ <groupId>org.asciidoctor</groupId>
+ <artifactId>asciidoctor-maven-plugin</artifactId>
+ </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
View
130 Component_Reference/src/main/docbook/en-US/Component_Reference.asciidoc
@@ -454,7 +454,7 @@ The [sgmltag]+<r:commandButton>+ component is similar to the JavaServer Faces (
[[figu-Component_Reference-commandButton-commandButton]]
.[sgmltag]+<r:commandButton>+
-image::images/figu-Component_Reference-commandButton-commandButton.png[]
+image::figu-Component_Reference-commandButton-commandButton.png[]
[NOTE]
@@ -490,7 +490,7 @@ The [sgmltag]+<r:commandLink>+ component is similar to the JavaServer Faces ( [a
[[figu-Component_Reference-commandLink-commandLink]]
.[sgmltag]+<r:commandLink>+
-image::images/figu-Component_Reference-commandLink-commandLink.png[]
+image::figu-Component_Reference-commandLink-commandLink.png[]
[NOTE]
@@ -1177,7 +1177,7 @@ public class MediaData implements Serializable {
The [sgmltag]+<r:mediaOutput>+ component uses the [classname]+MediaBean+ and [classname]+MediaData+ classes to generate a new image on each page refresh.
-image::images/figu-Component_Reference-mediaOutput-mediaOutput_example_result.png[The generated image containing a random verification number.]
+image::figu-Component_Reference-mediaOutput-mediaOutput_example_result.png[The generated image containing a random verification number.]
====
@@ -1387,7 +1387,7 @@ Use the [sgmltag]+<r:message>+ and [sgmltag]+<r:messages>+ components to display
Failed validation checks are reported using [sgmltag]+<r:message>+ components. The validation annotations in the managed bean are outlined in <<exam-Component_Reference-Validation-JSR-303_validation_annotations>>.
-image::images/figu-Component_Reference-validator-Messages.png[Failed validation checks are reported using +&lt;r:message&gt;+ components.]
+image::figu-Component_Reference-validator-Messages.png[Failed validation checks are reported using +&lt;r:message&gt;+ components.]
====
@@ -1515,7 +1515,7 @@ When validation occurs, the whole object is validated against the annotation con
If the entered passwords do not match, an error message is displayed:
-image::images/figu-Component_Reference-graphValidator-Basic_usage.png[Failed validation checks are reported using +&lt;r:message&gt;+ components.]
+image::figu-Component_Reference-graphValidator-Basic_usage.png[Failed validation checks are reported using +&lt;r:message&gt;+ components.]
====
@@ -1784,7 +1784,7 @@ The amount of data logged can be determined with the [varname]+level+ attribute:
----
-image::images/figu-Component_Reference-log-log_example.png[]
+image::figu-Component_Reference-log-log_example.png[]
The log readout displays all messages.
@@ -1939,7 +1939,7 @@ The auto-complete box is a standard JSF [classname]+UIInput+ control with added
[[figu-Component_Reference-autocomplete-autocomplete]]
.[sgmltag]+<r:autocomplete>+
-image::images/figu-Component_Reference-autocomplete-autocomplete.png[]
+image::figu-Component_Reference-autocomplete-autocomplete.png[]
[[sect-Component_Reference-autocomplete-Basic_usage]]
@@ -2082,7 +2082,7 @@ The [sgmltag]+<r:calendar>+ component allows the user to enter a date and time t
[[figu-Component_Reference-calendar-calendar]]
.[sgmltag]+<r:calendar>+
-image::images/figu-Component_Reference-calendar-calendar.png[]
+image::figu-Component_Reference-calendar-calendar.png[]
[[sect-Component_Reference-calendar-Basic_usage]]
@@ -2265,7 +2265,7 @@ The [sgmltag]+<r:editor>+ component is used for creating a WYSIWYG editor on a p
[[figu-Component_Reference-editor-editor]]
.[sgmltag]+<r:editor>+
-image::images/figu-Component_Reference-editor-editor.png[width="400"]
+image::figu-Component_Reference-editor-editor.png[width="400"]
[sgmltag]+<r:editor>+ component is based on the CKEditor implementation.
@@ -2337,7 +2337,7 @@ By default, [sgmltag]+<r:editor>+ has a skin called [code]+richfaces+ that is op
[[figu-Component_Reference-editor-richfaces_skin]]
-image::images/figu-Component_Reference-editor-richfaces_skin.png[width="400"]
+image::figu-Component_Reference-editor-richfaces_skin.png[width="400"]
A [sgmltag]+<r:editor>+ with the default [code]+richfaces+ editor skin rendered against several RichFaces Skin options.
@@ -2350,7 +2350,7 @@ Alternatively, you can use any other CKeditor skin, either from the standard dis
[[figu-Component_Reference-editor-distribution_skins]]
-image::images/figu-Component_Reference-editor-distribution_skins.png[width="400"]
+image::figu-Component_Reference-editor-distribution_skins.png[width="400"]
A CKEditor distribution skins [code]+kama+, [code]+v2+ and [code]+office2003+.
@@ -2685,7 +2685,7 @@ The component has three functional states:
[[figu-Component_Reference-inplaceSelect-inplaceSelect]]
.[sgmltag]+<r:inplaceSelect>+
-image::images/figu-Component_Reference-inplaceSelect-inplaceSelect.png[]
+image::figu-Component_Reference-inplaceSelect-inplaceSelect.png[]
[[sect-Component_Reference-inplaceSelect-Basic_usage]]
@@ -2773,7 +2773,7 @@ The [sgmltag]+<r:inputNumberSlider>+ component provides a slider for changing nu
[[figu-Component_Reference-inputNumberSlider-inputNumberSlider]]
.[sgmltag]+<r:inputNumberSlider>+
-image::images/figu-Component_Reference-inputNumberSlider-inputNumberSlider.png[]
+image::figu-Component_Reference-inputNumberSlider-inputNumberSlider.png[]
[[sect-Component_Reference-inputNumberSlider-Basic_usage]]
@@ -2829,7 +2829,7 @@ The [sgmltag]+<r:inputNumberSpinner>+ component is a single-line input field wit
[[figu-Component_Reference-inputNumberSpinner-inputNumberSpinner]]
.[sgmltag]+<r:inputNumberSpinner>+
-image::images/figu-Component_Reference-inputNumberSpinner-inputNumberSpinner.png[]
+image::figu-Component_Reference-inputNumberSpinner-inputNumberSpinner.png[]
[[sect-Component_Reference-inputNumberSpinner-Basic_usage]]
@@ -2883,7 +2883,7 @@ The [sgmltag]+<r:select>+ component provides a drop-down list box for selecting
[[figu-Component_Reference-select-select]]
.[sgmltag]+<r:select>+
-image::images/figu-Component_Reference-select-select.png[]
+image::figu-Component_Reference-select-select.png[]
[[sect-Component_Reference-select-Basic_usage]]
@@ -2977,7 +2977,7 @@ The [sgmltag]+<r:orderingList>+ is a component for ordering items in a list (cli
[[figu-Component_Reference-orderingList-orderingList]]
.[sgmltag]+<r:select>+
-image::images/figu-Component_Reference-orderingList-orderingList.png[]
+image::figu-Component_Reference-orderingList-orderingList.png[]
[[sect-Component_Reference-orderingList-Basic_usage]]
@@ -3075,7 +3075,7 @@ The [sgmltag]+<r:pickList>+ is a component for selecting items from a list. Addi
[[figu-Component_Reference-pickList-pickList]]
.[sgmltag]+<r:select>+
-image::images/figu-Component_Reference-pickList-pickList.png[]
+image::figu-Component_Reference-pickList-pickList.png[]
[[sect-Component_Reference-pickList-Basic_usage]]
@@ -3183,7 +3183,7 @@ The [sgmltag]+<r:panel>+ component is a bordered panel with an optional header.
[[figu-Component_Reference-panel-panel]]
.[sgmltag]+<r:panel>+
-image::images/figu-Component_Reference-panel-panel.png[]
+image::figu-Component_Reference-panel-panel.png[]
[[sect-Component_Reference-panel-Basic_usage]]
@@ -3231,7 +3231,7 @@ ____
[[figu-Component_Reference-panel-Adding_a_header]]
.Adding a header
-image::images/figu-Component_Reference-panel-Adding_a_header.png[]
+image::figu-Component_Reference-panel-Adding_a_header.png[]
@@ -3264,7 +3264,7 @@ The [sgmltag]+<r:accordion>+ is a series of panels stacked on top of each other,
[[figu-Component_Reference-accordion-accordion]]
.A [sgmltag]+<r:accordion>+ component containing three [sgmltag]+<r:accordionItem>+ components
-image::images/figu-Component_Reference-accordion-accordion.png[]
+image::figu-Component_Reference-accordion-accordion.png[]
[[sect-Component_Reference-accordion-Basic_usage]]
@@ -3379,7 +3379,7 @@ The [sgmltag]+<r:collapsiblePanel>+ component is a collapsible panel that shows
[[figu-Component_Reference-collapsiblePanel-collapsiblePanel]]
.[sgmltag]+<r:collapsiblePanel>+
-image::images/figu-Component_Reference-collapsiblePanel-collapsiblePanel.png[]
+image::figu-Component_Reference-collapsiblePanel-collapsiblePanel.png[]
[[sect-Component_Reference-collapsiblePanel-Basic_usage]]
@@ -3556,7 +3556,7 @@ ____
[[figu-Component_Reference-popupPanel-Header_and_controls]]
.Header and controls
-image::images/figu-Component_Reference-popupPanel-Header_and_controls.png[]
+image::figu-Component_Reference-popupPanel-Header_and_controls.png[]
@@ -3609,7 +3609,7 @@ The [sgmltag]+<r:tabPanel>+ component provides a set of tabbed panels for displa
[[figu-Component_Reference-tabPanel-tabPanel_component]]
.A [sgmltag]+<r:tabPanel>+ component containing three [sgmltag]+<r:tab>+ components
-image::images/figu-Component_Reference-tabPanel-tabPanel_component.png[]
+image::figu-Component_Reference-tabPanel-tabPanel_component.png[]
[NOTE]
@@ -4137,7 +4137,7 @@ ____
[[figu-Component_Reference-dataTable_example-dataTable_example]]
.[sgmltag]+<r:dataTable>+ example
-image::images/figu-Component_Reference-dataTable_example.png[]
+image::figu-Component_Reference-dataTable_example.png[]
@@ -4231,7 +4231,7 @@ ____
[[figu-Component_Reference-Basic_column_example-Basic_column_example]]
.Basic column example
-image::images/figu-Component_Reference-column-Basic_column_example.png[]
+image::figu-Component_Reference-column-Basic_column_example.png[]
@@ -4275,7 +4275,7 @@ ____
[[figu-Component_Reference-Column_spanning_example-Column_spanning_example]]
.Column spanning example
-image::images/figu-Component_Reference-column-Column_spanning_example.png[]
+image::figu-Component_Reference-column-Column_spanning_example.png[]
@@ -4321,7 +4321,7 @@ ____
[[figu-Component_Reference-Row_spanning_example-Row_spanning_example]]
.Row spanning example
-image::images/figu-Component_Reference-column-Row_spanning_example.png[]
+image::figu-Component_Reference-column-Row_spanning_example.png[]
@@ -4399,7 +4399,7 @@ The [sgmltag]+<r:columnGroup>+ can also be used to create complex headers in a t
____
.Complex headers using column groups[[figu-Component_Reference-Complex_headers_using_column_groups-Complex_headers_using_column_groups,Complex headers using column groups]]
-image::images/figu-Component_Reference-columnGroup-Complex_headers_using_column_groups.png[]
+image::figu-Component_Reference-columnGroup-Complex_headers_using_column_groups.png[]
@@ -4501,7 +4501,7 @@ In addition, the [sgmltag]+<r:collapsibleSubTable>+ component typically needs a
The resulting tables contains multiple sub-tables, grouping the list of cars by vendor. Each sub-table can be expanded or collapsed using the toggle with the vendor's name. The screenshot shows all sub-tables collapsed except for the sub-table for Ford cars.
-image::images/figu-Component_Reference-collapsibleSubTable-Basic_usage.png[A data table containing multiple collapsible sub-tables.]
+image::figu-Component_Reference-collapsibleSubTable-Basic_usage.png[A data table containing multiple collapsible sub-tables.]
====
@@ -4672,7 +4672,7 @@ This example [sgmltag]+<r:extendedDataTable>+ component demonstrates horizontal
----
-image::images/figu-Component_Reference-Tables_and_grids-extendedDataTable_example.png[A data table made using the +&lt;r:extendedDataTable&gt;+ component. It features horizontal and vertical scrolling and frozen columns.]
+image::figu-Component_Reference-Tables_and_grids-extendedDataTable_example.png[A data table made using the +&lt;r:extendedDataTable&gt;+ component. It features horizontal and vertical scrolling and frozen columns.]
====
@@ -4788,7 +4788,7 @@ public class ExtTableSelectionBean implements Serializable{
----
-image::images/figu-Component_Reference-Tables_and_grids-Selecting_multiple_rows.png[The example table with the first, second, third, and fifth rows selected.]
+image::figu-Component_Reference-Tables_and_grids-Selecting_multiple_rows.png[The example table with the first, second, third, and fifth rows selected.]
====
@@ -4801,13 +4801,13 @@ Columns in a [sgmltag]+<r:extendedDataTable>+ component can be rearranged by the
[[figu-Component_Reference-extendedDataTable-Dragging_columns]]
.Dragging columns
-image::images/figu-Component_Reference-Tables_and_grids-Dragging_columns.png[width="444"]
+image::figu-Component_Reference-Tables_and_grids-Dragging_columns.png[width="444"]
[[figu-Component_Reference-extendedDataTable-Rearranged_columns]]
.Rearranged columns
-image::images/figu-Component_Reference-Tables_and_grids-Rearranged_columns.png[width="444"]
+image::figu-Component_Reference-Tables_and_grids-Rearranged_columns.png[width="444"]
[[sect-Component_Reference-extendedDataTable-State_saving]]
@@ -4864,7 +4864,7 @@ The [sgmltag]+<r:dataGrid>+ component is similar in function to the JavaServer F
[[figu-Component_Reference-dataGrid-The_dataGrid_component]]
.The [sgmltag]+<r:dataGrid>+ component
-image::images/figu-Component_Reference-dataGrid-The_dataGrid_component.png[]
+image::figu-Component_Reference-dataGrid-The_dataGrid_component.png[]
[[sect-Component_Reference-dataGrid-Basic_usage]]
@@ -4918,7 +4918,7 @@ ____
[[figu-Component_Reference-dataGrid_example-dataGrid_example]]
.[sgmltag]+<r:dataGrid>+ example
-image::images/figu-Component_Reference-dataGrid-dataGrid_example.png[]
+image::figu-Component_Reference-dataGrid-dataGrid_example.png[]
@@ -4971,21 +4971,21 @@ By default, the list is displayed as an un-ordered bullet-point list. The [varna
[[figu-Component_Reference-list-Unordered_list]]
.Unordered list
-image::images/figu-Component_Reference-list-Unordered_list.png[]
+image::figu-Component_Reference-list-Unordered_list.png[]
+ordered+:: The list is presented as a numbered series of items, similar to the [sgmltag]+<ol>+ HTML element.
[[figu-Component_Reference-list-Ordered_list]]
.Ordered list
-image::images/figu-Component_Reference-list-Ordered_list.png[]
+image::figu-Component_Reference-list-Ordered_list.png[]
+definitions+:: The list is presented as a series of data definitions. Part of the data model, specified as the term, is listed prominently. The other associated data is listed after each term.
[[figu-Component_Reference-list-Data_definition_list]]
.Data definition list
-image::images/figu-Component_Reference-list-Data_definition_list.png[]
+image::figu-Component_Reference-list-Data_definition_list.png[]
The term is marked using the +term+ facet. The facet is required for all definition lists. Use of the facet is shown in <<exam-Component_Reference-list-Data_definition_list>>.
@@ -5050,7 +5050,7 @@ ____
[[figu-Component_Reference-list-list_example]]
.[sgmltag]+<r:list>+ example
-image::images/figu-Component_Reference-list-Unordered_list.png[]
+image::figu-Component_Reference-list-Unordered_list.png[]
@@ -5084,7 +5084,7 @@ The [sgmltag]+<r:dataScroller>+ component is used for navigating through multipl
[[figu-Component_Reference-dataScroller-The_dataScroller_component]]
.The [sgmltag]+<r:dataScroller>+ component
-image::images/figu-Component_Reference-dataScroller-The_dataScroller_component.png[]
+image::figu-Component_Reference-dataScroller-The_dataScroller_component.png[]
[[sect-Component_Reference-dataScroller-Basic_usage]]
@@ -5293,7 +5293,7 @@ The built-in filter controls can be disabled on a column-by-column basis by sett
The example uses a filter expression on the first column and a filter method on the second column.
-image::images/figu-Component_Reference-Table_filtering-External_filtering.png[A table of state capitals filtered by states beginning with the letter " a", further filtered to those states in the GMT-5 time zone.]
+image::figu-Component_Reference-Table_filtering-External_filtering.png[A table of state capitals filtered by states beginning with the letter " a", further filtered to those states in the GMT-5 time zone.]
====
@@ -5526,7 +5526,7 @@ The tree then accesses the nodes of the model using the +station+ variable:
----
-image::images/exam-Component_Reference-tree-Basic_usage.png[]
+image::exam-Component_Reference-tree-Basic_usage.png[]
====
@@ -5558,7 +5558,7 @@ Different nodes in the tree can have different appearances, such as node icons,
----
-image::images/exam-Component_Reference-tree-nodeType_attribute.png[]
+image::exam-Component_Reference-tree-nodeType_attribute.png[]
====
@@ -5860,7 +5860,7 @@ The [function]+getDirectories()+ function is used recursively until the object h
The resulting tree hierarchically lists the directories and files in the collection.
-image::images/exam-Component_Reference-treeModelRecursiveAdaptor-Basic_usage.png[A hierarchical tree detailing a file system.]
+image::exam-Component_Reference-treeModelRecursiveAdaptor-Basic_usage.png[A hierarchical tree detailing a file system.]
====
@@ -5897,7 +5897,7 @@ The [sgmltag]+<r:dropDownMenu>+ component is used for creating a drop-down, hier
[[figu-Component_Reference-dropDownMenu-dropDownMenu]]
.[sgmltag]+<r:dropDownMenu>+
-image::images/figu-Component_Reference-dropDownMenu-dropDownMenu.png[]
+image::figu-Component_Reference-dropDownMenu-dropDownMenu.png[]
[[sect-Component_Reference-dropDownMenu-Basic_usage]]
@@ -5972,7 +5972,7 @@ The [sgmltag]+<r:contextMenu>+ component is used for creating a hierarchical con
[[figu-Component_Reference-contextMenu-contextMenu]]
.[sgmltag]+<r:contextMenu>+
-image::images/figu-Component_Reference-contextMenu-contextMenu.png[]
+image::figu-Component_Reference-contextMenu-contextMenu.png[]
[[sect-Component_Reference-contextMenu-Basic_usage]]
@@ -6199,7 +6199,7 @@ The [sgmltag]+<r:panelMenu>+ component is used in conjunction with [sgmltag]+<r:
----
-image::images/figu-Component_Reference-panelMenu-panelMenu.png[A panel menu. The first menu group is collapsed. The second menu group is expanded; it contains menu items and a further menu group, which is currently selected and expanded. The third menu item is not a group and as such is not expandable.]
+image::figu-Component_Reference-panelMenu-panelMenu.png[A panel menu. The first menu group is collapsed. The second menu group is expanded; it contains menu items and a further menu group, which is currently selected and expanded. The third menu item is not a group and as such is not expandable.]
====
@@ -6243,7 +6243,7 @@ Icons for the panel menu can be chosen from a set of standard icons. Icons can b
[[figu-Component_Reference-panelMenu-Standard_icons]]
.[sgmltag]+<Standard icons>+
-image::images/figu-Component_Reference-panelMenuGroup-Standard_icons.png[]
+image::figu-Component_Reference-panelMenuGroup-Standard_icons.png[]
Alternatively, point the icon attributes to the paths of image files. The image files are then used as icons.
@@ -6400,7 +6400,7 @@ The [sgmltag]+<r:toolbar>+ component is a horizontal toolbar. Any JavaServer Fac
[[figu-Component_Reference-toolbar-toolbar]]
.[sgmltag]+<r:toolbar>+
-image::images/figu-Component_Reference-toolbar-toolbar.png[]
+image::figu-Component_Reference-toolbar-toolbar.png[]
[[sect-Component_Reference-toolbar-Basic_usage]]
@@ -6436,10 +6436,10 @@ Set the width and height of the toolbar using the common [varname]+width+ and [v
Items on the toolbar can be separated by a graphical item separator. Use the [varname]+itemSeparator+ attribute to specify one of the standard separator styles:
* +none+, the default appearance, does not show any item separators.
-* +disc+ shows a small circular disc to separate items: image:images/figu-Component_Reference-toolbar-disc.png[]
-* +grid+ shows a grid pattern to separate items: image:images/figu-Component_Reference-toolbar-grid.png[]
-* +line+ shows a vertical line to separate items: image:images/figu-Component_Reference-toolbar-line.png[]
-* +square+ shows a small square to separate items: image:images/figu-Component_Reference-toolbar-square.png[]
+* +disc+ shows a small circular disc to separate items: image:figu-Component_Reference-toolbar-disc.png[]
+* +grid+ shows a grid pattern to separate items: image:figu-Component_Reference-toolbar-grid.png[]
+* +line+ shows a vertical line to separate items: image:figu-Component_Reference-toolbar-line.png[]
+* +square+ shows a small square to separate items: image:figu-Component_Reference-toolbar-square.png[]
Alternatively, use the [varname]+itemSeparator+ attribute to specify a URL to an image. The image is then used as an item separator. The appearance of the item separator can be additionally customized by using the +itemSeparator+ facet.
@@ -6515,7 +6515,7 @@ Groups of toolbar items can be located on either the left-hand side or the right
The example shows how to locate a toolbar group to the right-hand side of the parent toolbar. It also demonstrates how item separators on the parent toolbar work with toolbar groups.
-image::images/figu-Component_Reference-toolbarGroup-toolbarGroup.png[A toolbar using icons. Two toolbar groups are located on the left-hand side of the toolbar and separated by a grid pattern. The third toolbar group is located to the right-hand side.]
+image::figu-Component_Reference-toolbarGroup-toolbarGroup.png[A toolbar using icons. Two toolbar groups are located on the left-hand side of the toolbar and separated by a grid pattern. The third toolbar group is located to the right-hand side.]
====
@@ -6546,7 +6546,7 @@ The [sgmltag]+<r:message>+ component is rendered in the same way as the standard
[[figu-Component_Reference-message-message_component]]
.r:message component
-image::images/figu-Component_Reference-message-message_component.png[]
+image::figu-Component_Reference-message-message_component.png[]
[[sect-Component_Reference-message-Basic_usage]]
@@ -6627,7 +6627,7 @@ The [sgmltag]+<r:messages>+ components works similarly to the [sgmltag]+<r:messa
[[figu-Component_Reference-messages-messages_component]]
.r:messages component
-image::images/figu-Component_Reference-messages-messages_component.png[]
+image::figu-Component_Reference-messages-messages_component.png[]
[[sect-Component_Reference-messages-Basic_usage]]
@@ -6655,7 +6655,7 @@ The layout of the messages can also be customized through CSS. By default, the m
[[figu-Component_Reference-messages-Messages_in_a_block]]
.Messages in a block
-image::images/figu-Component_Reference-messages-Messages_in_a_block.png[]
+image::figu-Component_Reference-messages-Messages_in_a_block.png[]
Override the [property]+display+ property for all CSS message classes to customize the layout as follows:
@@ -6675,7 +6675,7 @@ Display messages in a list with no icons:: To display the messages in a list for
[[figu-Component_Reference-messages-Messages_in_a_list]]
.Messages in a list
-image::images/figu-Component_Reference-messages-Messages_in_a_list.png[]
+image::figu-Component_Reference-messages-Messages_in_a_list.png[]
Display in-line messages:: To display the messages in line with text, override the message styles as follows:
@@ -6688,7 +6688,7 @@ Display in-line messages:: To display the messages in line with text, override t
[[figu-Component_Reference-messages-In-line_messages]]
.In-line messages
-image::images/figu-Component_Reference-messages-In-line_messages.png[]
+image::figu-Component_Reference-messages-In-line_messages.png[]
[[sect-Component_Reference-messages-Reference_data]]
@@ -6804,7 +6804,7 @@ The [sgmltag]+<r:notifyMessages>+ component is the same as the [sgmltag]+<r:noti
[[figu-Component_Reference-notifyMessages-notifyMessages]]
-image::images/figu-Component_Reference-notifyMessages-notifyMessages.png[width="200"]
+image::figu-Component_Reference-notifyMessages-notifyMessages.png[width="200"]
[[sect-Component_Reference-notifyMessages-Reference_data]]
@@ -6917,7 +6917,7 @@ The [sgmltag]+<r:progressBar>+ component displays a progress bar to indicate the
[[figu-Component_Reference-progressBar-progressBar]]
.[sgmltag]+<r:progressBar>+
-image::images/figu-Component_Reference-progressBar-progressBar.png[]
+image::figu-Component_Reference-progressBar-progressBar.png[]
[[sect-Component_Reference-progressBar-Basic_usage]]
@@ -7069,7 +7069,7 @@ The [sgmltag]+<r:tooltip>+ component provides an informational tool-tip. The too
[[figu-Component_Reference-tooltip-tooltip]]
.[sgmltag]+<r:tooltip>+
-image::images/figu-Component_Reference-toolTip-toolTip.png[]
+image::figu-Component_Reference-toolTip-toolTip.png[]
[[sect-Component_Reference-tooltip-Basic_usage]]
@@ -7451,7 +7451,7 @@ Timed queries are triggered at specified times. This can be useful for calling s
In the example, the selector picks out the odd [sgmltag]+<tr>+ elements that are children of the element with an [code]+id="customlist"+ attribute. The query [code]+addClass(odd)+ is then performed on the selection during page loading ( +load+) such that the +odd+ CSS class is added to the selected elements.
-image::images/Component_Reference-jQuery-jQuery_example.png[A table highlighted in a "zebra" fashion, with every odd row colored.]
+image::Component_Reference-jQuery-jQuery_example.png[A table highlighted in a "zebra" fashion, with every odd row colored.]
====
@@ -7695,7 +7695,7 @@ You can turn validation awareness off by setting the [varname]+validationAware+
[[figu-Component_Reference-focus-Validation_aware]]
.Validation-aware [sgmltag]+<r:focus>+
-image::images/figu-Component_Reference-focus-Validation_aware.png[]
+image::figu-Component_Reference-focus-Validation_aware.png[]
[[sect-Component_Reference-focus-Preserving_focus]]
@@ -7967,7 +7967,7 @@ This component brings a backward compatibility for HTML5 non-compliant browsers
[[figu-Component_Reference-placeholder-Input_components]]
.[sgmltag]+<r:placeholder>+
-image::images/figu-Component_Reference-placeholder-Input_components.png[]
+image::figu-Component_Reference-placeholder-Input_components.png[]
[[sect-Component_Reference-placeholder-Reference_data]]
View
26,050 Component_Reference/src/main/docbook/en-US/Component_Reference.asciidoc.xml
0 additions, 26,050 deletions not shown
View
6 Developer_Guide/pom.xml
@@ -14,7 +14,7 @@
<name>RichFaces Developer Guide</name>
<properties>
- <docname>Developer_Guide.asciidoc</docname>
+ <docname>Developer_Guide</docname>
<bookname>Developer Guide</bookname>
</properties>
@@ -25,10 +25,10 @@
<groupId>org.jboss.maven.plugins</groupId>
<artifactId>maven-jdocbook-plugin</artifactId>
</plugin>
- <!--plugin>
+ <plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
- </plugin>-->
+ </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
View
18,626 Developer_Guide/src/main/docbook/en-US/Developer_Guide.asciidoc.xml
0 additions, 18,626 deletions not shown
View
1  asciidoc/src/main/ruby/RenderAsciidoc.rb
@@ -15,6 +15,7 @@ def render_asciidoc(source, target, backend)
:header_footer => true,
:compact => false,
:attributes => {
+ 'imagesdir' => 'images',
'toc' => '',
'numbered' => '',
'docinfo' => '',
View
23 contributing.asciidoc
@@ -4,30 +4,9 @@
The [productname]#RichFaces# project uses a _docbook_ toolchain to generate it's documentation. Starting with RichFaces 5, we are generating our docbook xml from _asciidoc_ source.
-[NOTE]
-====
-While we are waiting for the key and menu macros to be added to the [productname]#Asciidoctor# project, (see issue link:https://github.com/asciidoctor/asciidoctor/issues/172[issue 172] and link:https://github.com/asciidoctor/asciidoctor/issues/173[issue 173]), we use a fork of asciidoctor included as a git module. This means we cannot use the asciidoctor maven plugin to process our asciidoc source.
-
-Instead we generate the docbook xml from the asciidoc source manually, executing a ruby script. The docbook xml output is stored in source control, so you *only need to execute this script when you make changes* to the asciidoc source.
-====
-
== Building the RichFaces doc
-To build the RichFaces documentation, perform the following steps:
-
-. Generate the docbook xml (optional)
-+
-[NOTE]
-====
-Make sure you have ruby >= 1.9.2 installed
-====
-+
-We use the [productname]#Asciidoctor# tool to generate the docbook xml from the asciidoc source from the root of the RichFaces docs project, run the conversion script.
-+
-----
-[docs]> bundle install
-[docs]> bundle exec ./asciidoc/src/main/ruby/RenderScript.rb
-----
+To build the RichFaces documentation, execute the following command:
. Generate the PDF, html_single, and html files
+
View
35 parent/pom.xml
@@ -40,21 +40,34 @@
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
- <version>0.1.2-SNAPSHOT</version>
+ <version>0.1.3</version>
<executions>
<execution>
- <id>output-html</id>
- <phase>generate-resources</phase>
+ <id>output-xml</id>
+ <phase>generate-sources</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
</execution>
</executions>
<configuration>
- <sourceDirectory>${basedir}/src/main/docbook</sourceDirectory>
- <outputDirectory>${basedir}/target/docbook/en-US</outputDirectory>
- <backend>docbook</backend>
- <doctype>book</doctype>
+ <sourceDirectory>${basedir}/src/main/docbook/en-US</sourceDirectory>
+ <sourceDocumentName>${basedir}/src/main/docbook/en-US/${docname}.asciidoc</sourceDocumentName>
+ <outputDirectory>${basedir}/target/docbook/en-US</outputDirectory>
+ <templateDir>${basedir}/../asciidoc/src/main/backend/slim/docbook45</templateDir>
+ <templateEngine>slim</templateEngine>
+ <headerFooter>true</headerFooter>
+ <compact>false</compact>
+ <imagesDir>images</imagesDir> <!-- TODO: Remove this config when the image/ prefix is removed from image paths -->
+ <attributes>
+ <numbered>true</numbered>
+ <docinfo>true</docinfo>
+ <experimental>true</experimental>
+ </attributes>
+ <toc>true</toc>
+ <backend>docbook45</backend>
+ <doctype>book</doctype>
+ <goalPrefix>asciidoctor</goalPrefix>
</configuration>
</plugin>
<!-- copy the asciidoc source tree for docbook xml processing -->
@@ -64,7 +77,7 @@
<executions>
<execution>
<id>copy-resources</id>
- <phase>generate-resources</phase>
+ <phase>process-sources</phase>
<goals>
<goal>copy-resources</goal>
</goals>
@@ -73,12 +86,6 @@
<resources>
<resource>
<directory>${basedir}/src/main/docbook/en-US</directory>
- <!-- Filter the docbook xml while the asciidoc -> docbook conversion is in transition -->
- <filtering>true</filtering>
- <excludes>
- <exclude>**/Developer_Guide.xml</exclude>
- <exclude>**/Component_Reference.xml</exclude>
- </excludes>
</resource>
</resources>
</configuration>
Please sign in to comment.
Something went wrong with that request. Please try again.