Skip to content

Commit 4d2d74b

Browse files
authored
feature(Configuration reference / Content formatting options -> Local… (#2355)
* feature(Configuration reference / Content formatting options -> Localization options): Update docs to new system * feature(Configuration reference / Content formatting options -> Localization options): Make changes as suggested per review
1 parent 24072fe commit 4d2d74b

File tree

13 files changed

+33
-26
lines changed

13 files changed

+33
-26
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ 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[leveloffset=+1]
6464

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

modules/ROOT/partials/configuration/automatic_uploads.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[[automatic_uploads]]
22
== `automatic_uploads`
33

4-
Enable or disable automatic upload of images represented by data URLs or blob URIs. Such images get generated, for example, as a result of image manipulation through link:{baseurl}/plugins/opensource/imagetools[Image Tools] plugin, or after image is drag-n-dropped onto the editor from the desktop.
4+
Enable or disable automatic upload of images represented by data URLs or blob URIs. Such images get generated, for example, as a result of image manipulation through xref:plugins/opensource/imagetools.adoc[Image Tools] plugin, or after image is drag-n-dropped onto the editor from the desktop.
55

66
NOTE: This option will do nothing if `images_upload_url` is not specified.
77

modules/ROOT/partials/configuration/browser_spellcheck.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
This option configures {productname} to use the browser's native spell checker.
55

6-
`browser_spellcheck` is not available in either Internet Explorer 8 or 9, as neither browser has native spell checker functionality. For more complete browser support, we recommend using link:../../enterprise/check-spelling/[Spell Checker Pro].
6+
`browser_spellcheck` is not available in either Internet Explorer 8 or 9, as neither browser has native spell checker functionality. For more complete browser support, we recommend using xref:plugins/premium/tinymcespellchecker.adoc[Spell Checker Pro].
77

88
*Type:* `Boolean`
99

@@ -19,4 +19,4 @@ tinymce.init({
1919
});
2020
----
2121

22-
For more information about spell checking in {productname}, see link:{baseurl}/general-configuration-guide/spell-checking/[this page] in the General-configuration-guide/ guide.
22+
For more information about spell checking in {productname}, see xref:general-configuration-guide/spell-checking.adoc[this page] in the General-configuration-guide/ guide.

modules/ROOT/partials/configuration/builtinformats.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,12 +92,16 @@ The following formats will work on most content.
9292
| Font size (1-7).
9393
|===
9494

95-
NOTE: The `mceToggleFormat` and `FormatBlock` link:{baseurl}/advanced/editor-command-identifiers/[commands] do not accept the following formats:
95+
[NOTE]
96+
====
97+
The `mceToggleFormat` and `FormatBlock` xref:advanced/editor-command-identifiers.adoc[commands] do not accept the following formats:
98+
9699
* `forecolor`
97100
* `hilitecolor`
98101
* `fontname`
99102
* `fontsize`
100103
* `fontsize_class`
104+
====
101105

102106
==== Definition list related formats
103107

modules/ROOT/partials/configuration/content_langs.adoc

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

66
include::partial$configuration/content_langs_base.adoc[]
77

8-
There is no default value for the `content_langs` option. If no value is specified, the `language` toolbar button and menu item are not available. A default value for this option is provided by the Spell Checker Pro plugin. For information on using the `content_langs` option with the Spell Checker Pro plugin, see: link:{baseurl}/plugins/premium/tinymcespellchecker/#content_langs[Spell Checker Pro plugin - `content_langs`].
8+
There is no default value for the `content_langs` option. If no value is specified, the `language` toolbar button and menu item are not available. A default value for this option is provided by the Spell Checker Pro plugin. For information on using the `content_langs` option with the Spell Checker Pro plugin, see: xref:plugins/premium/tinymcespellchecker.adoc#content_langs[Spell Checker Pro plugin - `content_langs`].
99

1010
*Type:* `Array`
1111

modules/ROOT/partials/configuration/content_langs_base.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
This option sets the languages displayed in the `language` toolbar button and the `language` menu item. The option accepts an array of language specs. Each language spec is a JavaScript object defined using the following properties.
22

3+
[cols="1,1,1,4"]
34
|===
45
| Name | Type | Requirement | Description
56

modules/ROOT/partials/configuration/formats.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This option is used to override default {productname} *formats* or add custom *f
55

66
{productname} is equipped with a formatting engine that allows you to register a set of styles and attributes as a named *format*. For example, the `bold` format is the style that is applied to text when the bold button is clicked.
77

8-
Check out the link:{baseurl}/demo/format-custom/[custom formats example] for a demonstration of this option.
8+
Check out the xref:demo/format-custom.adoc[custom formats example] for a demonstration of this option.
99

1010
The `formats` configuration option takes an object of format name and format specification pairs. Each format specification must be defined as an object where the value is either an object of format options or an array of such objects.
1111

@@ -41,7 +41,7 @@ There are three types of formats:
4141
* Inline format
4242
* Selector format
4343

44-
All three format types can be used with the `formats` configuration option. They can also be used to specify a new format item in the link:{baseurl}/configure/editor-appearance/#style_formats[`style_formats`] configuration option. However, a format that is specified using `formats` is then registered with the editor, and can be referred to by name in `style_formats` rather than needing to specify the format again.
44+
All three format types can be used with the `formats` configuration option. They can also be used to specify a new format item in the xref:configure/editor-appearance.adoc#style_formats[`style_formats`] configuration option. However, a format that is specified using `formats` is then registered with the editor, and can be referred to by name in `style_formats` rather than needing to specify the format again.
4545

4646
For example, these two configurations are equivalent:
4747

@@ -71,7 +71,7 @@ tinymce.init({
7171
});
7272
----
7373

74-
A registered format can also be used by name with the built-in link:{baseurl}/api/tinymce/tinymce.formatter[formatter] methods. See link:{baseurl}/configure/content-formatting/#usingcustomformats[/configure/content-formatting/#usingcustomformats] for an example.
74+
A registered format can also be used by name with the built-in xref:apis/tinymce.formatter.adoc[formatter] methods. See xref:configure/content-formatting.adoc#usingcustomformats[Using custom formats] for an example.
7575

7676
==== `block`
7777

@@ -270,7 +270,7 @@ Specifies what the remove behavior of the element should be when the format is r
270270

271271
This can be set to three different modes:
272272

273-
* *none*: Only styles, classes or attributes are removed from the element the element is never removed.
273+
* *none*: Only styles, classes or attributes are removed from the element. The element is never removed.
274274
* *empty*: If the element has no styles, classes, or attributes then the element is removed.
275275
* *all*: Removes the element regardless of its styles, classes, and or attributes.
276276

@@ -423,6 +423,7 @@ tinymce.init({
423423
});
424424
----
425425

426+
[[usingcustomformats]]
426427
=== Using custom formats
427428

428429
Custom formats can be handled through the {productname} API. Here is a basic example of usage for the custom format defined above.

modules/ROOT/partials/configuration/gecko_spellcheck.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
[[gecko_spellcheck]]
22
== `gecko_spellcheck`
33

4-
____
5-
Gecko Spell Check was deprecated in TinyMCE v4.3 (consider using <<browser_spellcheck,#browser_spellcheck>>). This option will be removed in {productname} 6.0.
6-
____
4+
NOTE: Gecko Spell Check was deprecated in TinyMCE v4.3 (consider using xref:browser_spellcheck[browser_spellcheck]). This option will be removed in {productname} 6.0.
75

86
This option allows you to disable https://en.wikipedia.org/wiki/Gecko_(software)[Gecko] based browsers' internal spell checker from being used in {productname}.
97

modules/ROOT/partials/configuration/iframe_aria_text.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44
include::partial$misc/requires_5_9v.adoc[]
55

66
This option is used to customize the `title` attribute on the {productname} `iframe` element. For example:
7+
[source, html]
8+
----
9+
<iframe title="Rich Text Area. Press ALT-0 for help."></iframe>
10+
----
711

8-
```html+++<iframe title="Rich Text Area. Press ALT-0 for help.">++++++</iframe>+++
9-
10-
```
11-
12-
The `title` attribute is read by screen-readers to help users identify the editor. This option only applies to {productname} classic (iframe) mode and has no effect on link:{baseurl}/configure/editor-appearance/#inline[`inline` editors].
12+
The `title` attribute is read by screen-readers to help users identify the editor. This option only applies to {productname} classic (iframe) mode and has no effect on xref:configure/editor-appearance.adoc#inline[`inline` editors].
1313

1414
*Type:* `String`
1515

modules/ROOT/partials/configuration/images_file_types.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
11
[[images_file_types]]
2-
=== `images_file_types`
2+
== `images_file_types`
33

44
include::partial$misc/requires_5_6v.adoc[]
55

66
This option configures which image file formats are accepted by the editor. Changing this option will adjust the following editor behaviour:
7-
- Which image file formats are allowed to be uploaded in the xref:plugins/opensource/image.adoc[Image] dialog.
8-
- Which image file formats are recognized and placed in an `img` element by the xref:plugins/opensource/paste.adoc[Paste] and xref:plugins/premium/powerpaste.adoc[PowerPaste] `smart_paste` functionality.
7+
8+
* Which image file formats are allowed to be uploaded in the xref:plugins/opensource/image.adoc[Image] dialog.
9+
* Which image file formats are recognized and placed in an `img` element by the xref:plugins/opensource/paste.adoc[Paste] and xref:plugins/premium/powerpaste.adoc[PowerPaste] `smart_paste` functionality.
910

1011
*Type:* `String`
1112

1213
*Default Value:* `'jpeg,jpg,jpe,jfi,jif,jfif,png,gif,bmp,webp'`
1314

1415
*Possible Values:* A list of valid web image file extensions. For a list of possible values see: https://developer.mozilla.org/en-US/docs/Web/Media/Formats/Image_types[MDN Web Docs - Image file type and format guide].
1516

16-
==== Example: Using `images_file_types`
17+
=== Example: Using `images_file_types`
1718

1819
[source, js]
1920
----

0 commit comments

Comments
 (0)