diff --git a/org.eclipse.wb.doc.user/html-src/accesibility.asciidoc b/org.eclipse.wb.doc.user/html-src/accessibility.asciidoc
similarity index 76%
rename from org.eclipse.wb.doc.user/html-src/accesibility.asciidoc
rename to org.eclipse.wb.doc.user/html-src/accessibility.asciidoc
index a968d4811..c8bdb8a28 100644
--- a/org.eclipse.wb.doc.user/html-src/accesibility.asciidoc
+++ b/org.eclipse.wb.doc.user/html-src/accessibility.asciidoc
@@ -1,3 +1,7 @@
+ifdef::env-github[]
+:imagesdir: ../html
+endif::[]
+
= Accessibility
The tool provides the following accessibility features:
@@ -10,9 +14,9 @@ palette and property pane can be traversed using the arrow keys.
component tree and design view as well as for the currently selected
property.
-____
+--
image:userinterface/images/single_selection.png[image]
-____
+--
* Color preferences are provided to control feedback for most layout
managers.
@@ -20,11 +24,11 @@ managers.
* Color is used as an enhancement to various feedbacks in the design
view.
-____
-image:userinterface/images/feedback_drag_grid1.png[image,width=229,height=124]
-image:userinterface/images/feedback_drag_grid2.png[image,width=229,height=124]
-image:userinterface/images/feedback_drag_grid3.png[image,width=229,height=124]
-____
+--
+image:userinterface/images/feedback_drag_grid1.png[image]
+image:userinterface/images/feedback_drag_grid2.png[image]
+image:userinterface/images/feedback_drag_grid3.png[image]
+--
* System high contrast settings are respected
* System fonts, colors and sizes are inherited
diff --git a/org.eclipse.wb.doc.user/html-src/error_reporting.asciidoc b/org.eclipse.wb.doc.user/html-src/error_reporting.asciidoc
index 38a00564a..8989114dc 100644
--- a/org.eclipse.wb.doc.user/html-src/error_reporting.asciidoc
+++ b/org.eclipse.wb.doc.user/html-src/error_reporting.asciidoc
@@ -1,19 +1,20 @@
+ifdef::env-github[]
+:imagesdir: ../html
+endif::[]
+
== Error Reporting
When something unexpected happens (such as an exception being thrown)
while trying to parse a user interface class or perform a design view
operation, the editor will display the following error page:
-[width="100%",cols="50%,50%"]
-|===
-a|
image:images/error_handling_page.png[image]
-a|
-The *link:#CreateReportDialog[Create Report]* button opens up an error
+
+The xref:#CreateReportDialog[*Create Report*] button opens up an error
reporting dialog that will create a bug report that you can submit to
the bug tracking system along with all the needed supporting details.
-link:#CreateReportDialog[image:images/create_report_button.png[image,width=133,height=42]]
+xref:#CreateReportDialog[image:images/create_report_button.png[image]]
The *Reparse* button will cause the current class to be reparsed.
@@ -23,7 +24,6 @@ The *Switch to code* button will switch the editor back to the *Source*
view.
image:images/switch_to_code_button.png[image]
-|===
Clicking the *Show stack trace* link will reveal the captured stack
trace. Clicking the link a second time will hide the stack trace.
@@ -36,34 +36,31 @@ image:images/error_handling_page_stack_trace.png[image]
Clicking the *Create Report* button will open the *Create Report
Dialog*:
-[width="100%",cols="50%,50%"]
-|===
-a|
-image:images/create_report_dialog.png[image,width=394,height=243]
-a|
+image:images/create_report_dialog.png[image]
+
The dialog contains several fields for entering information about the
problem and several options for attaching important support info:
* The Eclipse workspace *.metadata/.log* file is attached. This contains
any exceptions triggered as part of the error.
-* A *link:#Screenshots[screenshot]* of the design view immediately prior
+* A xref:#Screenshots[*screenshot*] of the design view immediately prior
to the exception will be attached. Additional screenshots may be
attached.
* The *Compilation unit of error* (the currently edited class) may be
optionally attached (this is recommended).
-link:support/test_cases.html[Reproducible test cases] are very important
+xref:support/test_cases.adoc[Reproducible test cases] are very important
for quick problem resolution.
* The *Entire project of error* (the currently edited project) may be
optionally attached (recommended if the current class has a lot of
-dependencies). link:support/test_cases.html[Reproducible test cases] are
+dependencies). xref:support/test_cases.adoc[Reproducible test cases] are
very important for quick problem resolution, so including any classes
needed to compile the class you are editing can be important.
-* A *link:#SoftwareHardwareSummary[Software and hardware summary]* is
+* A xref:#SoftwareHardwareSummary[*Software and hardware summary*] is
automatically attached to the case in order to identify any possible
conflicts.
* The WindowBuilder *preferences* are automatically attached to the
case.
-* Any additional *link:#FileAttachments[File attachments]* may be
+* Any additional xref:#FileAttachments[*File attachments*] may be
optionally added to the case (your *eclipse.ini* file, for example, or
any other classes needed by the class you are editing).
@@ -73,7 +70,6 @@ manually submitted to the
discussions]* or bug tracking system
(*https://github.com/eclipse-windowbuilder/windowbuilder/issues[GitHub
Issues]*).
-|===
[#ProductInfo]
=== Screenshots
@@ -81,12 +77,10 @@ Issues]*).
Click on the *Screenshots [.underline]#add..#* link to attach additional
screenshots to the case.
-++++
-
- 
- 
-
-++++
+--
+image:images/screenshots1.png[image]
+image:images/screenshots2.png[image]
+--
[#SoftwareHardwareSummary]
=== Software and hardware summary
@@ -102,16 +96,11 @@ image:images/software_and_hardware_info.png[image]
Click on the *File attachments [.underline]#add..#* link to attach
additional files to the case (such as your *eclipse.ini* file).
+--
+image:images/file_attachments1.png[image]
+image:images/file_attachments2.png[image]
+--
-++++
-
- 
- 
-
-++++
-
-[#ContactOptions]
-[#SubmitManually]
== Manually submit to discussions or bug tracking system
A ZIP file that includes all of the case data (including any images and
diff --git a/org.eclipse.wb.doc.user/html-src/faq.asciidoc b/org.eclipse.wb.doc.user/html-src/faq.asciidoc
index 34e7b62fe..0dc2e227d 100644
--- a/org.eclipse.wb.doc.user/html-src/faq.asciidoc
+++ b/org.eclipse.wb.doc.user/html-src/faq.asciidoc
@@ -1,49 +1,54 @@
-= WindowBuilder Pro FAQ
+ifdef::env-github[]
+:imagesdir: ../html
+endif::[]
+
+= WindowBuilder FAQ
The following are frequently asked questions about WindowBuilder:
-* link:#UpdateManager[What should I do if I'm getting errors using the
+* xref:#UpdateManager[What should I do if I'm getting errors using the
Update Manager?]
-* link:#OtherGUIBuilders[Can WindowBuilder Pro edit windows created with
+* xref:#OtherGUIBuilders[Can WindowBuilder Pro edit windows created with
JBuilder, VA Java, NetBeans, VisualCafe, etc.?]
-* link:#CreatedByHand[Can WindowBuilder Pro edit windows that have been
+* xref:#CreatedByHand[Can WindowBuilder Pro edit windows that have been
created by hand?]
-* link:#Refactor[Can I refactor or otherwise modify the WindowBuilder
+* xref:#Refactor[Can I refactor or otherwise modify the WindowBuilder
Pro generated code?]
-* link:#SpecialTags[Why doesn't WindowBuilder Pro surround generate code
+* xref:#SpecialTags[Why doesn't WindowBuilder Pro surround generate code
with special tags or mark it as read-only?]
-* link:#CantParse[Are there any specific constructs that WindowBuilder
+* xref:#CantParse[Are there any specific constructs that WindowBuilder
Pro can't parse?]
-* link:#Constructor[Why does WindowBuilder Pro generate in the
+* xref:#Constructor[Why does WindowBuilder Pro generate in the
constructor?]
-* link:#CustomWidgets[Can WindowBuilder Pro use custom widgets?]
-* link:#InstantiationException[What should I do if I encounter an
+* xref:#CustomWidgets[Can WindowBuilder Pro use custom widgets?]
+* xref:#InstantiationException[What should I do if I encounter an
InstantiationException or other error when using a custom widget?]
-* link:#Installation[What should I do if WindowBuilder Pro does not
+* xref:#Installation[What should I do if WindowBuilder Pro does not
appear after installation?]
-* link:#DoesNotWork[What should I do if WindowBuilder Pro does not work
+* xref:#DoesNotWork[What should I do if WindowBuilder Pro does not work
after installation?]
-* link:#DesignTab[What can I do if I don't see the Design tab when I
+* xref:#DesignTab[What can I do if I don't see the Design tab when I
edit a window?]
-* link:#Exception[What should I do if I encounter an exception using
+* xref:#Exception[What should I do if I encounter an exception using
WindowBuilder Pro?]
-* link:#ParsingError[What should I do if I encounter Parsing Error?]
-* link:#OutOfMemoryError[What should I do if I encounter an
+* xref:#ParsingError[What should I do if I encounter Parsing Error?]
+* xref:#OutOfMemoryError[What should I do if I encounter an
OutOfMemoryError using WindowBuilder Pro?]
-* link:#NoSuchMethodError[What should I do if I encounter an
-NoSuchMethodError or] link:#NoClassDefFoundError[NoClassDefFoundError
+* xref:#NoSuchMethodError[What should I do if I encounter an
+NoSuchMethodError or] xref:#NoClassDefFoundError[NoClassDefFoundError
using WindowBuilder Pro?]
-* link:#UnsupportedClassVersionError[What should I do if I encounter an
+* xref:#UnsupportedClassVersionError[What should I do if I encounter an
UnsupportedClassVersionError using WindowBuilder Pro?]
-* link:#UnsatisfiedLinkError[What should I do if I encounter an
+* xref:#UnsatisfiedLinkError[What should I do if I encounter an
UnsatisfiedLinkError when launching my SWT application?]
-* link:#Linux[How should WindowBuilder Pro be configured to work on
+* xref:#Linux[How should WindowBuilder Pro be configured to work on
Linux?]
-* link:#SuSELinux[What should I do if I have problems running under SuSE
+* xref:#SuSELinux[What should I do if I have problems running under SuSE
Linux?]
-* link:#LinuxFlashing[How can I prevent the preview window from flashing
+* xref:#LinuxFlashing[How can I prevent the preview window from flashing
under Linux using Metacity]
+[#UpdateManager]
== What should I do if I'm getting errors using the Update Manager?
If you encounter some sort of Eclipse Update Manager failure with
@@ -228,7 +233,7 @@ within WindowBuilder Pro and false at runtime.
An InstantiationException means that WindowBuilder Pro could not create
an instance of a particular class. The most common reason for this is
-that the component is not a link:#CustomWidgets[valid custom widget]. In
+that the component is not a xref:#CustomWidgets[valid custom widget]. In
order to be a valid Swing widget, a class must be a valid Java Bean and
have a public, zero-argument constructor. SWT widgets must have a public
two-argument constructor with parent and style bits as the two
@@ -253,7 +258,7 @@ answer true when the component is loaded within WindowBuilder Pro and
false at runtime.
More detail about the use of custom widgets is available in
-link:#CustomWidgets[this FAQ entry].
+xref:#CustomWidgets[this FAQ entry].
[#Installation]
== What should I do if WindowBuilder Pro does not appear after installation?
@@ -274,12 +279,12 @@ from your eclipse directory and restore those directories from the
Eclipse ZIP file.
After restarting Eclipse, open the Eclipse preference dialog and confirm
-that you see a link:preferences/index.html[WindowBuilder preference
-page]. If *WindowBuilder Pro* still does not appear, check your Eclipse
+that you see a xref:preferences/index.adoc[WindowBuilder preference
+page]. If *WindowBuilder* still does not appear, check your Eclipse
".log" file (found in your /.metadata directory) for any
recorded exceptions and then contact support.If no exceptions are
-present and *WindowBuilder Pro* is still not present, make sure that you
-are using a properly configured Eclipse-based IDE. *WindowBuilder Pro*
+present and *WindowBuilder* is still not present, make sure that you
+are using a properly configured Eclipse-based IDE. *WindowBuilder*
requires the complete *Eclipse SDK* to be present, and will not load
into an Eclipse subset (like EasyEclipse or the MyEclipse All-in-one
edition). The most important piece missing from some Eclipse
@@ -332,13 +337,13 @@ image:features/images/open_with.png[image]
Eclipse remembers the last editor type used with a file. If you don't see the
*Design* tab, that means that you are using the standard Eclipse *Java Editor*
-rather than the *link:features/editing_existing_window.html[WindowBuilder Editor]*.
+rather than the xref:features/editing_existing_window.adoc[*WindowBuilder Editor*].
Open the file with the
-*link:features/editing_existing_window.html[WindowBuilder Editor]* and
+xref:features/editing_existing_window.adoc[*WindowBuilder Editor*] and
you will see both the *Source* and *Design* tabs. Note that Eclipse will
only let you have a file open with one editor at a time, so you may need
to close any existing editor before opening it with the
-*link:features/editing_existing_window.html[WindowBuilder Editor]*.
+xref:features/editing_existing_window.adoc[*WindowBuilder Editor*].
image:features/images/source_design.png[image,width=252,height=70]
@@ -351,13 +356,13 @@ problem. If the problem has been reported in the past, there is a good
chance that it has already been fixed. If the problem still exists, you
should send your Eclipse ".log" file (found in your
*/.metadata* directory) as well as any relevant test cases to
-link:support/product_support.html[support]. Including a
-link:support/test_cases.html[test case] that will help us reproduce the
+xref:support/product_support.adoc[support]. Including a
+xref:support/test_cases.adoc[test case] that will help us reproduce the
problem is very important. The faster we can reproduce the problem, the
faster we can get you a fix. If we can't reproduce a problem, there is
little we can do to help you.
-Ideally, the link:support/test_cases.html[test case] you send should be
+Ideally, the xref:support/test_cases.adoc[test case] you send should be
the same window you were editing when the problem occurred (along with
any supporting files needed to compile it). If that is not possible
(possibly because you aren't allowed to send any code to a 3rd party),
@@ -374,14 +379,14 @@ As suggested by the message, this is error is caused by a parsing
problem. It has nothing to do with licensing. Your Eclipse ".log" file
(found in your */.metadata* directory) should provide a hint
as to the cause of the parsing error. Send the log file as well as a
-test case to link:support/product_support.html[support] (ideally the
+test case to xref:support/product_support.adoc[support] (ideally the
window you are trying to edit). Including a
-link:support/test_cases.html[test case] that will help us reproduce the
+xref:support/test_cases.adoc[test case] that will help us reproduce the
problem is very important. The faster we can reproduce the problem, the
faster we can get you a fix. If we can't reproduce a problem, there is
little we can do to help you.
-Ideally, the link:support/test_cases.html[test case] you send should be
+Ideally, the xref:support/test_cases.adoc[test case] you send should be
the same window you were editing when the problem occurred (along with
any supporting files needed to compile it). If that is not possible
(possibly because you aren't allowed to send any code to a 3rd party),
@@ -392,7 +397,7 @@ the problem at hand (e.g., keep deleting code until the problem goes
away and then restore that last code that was last deleted).
Parsing problems can also be a side effect of the other problems
-described in the link:#DoesNotWork[earlier FAQ entry here] so check each
+described in the xref:#DoesNotWork[earlier FAQ entry here] so check each
of the suggestions there. Refreshing and rebuilding your project using
the *Project > Clean* command can often help as can cleaning your
Eclipse "configuration" directory.
@@ -460,7 +465,7 @@ properly. If a plugin does not load, all of its methods will be
unreachable, and any attempts to access them will trigger a
NoSuchMethodError or NoClassDefFoundError. This problem can usually be
fixed by cleaning your Eclipse "configuration" directory as described in
-this link:#DoesNotWork[earlier FAQ entry].
+this xref:#DoesNotWork[earlier FAQ entry].
[#UnsupportedClassVersionError]
== What should I do if I encounter an UnsupportedClassVersionError using WindowBuilder Pro?
diff --git a/org.eclipse.wb.doc.user/html-src/faq_swing.asciidoc b/org.eclipse.wb.doc.user/html-src/faq_swing.asciidoc
index a2b6cdcd0..b27ae8eb5 100644
--- a/org.eclipse.wb.doc.user/html-src/faq_swing.asciidoc
+++ b/org.eclipse.wb.doc.user/html-src/faq_swing.asciidoc
@@ -1,36 +1,40 @@
+ifdef::env-github[]
+:imagesdir: ../html
+endif::[]
+
= Swing Designer FAQ
The following are frequently asked questions about *Swing Designer*:
-* link:#OtherGUIBuilders[Can Swing Designer edit windows created with
+* xref:#OtherGUIBuilders[Can Swing Designer edit windows created with
JBuilder, VA Java, NetBeans, VisualCafe, etc.?]
-* link:#CreatedByHand[Can Swing Designer edit windows that have been
+* xref:#CreatedByHand[Can Swing Designer edit windows that have been
created by hand?]
-* link:#Refactor[Can I refactor or otherwise modify the Swing Designer
+* xref:#Refactor[Can I refactor or otherwise modify the Swing Designer
generated code?]
-* link:#SpecialTags[Why doesn't Swing Designer surround generate code
+* xref:#SpecialTags[Why doesn't Swing Designer surround generate code
with special tags or mark it as read-only?]
-* link:#CantParse[Are there any specific constructs that Swing Designer
+* xref:#CantParse[Are there any specific constructs that Swing Designer
can't parse?]
-* link:#CustomWidgets[Can Swing Designer use custom widgets?]
-* link:#DesignTab[What can I do if I don't see the Design tab when I
+* xref:#CustomWidgets[Can Swing Designer use custom widgets?]
+* xref:#DesignTab[What can I do if I don't see the Design tab when I
edit a window?]
-* link:#Exception[What should I do if I encounter an exception using
+* xref:#Exception[What should I do if I encounter an exception using
Swing Designer?]
-* link:#ParsingError[What should I do if I encounter "Unknown Window
+* xref:#ParsingError[What should I do if I encounter "Unknown Window
Type (Parsing Error)"?]
-* link:#OutOfMemoryError[What should I do if I encounter an
+* xref:#OutOfMemoryError[What should I do if I encounter an
OutOfMemoryError using Swing Designer?]
-* link:#NoSuchMethodError[What should I do if I encounter an
+* xref:#NoSuchMethodError[What should I do if I encounter an
NoSuchMethodError or NoClassDefFoundError using Swing Designer?]
-* link:#UnsupportedClassVersionError[What should I do if I encounter an
+* xref:#UnsupportedClassVersionError[What should I do if I encounter an
UnsupportedClassVersionError using Swing Designer?]
-* link:#InstantiationException[What should I do if I encounter an
+* xref:#InstantiationException[What should I do if I encounter an
InstantiationException or other error when using a custom widget?]
-* link:#Linux[How should Swing Designer be configured to work on Linux?]
-* link:#SuSELinux[What should I do if I have problems running under SuSE
+* xref:#Linux[How should Swing Designer be configured to work on Linux?]
+* xref:#SuSELinux[What should I do if I have problems running under SuSE
Linux?]
-* link:#LinuxFlashing[How can I prevent the preview window from flashing
+* xref:#LinuxFlashing[How can I prevent the preview window from flashing
under Linux using Metacity]
[#OtherGUIBuilders]
@@ -147,15 +151,15 @@ image:features/images/open_with.png[image]
Eclipse remembers the last editor type used with a file. If you don't see the
*Design* tab, that means that you are using the standard Eclipse *Java Editor*
-rather than the link:features/editing_existing_window.html[*WindowBuilder*]
-*link:features/editing_existing_window.html[Editor]*. Open the file with
-the link:features/editing_existing_window.html[*WindowBuilder*]
-*link:features/editing_existing_window.html[Editor]* and you will see
+rather than the xref:features/editing_existing_window.adoc[*WindowBuilder*]
+xref/editing_existing_window.adoc[*Editor*]. Open the file with
+the xref:features/editing_existing_window.adoc[*WindowBuilder*]
+xref:features/editing_existing_window.adoc[*Editor*] and you will see
both the *Source* and *Design* tabs. Note that Eclipse will only let you
have a file open with one editor at a time, so you may need to close any
existing editor before opening it with the
-link:features/editing_existing_window.html[*WindowBuilder*]
-*link:features/editing_existing_window.html[Editor]*.
+xref:features/editing_existing_window.adoc[*WindowBuilder*]
+xref:features/editing_existing_window.adoc[*Editor*].
image:features/images/source_design.png[image,width=252,height=70]
@@ -298,7 +302,7 @@ contained in the SWT GTK plugin.
An InstantiationException means that Swing Designer could not create an
instance of a particular class. The most common reason for this is that
-the component is not a link:#CustomWidgets[valid custom widget]. In
+the component is not a xref:#CustomWidgets[valid custom widget]. In
order to be a valid Swing widget, a class must be a valid Java Bean and
have a public, zero-argument constructor. SWT widgets must have a public
two-argument constructor with parent and style bits as the two
@@ -323,7 +327,7 @@ answer true when the component is loaded within Swing Designer and false
at runtime.
More detail about the use of custom widgets is available in
-link:#CustomWidgets[this FAQ entry].
+xref:#CustomWidgets[this FAQ entry].
[#Linux]
== How should Swing Designer be configured to work on Linux?
diff --git a/org.eclipse.wb.doc.user/html-src/index.asciidoc b/org.eclipse.wb.doc.user/html-src/index.asciidoc
index 8a96b449c..76037282b 100644
--- a/org.eclipse.wb.doc.user/html-src/index.asciidoc
+++ b/org.eclipse.wb.doc.user/html-src/index.asciidoc
@@ -1,16 +1,20 @@
+ifdef::env-github[]
+:imagesdir: ../html
+endif::[]
+
= WindowBuilder User Guide
*WindowBuilder* is a powerful and easy to use bi-directional Java GUI
designer that makes it very easy to create Java GUI applications without
spending a lot of time writing code to display simple forms. With
*WindowBuilder* you can create complicated windows in minutes. Use the
-link:userinterface/design_view.html[visual designer] and
-link:userinterface/source_view.html[Java code] will be generated for
+xref:userinterface/design_view.adoc[visual designer] and
+xref:userinterface/source_view.adoc[Java code] will be generated for
you. You can easily add controls using drag-and-drop, add
-link:features/event_handling.html[event handlers] to your controls,
+xref:features/event_handling.adoc[event handlers] to your controls,
change various properties of controls using a
-link:userinterface/property_pane.html[property editor],
-link:features/internationalization.html[internationalize] your app
+xref:userinterface/property_pane.adoc[property editor],
+xref:features/internationalization.adoc[internationalize] your app
and much more.
*WindowBuilder* is built as a plug-in to http://www.eclipse.org[Eclipse]
@@ -22,7 +26,7 @@ manage the visual presentation.
Using WYSIWYG layout tools, you don't need to write any lines of java
code - the code will be generated for you by *WindowBuilder*. You can
easily add any component to a container by using drag-and-drop, add an
-link:features/event_handling.html[event handler] to your controls,
+xref:features/event_handling.adoc[event handler] to your controls,
change various properties of controls using property editors and much
more. Generated code doesn't require any additional custom libraries to
compile and run: all of the generated code can be used without having
@@ -33,45 +37,45 @@ _special_ areas) and most user refactorings (you can move, rename and
subdivide methods without a problem).
The editor is composed of the following major
-link:userinterface/index.html[user interface] components:
+xref:userinterface/index.adoc[user interface] components:
-* *link:userinterface/design_view.html[Design View]* - the main visual
+* xref:userinterface/design_view.adoc[*Design View*] - the main visual
layout area.
-* *link:userinterface/source_view.html[Source View]* - write code and
+* xref:userinterface/source_view.adoc[*Source View*] - write code and
review the generated code
-* *link:userinterface/structure_view.html[Structure View]* - composed of
+* xref:userinterface/structure_view.adoc[*Structure View*] - composed of
the *Component Tree* and the *Property Pane.*
-** *link:userinterface/component_tree.html[Component Tree]* - shows the
+** xref:userinterface/component_tree.adoc[*Component Tree*] - shows the
hierarchical relationship between all of the components.
-** *link:userinterface/property_pane.html[Property Pane]* - displays
+** xref:userinterface/property_pane.adoc[*Property Pane*] - displays
properties and events of the selected components.
-* *link:userinterface/palette.html[Palette]* - provides quick access to
+* xref:userinterface/palette.adoc[*Palette*] - provides quick access to
toolkit-specific components.
-* *link:userinterface/toolbar.html[Toolbar]* - provides access to
+* xref:userinterface/toolbar.adoc[*Toolbar*] - provides access to
commonly used commands.
-* *link:userinterface/context_menu.html[Context Menu]* - provides access
+* xref:userinterface/context_menu.adoc[*Context Menu*] - provides access
to commonly used commands.
-The editor also offers the following link:features/index.html[major
+The editor also offers the following xref:features/index.adoc[major
features]:
-* *link:features/bidirectional.html[Bi-directional Code Generation] -*
+* xref:features/bidirectional.adoc[*Bi-directional Code Generation*] -
read and write almost any format and reverse-engineer most hand-written
code
-* *link:features/internationalization.html[Internationalization (i18n) /
-Localization] -* externalize component strings, create and manage
+* xref:features/internationalization.adoc[*Internationalization (i18n) /
+Localization*] - externalize component strings, create and manage
resource bundles.
-* *link:features/custom_composites.html[Custom Composites & Panels]* -
+* xref:features/custom_composites.adoc[*Custom Composites & Panels*] -
create custom, reusable components.
-* *link:features/factories.html[Factories]* - create custom factory
+* xref:features/factories.adoc[*Factories*] - create custom factory
classes and methods.
-* *link:features/visual_inheritance.html[Visual Inheritance]* - create
+* xref:features/visual_inheritance.adoc[*Visual Inheritance*] - create
visual component hierarchies.
-* *link:features/event_handling.html[Event Handling]* - add event
+* xref:features/event_handling.adoc[*Event Handling*] - add event
handlers to your components.
-* *link:features/menu_editing.html[Menu Editing]* - visually create and
+* xref:features/menu_editing.adoc[*Menu Editing*] - visually create and
edit menubars, menu items and popup menus.
-* *link:features/morphing.html[Morphing]* - convert one component type
+* xref:features/morphing.adoc[*Morphing*] - convert one component type
into another.
*Powered by Eclipse Technology +
diff --git a/org.eclipse.wb.doc.user/html-src/index_swing.asciidoc b/org.eclipse.wb.doc.user/html-src/index_swing.asciidoc
index 6a33f3a54..226c499dd 100644
--- a/org.eclipse.wb.doc.user/html-src/index_swing.asciidoc
+++ b/org.eclipse.wb.doc.user/html-src/index_swing.asciidoc
@@ -1,16 +1,20 @@
+ifdef::env-github[]
+:imagesdir: ../html
+endif::[]
+
= Swing Designer User Guide
*Swing Designer* is a powerful and easy to use bi-directional Java GUI
designer that makes it very easy to create Java GUI applications without
spending a lot of time writing code to display simple forms. With *Swing
Designer* you can create complicated windows in minutes. Use the
-link:userinterface/design_view.html[visual designer] and
-link:userinterface/source_view.html[Java code] will be generated for
+xref:userinterface/design_view.adoc[visual designer] and
+xref:userinterface/source_view.adoc[Java code] will be generated for
you. You can easily add controls using drag-and-drop, add
-link:features/event_handling.html[event handlers] to your controls,
+xref:features/event_handling.adoc[event handlers] to your controls,
change various properties of controls using a
-link:userinterface/property_pane.html[property editor],
-link:features/internationalization.html[internationalize] your app
+xref:userinterface/property_pane.adoc[property editor],
+xref:features/internationalization.adoc[internationalize] your app
and much more.
*Swing Designer* builds an abstract syntax tree (AST) to navigate the
@@ -20,7 +24,7 @@ need to write any lines of java code - the code will be generated for
you by *Swing Designer*.
You can easily add any component to a container by using drag-and-drop,
-add an link:features/event_handling.html[event handler] to your
+add an xref:features/event_handling.adoc[event handler] to your
controls, change various properties of controls using property editors
and much more. Generated code doesn't require any additional custom
libraries to compile and run: all of the generated code can be used
@@ -31,45 +35,45 @@ anywhere...not just in _special_ areas) and most user refactorings (you
can move, rename and subdivide methods without a problem).
The editor is composed of the following major
-link:userinterface/index.html[user interface] components:
+xref:userinterface/index.adoc[user interface] components:
-* *link:userinterface/design_view.html[Design View]* - the main visual
+* xref:userinterface/design_view.adoc[*Design View*] - the main visual
layout area.
-* *link:userinterface/source_view.html[Source View]* - write code and
+* xref:userinterface/source_view.adoc[*Source View*] - write code and
review the generated code
-* *link:userinterface/structure_view.html[Structure View]* - composed of
+* xref:userinterface/structure_view.adoc[*Structure View*] - composed of
the *Component Tree* and the *Property Pane.*
-** *link:userinterface/component_tree.html[Component Tree]* - shows the
+** xref:userinterface/component_tree.adoc[*Component Tree*] - shows the
hierarchical relationship between all of the components.
-** *link:userinterface/property_pane.html[Property Pane]* - displays
+** xref:userinterface/property_pane.adoc[*Property Pane*] - displays
properties and events of the selected components.
-* *link:userinterface/palette.html[Palette]* - provides quick access to
+* xref:userinterface/palette.adoc[*Palette*] - provides quick access to
toolkit-specific components.
-* *link:userinterface/toolbar.html[Toolbar]* - provides access to
+* xref:userinterface/toolbar.adoc[*Toolbar*] - provides access to
commonly used commands.
-* *link:userinterface/context_menu.html[Context Menu]* - provides access
+* xref:userinterface/context_menu.adoc[*Context Menu*] - provides access
to commonly used commands.
-The editor also offers the following link:features/index.html[major
+The editor also offers the following xref:features/index.adoc[major
features]:
-* *link:features/bidirectional.html[Bi-directional Code Generation] -*
+* xref:features/bidirectional.adoc[*Bi-directional Code Generation*] -
read and write almost any format and reverse-engineer most hand-written
code
-* *link:features/internationalization.html[Internationalization (i18n) /
-Localization] -* externalize component strings, create and manage
+* xref:features/internationalization.adoc[*Internationalization (i18n) /
+Localization*] - externalize component strings, create and manage
resource bundles.
-* *link:features/custom_composites.html[Custom Composites & Panels]* -
+* xref:features/custom_composites.adoc[*Custom Composites & Panels*] -
create custom, reusable components.
-* *link:features/factories.html[Factories]* - create custom factory
+* xref:features/factories.adoc[*Factories*] - create custom factory
classes and methods.
-* *link:features/visual_inheritance.html[Visual Inheritance]* - create
+* xref:features/visual_inheritance.adoc[*Visual Inheritance*] - create
visual component hierarchies.
-* *link:features/event_handling.html[Event Handling]* - add event
+* xref:features/event_handling.adoc[*Event Handling*] - add event
handlers to your components.
-* *link:features/menu_editing.html[Menu Editing]* - visually create and
+* xref:features/menu_editing.adoc[*Menu Editing*] - visually create and
edit menubars, menu items and popup menus.
-* *link:features/morphing.html[Morphing]* - convert one component type
+* xref:features/morphing.adoc[*Morphing*] - convert one component type
into another.
*Powered by Eclipse Technology +
diff --git a/org.eclipse.wb.doc.user/html-src/quick_start.asciidoc b/org.eclipse.wb.doc.user/html-src/quick_start.asciidoc
index 3b2783df6..66d0cdddb 100644
--- a/org.eclipse.wb.doc.user/html-src/quick_start.asciidoc
+++ b/org.eclipse.wb.doc.user/html-src/quick_start.asciidoc
@@ -1,39 +1,40 @@
-= WindowBuilder Pro Quick Start
-
-image:userinterface/images/userinterface.png[image] +
-
-
-. *Install the latest WindowBuilder Pro build into Eclipse
-link:installation/updatesite_3.4.html[3.4],
-link:installation/updatesite_3.5.html[3.5] or
-link:installation/updatesite_3.6.html[3.6].* +
-
-. *Create a new project using the appropriate
-link:wizards/index.html[project wizard]. +
- *
-. *Use a link:wizards/index.html[class wizard] to create your first GUI
-window or link:features/editing_existing_window.html[edit an existing
-window]* +
-
-. *Choose an appropriate link:layoutmanagers/index.html[layout manager]
-for your window. +
- *
-. *Add various components from the
-link:userinterface/palette.html[Palette] and edit their properties using
-the link:userinterface/property_pane.html[Property Pane]. +
- *
-. *Visually create and edit your window's
-link:features/menu_editing.html[menubar]. +
- *
-. *Add link:features/event_handling.html[event handlers] to various
-widgets to provide behavior. +
- *
-. *If you create a new link:features/custom_composites.html[Composite or
+ifdef::env-github[]
+:imagesdir: ../html
+endif::[]
+
+= WindowBuilder Quick Start
+
+image:userinterface/images/userinterface.png[image]
+
+- *Install the latest WindowBuilder Pro build into Eclipse
+xref:installation/index.adoc[Installation].*
+
+- *Create a new project using the appropriate
+xref:wizards/index.adoc[project wizard].*
+
+- *Use a xref:wizards/index.adoc[class wizard] to create your first GUI
+window or xref:features/editing_existing_window.adoc[edit an existing
+window]*
+
+- *Choose an appropriate xref:layoutmanagers/index.adoc[layout manager]
+for your window.*
+
+- *Add various components from the
+xref:userinterface/palette.adoc[Palette] and edit their properties using
+the xref:userinterface/property_pane.adoc[Property Pane].*
+
+- *Visually create and edit your window's
+xref:features/menu_editing.adoc[menubar].*
+
+- *Add xref:features/event_handling.adoc[event handlers] to various
+widgets to provide behavior.*
+
+- *If you create a new xref:features/custom_composites.adoc[Composite or
JPanel], you can embed it in another window using the
-link:userinterface/palette.html[Choose Component] command. +
- *
-. *You can test launch your window by right-clicking on it and selecting
-Run As > Java Application. +
- *
-. *link:features/internationalization.html[Internationalize] your
+xref:userinterface/palette.adoc[Choose Component] command.*
+
+- *You can test launch your window by right-clicking on it and selecting
+Run As > Java Application.*
+
+- *xref:features/internationalization.adoc[Internationalize] your
application and manage multiple locales.*
\ No newline at end of file
diff --git a/org.eclipse.wb.doc.user/html-src/quick_start_swing.asciidoc b/org.eclipse.wb.doc.user/html-src/quick_start_swing.asciidoc
index 67a5c27d1..b32b2643f 100644
--- a/org.eclipse.wb.doc.user/html-src/quick_start_swing.asciidoc
+++ b/org.eclipse.wb.doc.user/html-src/quick_start_swing.asciidoc
@@ -1,31 +1,34 @@
+ifdef::env-github[]
+:imagesdir: ../html
+endif::[]
+
= Swing Designer Quick Start
-image:userinterface/images/userinterface.png[image] +
-
+image:userinterface/images/userinterface.png[image]
-. *Use a Swing Designer link:wizards/index.html[class wizard] to create
-your first GUI window or link:features/editing_existing_window.html[edit
-an existing window].* +
+- *Use a Swing Designer xref:wizards/index.adoc[class wizard] to create
+your first GUI window or xref:features/editing_existing_window.adoc[edit
+an existing window].*
-. *Choose an appropriate link:layoutmanagers/index.html[layout manager]
-for your window. +
- *
-. *Add various components from the
-link:userinterface/palette.html[Palette] and edit their properties using
-the link:userinterface/property_pane.html[Property Pane].* +
+- *Choose an appropriate xref:layoutmanagers/index.adoc[layout manager]
+for your window.*
+
+- *Add various components from the
+xref:userinterface/palette.adoc[Palette] and edit their properties using
+the xref:userinterface/property_pane.adoc[Property Pane].*
-. *Visually create and edit your window's
-link:features/menu_editing.html[menubar].* +
+- *Visually create and edit your window's
+xref:features/menu_editing.adoc[menubar].*
-. *Add link:features/event_handling.html[event handlers] to various
-widgets to provide behavior. +
- *
-. *If you create a new link:features/custom_composites.html[JPanel], you
+- *Add xref:features/event_handling.adoc[event handlers] to various
+widgets to provide behavior.*
+
+- *If you create a new xref:features/custom_composites.adoc[JPanel], you
can embed it in another window using the
-link:userinterface/palette.html[Choose Component] command. +
- *
-. *You can test launch your window by right-clicking on it and selecting
-Run As > Java Application. +
- *
-. *link:features/internationalization.html[Internationalize] your
+xref:userinterface/palette.adoc[Choose Component] command.*
+
+- *You can test launch your window by right-clicking on it and selecting
+Run As > Java Application.*
+
+- *xref:features/internationalization.adoc[Internationalize] your
application and manage multiple locales.*
\ No newline at end of file
diff --git a/org.eclipse.wb.doc.user/html-src/tipsandtricks.asciidoc b/org.eclipse.wb.doc.user/html-src/tipsandtricks.asciidoc
index 6e8d29bcb..7bd0c3113 100644
--- a/org.eclipse.wb.doc.user/html-src/tipsandtricks.asciidoc
+++ b/org.eclipse.wb.doc.user/html-src/tipsandtricks.asciidoc
@@ -1,3 +1,7 @@
+ifdef::env-github[]
+:imagesdir: ../html
+endif::[]
+
= Tips and Tricks
Here is a collection of useful commands to make you even more
@@ -6,7 +10,7 @@ productive.
== Directly editing widget text in the Design View
To quickly edit the text property a component, select the component in
-the **link:userinterface/design_view.html[Design View]**, and hit the
+the xref:userinterface/design_view.adoc[*Design View*], and hit the
*Space* key to reveal an edit box in which you can set the component's
text property.
@@ -15,36 +19,36 @@ image:userinterface/images/direct_edit.png[image]
== Adding multiple widgets of the same type
Multiple widgets of the same type may be added to the
-*link:userinterface/design_view.html[Design View]* by holding down the
+xref:userinterface/design_view.adoc[*Design View*] by holding down the
*Ctrl* key when selecting the widget in the
-*link:userinterface/palette.html[Palette]*.
+xref:userinterface/palette.adoc[*Palette*].
== Editing properties of multiple widgets at the same time
When multiple controls are selected, all of their shared properties are
-listed in the *link:userinterface/property_pane.html[Property Pane]*. If
+listed in the xref:userinterface/property_pane.adoc[*Property Pane*]. If
not all the selected controls have the same value for a property, the
-property editor in the *link:userinterface/property_pane.html[Property
-Pane]* will be blank.
+property editor in the xref:userinterface/property_pane.adoc[*Property
+Pane] will be blank.
== Configuring the Palette
-The *link:userinterface/palette_manager.html[Palette Manager]* dialog
+The xref:userinterface/palette_manager.adoc[*Palette Manager*] dialog
allows the toolkit-specific palette to be fully configured. Categories,
and entries may be added, edited, rearranged and removed.
== Editing advanced widget properties
-By default, the *link:userinterface/property_pane.html[Property Pane]*
+By default, the xref:userinterface/property_pane.adoc[*Property Pane*]
displays normal properties. To edit expert properties (shown in
_italics_) click the *Show advanced properties*
-image:userinterface/images/filter_advanced_properties.gif[image,width=16,height=16]
+image:userinterface/images/filter_advanced_properties.gif[image]
button to reveal them.
== Reverting a widget property to its default value
To quickly revert a property to its default value, select the property
-in the *link:userinterface/property_pane.html[Property Pane]* and hit
+in the xref:userinterface/property_pane.adoc[*Property Pane*] and hit
the *Delete* key or click *Restore default value*
image:userinterface/images/properties_default.gif[image,width=16,height=16]
button.
@@ -52,6 +56,6 @@ button.
== Hiding code from the parser
Code can be hidden from the parser by enclosing it in
-link:preferences/preferences_code_parsing.html[code hiding tags]. This
+xref:preferences/preferences_code_parsing.adoc[code hiding tags]. This
can be useful, if you need to add some complex dynamic code to your
-layout that can't be parsed by the tool**.**
\ No newline at end of file
+layout that can't be parsed by the tool.
\ No newline at end of file