Skip to content

Commit fea1fb8

Browse files
committed
fix api docs links
1 parent 1e4bbef commit fea1fb8

File tree

102 files changed

+4848
-4848
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

102 files changed

+4848
-4848
lines changed

modules/ROOT/pages/api/tinymce.dom/tinymce.dom.bookmarkmanager.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This class handles selection bookmarks.
88
[cols=",,",options="header",]
99
|===
1010
|name |summary |defined by
11-
|link:#bookmarkmanager[BookmarkManager()] |Constructs a new BookmarkManager instance for a specific selection instance. |link:/docs-4x/api/tinymce.dom/tinymce.dom.bookmarkmanager[tinymce.dom.BookmarkManager]
11+
|link:#bookmarkmanager[BookmarkManager()] |Constructs a new BookmarkManager instance for a specific selection instance. |link:{baseurl}/api/tinymce.dom/tinymce.dom.bookmarkmanager.html[tinymce.dom.BookmarkManager]
1212
|===
1313

1414
[[methods]]
@@ -17,9 +17,9 @@ This class handles selection bookmarks.
1717
[cols=",,",options="header",]
1818
|===
1919
|name |summary |defined by
20-
|link:#getbookmark[getBookmark()] |Returns a bookmark location for the current selection. This bookmark object can then be used to restore the selection after some content modification to the document. |link:/docs-4x/api/tinymce.dom/tinymce.dom.bookmarkmanager[tinymce.dom.BookmarkManager]
21-
|link:#isbookmarknode[isBookmarkNode()] |Returns true/false if the specified node is a bookmark node or not. |link:/docs-4x/api/tinymce.dom/tinymce.dom.bookmarkmanager[tinymce.dom.BookmarkManager]
22-
|link:#movetobookmark[moveToBookmark()] |Restores the selection to the specified bookmark. |link:/docs-4x/api/tinymce.dom/tinymce.dom.bookmarkmanager[tinymce.dom.BookmarkManager]
20+
|link:#getbookmark[getBookmark()] |Returns a bookmark location for the current selection. This bookmark object can then be used to restore the selection after some content modification to the document. |link:{baseurl}/api/tinymce.dom/tinymce.dom.bookmarkmanager.html[tinymce.dom.BookmarkManager]
21+
|link:#isbookmarknode[isBookmarkNode()] |Returns true/false if the specified node is a bookmark node or not. |link:{baseurl}/api/tinymce.dom/tinymce.dom.bookmarkmanager.html[tinymce.dom.BookmarkManager]
22+
|link:#movetobookmark[moveToBookmark()] |Restores the selection to the specified bookmark. |link:{baseurl}/api/tinymce.dom/tinymce.dom.bookmarkmanager.html[tinymce.dom.BookmarkManager]
2323
|===
2424

2525
== Constructors
@@ -34,7 +34,7 @@ Constructs a new BookmarkManager instance for a specific selection instance.
3434
[[parameters]]
3535
==== Parameters
3636

37-
* [.param-name]#selection# link:/docs-4x/api/tinymce.dom/tinymce.dom.selection[[.param-type]#(tinymce.dom.Selection)#] - Selection instance to handle bookmarks for.
37+
* [.param-name]#selection# link:{baseurl}/api/tinymce.dom/tinymce.dom.selection.html[[.param-type]#(tinymce.dom.Selection)#] - Selection instance to handle bookmarks for.
3838

3939
== Methods
4040

@@ -65,7 +65,7 @@ tinymce.activeEditor.selection.moveToBookmark(bm);
6565
* [.param-name]#normalized# [.param-type]#(Boolean)# - Optional state that enables you to get a position that it would be after normalization.
6666

6767
[[return-value]]
68-
==== Return value
68+
==== Return value
6969
anchor:returnvalue[historical anchor]
7070

7171
* [.return-type]#Object# - Bookmark object, use moveToBookmark with this object to restore the selection.

modules/ROOT/pages/api/tinymce.dom/tinymce.dom.domquery.adoc

Lines changed: 107 additions & 107 deletions
Large diffs are not rendered by default.

modules/ROOT/pages/api/tinymce.dom/tinymce.dom.domutils.adoc

Lines changed: 60 additions & 60 deletions
Large diffs are not rendered by default.

modules/ROOT/pages/api/tinymce.dom/tinymce.dom.eventutils.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ This class wraps the browsers native event logic with more convenient methods.
88
[cols=",,",options="header",]
99
|===
1010
|name |summary |defined by
11-
|link:#bind[bind()] |Binds a callback to an event on the specified target. |link:/docs-4x/api/tinymce.dom/tinymce.dom.eventutils[tinymce.dom.EventUtils]
12-
|link:#clean[clean()] |Removes all bound event listeners for the specified target. This will also remove any bound listeners to child nodes within that target. |link:/docs-4x/api/tinymce.dom/tinymce.dom.eventutils[tinymce.dom.EventUtils]
13-
|link:#fire[fire()] |Fires the specified event on the specified target. |link:/docs-4x/api/tinymce.dom/tinymce.dom.eventutils[tinymce.dom.EventUtils]
14-
|link:#unbind[unbind()] |Unbinds the specified event by name, name and callback or all events on the target. |link:/docs-4x/api/tinymce.dom/tinymce.dom.eventutils[tinymce.dom.EventUtils]
11+
|link:#bind[bind()] |Binds a callback to an event on the specified target. |link:{baseurl}/api/tinymce.dom/tinymce.dom.eventutils.html[tinymce.dom.EventUtils]
12+
|link:#clean[clean()] |Removes all bound event listeners for the specified target. This will also remove any bound listeners to child nodes within that target. |link:{baseurl}/api/tinymce.dom/tinymce.dom.eventutils.html[tinymce.dom.EventUtils]
13+
|link:#fire[fire()] |Fires the specified event on the specified target. |link:{baseurl}/api/tinymce.dom/tinymce.dom.eventutils.html[tinymce.dom.EventUtils]
14+
|link:#unbind[unbind()] |Unbinds the specified event by name, name and callback or all events on the target. |link:{baseurl}/api/tinymce.dom/tinymce.dom.eventutils.html[tinymce.dom.EventUtils]
1515
|===
1616

1717
== Methods
@@ -32,7 +32,7 @@ Binds a callback to an event on the specified target.
3232
* [.param-name]#scope# [.param-type]#(Object)# - Scope to call the callback function on, defaults to target.
3333

3434
[[return-value]]
35-
==== Return value
35+
==== Return value
3636
anchor:returnvalue[historical anchor]
3737

3838
* [.return-type]#function# - Callback function that got bound.

modules/ROOT/pages/api/tinymce.dom/tinymce.dom.rangeutils.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ This class contains a few utility methods for ranges.
88
[cols=",,",options="header",]
99
|===
1010
|name |summary |defined by
11-
|link:#compareranges[compareRanges()] |Compares two ranges and checks if they are equal. |link:/docs-4x/api/tinymce.dom/tinymce.dom.rangeutils[tinymce.dom.RangeUtils]
12-
|link:#getcaretrangefrompoint[getCaretRangeFromPoint()] |Gets the caret range for the given x/y location. |link:/docs-4x/api/tinymce.dom/tinymce.dom.rangeutils[tinymce.dom.RangeUtils]
11+
|link:#compareranges[compareRanges()] |Compares two ranges and checks if they are equal. |link:{baseurl}/api/tinymce.dom/tinymce.dom.rangeutils.html[tinymce.dom.RangeUtils]
12+
|link:#getcaretrangefrompoint[getCaretRangeFromPoint()] |Gets the caret range for the given x/y location. |link:{baseurl}/api/tinymce.dom/tinymce.dom.rangeutils.html[tinymce.dom.RangeUtils]
1313
|===
1414

1515
== Methods
@@ -28,7 +28,7 @@ Compares two ranges and checks if they are equal.
2828
* [.param-name]#rng2# [.param-type]#(DOMRange)# - First range to compare.
2929

3030
[[return-value]]
31-
==== Return value
31+
==== Return value
3232
anchor:returnvalue[historical anchor]
3333

3434
* [.return-type]#Boolean# - true/false if the ranges are equal.

modules/ROOT/pages/api/tinymce.dom/tinymce.dom.scriptloader.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,12 @@ scriptLoader.loadQueue(function() {
3333
[cols=",,",options="header",]
3434
|===
3535
|name |summary |defined by
36-
|link:#add[add()] |Adds a specific script to the load queue of the script loader. |link:/docs-4x/api/tinymce.dom/tinymce.dom.scriptloader[tinymce.dom.ScriptLoader]
37-
|link:#isdone[isDone()] |Returns true/false if a script has been loaded or not. |link:/docs-4x/api/tinymce.dom/tinymce.dom.scriptloader[tinymce.dom.ScriptLoader]
38-
|link:#load[load()] |Loads a specific script directly without adding it to the load queue. |link:/docs-4x/api/tinymce.dom/tinymce.dom.scriptloader[tinymce.dom.ScriptLoader]
39-
|link:#loadqueue[loadQueue()] |Starts the loading of the queue. |link:/docs-4x/api/tinymce.dom/tinymce.dom.scriptloader[tinymce.dom.ScriptLoader]
40-
|link:#loadscripts[loadScripts()] |Loads the specified queue of files and executes the callback ones they are loaded. This method is generally not used outside this class but it might be useful in some scenarios. |link:/docs-4x/api/tinymce.dom/tinymce.dom.scriptloader[tinymce.dom.ScriptLoader]
41-
|link:#markdone[markDone()] |Marks a specific script to be loaded. This can be useful if a script got loaded outside the script loader or to skip it from loading some script. |link:/docs-4x/api/tinymce.dom/tinymce.dom.scriptloader[tinymce.dom.ScriptLoader]
36+
|link:#add[add()] |Adds a specific script to the load queue of the script loader. |link:{baseurl}/api/tinymce.dom/tinymce.dom.scriptloader.html[tinymce.dom.ScriptLoader]
37+
|link:#isdone[isDone()] |Returns true/false if a script has been loaded or not. |link:{baseurl}/api/tinymce.dom/tinymce.dom.scriptloader.html[tinymce.dom.ScriptLoader]
38+
|link:#load[load()] |Loads a specific script directly without adding it to the load queue. |link:{baseurl}/api/tinymce.dom/tinymce.dom.scriptloader.html[tinymce.dom.ScriptLoader]
39+
|link:#loadqueue[loadQueue()] |Starts the loading of the queue. |link:{baseurl}/api/tinymce.dom/tinymce.dom.scriptloader.html[tinymce.dom.ScriptLoader]
40+
|link:#loadscripts[loadScripts()] |Loads the specified queue of files and executes the callback ones they are loaded. This method is generally not used outside this class but it might be useful in some scenarios. |link:{baseurl}/api/tinymce.dom/tinymce.dom.scriptloader.html[tinymce.dom.ScriptLoader]
41+
|link:#markdone[markDone()] |Marks a specific script to be loaded. This can be useful if a script got loaded outside the script loader or to skip it from loading some script. |link:{baseurl}/api/tinymce.dom/tinymce.dom.scriptloader.html[tinymce.dom.ScriptLoader]
4242
|===
4343

4444
== Methods
@@ -70,7 +70,7 @@ Returns true/false if a script has been loaded or not.
7070
* [.param-name]#url# [.param-type]#(String)# - URL to check for.
7171

7272
[[return-value]]
73-
==== Return value
73+
==== Return value
7474
anchor:returnvalue[historical anchor]
7575

7676
* [.return-type]#Boolean# - true/false if the URL is loaded.

modules/ROOT/pages/api/tinymce.dom/tinymce.dom.selection.adoc

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ alert(tinymce.activeEditor.selection.getNode().nodeName);
1717
[cols=",,",options="header",]
1818
|===
1919
|name |summary |defined by
20-
|link:#selection[Selection()] |Constructs a new selection instance. |link:/docs-4x/api/tinymce.dom/tinymce.dom.selection[tinymce.dom.Selection]
20+
|link:#selection[Selection()] |Constructs a new selection instance. |link:{baseurl}/api/tinymce.dom/tinymce.dom.selection.html[tinymce.dom.Selection]
2121
|===
2222

2323
[[methods]]
@@ -26,22 +26,22 @@ alert(tinymce.activeEditor.selection.getNode().nodeName);
2626
[cols=",,",options="header",]
2727
|===
2828
|name |summary |defined by
29-
|link:#collapse[collapse()] |Collapse the selection to start or end of range. |link:/docs-4x/api/tinymce.dom/tinymce.dom.selection[tinymce.dom.Selection]
30-
|link:#getbookmark[getBookmark()] |Returns a bookmark location for the current selection. This bookmark object can then be used to restore the selection after some content modification to the document. |link:/docs-4x/api/tinymce.dom/tinymce.dom.selection[tinymce.dom.Selection]
31-
|link:#getcontent[getContent()] |Returns the selected contents using the DOM serializer passed in to this class. |link:/docs-4x/api/tinymce.dom/tinymce.dom.selection[tinymce.dom.Selection]
32-
|link:#getend[getEnd()] |Returns the end element of a selection range. If the end is in a text node the parent element will be returned. |link:/docs-4x/api/tinymce.dom/tinymce.dom.selection[tinymce.dom.Selection]
33-
|link:#getnode[getNode()] |Returns the currently selected element or the common ancestor element for both start and end of the selection. |link:/docs-4x/api/tinymce.dom/tinymce.dom.selection[tinymce.dom.Selection]
34-
|link:#getrng[getRng()] |Returns the browsers internal range object. |link:/docs-4x/api/tinymce.dom/tinymce.dom.selection[tinymce.dom.Selection]
35-
|link:#getsel[getSel()] |Returns the browsers internal selection object. |link:/docs-4x/api/tinymce.dom/tinymce.dom.selection[tinymce.dom.Selection]
36-
|link:#getstart[getStart()] |Returns the start element of a selection range. If the start is in a text node the parent element will be returned. |link:/docs-4x/api/tinymce.dom/tinymce.dom.selection[tinymce.dom.Selection]
37-
|link:#iscollapsed[isCollapsed()] |Returns true/false if the selection range is collapsed or not. Collapsed means if it's a caret or a larger selection. |link:/docs-4x/api/tinymce.dom/tinymce.dom.selection[tinymce.dom.Selection]
38-
|link:#movetobookmark[moveToBookmark()] |Restores the selection to the specified bookmark. |link:/docs-4x/api/tinymce.dom/tinymce.dom.selection[tinymce.dom.Selection]
39-
|link:#select[select()] |Selects the specified element. This will place the start and end of the selection range around the element. |link:/docs-4x/api/tinymce.dom/tinymce.dom.selection[tinymce.dom.Selection]
40-
|link:#selectorchanged[selectorChanged()] |Executes callback when the current selection starts/stops matching the specified selector. The current state will be passed to the callback as it's first argument. |link:/docs-4x/api/tinymce.dom/tinymce.dom.selection[tinymce.dom.Selection]
41-
|link:#setcontent[setContent()] |Sets the current selection to the specified content. If any contents is selected it will be replaced with the contents passed in to this function. If there is no selection the contents will be inserted where the caret is placed in the editor/page. |link:/docs-4x/api/tinymce.dom/tinymce.dom.selection[tinymce.dom.Selection]
42-
|link:#setcursorlocation[setCursorLocation()] |Move the selection cursor range to the specified node and offset. If there is no node specified it will move it to the first suitable location within the body. |link:/docs-4x/api/tinymce.dom/tinymce.dom.selection[tinymce.dom.Selection]
43-
|link:#setnode[setNode()] |Sets the current selection to the specified DOM element. |link:/docs-4x/api/tinymce.dom/tinymce.dom.selection[tinymce.dom.Selection]
44-
|link:#setrng[setRng()] |Changes the selection to the specified DOM range. |link:/docs-4x/api/tinymce.dom/tinymce.dom.selection[tinymce.dom.Selection]
29+
|link:#collapse[collapse()] |Collapse the selection to start or end of range. |link:{baseurl}/api/tinymce.dom/tinymce.dom.selection.html[tinymce.dom.Selection]
30+
|link:#getbookmark[getBookmark()] |Returns a bookmark location for the current selection. This bookmark object can then be used to restore the selection after some content modification to the document. |link:{baseurl}/api/tinymce.dom/tinymce.dom.selection.html[tinymce.dom.Selection]
31+
|link:#getcontent[getContent()] |Returns the selected contents using the DOM serializer passed in to this class. |link:{baseurl}/api/tinymce.dom/tinymce.dom.selection.html[tinymce.dom.Selection]
32+
|link:#getend[getEnd()] |Returns the end element of a selection range. If the end is in a text node the parent element will be returned. |link:{baseurl}/api/tinymce.dom/tinymce.dom.selection.html[tinymce.dom.Selection]
33+
|link:#getnode[getNode()] |Returns the currently selected element or the common ancestor element for both start and end of the selection. |link:{baseurl}/api/tinymce.dom/tinymce.dom.selection.html[tinymce.dom.Selection]
34+
|link:#getrng[getRng()] |Returns the browsers internal range object. |link:{baseurl}/api/tinymce.dom/tinymce.dom.selection.html[tinymce.dom.Selection]
35+
|link:#getsel[getSel()] |Returns the browsers internal selection object. |link:{baseurl}/api/tinymce.dom/tinymce.dom.selection.html[tinymce.dom.Selection]
36+
|link:#getstart[getStart()] |Returns the start element of a selection range. If the start is in a text node the parent element will be returned. |link:{baseurl}/api/tinymce.dom/tinymce.dom.selection.html[tinymce.dom.Selection]
37+
|link:#iscollapsed[isCollapsed()] |Returns true/false if the selection range is collapsed or not. Collapsed means if it's a caret or a larger selection. |link:{baseurl}/api/tinymce.dom/tinymce.dom.selection.html[tinymce.dom.Selection]
38+
|link:#movetobookmark[moveToBookmark()] |Restores the selection to the specified bookmark. |link:{baseurl}/api/tinymce.dom/tinymce.dom.selection.html[tinymce.dom.Selection]
39+
|link:#select[select()] |Selects the specified element. This will place the start and end of the selection range around the element. |link:{baseurl}/api/tinymce.dom/tinymce.dom.selection.html[tinymce.dom.Selection]
40+
|link:#selectorchanged[selectorChanged()] |Executes callback when the current selection starts/stops matching the specified selector. The current state will be passed to the callback as it's first argument. |link:{baseurl}/api/tinymce.dom/tinymce.dom.selection.html[tinymce.dom.Selection]
41+
|link:#setcontent[setContent()] |Sets the current selection to the specified content. If any contents is selected it will be replaced with the contents passed in to this function. If there is no selection the contents will be inserted where the caret is placed in the editor/page. |link:{baseurl}/api/tinymce.dom/tinymce.dom.selection.html[tinymce.dom.Selection]
42+
|link:#setcursorlocation[setCursorLocation()] |Move the selection cursor range to the specified node and offset. If there is no node specified it will move it to the first suitable location within the body. |link:{baseurl}/api/tinymce.dom/tinymce.dom.selection.html[tinymce.dom.Selection]
43+
|link:#setnode[setNode()] |Sets the current selection to the specified DOM element. |link:{baseurl}/api/tinymce.dom/tinymce.dom.selection.html[tinymce.dom.Selection]
44+
|link:#setrng[setRng()] |Changes the selection to the specified DOM range. |link:{baseurl}/api/tinymce.dom/tinymce.dom.selection.html[tinymce.dom.Selection]
4545
|===
4646

4747
== Constructors
@@ -56,10 +56,10 @@ Constructs a new selection instance.
5656
[[parameters]]
5757
==== Parameters
5858

59-
* [.param-name]#dom# link:/docs-4x/api/tinymce.dom/tinymce.dom.domutils[[.param-type]#(tinymce.dom.DOMUtils)#] - DOMUtils object reference.
59+
* [.param-name]#dom# link:{baseurl}/api/tinymce.dom/tinymce.dom.domutils.html[[.param-type]#(tinymce.dom.DOMUtils)#] - DOMUtils object reference.
6060
* [.param-name]#win# [.param-type]#(Window)# - Window to bind the selection object to.
61-
* [.param-name]#serializer# link:/docs-4x/api/tinymce.dom/tinymce.dom.serializer[[.param-type]#(tinymce.dom.Serializer)#] - DOM serialization class to use for getContent.
62-
* [.param-name]#editor# link:/docs-4x/api/tinymce/tinymce.editor[[.param-type]#(tinymce.Editor)#] - Editor instance of the selection.
61+
* [.param-name]#serializer# link:{baseurl}/api/tinymce.dom/tinymce.dom.serializer.html[[.param-type]#(tinymce.dom.Serializer)#] - DOM serialization class to use for getContent.
62+
* [.param-name]#editor# link:{baseurl}/api/tinymce/tinymce.editor.html[[.param-type]#(tinymce.Editor)#] - Editor instance of the selection.
6363

6464
== Methods
6565

@@ -101,7 +101,7 @@ tinymce.activeEditor.selection.moveToBookmark(bm);
101101
* [.param-name]#normalized# [.param-type]#(Boolean)# - Optional state that enables you to get a position that it would be after normalization.
102102

103103
[[return-value]]
104-
==== Return value
104+
==== Return value
105105
anchor:returnvalue[historical anchor]
106106

107107
* [.return-type]#Object# - Bookmark object, use moveToBookmark with this object to restore the selection.

0 commit comments

Comments
 (0)