Skip to content

Commit c0cab9a

Browse files
committed
fixing more links, using more xrefs
1 parent 07143df commit c0cab9a

File tree

69 files changed

+183
-180
lines changed

Some content is hidden

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

69 files changed

+183
-180
lines changed

antora.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,13 @@ asciidoc:
88
baseurl: localhost:4000/tinymce/4
99
shared_baseurl:
1010
cdnurl: https://cdn.tiny.cloud/1/no-api-key/tinymce/4.9/tinymce.min.js
11-
moxiemanager_site: https://www.moxiemanager.com
1211
downloadspage: https://www.tiny.cloud/get-tiny/downloads/
1312
contactpage: https://www.tiny.cloud/contact
1413
pricingpage: https://www.tiny.cloud/pricing
14+
moxiemanagerhome: https://www.moxiemanager.com
15+
moxiemanagerdocs: https://www.moxiemanager.com/documentation/
16+
accountsignuppage: https://www.tiny.cloud/auth/signup
17+
tinymceproductsfeatures: https://www.tiny.cloud/tinymce/features/
1518
default_meta_keywords: tinymce, documentation, docs, plugins, customizable skins, configuration, examples, html, php, java, javascript, image editor, inline editor, distraction-free editor, classic editor
1619
nav:
1720
- modules/ROOT/nav.adoc

modules/ROOT/pages/advanced/boilerplate-content-css.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
There are a few advanced features in TinyMCE that require some CSS to be added to the page that displays the contents produced by the editor. In general, you want to get an as clean output as possible from a rich text editor, and some of the more advanced features like captioned images use CSS rather than inline styles to render correctly.
1010

11-
This Boilerplate CSS can be used to style these advanced elements. This CSS file can be used within the editor using the link:{rootDir}configure/content-appearance/#content_css[content_css] option and also on your page where the saved content is presented.
11+
This Boilerplate CSS can be used to style these advanced elements. This CSS file can be used within the editor using the xref:configure/content-appearance.adoc#content_css[content_css] option and also on your page where the saved content is presented.
1212

1313
[source,css]
1414
----

modules/ROOT/pages/advanced/creating-a-custom-button.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Here is the full code (you can experiment on it by clicking _Edit on Codepen_ in
9797

9898
As you see we've supplied identifier of our button in the `toolbar` property, along with `undo` and `redo` (`code` plugin is also included - so that you could see HTML code that gets generated). So whenever the user clicks _Insert Current Date_, the date will be inserted into the editor at the current cursor position. Notice how `undo` button gets enabled after insertion, that's because we handle modification history for you.
9999

100-
Another point is `setup` callback - see how we put all of our code into it? It is the callback that TinyMCE will link:{rootDir}configure/integration-and-setup/#setup[automatically invoke] for every initialised editor instance. It will receive a reference to the instance as the first argument. We can use `setup` callback to customize editor to our taste - here we are adding a button, but we could also add custom keyboard shortcuts, menus and everything that has to be added _before_ the editor is ready.
100+
Another point is `setup` callback - see how we put all of our code into it? It is the callback that TinyMCE will xref:configure/integration-and-setup.adoc#setup[automatically invoke] for every initialised editor instance. It will receive a reference to the instance as the first argument. We can use `setup` callback to customize editor to our taste - here we are adding a button, but we could also add custom keyboard shortcuts, menus and everything that has to be added _before_ the editor is ready.
101101

102102
[[button-options]]
103103
== Button options
@@ -111,15 +111,15 @@ Button configuration properties:
111111
* *tooltip* - _tooltip to pop up on hover_
112112
* *onclick* - _callback to call when button is clicked_
113113
* *onpostrender* - _callback to call when button is rendered_
114-
* *cmd* - _editor command to invoke, when button is clicked (command link:{rootDir}api/tinymce/tinymce.editorcommands/#addcommands[should be registered] prior to this, either by editor or by you)_
114+
* *cmd* - _editor command to invoke, when button is clicked (command xref:api/tinymce/tinymce.editorcommands.adoc#addcommands[should be registered] prior to this, either by editor or by you)_
115115

116116
[[conditionally-disable-button]]
117117
== Conditionally disable button
118118
anchor:conditionallydisablebutton[historical anchor]
119119

120120
You probably do not want your button to be enabled at all times since sometimes it might fall out of context. For example, it would be awkward if we could insert `<time>` tag into another `<time>` tag, right? And you can see in the example above, that it _is_ possible.
121121

122-
So basically we need a way to monitor the cursor position and disable our button when it's inappropriate. For this purpose, we can hook onto a link:{rootDir}advanced/events/#nodechange[NodeChange event], that gets fired when cursor jumps from one node to another.
122+
So basically we need a way to monitor the cursor position and disable our button when it's inappropriate. For this purpose, we can hook onto a xref:advanced/events.adoc#nodechange[NodeChange event], that gets fired when cursor jumps from one node to another.
123123

124124
[source,js]
125125
----

modules/ROOT/pages/advanced/editor-command-identifiers.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
:keywords: editorcommands editorcommand execcommand Bold Italic Underline Strikethrough Superscript Subscript Cut Copy Paste Unlink JustifyLeft JustifyCenter JustifyRight JustifyFull JustifyNone InsertUnorderedList InsertOrderedList ForeColor HiliteColor FontName FontSize RemoveFormat mceBlockQuote FormatBlock mceInsertContent mceToggleFormat mceSetContent Indent Outdent InsertHorizontalRule mceToggleVisualAid mceInsertLink selectAll delete mceNewDocument Undo Redo mceAutoResize mceShowCharmap mceCodeEditor mceDirectionLTR mceDirectionRTL mceFullPageProperties mceFullscreen mceImage mceInsertDate mceInsertTime mceInsertDefinitionList mceNonBreaking mcePageBreak mcePreview mcePrint mceSave SearchReplace mceSpellcheck mceInsertTemplate mceVisualBlocks mceVisualChars mceMedia mceAnchor mceTableSplitCells mceTableMergeCells mceTableInsertRowBefore mceTableInsertRowAfter mceTableInsertColBefore mceTableInsertColAfter mceTableDeleteCol mceTableDeleteRow mceTableCutRow mceTableCopyRow mceTablePasteRowBefore mceTablePasteRowAfter mceTableDelete mceInsertTable mceTableRowProps mceTableCellProps mceEditImage
77
:title_nav: Editor Command Identifiers
88

9-
Here is a list of the currently exposed editor commands. All these commands are provided by `tinymce` and not by the browser's internal commands. These commands can be executed using the link:{rootDir}api/tinymce/tinymce.editorcommands/#execcommand[execCommand] function.
9+
Here is a list of the currently exposed editor commands. All these commands are provided by `tinymce` and not by the browser's internal commands. These commands can be executed using the xref:api/tinymce/tinymce.editorcommands.adoc#execcommand[execCommand] function.
1010

1111
|===
1212
| Command | Core/Plugin | Description

modules/ROOT/pages/advanced/editor-control-identifiers.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
:keywords: aligncenter alignjustify alignleft alignright anchor backcolor blockquote bold bullist cancel cell charmap code column controls copy cut deletetable emoticons fontselect fontsizeselect forecolor formats formatselect fullscreen hr image indent insertdatetime insertfile inserttable italic link ltr media newdocument nonbreaking numlist outdent pagebreak paste pastetext preview print redo removeformat row rtl save searchreplace selectall spellchecker strikethrough styleselect subscript superscript table tableprops template toolbar underline undo unlink visualaid visualblocks visualchars a11ycheck
77
:title_nav: Editor Control Identifiers
88

9-
Here is a list of the toolbar/menu controls that the core and plugins provides. These controls can be configured using the link:{rootDir}configure/editor-appearance/#toolbar[toolbar] or the link:{rootDir}configure/editor-appearance/#menu[menu] config options.
9+
Here is a list of the toolbar/menu controls that the core and plugins provides. These controls can be configured using the xref:configure/editor-appearance.adoc#toolbar[toolbar] or the xref:configure/editor-appearance.adoc#menu[menu] config options.
1010

1111
[[toolbar-controls]]
1212
== Toolbar controls

modules/ROOT/pages/advanced/handle-async-image-uploads.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
Please note, this image upload feature is available for TinyMCE version 4.2 and above. Alternatively, the Tiny PowerPaste plugin is capable of this functionality in versions of TinyMCE 4.0 and above.
1010

11-
The image uploader is designed to complement the new image editing functionality of TinyMCE 4.2. Images that are edited within TinyMCE can be uploaded using this function. Local images that are added through other means - for example drag and drop when using the link:{rootDir}plugins/paste/#paste_data_images[paste_data_images] configuration property or using Tiny's PowerPaste Plugin - can also be uploaded using this functionality.
11+
The image uploader is designed to complement the new image editing functionality of TinyMCE 4.2. Images that are edited within TinyMCE can be uploaded using this function. Local images that are added through other means - for example drag and drop when using the xref:plugins/paste.adoc#paste_data_images[paste_data_images] configuration property or using Tiny's PowerPaste Plugin - can also be uploaded using this functionality.
1212

1313
Once uploaded, TinyMCE will automatically update the `<image>` src attribute with the new path to the remote image.
1414

@@ -80,16 +80,16 @@ Multiple configuration options will affect the operation of this feature. These
8080
|===
8181
| Image Upload Handling Option | Description
8282

83-
| link:{rootDir}configure/file-image-upload/#images_upload_url[images_upload_url]
83+
| xref:configure/file-image-upload.adoc#images_upload_url[images_upload_url]
8484
| This option lets you specify a URL to where you want images to be uploaded when you call editor.uploadImages.
8585

86-
| link:{rootDir}configure/file-image-upload/#images_upload_base_path[images_upload_base_path]
86+
| xref:configure/file-image-upload.adoc#images_upload_base_path[images_upload_base_path]
8787
| This option lets you specify a basepath to prepend to urls returned from the configured images_upload_url page.
8888

89-
| link:{rootDir}configure/file-image-upload/#images_upload_credentials[images_upload_credentials]
89+
| xref:configure/file-image-upload.adoc#images_upload_credentials[images_upload_credentials]
9090
| This option lets you specify if calls to the configured images_upload_url should pass along credentials like cookies etc cross domain. This is disabled by default.
9191

92-
| link:{rootDir}configure/file-image-upload/#images_upload_handler[images_upload_handler]
92+
| xref:configure/file-image-upload.adoc#images_upload_handler[images_upload_handler]
9393
| This option lets you replace TinyMCE's default javascript upload handler function with custom logic. The upload handler function takes three arguments, blobInfo, a success callback and a failure callback. When this option is not set, TinyMCE utilizes an XMLHttpRequest to upload images one at a time to the server, and calls the success callback with the location of the remote image.
9494
|===
9595

modules/ROOT/pages/advanced/migration-guide-from-3.x.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ top.tinymce.activeEditor.windowManager.close();
149149
== HTML5 output
150150
anchor:html5output[historical anchor]
151151

152-
TinyMCE produces HTML5 loose output as of 4.0. This means it can handle all new HTML5 elements and also allow the deprecated HTML4 attributes and elements. If you want to use html4 or html5-strict output check the link:{rootDir}configure/content-filtering/#schema[schema] option for details.
152+
TinyMCE produces HTML5 loose output as of 4.0. This means it can handle all new HTML5 elements and also allow the deprecated HTML4 attributes and elements. If you want to use html4 or html5-strict output check the xref:configure/content-filtering.adoc#schema[schema] option for details.
153153

154154
[[using-the-compat3x-plugin]]
155155
== Using the compat3x plugin

modules/ROOT/pages/advanced/usage-with-module-loaders.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ tinymce.init({
6464
== Getting the skin
6565
anchor:gettingtheskin[historical anchor]
6666

67-
TinyMCE will not work without a *skin*, which consists of some fonts and CSS files used by the editor. By default TinyMCE looks for these files in a `/skins` directory located in your root directory, although this can be link:{rootDir}configure/editor-appearance/#skin_url[configured in the init object].
67+
TinyMCE will not work without a *skin*, which consists of some fonts and CSS files used by the editor. By default TinyMCE looks for these files in a `/skins` directory located in your root directory, although this can be xref:configure/editor-appearance.adoc#skin_url[configured in the init object].
6868

6969
No matter where you choose to put it you need a skin, and the quickest way to get started is to copy the skin that comes packaged with TinyMCE, located in `node_modules/tinymce/skins` - either manually copying the files in the finder/file explorer, or using the terminal with a command something like this:
7070

modules/ROOT/pages/changelog.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -371,16 +371,16 @@ anchor:version473november232017[historical anchor]
371371
* Fixed bug where pressing the enter button inside of an h1 with contenteditable set to true would sometimes produce a p tag.
372372
* Fixed bug with backspace not working as expected before a noneditable element.
373373
* Fixed bug where operating on tables with invalid rowspans would cause an error to be thrown.
374-
* Fixed so a real base64 representation of the image is available on the blobInfo that the link:{rootDir}configure/file-image-upload/#images_upload_handler[images_upload_handler] gets called with.
375-
* Fixed so the image upload tab is available when the link:{rootDir}configure/file-image-upload/#images_upload_handler[images_upload_handler] is defined (and not only when the link:{rootDir}configure/file-image-upload/#images_upload_url[images_upload_url] is defined).
374+
* Fixed so a real base64 representation of the image is available on the blobInfo that the xref:configure/file-image-upload.adoc#images_upload_handler[images_upload_handler] gets called with.
375+
* Fixed so the image upload tab is available when the xref:configure/file-image-upload.adoc#images_upload_handler[images_upload_handler] is defined (and not only when the xref:configure/file-image-upload.adoc#images_upload_url[images_upload_url] is defined).
376376

377377
[[version-472-november-7-2017]]
378378
== Version 4.7.2 November 7, 2017
379379
anchor:version472november72017[historical anchor]
380380

381381
* Rewrote the link:{rootDir}plugins/table.html[Table Plugin].
382-
* Rewrote/simplified the CSS for link:{rootDir}configure/content-appearance/#inline_boundaries[inline boundaries] selection by switching to an attribute selector.
383-
* Added support for attributes with colon in link:{rootDir}configure/content-filtering/#valid_elements[valid_elements] and addValidElements.
382+
* Rewrote/simplified the CSS for xref:configure/content-appearance.adoc#inline_boundaries[inline boundaries] selection by switching to an attribute selector.
383+
* Added support for attributes with colon in xref:configure/content-filtering.adoc#valid_elements[valid_elements] and addValidElements.
384384
* Added support for dailymotion short url in the link:{rootDir}plugins/media.html[Media Plugin]. Patch contributed by https://github.com/maat8[maat8].
385385
* Added support for converting to half pt when converting font size from px to pt. Patch contributed by https://github.com/danny6514[danny6514].
386386
* Added support for location hash to the link:{rootDir}plugins/autosave.html[Autosave plugin] to make it work better with SPAs using hash routing.
@@ -438,12 +438,12 @@ anchor:version470october32017[historical anchor]
438438

439439
* Added new mobile UI that is specifically designed for mobile devices. See the link:{rootDir}mobile.html[mobile docs].
440440
* Added an updated the default skin to be more modern. It's now more white (since white is preferred by most implementations).
441-
* Added an updated default menu structure to be more similar to common office suites like Google Docs. To customize the menu, see the link:{rootDir}configure/editor-appearance/#menu[menu] and link:{rootDir}configure/editor-appearance/#menubar[menubar] config docs.
441+
* Added an updated default menu structure to be more similar to common office suites like Google Docs. To customize the menu, see the xref:configure/editor-appearance.adoc#menu[menu] and xref:configure/editor-appearance.adoc#menubar[menubar] config docs.
442442
* Fixed so theme can be set to false on both inline and iframe editor modes.
443443
* Fixed bug where inline editor would add/remove the link:{rootDir}plugins/visualblocks.html[visualblocks] css multiple times.
444444
* Fixed bug where selection wouldn't be properly restored when editor lost focus and commands were invoked.
445445
* Fixed bug where the link:{rootDir}plugins/toc.html[Table of Contents plugin] would generate `id:s` for headers even though a `toc` wasn't inserted into the content.
446-
* Fixed bug where is wasn't possible to drag/drop contents within the editor if link:{rootDir}plugins/paste/#paste_data_images[paste_data_images] was set to true.
446+
* Fixed bug where is wasn't possible to drag/drop contents within the editor if xref:plugins/paste.adoc#paste_data_images[paste_data_images] was set to true.
447447
* Fixed bug where *getParam* and close in *WindowManager* would get the first opened window instead of the last opened window.
448448
* Fixed table bug where `delete` would delete between cells inside a table in Firefox.
449449

@@ -471,7 +471,7 @@ anchor:version467september182017[historical anchor]
471471
anchor:version466august302017[historical anchor]
472472

473473
* Fixed so that notifications wrap long text content instead of bleeding outside the notification element.
474-
* Fixed so the link:{rootDir}configure/content-appearance/#content_style[content_style] css is added after the skin and custom stylesheets.
474+
* Fixed so the xref:configure/content-appearance.adoc#content_style[content_style] css is added after the skin and custom stylesheets.
475475
* Fixed bug where it wasn't possible to remove a table with the cut button.
476476
* Fixed bug where the center format wasn't getting the same font size as the other formats in the format preview.
477477
* Fixed bug where the link:{rootDir}plugins/wordcount.html[Word Count plugin] wasn't counting hyphenated words correctly.
@@ -494,7 +494,7 @@ anchor:version466august302017[historical anchor]
494494
== Version 4.6.5 August 2, 2017
495495
anchor:version465august22017[historical anchor]
496496

497-
* Added new link:{rootDir}configure/content-appearance/#inline_boundaries_selector[inline_boundaries_selector] that allows you to specify the elements that should have boundaries.
497+
* Added new xref:configure/content-appearance.adoc#inline_boundaries_selector[inline_boundaries_selector] that allows you to specify the elements that should have boundaries.
498498
* Added new local upload feature, which allows the user to upload images directly from the image dialog.
499499
* Added a new API for providing meta data for plugins. It will show up in the link:{rootDir}plugins/help.html[Help dialog] if it's provided.
500500
* Fixed so that the notifications created by the notification manager are more screen reader accessible.

0 commit comments

Comments
 (0)