[update] grammar and style in Form guides - #150
Open
serhiipylypchuk1991 wants to merge 27 commits into
Open
serhiipylypchuk1991 wants to merge 27 commits into
serhiipylypchuk1991 wants to merge 27 commits into
Conversation
- the opening line read "A compact but useful control for swift uploading of an avatar into a form": the but-useful contrast implies compact things usually are not, "swift" says nothing, the preposition was wrong and "uploading of" is a gerund noun. The noun-phrase form is kept, it is the house style across all 19 control pages - dropped "easily", "initialization of a form" -> "form initialization" - "manipulate an Avatar control by using methods or events of the object returned by the getItem() method" carried a by-ing link, a loose verb and a passive participle; the method name in the link label got backticks - three link labels said "the full list of X of the Avatar control", now "Avatar configuration properties", "Avatar methods", "Avatar events" Checked and deliberately left alone: View for properties and Check for methods/events looked like an inconsistency but is the site convention, 19 occurrences of each across docs/form/. The "manipulate a X control by using methods or events of the object returned by getItem()" sentence is repeated verbatim in 19 files under docs/form/, along with the "full list of ... of the ... control" labels. Fixed here only, as with the earlier shared boilerplate.
The opening line claimed the Form Button "can be twoState and can have a badge with a number". Neither exists on this control: - twoState appears nowhere in the Form Button properties; across the docs it belongs to Sidebar navItem and Toolbar only - the control has no count or countColor property, so no badge. Sidebar navItem does, documented as "a badge with a number" The sentence was copied from toolbar/button.md:9, where both are real, and "two states" was even turned into the property name twoState on the way. Replaced with submit, which the properties table documents along with url and its own related sample. Grammar and style in the same pass: - dropped the etc. that ended the sentence and the *twoState* italics - "You can easily add a Button control during initialization of a form" -> "during form initialization" - "manipulate a Button control by using methods or events of the object returned by the getItem() method" carried a by-ing link, a loose verb and a passive participle; the method name in the link label got backticks - three link labels said "the full list of X of the Button control", now "Button configuration properties", "Button methods", "Button events" - "disable a control on a page" -> "disable the control" View for properties and Check for methods/events are left as they are, that split is the site convention rather than an inconsistency. The shared "manipulate a X control by using..." sentence and the "full list of ... of the ... control" labels remain in 18 other docs/form/ files, fixed here only as agreed.
- "## Properties" sat at the same level as "## Adding DatePicker" while Methods and Events in the same file were "###". Sibling pages use "### Properties" 16 times against 2, nothing links to the #properties anchor and the slug is unchanged, so it is "###" now - the control was called DatePicker 12 times and Datepicker 3 times, in the properties, methods and events link labels - "There is a possibility to use methods of DHTMLX Calendar via the getWidget() method" carried a weak opener, via and an of-chain - "For example, you can show the current month in the control. To do this, you need to get the widget..." merged into one sentence without the modal padding - "the full list of methods of the DHTMLX Calendar component which you can apply via the getWidget() method": restrictive which -> that, via -> with, of-chain removed from the label - "You can easily add a DatePicker control during initialization of a form" -> "during form initialization" - "manipulate a DatePicker control by using methods or events of the object returned by the getItem() method" rewritten, and getItem(), getWidget() and showDate() got backticks in their link labels - three labels said "the full list of X of the Datepicker control", now "DatePicker configuration properties", "DatePicker methods", "DatePicker events" - "a calendar attached to it" -> "an attached calendar" Headings "Working with DatePicker" and "Working with the dhtmlxCalendar widget" are untouched: whatsnew.md:3033-3035 and form/features.md:121 link to their anchors, so the legacy dhtmlxCalendar spelling stays in the heading even though the body says DHTMLX Calendar. Noticed in passing, not changed: the getValue sample declares const value twice in the same scope, so it would not run as written.
- the opening line mixed a gerund and a bare infinitive in one series:
"allows displaying the specified value or change it". Rewritten as
"displays the specified value and allows you to switch it", which also
drops the allows-ing form
- the two samples disagreed: the first sets id "agree", the second
called form.getItem("checkbox"). Sibling pages (input, select,
textarea) always pass the id their own sample defines, so this is now
getItem("agree")
- "You can easily add a Checkbox control during initialization of a
form" -> "during form initialization"
- "manipulate a Checkbox control by using methods or events of the
object returned by the getItem() method" carried a by-ing link, a
loose verb and a passive participle; the method name in the link label
got backticks
- three labels said "the full list of X of the Checkbox control", now
"Checkbox configuration properties", "Checkbox methods", "Checkbox
events"
Heading levels were already correct here, unlike calendar.md.
View for properties and Check for methods/events stay as they are, that
split is the site convention.
The shared boilerplate remains in 17 other docs/form/ files.
- the sample called form.getItem("CheckboxGroup") while the config above
it sets id "checkboxGroup"; case matters, so the call would not find
the control
- that same line assigned hide() to a const named value, though hide()
returns nothing and the action is not about a value. The assignment is
gone
- line 62 opened with "Check [the full list of configuration
properties...", the only such occurrence in docs/form/; the other 15
use View. Changed to View
- the heading "Properties of Checkbox of CheckboxGroup control" stacked
two of-phrases. Nothing links to its anchor, features.md only uses
#working-with-checkboxgroup, so it is now "Properties of a Checkbox in
CheckboxGroup"
- "A control intended for creating groups of checkboxes" -> "A control
that groups checkboxes", keeping the noun-phrase blurb style
- "You can easily add a CheckboxGroup control during initialization of a
form" -> "during form initialization"
- "manipulate a CheckboxGroup control by using methods or events of the
object returned by the getItem() method" rewritten, and the method
name in the link label got backticks
- four link labels carried of-chains: "configuration properties of a
Checkbox of the CheckboxGroup control" -> "for a Checkbox in
CheckboxGroup", plus CheckboxGroup configuration properties, methods
and events
- "hide a control on a page" -> "hide the control"
The shared boilerplate remains in 16 other docs/form/ files.
Same defect set as calendar.md, the two pages are structurally identical.
- Colorpicker appeared in two link labels against 16 uses of ColorPicker
- "There is a possibility to use methods of DHTMLX ColorPicker via the
getWidget() method" carried a weak opener, via and an of-chain
- "For example, you can set focus... To do this, you need to get the
widget..." merged into one sentence without the modal padding
- "the full list of methods of the DHTMLX Colorpicker component which
you can apply via the getWidget() method": restrictive which -> that,
via -> with, of-chain removed from the label
- "You can easily add a ColorPicker control during initialization of a
form" -> "during form initialization"
- "manipulate a ColorPicker control by using methods or events of the
object returned by the getItem() method" rewritten, and getItem(),
getWidget() and setFocus() got backticks in their link labels
- three labels said "the full list of X of the ColorPicker control", now
"ColorPicker configuration properties", "ColorPicker methods",
"ColorPicker events"
- "a color picker attached to it" -> "an attached color picker"
- removed a stray blank line before the closing paragraph
Headings are untouched: whatsnew.md:3035 and form/features.md:121 link
to #working-with-colorpicker and
#working-with-the-dhtmlxcolorpicker-widget, so the legacy
dhtmlxColorPicker spelling stays in the heading.
Unlike checkbox.md and checkboxgroup.md, getItem("colorpicker") here
matches the name in the sample above it.
- the getValue sample called form.getItem("Combo") while the config sets
name "combo" and the widget sample three lines below uses
getItem("combo"). Case matters, and the page contradicted itself
- "An input that represents an advanced select box" -> "works as", per
the misused-words rule
- "It is able to provide suggestions while a user is typing text" ->
"It can show suggestions while the user types": padded modal, the
overused provide, and present continuous
- "There is a possibility to use methods of DHTMLX Combobox via the
getWidget() method" carried a weak opener, via and an of-chain
- "For example, you can set focus... To do this, you need to get the
widget..." merged into one sentence without the modal padding
- "the full list of methods of the DHTMLX Combobox component which you
can apply via the getWidget() method": restrictive which -> that,
via -> with, of-chain removed from the label
- "You can easily add a Combo control during initialization of a form"
-> "during form initialization"
- "manipulate a Combo control by using methods or events of the object
returned by the getItem() method" rewritten, and getItem(),
getWidget() and focus() got backticks in their link labels
- three labels said "the full list of X of the Combo control", now
"Combo configuration properties", "Combo methods", "Combo events"
Checked and left alone: the "### Working with the dhtmlxComboBox widget"
heading level. Siblings are split, ## in calendar.md and colorpicker.md
against ### in combo.md, timepicker.md and slider.md, so neither is the
convention. The heading text is an anchor target from whatsnew.md:1824.
- "Grouping Controls in Form" was the only Title Case heading of the seven on this page. Slugs are lowercased, so the anchor #grouping-controls-in-form is unchanged and the 7 links to it from features.md, form_cols_config.md, form_rows_config.md and this page still resolve - "set aligning direction" used a gerund as a modifier and dropped the article; "generate space" and "adjust sizes of a control group" reworded - two by-ing links removed: "apply ... by specifying the property" split into two sentences, "combine controls by placing controls" no longer repeats controls and loses the "To do this" bridge - "By default, Form is enabled/visible" replaced with the adjective form the rule asks for, and "make Form disabled/hidden" -> "disable Form" / "hide Form" - true moved from italics to backticks, twice - make use of -> use, with the help of -> with - the padding section called it a "parameter" while the other six sections say "property" - "with the corresponding properties [height] and [width]" reordered, dropping the vague "corresponding" - "various options of alignment for different control groups" carried both various and different plus an of-chain - "in the configuration object of the component" -> "in the component configuration object" - "with any level of complexity" -> "of nesting", which is what is actually being measured - removed a trailing space Noticed but out of scope: line 55 says "**Related Sample**:" with a capital S while line 57 says "**Related sample**:". The skill excludes those template lines from review.
- replaced the legacy {{pronote}} macro with a :::info admonition, it
was rendering literally on the page
- "The list of the properties is used to configure the Container
control" credited the list rather than the properties, and was
passive. css, height, width and padding are real Container properties
per api_container_properties.md, so they are in backticks now
- dropped etc. twice; on line 44 it followed "For example", which the
abbreviations rule calls redundant
- trimmed the marketing: "a very convenient way", "to make the project
functional and easy to use"
- "You can add the Container control to the Form in an easy way" said
nothing the next sentence did not, merged into it
- "You need to specify the type of the control `type: "container"`" was
an apposition without punctuation plus a modal, now "set
`type: "container"`"
- "You cannot attach Layout and Form widgets" was tacked onto the end of
a promotional paragraph; it stands on its own now
- fixed articles: "the DHTMLX widgets", "attach the HTML code", "for
DHTMLX widget"
- "during the initialization of Form" -> "during Form initialization"
- "manipulate the Container control by using methods/events of the
object returned by the getItem() method" in both sections, with
getItem() gaining backticks in the labels
- "List of the Container control methods/events/properties" -> "List of
Container methods/events/properties"
- hyphen separators in the list -> em dashes, and the stranded "Look at
the sample above" joined to its sentence
The ## Methods heading is untouched, features.md:121 links to its anchor.
{{pronote}} still stands in 6 other files: pagination/index.md,
list/load_data.md, helpers/lazydataproxy.md, helpers/datadrivers.md,
helpers/custom_scroll.md and grid/data_loading.md.
- "You can modify styling of Form controls as well using the **css** option inside the object of a related control" was the page's own sentence and its worst one: css in bold instead of backticks, a gerund noun with an of-chain, two adverbials running together without a comma, and another of-chain at the end. Now "You can also style individual Form controls with the `css` option in the control configuration object" - fixed the shared CSS boilerplate: "a new CSS class(es)", the <style> entity, lowercase list items, the "don't forget to" parenthetical, "There is a possibility to make changes in the look and feel of a form", "For this you need to take the following steps", and the passive "the created CSS class" - removed a trailing space Same boilerplate as combobox/customization.md and dataview/customization.md, which were fixed earlier. It now stands corrected in 3 of the 20 */customization.md files.
The Form controls table described the wrong controls on two rows: the Checkbox row read "add a Checkbox group control" and the Checkbox group row read "add a Checkbox control". The links were on the correct rows, scs712zl is checkbox.md's sample and p89u4ovb is checkboxgroup.md's, so only the description text was swapped. Grammar and style in the same pass: - ten section intros used six different openings (can find out, will know, will learn, can learn, will study twice, This section explains); unified to "In this section you will learn...". "find out corresponding references of Form and Form controls API" did not parse and was rewritten - "add a X control into a Form" -> "to a Form", 17 rows - the Form controls API table repeated "of Form" in all 16 rows although the section is already called Form controls API. Control names in the descriptions aligned with the control pages: Datepicker -> DatePicker, Colorpicker -> ColorPicker, Radiogroup -> RadioGroup, Simple Vault -> SimpleVault, Timepicker -> TimePicker - "specify that the input field is required to be filled in by the user" -> "make an input field required" - "messages that will notify the end users, whether they are filling the form in correctly": future tense, end users, a comma before whether and a split phrasal verb - "to provide entering of values in a predefined way" -> "to control how users enter values" - "get access to the own methods and events" -> "access the own methods and events" - "the object of the related DHTMLX widget of the control and apply the methods of the widget" unstacked - "the properties which are set" -> "that are set" - "change the configuration settings of a Form right from UI" -> "Form configuration settings from the UI" - "inside the control group" and "for the control group" -> "a control group", the definite article had no antecedent - "A set of CSS classes provided by the DHTMLX library" -> "The CSS classes included in" - "perform the code after the component's rendering" -> "run code after the component renders" - "Learn basic rules on how to work with events" -> "the basic rules of event handling", "call the Form events" -> zero article - page intro and Optimus boilerplate, double spaces, a whitespace-only line and trailing spaces Two things left for a decision: - line 78 links [Defining restricted values] to #number-of-allowed-characters while describing minimum and maximum values. work_with_form.md:364 has a dedicated "Minimal and maximal values" section, so lines 78 and 79 currently share one anchor. The skill forbids changing link targets - line 32 calls the control Combobox, but form/combo.md calls it Combo; Combobox is the widget underneath
- the sample called form.getItem("fieldset") while the config above it
sets name "f1". Third page in this branch with that mismatch, after
checkbox.md and checkboxgroup.md
- "A control that allows arranging the elements of the form controls
into groups" used the allows-ing form and an of-chain that shifted the
meaning: Fieldset groups the controls themselves, not elements of
them. Now "A control that arranges Form controls into groups"
- "You can easily add a Fieldset control during initialization of a
form" -> "during form initialization"
- "manipulate a Fieldset control by using methods or events of the
object returned by the getItem() method" rewritten, and the method
name in the link label got backticks
- three labels said "the full list of X of the Fieldset control", now
"Fieldset configuration properties", "Fieldset methods", "Fieldset
events"
- "disable a control on a page" -> "disable the control"
- collapsed five blank lines at the end of the file
The shared boilerplate remains in 15 other docs/form/ files.
- both samples declared function(name, e) but logged console.log(id),
a variable that is never defined. Now they log name
- replaced the legacy {{note}} macro with a :::note admonition, it was
rendering literally and carried a double space inside
- form.events.on(), form.events.detach(), fire() and events moved from
bold to backticks
- "Several handlers can be attached... will be executed" rewritten in
active present with Form as the actor
- "A custom event can be called with the fire() method" turned active
- "There is a simple way of removing an event handler" replaced with the
method leading the sentence, dropping the editorial "simple"
- "add any handler to the events of Form" -> "a custom handler to any
Form event", removing the indefinite pronoun and the of-chain
- "To do this, use the ... method" bridge merged into the sentence
before it
- "The names of the events" -> "Event names", table cells "name of the
event" -> "the event name" and "user-defined event handler" -> "a
custom event handler"
The raw HTML parameters table keeps its <b> markup per the site
convention; only the descriptive cells were reworded.
This page differed from its Combobox and DataView twins: it already used
"with" rather than "via", and its Calling events section was passive
rather than an inversion.
- "e.g." replaced with "for example" per the abbreviations rule, and "form_container" moved from straight quotes to backticks - suite.js and suite.css moved from italics to backticks, rows and cols from bold - the constructor parameter list items were lowercase, inconsistently punctuated and trailed spaces; "a configuration object which (besides config options) contains an array of form controls defined as objects with a set of attributes" is now a plain sentence with that instead of which - the page opened with "To add DHTMLX Form into an application, you need to take the following simple steps"; now "Follow these steps to add DHTMLX Form to an application", without the editorial "simple" - "Now you need to specify", "Thus, the structure ... will look like this" and "you should put them into a layout" lost their filler openers, modals and future tense - "either a vertical one (the rows attribute), or a horizontal one" had a comma before or in a two-item pair; attribute -> property, the term used elsewhere - "In the example below controls are arranged vertically" turned active - added the missing serial comma in the controls description, and joined two sentences that were wrapped mid-line - "as a part of" -> "as part of", plus the missing period in :::info - "a folder of your project" -> "your project folder", "into the header of the file" -> "in its header", "with the object constructor" -> "with the constructor" in two places - "Add a container for the Form" -> "for a Form" Left for a decision: the sample under "Define Form structure" contains three inputs (Name, Email, Password), while the prose says "two text fields", the structure list names only Name and Email, and the screenshot shows the same two. The sample is the outlier; reconciling it is a content call, not a grammar one.
- both Guides blurbs were subjectless: "Guides you through common information you may need while working with Form" and "Discusses the creation of Form controls and the possibilities of manipulating them". Both now start with "These guides", which also clears two nominalizations and their of-chains - the intro ran two clauses together: "a typical form widget that can contain ... controls, supports data validation and localization of labels" left "supports" hanging after the relative clause had closed. Split in two, dropping "typical", "a number of" and "easy-to-use", and "localization of labels" -> "label localization" - "### Form Controls" was Title Case while its sibling "### Working with Form" is sentence case. Nothing links to the anchor and the slug is unchanged - the two Related resources bullets had different shapes, now parallel imperatives: "as a part of" -> "as part of", "by [downloading DHTMLX Suite]" now leads with the link, "There are also" -> "Browse" - line 27 ended with two spaces, which Markdown renders as a line break - "You can check the following page" -> "Check the following page" - removed a trailing space Noticed, not changed: the "Discusses the creation of ... and the possibilities of manipulating them" sentence is repeated verbatim in toolbar/index.md:44.
- fixed the typo "To use a different locale, your need to:", the same
one that was in combobox/localization.md. That line was also a list
intro the items had to finish grammatically, and an inversion opening
the section; replaced with "Follow these steps to use a different
locale:"
- dropped "e.g." per the abbreviations rule
- dhx.i18n.setLocale() moved from bold to backticks, twice, and the
"by calling" link removed from both bullets
- the third bullet buried its condition: "apply the language settings by
calling the setLocale() method with the name of the control as a
parameter for ColorPicker, DatePicker, Combo, TimePicker controls
before Form initialization". The condition now leads, the of-chain is
gone and the serial comma is in
- all three list items capitalized
- "the interface of DHTMLX Form" -> "the DHTMLX Form interface", removed
"just", "corresponding", "necessary", "a ready locale" -> "the
resulting locale", "provide translation for" -> "translate"
- "looks like this" twice, and the missing article in "for Form
SimpleVault control"
- the closing sentence repeated "the localization of" and lacked the
serial comma in both lists
No code issues here: setLocale("form", de) and setLocale("colorpicker",
de) both pass widget names, unlike combobox/localization.md, which
passed a container id.
- "properties that you can provide in the configuration object of a
RadioButton of the RadioGroup control" stacked two of-phrases and used
the overused provide; now "properties that you can set for a
RadioButton in RadioGroup"
- "A control intended for creating groups of Radio buttons" -> "A
control that groups Radio buttons", the same wrapper that was in
checkboxgroup.md
- "You can easily add a RadioGroup control during initialization of a
form" -> "during form initialization"
- "manipulate a RadioGroup control by using methods or events of the
object returned by the getItem() method" rewritten, and the method
name in the link label got backticks
- three labels said "the full list of X of the RadioGroup control", now
"RadioGroup configuration properties", "RadioGroup methods",
"RadioGroup events"
No factual defects on this page. getItem("radiogroup") matches the id in
the sample, unlike checkbox.md, checkboxgroup.md and fieldset.md.
Headings are untouched: whatsnew.md:3033-3034 and features.md:121 link
to #working-with-radiogroup. "Properties of RadioButton" was already
free of extra of-phrases, unlike its checkboxgroup counterpart.
- "An advanced select box that provides a set of options to choose from"
used the overused provide in a relative clause that earned nothing;
now "with a set of options to choose from"
- "You can easily add a Select control during initialization of a form"
-> "during form initialization"
- "manipulate a Select control by using methods or events of the object
returned by the getItem() method" carried a by-ing link, a loose verb
and a passive participle; the method name in the link label got
backticks
- three labels said "the full list of X of the Select control", now
"Select configuration properties", "Select methods", "Select events"
The cleanest control page in this branch: no factual defects, and
getItem("select") matches the name in the sample.
Headings are untouched, whatsnew.md and features.md:121 link to
#working-with-select.
The shared boilerplate remains in 12 other docs/form/ files.
- three samples called form.getItem("simpleVault") while the config sets
name "simplevault" in lower case; the camel case looks copied from the
type on the line above. Fourth page in this branch with that mismatch,
after checkbox.md, checkboxgroup.md and fieldset.md
- "A handy control for quick and easy uploading of a file or a set of
files" carried two editorial phrases and a gerund noun; now "A control
for uploading a file or a set of files"
- removed the comma in "the [remove], or [removeAll] method", a comma in
a two-item pair
- "To do that, you need to apply the ... method ... to the object
returned by the getItem() method as follows" lost its bridge, its
modal and its passive participle
- "manipulate a SimpleVault control with the help of the DataCollection
API" -> "manage ... with"
- "You can easily add a SimpleVault control during initialization of a
form" -> "during form initialization"
- "manipulate ... by using methods or events of the object returned by
the getItem() method" rewritten, and getItem() got backticks in both
link labels
- three labels said "the full list of X of the SimpleVault control", now
"SimpleVault configuration properties", "SimpleVault methods",
"SimpleVault events"
- "uploading files into a SimpleVault control" -> "to", and the vague
[related article] label -> [Vault documentation]
Headings are untouched, whatsnew.md and features.md:121 link to
#working-with-simplevault.
- both samples called form.getItem("slider_id") while the config sets
name "slider"; slider_id appears nowhere in the config. Fifth page in
this branch with such a mismatch, after checkbox.md, checkboxgroup.md,
fieldset.md and simplevault.md
- "## Adding Slider" had a double space after the hashes and no blank
line before the paragraph under it
- "A control that allows selecting a numeric value" -> "allows you to
select", the form the gerunds rule prescribes
- "There is a possibility to use methods of DHTMLX Slider via the
getWidget() method" carried a weak opener, via and an of-chain
- "For example, you can disable a Slider control. To do this, you need
to get the widget..." merged into one sentence without the modal
padding
- "the full list of methods of the DHTMLX Slider component which you can
apply via the getWidget() method": restrictive which -> that, via ->
with, of-chain removed from the label
- "You can easily add a Slider control during initialization of a form"
-> "during form initialization"
- "manipulate a Slider control by using methods or events of the object
returned by the getItem() method" rewritten, and getItem(),
getWidget() and disable() got backticks in their link labels
- three labels said "the full list of X of the Slider control", now
"Slider configuration properties", "Slider methods", "Slider events"
- added the missing trailing newline at the end of the file
Headings are untouched: whatsnew.md:3035 and features.md:121 link to
#working-with-slider and #working-with-the-dhtmlxslider-widget.
- the hide sample assigned form.getItem("spacer").hide() to a const
named value, though hide() returns nothing and the example is about
hiding. The assignment is gone, same fix as in checkboxgroup.md. The
name "spacer" matches the config
- "This item takes space on the form and is used for aligning controls"
was passive with a gerund, said "takes space" instead of "takes up
space", and opened with "This item" where sibling pages use the
"A control that..." blurb; now "A control that takes up space in a
form to align other controls"
- "You can easily add a Spacer control during initialization of a form"
-> "during form initialization"
- "manipulate a Spacer control by using methods or events of the object
returned by the getItem() method" rewritten, and the method name in
the link label got backticks
- three labels said "the full list of X of the Spacer control", now
"Spacer configuration properties", "Spacer methods", "Spacer events"
The heading "Working with Spacer" is untouched, features.md:121 links to
its anchor. Uneven indentation in the config sample is left alone, code
is outside the skill's scope.
- "A control for adding some text" used the indefinite pronoun some,
which the pronouns rule drops; now "A control for adding text to a
form"
- "You can easily add a Text control during initialization of a form"
-> "during form initialization"
- "manipulate a Text control by using methods or events of the object
returned by the getItem() method" carried a by-ing link, a loose verb
and a passive participle; the method name in the link label got
backticks
- three labels said "the full list of X of the Text control", now "Text
configuration properties", "Text methods", "Text events"
No factual defects: getItem("text") matches the name in the sample.
The heading "Working with Text" is untouched, whatsnew.md and
features.md:121 link to its anchor.
- "A control that allows a user to enter a simple multi-line text" put
the article a in front of uncountable text and added the vague simple;
now "A control that allows users to enter multi-line text"
- "You can easily add a Textarea control during initialization of a
form" -> "during form initialization"
- "manipulate a Textarea control by using methods or events of the
object returned by the getItem() method" carried a by-ing link, a
loose verb and a passive participle; the method name in the link label
got backticks
- three labels said "the full list of X of the Textarea control", now
"Textarea configuration properties", "Textarea methods", "Textarea
events"
No factual defects: getItem("textarea") matches the name in the sample.
The heading "Working with Textarea" is untouched, whatsnew.md and
features.md:121 link to its anchor.
- the opening line dropped the article in "select time value", mixed
singular and plural in "hour and minutes values", stacked two by-ing
links and used "into related inputs"; now "select a time value: either
move handles along track bars or enter hour and minute values directly
in the related inputs"
- "### Methods:" and "### Events:" ended with colons that no sibling page
uses; the slugs are unchanged
- the control was called TimePicker and, in three link labels,
Timepicker; unified to TimePicker
- "There is a possibility to use methods of DHTMLX TimePicker via the
getWidget() method" carried a weak opener, via and an of-chain
- "you can set value for a TimePicker control. To do this, you need to
get the widget..." dropped its article and padding, merged into one
sentence
- "the full list of methods of the DHTMLX Timepicker component which you
can apply via the getWidget() method": restrictive which -> that, via
-> with, of-chain removed from the label
- "You can easily add a TimePicker control during initialization of a
form" -> "during form initialization"
- "manipulate a TimePicker control by using methods or events of the
object returned by the getItem() method" rewritten, and getItem(),
getWidget() and setValue() got backticks in their link labels
- the properties, methods and events labels lost their of-chains
No factual defects: all three getItem("timepicker") calls match the
name in the sample.
Headings "Working with TimePicker" and "Working with the dhtmlxTimePicker
widget" are untouched, whatsnew.md:3033-3035 and features.md:121 link to
their anchors.
- "A special button control that changes its state from pressed to the
unpressed one when clicked": "special" said nothing, the transition
described only one direction although Toggle switches both ways, the
pair was mismatched (pressed with no article, "the unpressed one"),
and "when clicked" left out who clicks. Now "A button control that
switches between the pressed and unpressed states when the user clicks
it"
- "You can easily add a Toggle control during initialization of a form"
-> "during form initialization"
- "manipulate a Toggle control by using methods or events of the object
returned by the getItem() method" carried a by-ing link, a loose verb
and a passive participle; the method name in the link label got
backticks
- three labels said "the full list of X of the Toggle control", now
"Toggle configuration properties", "Toggle methods", "Toggle events"
- added the missing trailing newline at the end of the file
No factual defects: getItem("toggle") matches the name in the sample.
- the sample could not work: the toggleGroup config had neither name nor
id, only the ids of its options (left, center, right), so
form.getItem("ToggleGroup") would find nothing. Earlier pages only
needed the call aligned with an existing name; here there was none, so
the config gains name "togglegroup", in the lower-case style of the
sibling pages, and the call uses it
- the same line assigned hide() to a const named value, though hide()
returns nothing; the assignment is gone, as in checkboxgroup.md and
spacer.md
- "A control intended for creating groups of toggle buttons" -> "A
control that groups toggle buttons", matching checkboxgroup.md and
radiogroup.md
- "You can easily add a ToggleGroup control during initialization of a
form" -> "during form initialization"
- "manipulate a ToggleGroup control by using methods or events of the
object returned by the getItem() method" rewritten, and the method
name in the link label got backticks
- "hide a control on a page" -> "hide the control"
- three labels said "the full list of X of the ToggleGroup control", now
"ToggleGroup configuration properties", "ToggleGroup methods",
"ToggleGroup events"
- added the missing trailing newline at the end of the file
Factual defects: - the patternMask note said "The inputMask property supports static masks"; inputMask exists nowhere in the docs, the section is about patternMask - the price example read "$ 1.000.000", but its config leaves groupSeparator unset and the default is ","; the result is "$ 1,000,000" - the disable() sample carried "// -> true|false", copied from isDisabled; disable() is declared as void, the comment is gone - the masks intro placed getText() in "the Input control API" only, while the section below documents it for both Input and Textarea Grammar and style in the same pass: - "he/she" -> "they", in a sentence that also said "end user", used future tense and "filling the form in" - "it's high time to check, whether it is done correctly" dropped the idiom and the comma before whether - "attribute" -> "property" eight times, matching the API terminology - "there is the [setValue] at your disposal" was missing "method" - "(if the name attribute is not defined in the config of the control)" repeated six times, now "(or id, if the control has no name)" - numberMask and patternMask property lists used ***bold italics*** and italics on property names; now backticks and em dashes, with "a text", "maximal" and "allows setting" fixed - "provide entering of values", "the process of a form sending" and "takes as a parameter an entered value" rewritten - "and returns a promise object." dangled after the parameters table, now a sentence - removed make use of, with the help of, easily, just, Starting from, There is a possibility, "By default" and a comma splice after "they are:"; method link labels got backticks, list items capitalized, double spaces removed - "POST" by default in the send() table cell -> "the default value is POST" Not changed: validAplhaNumeric looks like a typo for Alpha, but api_input_properties.md:135 and api_textarea_properties.md:131 spell it the same way, so it may be the real identifier. The frontmatter description is the placeholder "description". Headings are untouched, features.md and other pages link to their anchors.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Checked and deliberately left alone: View for properties and Check for methods/events looked like an inconsistency but is the site convention, 19 occurrences of each across docs/form/.
The "manipulate a X control by using methods or events of the object returned by getItem()" sentence is repeated verbatim in 19 files under docs/form/, along with the "full list of ... of the ... control" labels. Fixed here only, as with the earlier shared boilerplate.