Skip to content

Commit daec4f1

Browse files
hamza0867lnewson
hamza0867
and
lnewson
authored
feature(Plugins/Opensource): Update docs for all open source plugins (#2328)
* feature(Plugins/Opensource): Update docs for all open source plugins * feature(Plugins/Open source): Update files that needed update after #2308 got merged * feature(Plugins/Open source): Add needed id to image_file_types.adoc * Update modules/ROOT/partials/configuration/noneditable_regexp.adoc Co-authored-by: Lee Newson <[email protected]> * Update modules/ROOT/partials/configuration/table_responsive_width.adoc Co-authored-by: Lee Newson <[email protected]> * Update modules/ROOT/partials/configuration/target_list.adoc Co-authored-by: Lee Newson <[email protected]> * Update modules/ROOT/partials/configuration/template_cdate_format.adoc Co-authored-by: Lee Newson <[email protected]> * Update modules/ROOT/partials/configuration/template_mdate_format.adoc Co-authored-by: Lee Newson <[email protected]> * Update modules/ROOT/partials/configuration/textpattern_patterns.adoc Co-authored-by: Lee Newson <[email protected]> * feature(Plugins/Open source): Make requested changes in the review * Update modules/ROOT/partials/configuration/type_ahead_urls.adoc Co-authored-by: Lee Newson <[email protected]> * feature(Plugins/Open source): Make requested changes in the review * feature(Plugins/Open source): Make requested changes in the review * feature(Plugins/Open source): Make requested changes in the review * feature(Plugins/Open source): Make requested changes in the review * Update modules/ROOT/pages/plugins/opensource/image.adoc Co-authored-by: Lee Newson <[email protected]> * feature(Plugins/Open source): Make requested changes in the review Co-authored-by: Lee Newson <[email protected]>
1 parent dbba9b7 commit daec4f1

File tree

128 files changed

+375
-241
lines changed

Some content is hidden

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

128 files changed

+375
-241
lines changed

‎modules/ROOT/pages/plugins/opensource/advlist.adoc‎

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

66
The `advlist` plugin extends the core `bullist` and `numlist` toolbar controls by adding CSS `list-style-type` styled number formats and bullet types to the controls.
77

8-
IMPORTANT: The link:../lists[Lists] (`lists`) plugin must be activated for the `advlist` plugin to work.
8+
IMPORTANT: The xref:plugins/opensource/lists.adoc[Lists] (`lists`) plugin must be activated for the `advlist` plugin to work.
99

1010
== Basic setup
1111

‎modules/ROOT/pages/plugins/opensource/autoresize.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ include::partial$configuration/autoresize_on_init.adoc[]
2828

2929
include::partial$configuration/autoresize_overflow_padding.adoc[]
3030

31-
include::partial$configuration/max_height.adoc[]
31+
include::partial$configuration/max_height.adoc[leveloffset=+1]
3232

33-
include::partial$configuration/min_height.adoc[]
33+
include::partial$configuration/min_height.adoc[leveloffset=+1]
3434

3535
== Commands
3636

‎modules/ROOT/pages/plugins/opensource/bbcode.adoc‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,11 @@
44
:keywords: punbb informer
55
:title_nav: BBCode
66

7-
IMPORTANT: The BBCode plugin (`bbcode`) was deprecated with the release of TinyMCE 5.9. For details, see link:{baseurl}/release-notes/release-notes59/#thebbcodebbcodeplugin[the BBCode plugin deprecation notice]. The BBCode plugin will be removed in TinyMCE 6.0.
7+
IMPORTANT: The BBCode plugin (`bbcode`) was deprecated with the release of TinyMCE 5.9. For details, see xref:release-notes/release-notes59.adoc#thebbcodebbcodeplugin[the BBCode plugin deprecation notice]. The BBCode plugin will be removed in TinyMCE 6.0.
88

99
This plugin makes it possible to edit BBCode in a WYSIWYG style by converting tags like `[b]` into `<strong>` and then back, when user submits the content.
1010

11-
____
12-
You will need to sacrifice quite a lot of {productname}'s functionality to use this plugin properly, since BBCode format doesn't support the whole HTML specification.
13-
____
11+
NOTE: You will need to sacrifice quite a lot of {productname}'s functionality to use this plugin properly, since BBCode format doesn't support the whole HTML specification.
1412
1513
== Basic setup
1614

‎modules/ROOT/pages/plugins/opensource/codesample.adoc‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,13 @@ You need to add `prism.js` and `prism.css` to your page in order to get the synt
3030

3131
=== Example of using the Prism.js script
3232

33-
```html+++<link rel="stylesheet" type="text/css" href="prism.css">++++++</link>++++++<script src="prism.js">++++++</script>+++
34-
35-
[,markup]
33+
[source, html]
3634
----
37-
...
35+
<link rel="stylesheet" type="text/css" href="prism.css">
36+
<script src="prism.js"></script>
37+
<pre class="language-markup"><code>...</code></pre>
3838
----
3939

40-
```
41-
4240
== Interactive example
4341

4442
liveDemo::codesample[]

‎modules/ROOT/pages/plugins/opensource/emoticons.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ tinymce.init({
2727
== Browser emoji support
2828

2929
By default, the emoticon plugin inserts Unicode character codes, such as `\ud83d\ude03` for the smiley emoji. How emoji are rendered is dependent on the web browser and operating system of the user. As a result of this, some emoji may be rendered in black and white, or may not render.
30-
To ensure emoji render consistently across browsers and operating systems, {companyname} recommends adding an emoji-compatible web font to the default font-family using link:{baseurl}/configure/content-appearance/#content_css[`content_css`].
30+
To ensure emoji render consistently across browsers and operating systems, {companyname} recommends adding an emoji-compatible web font to the default font-family using xref:configure/content-appearance.adoc#content_css[`content_css`].
3131

3232
liveDemo::emoticons[]
3333

‎modules/ROOT/pages/plugins/opensource/help.adoc‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
The help plugin adds a button and/or menu item that opens a dialog showing two tabs:
1111

12-
* Handy shortcuts that explains some nice-to-know keyboard shortcuts
12+
* Handy shortcuts that explain some nice-to-know keyboard shortcuts
1313
* Plugin list that shows which plugins that have been installed, with links to the relevant documentation pages if available, and a list of available premium plugins.
1414
1515
In the footer of the dialog you can also see which version of {productname} you are using.
@@ -31,13 +31,14 @@ tinymce.init({
3131

3232
include::partial$configuration/help_tabs.adoc[]
3333

34+
[[api]]
3435
== API
3536

3637
|===
3738
| Name | Arguments | Description
3839

3940
| addTab
40-
| tabSpec: link:{baseurl}/ui-components/dialogcomponents/#tabpanel[TabPanel]
41+
| tabSpec: xref:ui-components/dialogcomponents.adoc#tabpanel[TabPanel]
4142
| Register a tab for the Help dialog
4243
|===
4344

@@ -59,7 +60,7 @@ tinymce.activeEditor.plugins.help.addTab({
5960

6061
== Exposing metadata for the help plugin
6162

62-
For information on how to expose metadata from you custom plugin to add it to the Installed plugins list in the Help plugin, see the link:{baseurl}/advanced/creating-a-plugin/#exposingmetadata[Creating a Plugin page].
63+
For information on how to expose metadata from you custom plugin to add it to the Installed plugins list in the Help plugin, see the xref:advanced/creating-a-plugin.adoc[Creating a Plugin page].
6364

6465
include::partial$misc/plugin-toolbar-button-id-boilerplate.adoc[]
6566

‎modules/ROOT/pages/plugins/opensource/image.adoc‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ This plugin enables the user to insert an image into {productname}'s editable ar
1111
1212
== Basic setup
1313
14-
```js
14+
[source, js]
15+
----
1516
tinymce.init({
1617
selector: 'textarea', // change this value according to your HTML
1718
plugins: 'image',
@@ -22,8 +23,7 @@ tinymce.init({
2223
{title: 'My image 2', value: 'http://www.moxiecode.com/my2.gif'}
2324
]
2425
});
25-
26-
```
26+
----
2727

2828
NOTE: This is not drag-drop functionality and the user is required to enter the path to the image. Optionally the user can also enter the image description, dimensions, and whether image proportions should be constrained (selected via a checkbox). Some of these settings can be preset using the plugin's configuration options.
2929

@@ -36,11 +36,11 @@ These configuration options affect the execution of the `image` plugin. Many of
3636
If you wish to align the image, you can also use the text align buttons while images are selected.
3737

3838
:includedSection: imagePlugin
39-
#include::partial$configuration/a11y_advanced_options.adoc[]
39+
include::partial$configuration/a11y_advanced_options.adoc[leveloffset=+1]
4040
:includedSection: false
41-
#include::partial$configuration/file_picker_callback.adoc[]
41+
include::partial$configuration/file_picker_callback.adoc[leveloffset=+1]
4242

43-
= include::partial$configuration/file_picker_types.adoc[]
43+
include::partial$configuration/file_picker_types.adoc[leveloffset=+1]
4444

4545
include::partial$configuration/image_caption.adoc[]
4646

@@ -60,17 +60,17 @@ include::partial$configuration/image_title.adoc[]
6060

6161
include::partial$configuration/image_uploadtab.adoc[]
6262

63-
= include::partial$configuration/images_file_types.adoc[]
63+
include::partial$configuration/images_file_types.adoc[]
6464

65-
= include::partial$configuration/images_upload_base_path.adoc[]
65+
include::partial$configuration/images_upload_base_path.adoc[leveloffset=+1]
6666

67-
= include::partial$configuration/images_upload_credentials.adoc[]
67+
include::partial$configuration/images_upload_credentials.adoc[leveloffset=+1]
6868

69-
= include::partial$configuration/images_upload_handler.adoc[]
69+
include::partial$configuration/images_upload_handler.adoc[leveloffset=+1]
7070

71-
= include::partial$configuration/images_uploads_url.adoc[]
71+
include::partial$configuration/images_uploads_url.adoc[leveloffset=+1]
7272

73-
= include::partial$configuration/type_ahead_urls.adoc[]
73+
include::partial$configuration/type_ahead_urls.adoc[]
7474

7575
== Q: Where are the advanced image options?
7676

‎modules/ROOT/pages/plugins/opensource/imagetools.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ include::partial$misc/svgsNotSupported.adoc[]
1818

1919
== Cloud Installation
2020

21-
The Image Tools plugin is provided with all subscriptions to link:{baseurl}/cloud-deployment-guide/editor-and-features/[{cloudname}], including an automatically configured image proxy.
21+
The Image Tools plugin is provided with all subscriptions to xref:cloud-deployment-guide/editor-and-features.adoc[{cloudname}], including an automatically configured image proxy.
2222
Simply add `image` to the `toolbar` list and `image imagetools` to the `plugins` list.
2323

2424
=== Basic setup using Tiny Cloud

‎modules/ROOT/pages/plugins/opensource/importcss.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
:keywords: importcss content_css importcss_append importcss_file_filter importcss_selector_filter importcss_groups importcss_merge_classes importcss_selector_converter importcss_exclusive
44
:title_nav: Import CSS
55

6-
The `importcss` plugin adds the ability to automatically import CSS classes from the CSS file specified in the link:{baseurl}/configure/content-appearance/#content_css[`content_css`] configuration setting.
6+
The `importcss` plugin adds the ability to automatically import CSS classes from the CSS file specified in the xref:configure/content-appearance.adoc#content_css[`content_css`] configuration setting.
77

88
By default selectors like `".my-class"`, `".my-class1.my-class2"` and `"p.my-class"` get imported as format rules.
99

‎modules/ROOT/pages/plugins/opensource/legacyoutput.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
:keywords: legacyoutput filter content cms email flash
44
:title_nav: Legacy Output
55

6-
IMPORTANT: The Legacy Output plugin (`legacyoutput`) was deprecated with the release of TinyMCE 5.9. For details, see link:{baseurl}/release-notes/release-notes59/#thelegacyoutputlegacyoutputplugin[the Legacy Output plugin deprecation notice]. The Legacy Output plugin will be removed in TinyMCE 6.0.
6+
IMPORTANT: The Legacy Output plugin (`legacyoutput`) was deprecated with the release of TinyMCE 5.9. For details, see xref:release-notes/release-notes59.adoc#thelegacyoutputlegacyoutputplugin[the Legacy Output plugin deprecation notice]. The Legacy Output plugin will be removed in TinyMCE 6.0.
77

88
The `legacyoutput` plugin changes {productname}'s output, producing legacy elements such as `font`, `b`, `i`, `u`, `strike`, and use `align` attributes.
99

0 commit comments

Comments
 (0)