Repository navigation
Article grammar changes - #174
Merged
Merged
Conversation
- fixed the chart count: the intro claimed 11 types while the article
itself lists 13, matching chart_type_config.md (treeMap since v7.3,
calendarHeatMap since v8.0)
- fixed a typo ("represent you data"), "charts types", and two comma
splices in the intro and the Bar section
- "less than 10 items" -> "fewer": items are countable
- hyphenated "two dimensional", already spelled correctly one screen
above in the Radar section
- rewrote all eight type descriptions: removed future tense, four
passive clauses, "in order to", "The peculiarity of X is that",
four missing articles and the "represent" verb
- dropped the table-of-contents entry that repeated the page title
- fixed "the chart will displayed" in two sections: the auxiliary verb was missing - fixed a broken code sample: the string literal in the Area/SplineArea example was split across two lines, so the snippet did not parse - "inclusively" -> "inclusive" in six range descriptions - startDate and endDate moved from bold to backticks, matching how the Mixed graphs section already writes API names; value types in the Main properties list moved from italics to backticks as well - "actual for all chart types" -> "that apply to", "individual for particular types" -> "specific to", "the minimal/maximal year" -> "earliest/latest" - replaced eight future-tense passives in the date-range examples, "i.e." twice, "via", and a semicolon that introduced a value list - corrected the maxPoints description: the property sets a threshold, it does not display anything - restored missing spaces and the serial comma in the scale type list
- five option names moved from bold to backticks: textTemplate, gradient, tooltipTemplate, showTextTemplate, valueTemplate - `<style>` written as a code span instead of an escaped HTML entity - replaced three noun phrases that hid their verb: "there is a possibility to", "it is possible to define", "you can easily define" - dropped "with the help of" and "via", added the missing article in "in tooltip" and the serial comma in "Pie, Pie3D, and Donut" - list items in the styling steps now start with a capital letter - headings left as they are: whatsnew.md links to the anchor of the last one, so renaming five of six would break consistency
- fixed "A data set for Treemap chart has also another structure": wrong adverb placement and a missing article, same omission for the Calendar heatmap chart one section below - serialize() moved from bold to backticks, matching load() and parse() on the same page; key:value and "color": "value" set as code - fixed three wrong prepositions: "on the initialization stage", "wrap into a promise", "parse the data to a different chart" - replaced three future-tense forms describing constant behaviour - "make use of" -> "use", "the URL of the file with data" -> "the data file URL", dropped "Please note that" inside an info block - "Heatmap chart" -> "Calendar heatmap chart", added the serial comma in "Pie, Pie3D, and Donut", capitalized four list items
- fixed two code samples that did not parse: function({width:500,
height:500}) is an invalid destructuring target, node --check failed
on both blocks; now function({ width, height })
- three method names moved from bold to backticks
- section headings changed from gerunds to verb phrases; no file links
to these anchors, verified across the docs tree
- "Calling events" -> "Trigger events": you call a method, an event is
triggered
- "The full list of events is available in the related API section" ->
"For the full event list, see the API section"
- section openers deliberately varied instead of unified: on the
Calendar page the same fix produced three identical "Use the ...
method" lines, which the next review flagged as repetition
- H1 left as a noun phrase: every page in the section keeps H1 equal to
sidebar_label, and features.md links here under the same label
- closed an unclosed parenthesis: "(for x,y, or both scales" - "you will know how to export" -> "learn how to": know is a state, not something a section teaches - "go into deep dive on its functionality" -> the intro now says what the page actually is, a directory of guides and references - "perform the code" -> "run code", "perform iteration" -> "iterate" - removed six section intros that only restated their own heading and unwrapped four more from the "In this section you can..." frame - fixed missing articles before Bar chart twice, before charts with scales, and in the Optimus cell; dropped the extra article in "call the Chart events", which lines below write without it - "Check the list of all available DataCollection API" trailed off; now "Check the full DataCollection API reference" - kept the repeated "Learn how to" in table cells on purpose: in a navigation table the identical opening is what makes the column scannable
- fixed a broken parallel in the intro: "the possibility to render ... and adding tooltips" mixed an infinitive with a gerund inside a 47-word sentence, now split in two - "add Chart on the page" -> "to a page" - added the comma after introductory phrases in two Related resources items, where the first item already had it, and terminal periods to all four - DataCollection wrapped in backticks - replaced marketing wording: "a great tool", "powerful charts", "a whole kit of", "full-featured" - dropped the duplicate link to online samples: the same URL appeared in the intro and in Related resources - "our website" -> "the DHTMLX website": the rest of the docs is written impersonally
- four file names moved from italics to backticks, matching how the Calendar initialization page already writes the same list - container id and the HTML id attribute set as code - fixed three prepositions: paths go in a header not into it, "at the previous step" -> "in", and the stranded "a container to place a Chart into" - "as a part of the Suite package" -> "as part of", in both the info block and the section below - "Detailed information ... is given in the article" -> the article itself is now the subject - "a folder of your project" -> "your project folder", dropped "you need to take the following steps" and "you need to include" twice - list items under the constructor now start with a capital letter and the link label says what it points to instead of "here"
- fixed a sentence that contradicted its own code sample: the text told the reader to pass an array of series objects to the handler, while eachSeries calls the handler once per series - property names in the HTML table and the series id set as code; Export module wrapped in backticks in two places where the line above already did it - "add items into your Chart" -> "to your Chart"; the heading keeps "into" because features.md links to its anchor - replaced four noun phrases hiding their verb: "gives you the possibility to get", "It is possible to iterate", "with the help of", "takes as a parameter an object with..." - "perform iteration" -> "iterate", "perform operations with" -> "work with", "via the corresponding methods" -> the two methods by name - "A new data item is added" -> Chart is now the subject; "in case of adding many items" -> "when you add several items"
- replace "It is possible to"/"There is a possibility to" openers with active phrasing - rewrite passive constructions so Colorpicker or the reader is the subject - put code values and property names in backticks instead of italic/bold - drop vague "via" and "with the help of" in favour of direct verbs - fix the missing article in "at the top of the palette" - call paletteOnly a configuration option, not a mode - unify the transparency link with the other auto-labeled API links
- replace the "There is a possibility to" opener with active phrasing - capitalize list items and add the missing colon before the code block - fix "a new CSS class(es)" article and number mismatch - put the style tag in backticks and drop the plain-text css link label - trim wordy asides: desired settings, your file with styles, don't forget
- rewrite section intros in present simple instead of "In this section you will find out" - add the missing articles in Optimus, palette, API and library descriptions - replace "mode of displaying Colorpicker" with "Colorpicker display mode" - fix "perform the code" and the focus row that promised a value instead of a color - drop vague "certain color", "necessary width" and "and more" - remove the stray leading space before the palette heading
- put the events.on/detach/fire method names in backticks instead of bold - open all three sections with the same "You can ... with the ... method" form - say "detach event listeners" instead of "detach events" - let the API section link carry the sentence instead of "is available in the related"
- fix "a colorpicker and a popup objects" and the missing articles around it - replace "presupposes" and "attach a colorpicker into it" with plain wording - spell the component as Colorpicker everywhere instead of ColorPicker/color picker - put suite.js, suite.css and null in backticks instead of italic - capitalize the parameter and popup step lists, add the missing comma - rewrite passive constructions and turn the broken "and initialize..." line into a sentence - align the contents link label with the "Select initial color" heading
- split the 36-word intro sentence and attach "can be used" to the component, not to colors - replace "It possesses easy-to-configure interface" with an active sentence and the missing articles - drop the evaluative "smart", "simply" and "handy" - give the Guides intro a subject and infinitives instead of a gerund pile - spell the component as Colorpicker instead of ColorPicker
Applies across all component overview pages the three defects found while reviewing the Colorpicker overview, so the shared template stays in sync. - "as a part of the Suite library" -> "as part of" (17 overview pages, plus the Grid and Tree initialization sentences) - "You can get X ... by [downloading DHTMLX Suite]" -> "[Download DHTMLX Suite] to get X ...", dropping the "by -ing" link - "There are also [online samples ...]" -> "Try the [online samples ...]" (21 pages) - "You can check the following page to learn how to build ..." -> "Learn how to build ..." (21 pages) List items keep their existing no-period style so each list stays consistent.
- replace "make use of the ... method" with "Use the ... method to ..." - call the "palette"/"picker" states modes, matching the API and the heading - rewrite passive constructions: is rendered, which is shown, will be displayed - drop vague "via", "with the help of", "a certain color" and "handy" - spell the component as Colorpicker instead of ColorPicker/color picker - move "as a parameter" after the object it follows
- replaced the legacy {{note}} macro with a :::note admonition, it was
rendering literally on the page
- API names value, src and serialize() moved from bold to backticks,
same for the key:value notation
- future tense and agentless passive rewritten as present simple with
an explicit subject
- fixed articles: JSON format, id fields
- "until you use" -> "unless you apply", "on the initialization stage"
-> "during initialization", "represent" -> "define"
- three sections no longer open with the same "To do X, do Y" frame,
the API method now leads the sentence
- ambiguous "It" pointing at DataCollection replaced with "The method"
- three parallel serialize() conditions folded into a state table
- component name unified to Combobox, "dataset" -> "data set" in prose
- code samples: dhx.Combo -> dhx.Combobox (no such constructor exists
anywhere else in docs), undefined combo1 -> combo
- replaced the legacy {{note}} macro with a :::note admonition, it was
rendering literally on the page
- API names and values moved from italics/bold to backticks: value,
multiselection, count, number, true, false
- fixed a factual slip in the Initial value list: it said "either of the
two values" and then listed three forms
- the initial value list got an intro sentence and consistent
terminators, it was hanging after the Related sample line
- "and should return a template..." was an orphaned sentence fragment
left after a bullet, folded back into a full sentence
- added the missing colon before six code samples
- "configuration property for this property" in Hidden label was a
duplicated word, the sentence is rewritten
- future tense replaced with present simple, four places
- "via" replaced with direct verbs, four places
- dropped empty sentences: "provides you with such an ability",
"This is how it can be done"
- "There is/There are", "it is possible to", "it is useful to" replaced
with active constructions
- removed filler: simply, just, If needed, Don't forget to, In order to,
make use of, In case, each time when, for this purpose
- end users -> users, from UI -> from the UI, some placeholder ->
a placeholder, options' ids -> option ids
- component name unified to Combobox
- bare "or" between two label samples replaced with a lead-in sentence
Image alt texts keep the site-wide "DHTMLX ComboBox ... in DHTMLX Suite"
pattern, and empty link labels are filled at build time, both left as is.
- fixed "a new CSS class(es)", an article paired with a plural suffix - "and should return *true/false*..." was an orphaned sentence fragment left after the parameters table, rebuilt as a full sentence - true/false moved from italics to backticks, and the passive "whether an item should be displayed" now names Combobox as the actor - <style> entity replaced with a `<style>` code span - list items capitalized and given periods, the parenthetical about including the stylesheet folded into the sentence - "There is a possibility to make changes in" and "It is possible to set" replaced with active constructions - via replaced with a direct verb, "the options of ComboBox" -> "Combobox options", "the created CSS class" -> "the class you created" - split the closing sentence about the fuzzy filter, its "in the popup list" modifier was stranded at the end, "independent of" -> "regardless of" - component name unified to Combobox The same CSS boilerplate bullet exists verbatim in 19 other */customization.md files and is deliberately left untouched there. The raw HTML parameters table with <b>/<i> is kept as is: that markup is the site-wide convention for parameter tables.
- fixed a copy-paste bug: the integration rows said "DHTMLX Chart with React/Angular/Vue" on the Combobox page; checked all 21 features.md files, only this one named a foreign component - "The example shows to load..." was missing "how", and "The example to load..." had no verb at all - "find out corresponding references of Combobox API", "Check the list of all available DataCollection API" and "perform the code after the component's rendering" rewritten, none of them parsed as English - the Clearing input row was the only table row without a leading pipe, normalized to match the rest - nine section intros used five different openings (can find out, will find out, can learn, can discover, This section explains), unified to "In this section you will learn..." - fixed broken parallelism in two intros: "how to set..., to enable..., to configure..." -> "how to set..., enable..., configure..." - "go into deep dive on its functionality" replaced, and future tense dropped from the page intro - "enable/disable the ability to..." wrappers collapsed into direct phrasing - end users -> users, via UI -> from the UI, edit/delete -> edit and delete, any operations -> all operations - missing articles added, double spaces removed, "provided by the DHTMLX library" -> "included in the DHTMLX library" - component name unified to Combobox, "look and feel" -> "appearance" to match the already updated customization page The page intro sentence is shared boilerplate across all 21 features.md files and was fixed here only, same as the CSS bullet earlier. Noticed in passing: docs/pagination/features.md:9 says "DHTMLX Message", the same copy-paste bug, left for a separate change.
- replaced the legacy {{note}} macro with a :::note admonition, it was
rendering literally on the page
- combo.events.on(), detach() and fire() moved from bold to backticks
- "The user can add... To do this, the user can use..." addressed the
reader as a third party and repeated the subject, merged into one
sentence in second person
- "any user-defined handler to any of the available events" carried two
indefinite pronouns, now "a custom handler to any available event"
- "Several handlers can be attached... will be executed" rewritten in
active present with Combobox as the actor
- "one and the same event" -> "the same event"
- "There is a simple way of removing... via the detach() method" now
leads with the method itself
- Detaching and Calling sections both opened with "To do X, ...", they
now match the Attaching section and lead with the API member
- "The names of the events" -> "Event names", table cell "name of the
event" -> "the event name"
- ComboBox -> Combobox, user-defined handler -> custom handler
The raw HTML parameters table with <b> is kept as is, per the site-wide
convention; only the descriptive cells were reworded.
- fixed a Cyrillic С (U+0421) in the placeholder value of the initialization sample, it looked identical to a Latin C but got copied into user code; the file is now ASCII apart from one em dash - "The one we have created at the previous step." was a sentence fragment, the only first-person "we" on the page and in present perfect, folded into the list item it belonged to - "Detailed information ... is given in the [] article" turned active - the page intro and the Initialize section both opened with "To do X, do Y", the second one just restating its own heading - suite.js and suite.css moved from italics to backticks, and "combo_container" from straight quotes to a code span - wrong prepositions: add ... in your application -> to, at the previous step -> in, as a part of -> as part of - "a folder of your project" -> "your project folder", "into the header of the file" -> "in its header" - removed padding: you need to follow, you should use, After that, "constructor function" -> "constructor", "the object constructor" -> "the constructor" - capitalized the two constructor parameter list items - added the missing period in the :::info block - component name unified to Combobox, including the Initialize and Load data headings; their anchors are unchanged, so the in-page links from the steps list still resolve
- rewrote the intro paragraph: "provides the ability to show suggestions" -> "shows suggestions", present continuous -> present simple, "specify templates of displaying options" reworded - "Among other nice features there are tuning of..., selection of... and data loading on request" dropped the editorial "nice", the there-are construction and three gerund nouns, and gained the missing serial comma - removed a mid-sentence hard wrap with a trailing space - the three Related resources bullets had three different shapes (statement, "There are also", inversion), now parallel imperatives - "as a part of" -> "as part of", "by [downloading DHTMLX Suite]" now leads with the link, "To work with data of ComboBox check" was missing its comma and became "Check the [DataCollection API] to work with Combobox data" - "You can check the following page" -> "Check the following page" - component name unified to Combobox, including the H1; its anchor combobox-overview is unchanged The Features lead-in and the Related resources bullets are shared boilerplate across all index.md files (List has them verbatim) and were fixed here only, same as the earlier pages in this branch. This page has no code samples.
- fixed the setLocale sample: it passed the DOM container id
("combo_container") where the method expects a widget name. Every
other page uses setLocale("form"/"calendar"/"grid"/"colorpicker", de),
and grid/configuration.md:1185 uses setLocale("combobox", locale) for
this very component, so the sample as written would not localize
- fixed the typo "To use a different locale, your need to:"
- that same line was a list intro the items had to finish
grammatically, replaced with "Follow these steps to use a different
locale:"
- dhx.i18n.setLocale() moved from bold to backticks
- both list items capitalized and turned into parallel imperatives, the
"by calling" link dropped
- the hyphen used as a parenthetical dash replaced with an em dash,
"names of buttons and labels" -> "button and label names"
- removed padding: just, corresponding, necessary; "a ready locale" ->
"the resulting locale"
- "the interface of DHTMLX Combo" -> "the DHTMLX Combobox interface",
"looks like this" -> "uses the following default locale"
The German sample strings are untouched, but two of them read oddly:
createItem is "Schaffen" rather than "Erstellen", and unselectAll is
"Deaktivieren Sie Alle" while selectAll next to it is "Alle auswählen".
That is a translation call, not a grammar one.
- parameter names and types moved from bold/italics to backticks, with the hyphen separator replaced by an em dash - method link labels were split between [setValue()] and [`paint()`], all nine unified to backticks; that form is the more common site convention (128 files against 66) and is what api-formatting requires - eight paragraphs in a row opened with "To do X, do Y", each restating its own heading; they now lead with the method or event - "e.g." -> "for example", "by default" -> "the default return type is" - "It takes two parameters" pointed at Data Collection rather than the method, twice, now "The method takes" - "Pass the id of the option that should be removed to the method" stranded its modifier and used passive, now "Pass the option id" - "It is possible to clear/add" replaced with active constructions - "with the help of" dropped in three places - removed padding: In order to, make use of, for this purpose, When needed, the process of showing/hiding, the corresponding methods - "prevent showing/hiding of a popup" -> "prevent the popup from opening/closing", "for adding" -> "to add" - via -> with, restrictive "which" -> "that" - fixed prepositions and of-chains: clear the selected values from the input, add options to an initialized Combobox, "config options of the option" -> "option settings" - ComboBox/Combo/combobox -> Combobox, ID(s)/IDs -> ids, "Data collection API" -> "Data Collection API", For instance -> For example Section headings are untouched: features.md links to their anchors (#disablingenabling-combobox, #hidingshowing-the-popup and others). The H1 is left as is so it keeps matching sidebar_label. HTML tables keep their <b>/<i> markup per the site convention; only cell wording changed.
- resolved a contradiction in the Grid section: roles and attributes were marked "(enabled by default)" while the next sentence said there is no flag to disable them - fixed a Cyrillic С (U+0421) in "High-Сontrast Themes"; the file now has no non-ASCII left apart from em dashes - fixed "There are general description of the component" (subject-verb disagreement) and the missing period in "are enabled by default You can find", both duplicated in List/DataView and Toolbar - fixed the dangling participle "Being rather attractive, it is also helpful", where "it" had no antecedent - "users that are visually impaired" -> "who", and the Enter key bullet was missing the word "key" that its three siblings had - ARIA role and attribute values moved from italics to backticks, and pointType from bold to backticks - "3 levels of conformance; A, AA and AAA" used a semicolon where a colon belongs, repeated "conformance" three times and lacked the serial comma - passive constructions rewritten with a named actor: care should be taken, information is taken from, the ability is not provided, you are not mandated to conform, are provided with keyboard navigation support - "Role presentation and aria-hidden are used to hide" (4 occurrences) -> "The presentation role and aria-hidden hide" - three of four keyboard bullets were passive while the fourth was active; all four are active now and capitalized - "presupposes equal access" -> "gives equal access", "provides support for" -> "supports", "WCAG 2.0 standards" -> singular - removed padding: Currently, most commonly encountered, the guidelines outlined, Among various themes there are, four "There are" openers - hyphen separators in the standards list -> em dashes, "web based" -> "web-based", missing serial commas, stray double space and a trailing space in the Toolbar heading Not changed, flagged instead: line 40 lists aria attributes with mixed naming, some without the aria- prefix (label, rowcount, colcount, rowindex, colindex) and some with it. That is a factual question about the attribute names, not a grammar one. Headings are untouched, the page links to their anchors itself.
- replaced the legacy {{pronote}} macro with a :::info admonition, it
was rendering literally on the page, and added the missing article in
"requires the PRO version"
- dropped "i.e." per the abbreviations rule and rewrote the passive
"they are initially hidden and shown only when the user hovers"
- removed the comma in "You may notice, that all DHTMLX demos", a comma
before that in an essential clause, along with the filler opener
- enable, dhx.scrollViewConfig, true, enable() and scrollView moved from
bold/italics to backticks
- the bare lowercase "or" between two code samples replaced with a lead
in naming the second option
- dropped the editorial "neat", "add the feature into your application"
-> "to", "you need to set" -> "set", "before initialization of the
widgets" -> "before you initialize the widgets"
- "read [this article]" -> a link labeled with the target article
- the Related article column repeated "learn more in the related
article" in all seven cells, which restated the column header and gave
seven links the same text; cells now carry named links, targets
unchanged
- added the missing "and" in the component list, removed three trailing
spaces
Two things left for a decision, not changed here:
- the demo URLs look shifted. dhtmlxFileExplorerDemo is used twice, for
File Explorer (correct) and UI Dashboard, while Hotel Management
Template points at dhtmlxDashboard. Guessing the right targets is not
a grammar call.
- {{pronote}} also appears in pagination/index.md, form/container.md,
list/load_data.md, helpers/lazydataproxy.md, helpers/datadrivers.md,
helpers/custom_scroll.md and grid/data_loading.md, all rendering as
plain text. Fixed here only, as with the earlier boilerplate.
- "Since version 7.0 and upper" is not a construction that exists;
replaced with "From v7.0", the phrasing used elsewhere in the docs
- fixed the dangling modifier in "While interacting with applications by
touching the screen, a tap becomes...", where the implied subject was
the user but the main clause subject was the tap
- removed the comma in "But note, that the mouseover events...", a comma
before that in an essential clause
- "the click events (fire on clicking, double clicking an item)" did not
parse as a sentence and lacked a conjunction
- added the missing "and" between the two purposes in the Drag bullet
- replaced the legacy {{note}} macro with a :::info admonition, and the
raw <a target="_blank"> inside it with a markdown link; Docusaurus adds
the target attribute to external links itself
- hyphen separators in the gesture list -> em dashes
- "provides the built-in Touch support that should work out of the box"
carried "provide", a stray article, a capitalized Touch mid-sentence
and a banned phrase; now "includes built-in touch support"
- "comfy" -> "comfortable", dropped the "As a result," and "Thus,"
openers, future tense -> present
- "enables recognition for the following touch gestures" -> "recognizes
the following gestures", which also drops the third "touch" in two
sentences
- removed a stray article and a trailing space
Not changed: "the dhtmlxSuite library" is a legacy spelling of the
product name in 16 files (sidebar/initialization.md, pagination/init.md,
data_proxy/index.md and others). Normalized to DHTMLX Suite here only,
as with the earlier shared boilerplate.
- fixed "much easier, safety, and productive", a noun in a list of
adjectives, and "all modern IDE" missing its plural
- fixed "Typescript" on line 13, the only occurrence of that spelling in
the whole docs tree; the same page spells it TypeScript four times
- the page jumped from # straight to ###; promoted the section to ##.
Nothing links to its anchor and the slug is unchanged
- replaced the legacy {{note}} macro with a :::info admonition and the
raw <a target="_blank"> inside it with a markdown link
- lines 9 and 13 said the same thing twice; the first now covers the
definitions, the second the absence of setup
- "provides a built-in support of Typescript that should work out of the
box" carried "provide", a wrong article and preposition, a banned
phrase and a hedging "should"
- "by using TypeScript definitions" link removed by making the
definitions the subject of the benefit
- fixed articles: the app development, a more stable code
- dropped the "Moreover," opener and the "therefore" aside, future tense
-> present, "help you to avoid" -> "help you avoid"
- "Checking the types together with autocompletion" -> "Type checking
and autocompletion", "your code created with DHTMLX" -> "the DHTMLX
code you write"
- removed trailing spaces on three lines
Not changed: "The dhtmlxSuite library" is the same legacy product
spelling found in 16 files. Normalized here only, as with the earlier
shared boilerplate.
Wrong, not merely clumsy: - "the possiblity of dragging" was misspelled. 1 such misspelling remains in the docs, in 1 file - "It presupposes that data is rendered by parts" and "Setting the multiselection property to true presupposes selection of multiple items" both used presupposes for "means". The first also said by parts where it meant in parts, the only such phrase in the docs - "as easy as that" would need to be as easily; the phrase is dropped rather than corrected, since it adds nothing Names and literals: - itemHeight and multiselection were bold in running prose and now use code formatting, as the api formatting rule requires - true, false and ctrlClick moved from italics and quotes to code - the drag mode values target, source and both moved from quotes to code, the dominant form for a value list: 229 against 39 Wording: - "provides the possibility to navigate" became "lets you navigate" - "All data is loaded into List and rendered at once" became "List loads and renders all data at once" - "There is a possibility to increase the speed of your application containing a List" became "You can increase the speed of an application that contains a List", the modifier having attached to the wrong noun - "allows highlighting a List item" became "allows you to highlight", the form the gerunds rule prescribes - "In case you use" and "In case you need" became If - "Set as its value a function" became "Set its value to a function" - "of a custom template of List items" became "of a custom List item template" - two sentences lost a repeated word: selection twice in one clause, and "enable the possibility to select" - added a colon before a code block, removed three trailing spaces - the two brace notes became the triple-colon form. This is NOT a rendering fix, the macro expands correctly; it follows the dominant syntax, now 467 triple-colon against 133 brace blocks Measured and left alone: make use of (60 hits in 38 files), the italic type names, since function is italic 42 times and never in code format, and the italic CSS calc() function phrase, 7 uses against 0 for a code-formatted calc(). The hyphen separating a value from its description is also the house form and stays. No heading was touched: 32 links point here and nearly every heading carries an anchor. Left for the author: this page and list_itemheight_config.md both give a default item height of 37 with no unit. Verified with a docusaurus build, and the rendered page was checked to confirm both notes became admonitions and every literal became code.
- "You can style particular cells in the list" said cells, a thing List does not have. The word appears 0 times in all of docs/list, and the heading directly above the sentence reads Styling items, while the next paragraph says each even item. Now items - "add a new CSS class(es)" did not agree in number; it now reads "a new CSS class (or classes)", matching the parenthetical of the next bullet - "make changes in the look and feel of a list. For this you need to take the following steps" became "You can change the look and feel of a list. To do this, take the following steps": changes in takes to, the opener was padding, and the introductory phrase needed its comma - "customize selection of an item" was missing an article The Styling section is a template shared by twenty component pages, so only its outright errors were touched. Left as they are, being clumsy rather than wrong: "your file with styles" (20 uses), "include your file on the page", and "the name of the created CSS class". The escaped style element also stays: 20 pages write it that way against 1 that puts it in code format. After this commit the template still carries 19 copies of the class(es) mismatch in 19 files, 19 of "make changes in the look and feel", and 33 of "There is a possibility to" across 30 files. That last construction sits above the threshold at which house forms are normally left alone; it is corrected here because the same construction was corrected in the previous commit, and being consistent inside one branch matters more than the threshold. Same defect elsewhere, not touched: dataview/customization.md says "style particular cells in the dataview", and cell appears 0 times in docs/dataview against 192 for item. CSS classes on this page were checked and are sound: every class the samples define is used and every class used is defined, with no look-alike characters. That is the defect found earlier in the Grid and Layout customization pages; it is not present here. Verified with a docusaurus build, and the rendered page carries no occurrence of the word cell.
Wrong, not merely clumsy: - "go into deep dive on its functionality" is not an idiom; it is now "dive deep into its functionality". 19 copies remain in 19 files - "perform the code" became "run the code": code is run. 19 copies remain in 19 files - "you can find out corresponding references of List API" became "you can find the corresponding List API references". References are found, not found out, and the article was missing. 19 copies remain - "use DHTMLX Optimus framework for creating DHTMLX-based app" was missing both articles, and carried a stray double space. 19 copies remain in 19 files - "on the initialization stage" became "at the initialization stage". 17 copies remain - "from external file" and "from external DataCollection" each gained the missing article; 4 and 3 copies remain - "for working with data of List, i.e. edit, add, remove, sort data, etc." became "to work with List data, such as editing, adding, removing and sorting it". The abbreviation introduced examples while meaning "that is", and with such as the trailing etc. was redundant. The docs still hold 19 uses of the first and 39 of the second - "from a selected item(s)" does not agree; it now reads "from a selected item (or items)", the same shape used for class(es) in the customization page. 1 copies remain Deliberately left, being weaker phrasing rather than error: - the seven ways this page and its siblings open a section. There is no majority to align to: you can find out 45, you will learn 32, you can learn 25, this section explains 19, you may study 15, will tell you 8, you will know 7. The Layout features page was left the same way; the Grid one was harmonised, but only because a single file there contradicted itself, which is not the case here - restrictive which in "functionality of the library which can be useful", 20 copies, since the form is grammatical - "help you to start working", and the double spaces inside table cells, which do not reach the rendered page No heading was touched, no link target changed, and the curly apostrophe in "component's rendering" was preserved rather than flattened to ASCII. Verified with a docusaurus build.
- "arrange multiple objects ... and make your data organized" became "and keep your data organized". The phrase was the only one of its kind in the docs, so nothing else shares it - "To work with data of List check the DataCollection API" became "To work with List data, check ...": the introductory clause needed its comma, and the noun chain read backwards. 1 such chain remains elsewhere in the docs - removed the trailing space that ended the opening paragraph Measured and deliberately left, all of them shared templates rather than defects of this page: - "as a part of the Suite library" (19 copies). The tighter "as part of" appears 0 times in the whole documentation, so changing this would invent a form rather than follow one; the longer phrase is used 46 times across 39 files and is grammatical - "by downloading DHTMLX Suite" (17 copies in 17 files) - "There are also online samples ..." (21 copies) and "You can check the following page ..." (21 copies) Worth a separate look, not touched here: the page links to the same samples URL twice with the same label, once in the opening paragraph and once under Related resources. That duplication comes from the shared template, so it belongs to all 21 pages rather than this one. No heading was touched, no link target changed, and the nine empty-label links that the build expands are intact. Verified with a docusaurus build, and the rendered page was checked to confirm both rewrites landed and the kept forms stayed.
Wrong, not merely clumsy: - "You can manipulate with List items" lost the preposition: manipulate is transitive. Master carries 4 of these; this commit fixes one, leaving 3 in 3 files - "the method selects all unselected items when calling without parameters" became "when called". As written, the participle makes the method do the calling. Master carries 7; two of them were on this page, leaving 5 in 4 files Worth stating, since it cuts against how other phrases in this series were handled: before this change the correct wording appeared 0 times in the whole documentation, and the 2 occurrences that exist now are the two introduced here. A missing precedent stopped me from touching "as part of" and a code-formatted calc(), but those existing forms were grammatical and merely less idiomatic. This one is not, so the absence of a precedent only means every copy shares the error Formatting and house forms: - the five bold API names on the page moved to code formatting. Master already writes 466 of these in code against 154 in bold, so this follows the established form rather than anything introduced by this series - "As a parameter the method takes the id of an item" became "The method takes as a parameter the id of an item". Master holds 3 of the inversion against 33 of the form now used, in 27 files - the brace note became the triple-colon form. Master holds 127; 124 remain in 92 files. This is not a rendering fix, the macro expands correctly - removed a trailing space from the prose. The one inside the code sample was left alone, being out of scope Measured and deliberately left, being weaker phrasing rather than error: "make use of" (60 copies in 38 files), "To make the process of working with the selection of items more flexible" (7 copies), and the split between "the Selection object" (24) and "the selection object" (11), which is a naming convention for the maintainer to settle rather than a grammar point. No heading was touched: features.md and work_with_list.md link to three of them by anchor. Verified with a docusaurus build, and the rendered page was checked to confirm both errors are gone and no bold API name survives.
Each count below is given as master, then what remains after this change, so neither figure goes stale because of the edit itself. - "It will return the id of an item in focus" became "It returns". A method's behaviour belongs in the present, and the sentence two paragraphs above already says "It takes". Master holds 6, leaving 5 in 4 files - "an object with new configuration of the item" was missing its article. Master holds 3, leaving 2 - "Pass the id of the item that should be removed to the method" stranded "to the method" at the end, so the sentence briefly reads as an item being removed to the method. It now says "Pass to the method the id of the item that should be removed". Master holds 3, leaving 2 Measured and deliberately left: - DataCollection on the removeAll line, against Data Collection five times elsewhere on the page. This looks like an internal contradiction, and I was going to align it, but the documentation writes DataCollection 261 times across 88 files against 51 for the spaced form in 15. The page as a whole is the minority, not that one line, and the joined spelling may well be the class name, which is out of scope to touch - the page says "It takes the id of an item as a parameter" in one place and "It takes as a parameter the id of an item" in another. Both are ordinary English; the docs use the trailing form 28 times against 13 for the other, and imposing one for the sake of a single page would be taste rather than correction - "make use of" (60 copies in 38 files) and "with the help of" (133 in 81), both house forms No heading was touched: twelve links point at this page and eight of its headings carry anchors, including from features.md and whatsnew.md. Verified with a docusaurus build, and the rendered page was checked to confirm all three rewrites landed and both HTML tables still render.
Counts are given as master, then what remains, so neither figure goes stale because of this change. - "This item takes space on the toolbar" described a Spacer on the Menu page. The identical sentence lives in docs/toolbar/spacer.md, where it is correct, and nowhere else: master held 2, one on each page, and 1 remains, the Toolbar one. The Menu page now says "on the menu" The phrase "takes space on the menu" appeared 0 times before this commit. That absence is not a reason to keep the old wording, as it was for "as part of" and a code-formatted calc() earlier in this series: those existing forms were grammatical and merely less idiomatic, whereas this one was false for the page it sat on - the four bold add() names moved to code formatting. Master already writes 466 of these in code against 154 in bold - "you can use Menu API and Tree Collection API" was missing an article. The sentence existed in a single file, so the fix is local; master held 1 of it and 0 remain Measured and deliberately left, all grammatical and shared by several pages: "can be easily added" (17 copies in 17 files), "A new Separator can be created" (3) and "A new Spacer can be created" (4), "This is an item that" (7), "This item takes space" (5), "items/groups of items" (4) and "with the help of" (133 in 81). No heading was touched: thirteen links point at this page, four of its headings carry anchors, and "Adding menuItem" is written in lower case where its three siblings are not. That is left for a change that can update the anchors with it. Left for a separate look: docs/menu/data_loading.md speaks of saving the state of a toolbar on a Menu page, which looks like the same copy-paste as the sentence fixed here. Verified with a docusaurus build, and the rendered page was checked to confirm the wrong component name is gone and no bold API name survives.
Counts are given as master, then what remains, so neither figure goes stale because of this change. - the ContextMenu sample was missing a comma between the css and data properties, so copying it raised a SyntaxError. It was the only such sample in the documentation. The fixed block passes a syntax check, and the same block without the comma still fails one, which is what makes the comma the defect rather than a coincidence - "either loaded ... or parsed ... or loaded" offered three alternatives, where either takes two. Master held 1, 0 remains - "It will be of great help for frequently used actions in web sites, help systems, etc." became "It is useful for frequently used actions in web sites and help systems": future tense and a trailing abbreviation. Master held 1, 0 remains - "Like with DHTMLX Menu" became "As with". Master held 1 - "the position of showing a context menu" became "the position at which a context menu is shown", and "By default" gained its comma. Master held 1 of the gerund chain - a comma was removed from a compound predicate: "is attached to a context zone, and can be shown" - the variable e moved from bold to code (1 on master), and the click and pointer values moved from quotes to code, the form the docs use 176 times against 34 for quoted values in a nested list Measured and deliberately left: - dhtmlxContextMenu, 9 occurrences and the same number on master, against 39 for the plain ContextMenu spelling across 8 files. The page already mixes both, so there is a case for aligning it, but the identical question about dhtmlxSuite is already waiting on the maintainer, and settling it in one place while deferring it in another would be inconsistent. One occurrence also sits in a heading, which anchors forbid touching - "web sites": the single-word spelling appears 0 times in the whole documentation against 2 for the spaced one, so changing it would invent a form rather than follow one - italic null, 25 against 29 in code: too close to call a house form - "expects loaded data", 12 copies in 12 files No heading was touched. Two of them would benefit from it: "Adding menuItem" is lower case where its siblings are not, and "Attaching to HTML object" is missing an article. Both need a change that can update the anchors with them. Verified with a docusaurus build, and the rendered page was checked to confirm the comma survives into the published code block.
Counts are given as this branch before the change, then what remains after it, so neither figure goes stale because of the edit itself. - the styling sample defined .my-first-class and .my-second-class but applied my_first_class my_second_class, so it styled nothing. The definitions now match the configuration: my_first_class, my_second_class The configuration spelling is the stable one. Across the customization pages the underscored names appear in the css option far more often than the hyphenated ones, while the style blocks are what drift, so the definitions moved rather than the option - "There is a possibility to make changes in the look and feel of a menu" became "You can change the look and feel of a menu": changes take to, not in. 20 such phrases stood here before, 19 remain in 19 files - "For this you need to take the following steps" became "To do this, take the following steps": the introductory phrase needed its comma. 19 before, 18 now - "a new CSS class(es)" does not agree in number and now reads "a new CSS class (or classes)". 20 before, 19 now - the icon property moved from bold to code. 6 before, 5 now - two link labels read "including link to its CDN" and now read "a link". 11 before, 9 now in 5 files - the brace note became the triple-colon form. 124 before, 123 now in 90 files. This is not a rendering fix, the macro expands correctly - removed a trailing space from the prose Measured and deliberately left: "There is a possibility to" on its own (34 copies in 31 files; here it went only because the same sentence carried the wrong preposition) and "icon font pack, if necessary" (6 copies). The same broken sample is still in 6 other components: layout, pagination, ribbon, sidebar, slider, toolbar. Most apply underscored names against hyphenated definitions; slider has it the other way round. They need one pass of their own rather than a grammar commit each. No heading was touched: features.md anchors both of them. Verified with a docusaurus build, and the published page was checked with the syntax highlighting stripped, so the class names were read as the reader's browser sees them.
Counts are given as this branch before the change, then what remains after it, so neither figure goes stale because of the edit itself. - "To save the current state of a toolbar" sat on the Menu page, and the next clause of the same paragraph already said "the data of a menu", so the paragraph contradicted itself. The identical sentence lives in docs/toolbar/load_data.md, where it is correct: there were 2, one on each page, and 1 remains, the Toolbar one This is the second sentence carried over from the Toolbar docs that this pass has found in Menu. The first was the Spacer description in configuring_menu_items.md. Worth checking the component for more of them rather than catching them one page at a time - seven API names moved from bold to code. The branch already writes 3963 of these in code against 972 in bold. The one bold word left on the page is "unique", which is ordinary prose, not a name - three sentences said "You will find the full list" where the first one on the same page says "You can find". The docs use the second form 31 times; there were 7 of the first, 4 remain - "Please note that" opened a sentence inside an info admonition, which already says as much. 33 before, 32 remain in 31 files - three wrong prepositions: "on the initialization stage" became at (18 before, 17 now), "wrap code into a promise" became in (13 before, 12 now), and "parse the data to a different menu" became into (10 before, 9 now) - "This section will give you the idea" became "gives you an idea": the article was wrong and the section does this now, not later. 4 before, 3 remain - "separators that will draw horizontal lines" became "that draw", and two trailing spaces went Measured and deliberately left: - the page spells the collection three ways: TreeCollection (233 in 88 files), Tree Collection (75 in 37) and tree collection (45 in 29). All three are widespread, so this is a naming convention for the maintainer to settle, like the dhtmlxSuite question already waiting - "There are several simple ways of" (6 copies in 6 files) and "expects loaded data" (12 in 12) No heading was touched. Verified with a docusaurus build, and the published page was checked to confirm the component name is right and that the only bold left is the prose word.
Counts are given as this branch before the change, then what remains after it, so neither figure goes stale because of the edit itself. Wrong, not merely clumsy: - "go into deep dive on its functionality" is not an idiom; it now reads "dive deep into". 20 before, 19 remain in 19 files - "perform the code" became "run the code": code is run. 20 before, 19 remain - "you can find out corresponding references of Menu and Menu controls API" became "you can find the corresponding Menu and Menu control API references". References are found, not found out, and the article was missing. 20 before, 19 remain - "on the initialization stage" became at. 17 before, 16 remain - "from external file" and "from external TreeCollection" each gained the missing article: 5 and 5 before, 4 and 4 now - "use DHTMLX Optimus framework for creating DHTMLX-based app" was missing both articles and carried a stray double space. 20 before, 19 remain - "for working with data of Menu, i.e. edit, add, remove, rearrange items, etc." became "to work with Menu data, such as editing, adding, removing and rearranging items". The abbreviation introduced examples while meaning "that is", and with such as the trailing etc. was redundant. 22 and 41 before, 21 and 40 now - "set a text label for menu item" gained its article - "you will find the ways of work with selection functionality" became "the ways to work with". This one was local rather than template: 1 copy in the whole documentation, 0 now, against 2 for the ordinary form - removed a stray trailing space Measured and deliberately left, being weaker phrasing rather than error: the restrictive which in "functionality of the library which can be useful" (20 copies in 20 files), "will help you to start working" (20 in 20), the seven ways these pages open a section, and "Setting item's configuration", which is an ordinary possessive in a table label. The apostrophe in "component's rendering" was left exactly as it is. An earlier commit on this branch had changed it from the typographic form to the plain one, which looked like an accident until it was counted: 20 of the features pages use the plain apostrophe and 0 use the typographic one, so that commit brought this page into line rather than away from it. No heading was touched. Verified with a docusaurus build, and the published page was checked both for what the edit added and for the absence of what it removed.
Counts are given as this branch before the change, then what remains after it. - menu.events.on() and menu.events.detach() moved from bold to code. This family is still mostly bold, 55 against 3 in code, but method names across the documentation run the other way, 589 in code against 206 in bold, and the api formatting rule asks for code - fire() moved to code for the same reason - the brace note became the triple-colon form, and the stray double space after the macro name and the space before the closing braces went with it. 123 brace notes before, 122 remain in 89 files, against 135 triple-colon ones One change is weaker than the rest and easy to undo: - the events module in "the fire() method of the events module" also moved to code. The code form had 0 occurrences in the whole documentation before this commit and now has 1, the one introduced here, against 10 that stay bold in 9 files. I made it so that one sentence would not carry fire() in code and events in bold at once, but the corpus does not support the form on its own. Reverting this one piece alone is trivial Deliberately left, being shared templates rather than defects of this page, and the same decision taken on the List events page: - "Several handlers can be attached to one and the same event" (10 copies in 10 files) - "There is a simple way of removing an event handler" (10 in 10) - "The names of the events are case-insensitive" (10 in 10). An earlier commit of mine on another branch rewrote this sentence in the Layout events page, which made that page the only one of the ten to word it differently. That was a mistake of consistency, not of grammar, and it is not repeated here The trailing space inside the code sample was left as it is, being out of scope. No heading was touched. Verified with a docusaurus build, and the published page was checked both for the names that became code and for the three templates that had to survive.
Counts are given as this branch before the change, then what remains. - "place full paths to JS and CSS files of the dhtmlxSuite library" was missing an article and read as a chain of of-phrases; it now says "place the full paths to the dhtmlxSuite JS and CSS files". 20 copies of the old wording before, 19 remain in 19 files - "Add a container for the Menu" dropped the article, since the page writes Menu bare in every other sentence. 1 before, 0 now - e.g. became "for example". Worth being plain about the basis: the abbreviation is the more common form in these docs, 92 occurrences before this change against 52 of the expanded one, so this follows the style rule rather than the corpus. It is not the same as inventing a form, since the expanded version is already used 52 times, but if the rule is wrong for this documentation then more than this page needs revisiting Left untouched on purpose, and checked to be sure: - the product spelling dhtmlxSuite, 61 occurrences in 47 files against 2515 for the spaced form. That is a naming decision for the maintainer, and fixing the grammar of the sentence around it should not pre-empt it - the italic file names. The api formatting rule would put them in code, but there is no precedent for that: 19 pages write them in italics and 1 in code, and that one page got its code formatting from an earlier commit of mine in this same series. An earlier Layout commit cited it as precedent, which was circular reasoning on my part; the rule still supports the change, the argument from existing usage does not - the shared steps of this template: "you need to take the following simple steps" (18 in 18 files), "Unpack the downloaded package" (21 in 21) and "the settings will be default" (12 in 12) No heading was touched. Verified with a docusaurus build, and the published page was checked both for the two rewrites and for the four things that had to survive.
Counts are given as this branch before the change, then what remains. - "add a drop down menu to user's projects" became "a drop-down menu to your projects". The unhyphenated spelling was the only one in the documentation; the hyphenated form already appears 16 times in 13 files and the closed one 33 times, so this follows existing usage rather than inventing it. The possessive had no article and now addresses the reader directly - "DHTMLX Menu component can be a good navigation aid to web sites, help systems, etc." gained its article and lost the trailing abbreviation. 40 of those before, 39 remain in 33 files - "To work with data of Menu check the TreeCollection API" became "To work with Menu data, check ...": the introductory clause needed its comma and the noun chain read backwards - "how to add Menu on the page" became "to the page". A component is added to a page. The corrected wording had 1 occurrences before this commit, but the absence of a precedent does not license a wrong preposition, the same reasoning applied earlier to a dangling participle in the List pages. 3 copies of the old preposition remain in 3 files Deliberately left: - "web sites" as two words. The single-word spelling appears 0 times in the whole documentation against 2 for the spaced one, so changing it would invent a form - "This component is highly customizable and supports a wide range of features". The style rules call this a generic description, and it tells the reader nothing concrete, but what an overview claims about a product is the author's decision rather than a grammar defect, so it is reported rather than rewritten - the shared overview template: "as a part of the Suite library", "by downloading DHTMLX Suite", "There are also online samples" and "You can check the following page" The page links to the same samples URL twice with nearly the same label, once in the opening paragraph and once under Related resources. That duplication comes from the template and belongs to every overview page, not this one. No heading was touched. Verified with a docusaurus build, and the published page was checked both for the four rewrites and for the things that had to survive.
Counts are given as this branch before the change, then what remains. - eight Tree collection method names moved from bold to code. The page already linked the Menu methods, so only the collection ones were left in bold. Across the branch the code form leads, 551 against 145; 137 bold names remain elsewhere - three brace notes became the triple-colon form. 122 before, 119 remain in 88 files - "Both methods can take one parameter - the ID of a menu item" now uses a colon, which is what the identical sentence further down the same page already does - "manipulate the controls of Menu" became "manipulate Menu controls", and a trailing space went with it - "even if in menu item configuration you set it as a number" became "even if you set it as a number in the menu item configuration": the article was missing and the clause read back to front Found while reading, reported rather than fixed: Four links point at anchors this page does not have. The published page carries 15 heading ids, and these are not among them: - menu_isselected_method.md asks for checkingifamenuitemisselected, the page has checking-if-a-menu-item-is-selected - menu_isdisabled_method.md asks for checkingifamenuoptionisdisabled, the page has checking-if-a-menu-option-is-disabled - menu_select_method.md and menu_unselect_method.md both ask for selectingunselectinganitem, the page has selectingunselecting-an-item 4 files are affected. The build does not fail on them because onBrokenAnchors is set to warn. They sit inside related-article comment lines, which this pass does not touch, and they are link targets, which it must not rewrite, so they are left for a change that can edit them deliberately. Deliberately left: - the trailing spaces in two headings, at lines 208, 226. They do not affect the generated anchors, but no heading has been touched anywhere in this pass and that is worth keeping uniform - four spellings of the collection name on one page: TreeCollection (233 in 88 files), Tree Collection (75), Tree collection (11) and tree collection (45). A naming decision for the maintainer - "make use of" (60 copies in 38 files) Verified with a docusaurus build. The published page was checked for the rewrites, and its heading ids were counted to confirm none moved.
[update] grammar and style in Menu guides- #153
[fix] correct typo and wrong words in List guides
[update] grammar and style in Form guides
[update] grammar and style in Colorpicker guides
[update] grammar and style in Chart user guides
[update] grammar and style in DataView guides
…article-grammar [update] grammar and style in Combobox and Common Features guides
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
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.
No description provided.