Skip to content

Commit 2475a1c

Browse files
committed
DOC-3021: Update plugin documentation for consistency and clarity in premium and open source sections
1 parent bca0446 commit 2475a1c

3 files changed

Lines changed: 120 additions & 103 deletions

File tree

modules/ROOT/pages/plugins.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
:navtitle: Plugins
33
:description: This section lists the all plugins provided by {companyname}.
44

5-
{productname} is an incredibly powerful, flexible and customizable rich text editor. This section will help configure and extend the editor by using {productname} plugins.
5+
This page organizes {productname} plugins into functional categories to help you quickly find the features you need. Each section is labeled as either Premium or Open Source and groups plugins by purpose, such as writing, layout, code editing, and productivity, making it easier to identify the right plugin for your use case.
66

77
[[premium-plugins]]
8-
== Premium plugins
8+
== Premium Plugins
99

1010
include::partial$index-pages/premium-plugins.adoc[]
1111

1212
[[open-source-plugins]]
13-
== Open source plugins
13+
== Open Source Plugins
1414

1515
include::partial$index-pages/opensource-plugins.adoc[]
Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
This section lists the open source plugins provided with {productname}.
22

3-
== Core Writing & Formatting Tools
3+
== Core Writing & Formatting
44

55
[cols="1,1"]
66
|===
@@ -9,25 +9,25 @@ a|
99
[.lead]
1010
xref:charmap.adoc[Character Map]
1111

12-
Insert special characters into {productname}.
12+
Enables insertion of special characters into {productname}.
1313

1414
a|
1515
[.lead]
1616
xref:directionality.adoc[Directionality]
1717

18-
Toolbar buttons for setting the left-to-right or right-to-left direction of content.
18+
Adds toolbar buttons for setting text direction to left-to-right or right-to-left.
1919

2020
a|
2121
[.lead]
2222
xref:emoticons.adoc[Emoticons]
2323

24-
Bring a smiley to your content.
24+
Enables insertion of emoticons into {productname} content.
2525

2626
a|
2727
[.lead]
2828
xref:image.adoc[Image]
2929

30-
Insert an image into {productname}.
30+
Enables inserting and managing images in {productname}.
3131

3232
a|
3333
[.lead]
@@ -39,47 +39,47 @@ a|
3939
[.lead]
4040
xref:link.adoc[Link]
4141

42-
Add and edit links in {productname}.
42+
Enables adding and editing hyperlinks within content.
4343

4444
a|
4545
[.lead]
4646
xref:lists.adoc[Lists]
4747

48-
Normalize list behavior between browsers.
48+
Normalize list behavior across different browsers.
4949

5050
a|
5151
[.lead]
5252
xref:advlist.adoc[List Styles]
5353

54-
Create styled number and bulleted lists.
54+
Enables creation of styled ordered and unordered lists.
5555

5656
a|
5757
[.lead]
5858
xref:media.adoc[Media]
5959

60-
Embed and manage HTML5 video and audio elements.
60+
Embed and manage HTML5 video and audio elements in {productname}.
6161

6262
a|
6363
[.lead]
6464
xref:nonbreaking.adoc[Nonbreaking Space]
6565

66-
Insert a non-breaking space.
66+
Enables insertion of non-breaking spaces.
6767

6868
a|
6969
[.lead]
7070
xref:pagebreak.adoc[Page Break]
7171

72-
Add a page break.
72+
Enables insertion of a page break into content.
7373

7474
a|
7575
[.lead]
7676
xref:table.adoc[Table]
7777

78-
Create and edit tables, including rows, columns, and cell formatting.
78+
Create and edit tables, including structure and cell formatting.
7979

8080
|===
8181

82-
== Content Structure & Layout Controls
82+
== Content Structure & Layout
8383

8484
[cols="1,1"]
8585
|===
@@ -88,7 +88,7 @@ a|
8888
[.lead]
8989
xref:accordion.adoc[Accordion]
9090

91-
Create expandable and collapsible sections.
91+
Enables creation of expandable and collapsible content sections.
9292

9393
a|
9494
[.lead]
@@ -100,37 +100,37 @@ a|
100100
[.lead]
101101
xref:fullscreen.adoc[Full Screen]
102102

103-
Expands the editor to full-screen mode.
103+
Expands the editor to full-screen mode for focused editing.
104104

105105
a|
106106
[.lead]
107107
xref:importcss.adoc[Import CSS]
108108

109-
Automatically populate CSS class names into the Format dropdown.
109+
Imports CSS class names into the Format dropdown for styling content.
110110

111111
a|
112112
[.lead]
113113
xref:preview.adoc[Preview]
114114

115-
Displays a read-only preview of the current content in a separate dialog.
115+
Displays a read-only preview of the current content in a separate view.
116116

117117
a|
118118
[.lead]
119119
xref:quickbars.adoc[Quick Toolbars]
120120

121-
User interface controls to create content faster.
121+
Provides contextual toolbar controls that appear near selected content to speed up formatting and editing workflows.
122122

123123
a|
124124
[.lead]
125125
xref:visualblocks.adoc[Visual Blocks]
126126

127-
Allow a user to see block level elements such as paragraphs.
127+
Enables visual outlines of block elements, helping users understand and structure document layout more effectively.
128128

129129
a|
130130
[.lead]
131131
xref:visualchars.adoc[Visual Characters]
132132

133-
See invisible characters such as non-breaking spaces.
133+
Enables visibility of hidden characters such as spaces and breaks to help troubleshoot formatting issues.
134134

135135
|===
136136

@@ -144,19 +144,19 @@ a|
144144
[.lead]
145145
xref:code.adoc[Code]
146146

147-
Edit the current content’s HTML source.
147+
Enables direct editing of HTML source code for users who need full control over document markup.
148148

149149
a|
150150
[.lead]
151151
xref:codesample.adoc[Code Sample]
152152

153-
Insert and embed syntax-highlighted code snippets.
153+
Enables insertion of formatted, syntax-highlighted code snippets for technical documentation or developer content.
154154

155155
a|
156156
[.lead]
157157
xref:searchreplace.adoc[Search and Replace]
158158

159-
Find and replace content in {productname}.
159+
Find and replace text across content, improving efficiency when making large-scale edits.
160160

161161
|===
162162

@@ -170,45 +170,46 @@ a|
170170
[.lead]
171171
xref:autolink.adoc[Autolink]
172172

173-
Automatically create hyperlinks when a user types a valid URL.
173+
Automatically converts URLs into clickable links, saving users time and ensuring consistent link formatting.
174174

175175
a|
176176
[.lead]
177177
xref:autoresize.adoc[Autoresize]
178178

179-
Automatically resize {productname} to fit content.
179+
Automatically adjusts the editor height to match content, improving usability and reducing scroll friction.
180180

181181
a|
182182
[.lead]
183183
xref:autosave.adoc[Autosave]
184184

185-
Automatically save content in your local browser.
185+
Automatically saves content in the browser to prevent data loss during editing sessions.
186186

187187
a|
188188
[.lead]
189189
xref:help.adoc[Help]
190190

191-
Opens the built-in help dialog.
191+
Provides quick access to documentation and guidance, helping users understand editor features without leaving the interface.
192192

193193
a|
194194
[.lead]
195195
xref:save.adoc[Save]
196196

197-
Add toolbar button to trigger saving of editor content.
197+
Adds a manual save button so users can explicitly store content when needed.
198198

199199
a|
200200
[.lead]
201201
xref:wordcount.adoc[Word Count]
202202

203-
Show a word count in the {productname} editor status bar.
203+
Displays real-time word count to help users track content length and meet writing requirements.
204+
205+
|===
204206

205207
// Dummy table cell.
206208
// 1. Remove the inline comment markup pre-pending this
207209
// element when the number of cells in the table is
208210
// odd.
209211
// 2. Prepend the inline comment markup to this element
210212
// when the number of cells in the table is even.
211-
a|
212213

213-
|===
214+
214215

0 commit comments

Comments
 (0)