Skip to content

Commit 5568b07

Browse files
ptzieglerazoitl
authored andcommitted
Fix broken hyperlinks and relative image paths of documentation
- When viewing the documentation from GitHub, the images are not shown as they are contained in the "guide" folder, rather than the "guide-src" folder. - References to other documents use the name of the generated HTML file, not the AsciiDoc file. By using .adoc, this is automatically updated during the conversion.
1 parent 6152564 commit 5568b07

File tree

14 files changed

+101
-43
lines changed

14 files changed

+101
-43
lines changed

org.eclipse.draw2d.doc.isv/guide-src/connections.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
ifdef::env-github[]
2+
:imagesdir: ../guide/
3+
endif::[]
4+
15
= Connections and Routing
26

37
== Connections and Routing

org.eclipse.draw2d.doc.isv/guide-src/coordinates.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
ifdef::env-github[]
2+
:imagesdir: ../guide/
3+
endif::[]
4+
15
= Coordinate Systems
26

37
== Coordinate Systems

org.eclipse.draw2d.doc.isv/guide-src/extensions.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
ifdef::env-github[]
2+
:imagesdir: ../guide/
3+
endif::[]
4+
15
= User-specific Extensions
26

37
== BreakIterator
Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,23 @@
1+
ifdef::env-github[]
2+
:imagesdir: ../guide/
3+
endif::[]
4+
15
= Draw2d Guide
26

37
== Draw2d Programmer's Guide +
48
org.eclipse.draw2d +
59

6-
* link:overview.html[Overview] - the big picture
7-
* link:painting.html[Painting] - details of the paint process and how
10+
* xref:overview.adoc[Overview] - the big picture
11+
* xref:painting.adoc[Painting] - details of the paint process and how
812
nesting affects painting
9-
* link:layout.html[Layout] - preferred size, layout, validating figures
10-
* link:hittest.html[Hit Testing] - finding figures, correcting
13+
* xref:layout.adoc[Layout] - preferred size, layout, validating figures
14+
* xref:hittest.adoc[Hit Testing] - finding figures, correcting
1115
coordinates, modifying the space occupied by a figure
12-
* link:connections.html[Connections and Routing] - connections, anchors,
16+
* xref:connections.adoc[Connections and Routing] - connections, anchors,
1317
decorations, and routing
14-
* link:coordinates.html[Coordinate Systems] - absolute and relative
18+
* xref:coordinates.adoc[Coordinate Systems] - absolute and relative
1519
coordinates, working with absolute coordinates
16-
* link:extensions.html[User-specific Extensions] - customize runtime
20+
* xref:extensions.adoc[User-specific Extensions] - customize runtime
1721
behavior
18-
* link:migration-guide.html[Plug-in Migration Guide] - changes between
22+
* xref:migration-guide.adoc[Plug-in Migration Guide] - changes between
1923
individual releases

org.eclipse.draw2d.doc.isv/guide-src/hittest.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
ifdef::env-github[]
2+
:imagesdir: ../guide/
3+
endif::[]
4+
15
= Hit Testing
26

37
== Hit Testing

org.eclipse.draw2d.doc.isv/guide-src/layout.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
ifdef::env-github[]
2+
:imagesdir: ../guide/
3+
endif::[]
4+
15
= Layout
26

37
== Layout
@@ -84,7 +88,7 @@ in SWT.
8488

8589
In some cases, the top-down process is modified. A common example is
8690
figures whose bounds must wrap around the bounds of their children.
87-
link:connections.html[Connections]
91+
xref:connections.adoc[Connections]
8892

8993
The other special layout case is found in the text package. Text figures
9094
must layout in two steps. First, they contribute fragments into

org.eclipse.draw2d.doc.isv/guide-src/migration-guide.adoc

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
1+
ifdef::env-github[]
2+
:imagesdir: ../guide/
3+
endif::[]
4+
15
= Plug-in Migration Guide
26

37
== Contents
48

5-
* link:#3.15[Migrating from 3.14 to 3.15]
9+
* xref:#migrating-from-314-to-315[Migrating from 3.14 to 3.15]
610

7-
=== [#3.15]#Migrating from 3.14 to 3.15#
11+
=== [#migrating-from-314-to-315]#Migrating from 3.14 to 3.15#
812

913
Draw2D has dropped ICU as the default Java implementation for *`Bidi`* and
1014
*`BreakIterator`*. If clients require a different behavior, they may contribute
11-
their own implementation as described in link:extensions.html[User-specific extensions].
15+
their own implementation as described in xref:extensions.adoc[User-specific extensions].
1216

1317
The selection, stack and property `Actions` of the `GraphicalEditor` can only
1418
hold Strings and no longer support objects of type IAction. Clients can convert

org.eclipse.draw2d.doc.isv/guide-src/overview.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
ifdef::env-github[]
2+
:imagesdir: ../guide/
3+
endif::[]
4+
15
= Draw2d Architecture
26

37
== Draw2d Overview

org.eclipse.draw2d.doc.isv/guide-src/painting.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
ifdef::env-github[]
2+
:imagesdir: ../guide/
3+
endif::[]
4+
15
= Painting
26

37
== Painting of Figures
@@ -61,4 +65,4 @@ image:images/paintclip.gif[image,width=616,height=186]
6165

6266
=== See Also
6367

64-
* link:hittest.html[Hit Testing]
68+
* xref:hittest.adoc[Hit Testing]

org.eclipse.gef.doc.isv/guide-src/guide.adoc

Lines changed: 34 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,28 @@
1+
ifdef::env-github[]
2+
:imagesdir: ../guide/
3+
endif::[]
4+
15
= GEF Developer's Guide
26

37
== GEF Programmer's Guide +
48
org.eclipse.gef
59

6-
* link:#Overview[Overview] - Description of the "big picture"
7-
* link:#When[When to Use] - How can GEF and the Eclipse Platform be used
8-
* link:#EditParts[EditParts] - An introduction to primary building block
9-
of GEF
10-
* link:#GraphicalView[Graphical View] - How to create a Graphical View
11-
of your Model
12-
* link:#Editing[Editing and Edit Policies] - Adding editing support to
13-
your Graphical View
14-
* link:#Lifecycle[Editpart Lifecycle] - Interesting events to know about
15-
* link:#ToolPalette[Tools and Palette]
16-
* link:#Interactions[Interactions] - the GEF interactions and the
17-
players involved
18-
19-
=== [#Overview]#Overview#
10+
* xref:#overview[Overview] - Description of the "big picture"
11+
* xref:#when-can-i-use-gef[When to Use] - How can GEF and the Eclipse Platform
12+
be used
13+
* xref:#an-introduction-to-editparts[EditParts] - An introduction to primary
14+
building block of GEF
15+
* xref:#creating-a-graphical-view-of-a-model[Graphical View] - How to create a
16+
Graphical View of your Model
17+
* xref:#editing-and-editpolicies[Editing and Edit Policies] - Adding editing
18+
support to your Graphical View
19+
* xref:#the-editpart-lifecycle[Editpart Lifecycle] - Interesting events to know
20+
about
21+
* xref:#tools-and-the-palette[Tools and Palette]
22+
* xref:#types-of-interactions-in-gef[Interactions] - the GEF interactions and
23+
the players involved
24+
25+
=== [#overview]#Overview#
2026

2127
Draw2d focuses on efficient painting and layout of figures. The GEF
2228
plug-in adds editing on top of Draw2d. The purpose of this framework is
@@ -78,7 +84,7 @@ JFace viewers in that they manage an SWT Control. Viewers are also a
7884
selection provider, and the unit of selection is the EditPart.
7985
____
8086

81-
=== [#When]#When can I use GEF?#
87+
=== [#when-can-i-use-gef]#When can I use GEF?#
8288

8389
GEF can be used anywhere that you can use an SWT Control inside a
8490
Workbench. It could be an editor, a view, a wizard page, etc. Most
@@ -88,7 +94,7 @@ outline page.
8894
GEF requires the Eclipse Rich Client Platform (RCP) and the "views"
8995
plug-in (`org.eclipse.ui.views`), which provides property sheet support.
9096

91-
=== [#EditParts]#An Introduction to EditParts#
97+
=== [#an-introduction-to-editparts]#An Introduction to EditParts#
9298

9399
Editparts associate their view and model, but they also form their own
94100
structure. An editpart maintains children. Usually this corresponds to a
@@ -139,7 +145,7 @@ As the name implies, editparts must support editing the model. But first
139145
we will focus on the initial steps of building an application, which is
140146
to display the initial model.
141147

142-
=== [#GraphicalView]#Creating a Graphical View of a Model#
148+
=== [#creating-a-graphical-view-of-a-model]#Creating a Graphical View of a Model#
143149

144150
Once you have a model and some figures with which to view it, the next
145151
step is to put the pieces together. This means creating the editparts
@@ -256,7 +262,7 @@ model elements for which children editparts should be created.
256262
elements returned here indicate connections for which the editpart is
257263
the source or target.
258264

259-
=== [#Editing]#Editing and EditPolicies#
265+
=== [#editing-and-editpolicies]#Editing and EditPolicies#
260266

261267
Once you have some editparts displayed it's time to start editing.
262268
Editing is usually the most complex task an editpart performs. Editing
@@ -344,7 +350,7 @@ removed or swapped out. The rest of the time it is just a good habit.
344350
GEF also provides several policies for use with these roles. Many of
345351
these policies must be extended to fill in the missing pieces that work
346352
with the application's model. EditPolicies are discussed in more detail
347-
in the section on link:#Interactions[interactions].
353+
in the section on xref:#types-of-interactions-in-gef[interactions].
348354
| image:images/editing2.gif[image]
349355
|===
350356

@@ -356,7 +362,7 @@ encapsulate and combine changes to the application's model.
356362
An application has a single command stack. Commands must be executed
357363
using the command stack rather than directly calling execute.
358364

359-
=== [#Lifecycle]#The EditPart Lifecycle#
365+
=== [#the-editpart-lifecycle]#The EditPart Lifecycle#
360366

361367
With respect to lifecycle, editpart implementations typically only have
362368
to worry about extending activation and deactivation, which is when the
@@ -448,7 +454,7 @@ editparts should not contain any important state that must be restored
448454
on undo.
449455
|===
450456

451-
=== [#ToolPalette]#Tools and the Palette#
457+
=== [#tools-and-the-palette]#Tools and the Palette#
452458

453459
A tool handles most events from a viewer. The `EditDomain` keeps track
454460
of the currently active tool. Applications may use the palette
@@ -470,7 +476,7 @@ A tool is activated by setting it on the EditDomain. There is only one
470476
active tool for all viewers in the domain. If a palette is being used,
471477
selecting a tool in the palette will activate that tool.
472478

473-
==== [#Tools/Selection]#The Selection Tool#
479+
==== [#the-selection-tool]#The Selection Tool#
474480

475481
The Selection Tool is the primary tool used in GEF and is often the
476482
default for an application. The selection tool is unique in its ability
@@ -495,7 +501,7 @@ selection gesture, it modifies the viewer's selection. Trackers even
495501
handle events like double-click.
496502

497503
For more on the selection tool and trackers, see the section on
498-
link:#Interactions/Selection[Selection Interaction].
504+
xref:#selection[Selection Interaction].
499505

500506
==== Palette
501507

@@ -517,13 +523,13 @@ The PaletteViewer displays a Palette model, which starts with the
517523
which open and close, or groups, which do not. Each grouping element
518524
then contains Palette Entries. An Entry defines either a tool or
519525
template for the User. Templates are described below in
520-
link:#Interactions/Creation[Creation].
526+
xref:#creation[Creation].
521527

522528
The Palette provides several display modes, such as icon-only. You can
523529
also provide a customizer to allow the user to modify or create palette
524530
content.
525531

526-
=== [#Interactions]#Types of Interactions in GEF#
532+
=== [#types-of-interactions-in-gef]#Types of Interactions in GEF#
527533

528534
This section discusses the various types of interactions that are
529535
included in the framework, and which parts of the framework are involved
@@ -551,7 +557,7 @@ These are just constants defined on the EditPolicy interface.
551557
* Any EditPolicy implementations provided in GEF for use with the
552558
interaction.
553559

554-
==== [#Interactions/Selection]#Selection#
560+
==== [#selection]#Selection#
555561

556562
[.custom,width="100%",cols="25%,25%,25%,25%",options="header"]
557563
|===
@@ -573,7 +579,7 @@ No interaction is more basic or universal than selecting items in a
573579
viewer. Most of the interactions discussed here operate on what is
574580
currently selected. Yet, selection is a complex topic and there are
575581
several steps involved. The Selection Tool was
576-
link:#Tools/Selection[briefly discussed] in the above section on tools.
582+
xref:#the-selection-tool[briefly discussed] in the above section on tools.
577583

578584
Let's first define selection. Selection is a List of EditParts
579585
maintained by an EditPartViewer. Changes to the selection are made by
@@ -736,7 +742,7 @@ deleted as part of multiple selection. The logic example's delete
736742
command addresses all of these concerns.
737743
|===
738744

739-
==== [#Interactions/Creation]#Creation#
745+
==== [#creation]#Creation#
740746

741747
[.custom,width="100%",cols="25%,25%,25%,25%",options="header",]
742748
|===

0 commit comments

Comments
 (0)