Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct usage of ellipsis, part 5 #18203

Merged
merged 3 commits into from
Jul 11, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@ Method pages need the following sections:
5. **Syntax**: The syntax section should include a 2–3 line example — usually just construction of the interface, then calling of the interface method.

- The syntax should be of the form:
- : method(param1, param2, ...)
- : method(param1, param2, )

The syntax section should include three subsections (see {{domxref("SubtleCrypto.sign()")}} for an example):

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/mdn/contribute/markdown_in_mdn/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ For example, if we want to use "Warnung" for "Warning" in German, then in German
> **Warnung:** So schreibt man eine Warnung.
```

...and this will produce:
And this will produce:

```html
<div class="notecard warning">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ The [Searchfox](https://searchfox.org/) website provides another method you can

## Opera

_If you have insights into locating release versions for changes to Opera, please consider helping us write this section..._
_If you have insights into locating release versions for changes to Opera, please consider helping us write this section_

### Presto

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/mdn/guidelines/video/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ This actually provides pretty easy simple recording facilities too:
4. Press the _Start Recording_ button.
5. Perform whatever actions you want to record.
6. Press the _Stop_ button.
7. Choose _File_ > _Export As..._ > _1080p_ from the main menu to save as hi definition.
7. Choose _File_ > _Export As_ > _1080p_ from the main menu to save as hi definition.

### Other resources

Expand Down
8 changes: 4 additions & 4 deletions files/en-us/mdn/guidelines/writing_style_guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ Instead, the summary should focus on the `strokeText()` method, and should refer
> If the value is `"left"`, the string is drawn starting at the specified value of `x`.
> And if `textAlign` is `"right"`, the text is drawn such that it ends at the specified X-coordinate.
>
> (etc etc etc...)
> ()
>
> You can, optionally, provide a fourth parameter that lets you specify a maximum width for the string, in pixels.
> If you provide this parameter, the text is compressed horizontally or scaled (or otherwise adjusted) to fit inside a space that wide when being drawn.
Expand Down Expand Up @@ -288,7 +288,7 @@ They also ensure correct linking to detailed documentation.
- : Use the [`htmlattrdef`](https://github.com/mdn/yari/blob/main/kumascript/macros/htmlattrdef.ejs) macro (e.g., `\{{htmlattrdef("type")}})` for the definition term, so that it can be linked to from other pages easily by using the [`htmlattrxref`](https://github.com/mdn/yari/blob/main/kumascript/macros/htmlattrxref.ejs) macro (e.g., `\{{htmlattrxref("type","element")}}`) to reference attribute definitions.
- Attribute values
- : Use the "Inline Code" style to apply `<code>` to attribute values, and don't use quotation marks around string values, unless needed by the syntax of a code sample.
**For example:** "When the `type` attribute of an `<input>` element is set to `email` or `tel` ..."
**For example:** "When the `type` attribute of an `<input>` element is set to `email` or `tel`"

### Latin abbreviations

Expand Down Expand Up @@ -342,8 +342,8 @@ Use full capitals and delete periods in all acronyms and abbreviations, includin

On the first mention of a term on a page, expand acronyms that are likely to be unfamiliar to users. When in doubt, expand it—or better yet, link it to the article or [glossary](/en-US/docs/Glossary) entry describing the technology.

- **Correct**: "XUL (XML User Interface Language) is Mozilla's XML-based language..."
- **Incorrect**: "XUL is Mozilla's XML-based language..."
- **Correct**: "XUL (XML User Interface Language) is Mozilla's XML-based language"
- **Incorrect**: "XUL is Mozilla's XML-based language"

#### Plurals of acronyms and abbreviations

Expand Down
1 change: 0 additions & 1 deletion files/en-us/mdn/kitchensink/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,6 @@ When you request to access a {{Glossary("URL")}}, the gateway server can relay y
- JavaScript {{jsxref("Array")}} on MDN

Listening for mouse movement is even easier than listening for key presses: all we need is the listener for the {{domxref("Element/mousemove_event", "mousemove")}} event.
...just below the `keyup event`:

## Browser compatibility

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/mdn/structures/compatibility_tables/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Now, whenever you want to update your fork, you can do so by:
Next, go to your remote fork (it will be at `https://github.com/your-username/browser-compat-data`) and create a new branch to store your changes for this data addition. This can be done by:

1. Clicking on the "Branch: Main" button.
2. Entering a new branch name into the "Find or create a branch..." text field.
2. Entering a new branch name into the "Find or create a branch" text field.
3. Pressing the resulting "Create branch _name-of-branch_ from Main" button.

For example, if you were wanting to add data for the WebVR API, you'd create a branch called something like "webvr".
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,8 @@ In this section, describe the API's purpose and usage cases in a bit more detail
What problems does it solve? What concepts does it involve? How do you use it, from a high level perspective?

Don't go into a lot of detail in this section, and don't include code examples.
If there are a lot of concepts to explain around this API, you should explain them in a separate "Fundamentals ..." or "Concepts..." article (e.g. [Fundamentals of WebXR](/en-US/docs/Web/API/WebXR_Device_API/Fundamentals)).
For a practical usage guide with code examples, you should include a "Usage..." article in your API docs (e.g. [Using the WebVR API](/en-US/docs/Web/API/WebVR_API/Using_the_WebVR_API)).
If there are a lot of concepts to explain around this API, you should explain them in a separate "Fundamentals" or "Concepts" article (e.g. [Fundamentals of WebXR](/en-US/docs/Web/API/WebXR_Device_API/Fundamentals)).
For a practical usage guide with code examples, you should include a "Usage" article in your API docs (e.g. [Using the WebVR API](/en-US/docs/Web/API/WebVR_API/Using_the_WebVR_API)).

To help improve content discoverability and {{Glossary("SEO")}}, keep the following tips in mind:

Expand Down
4 changes: 2 additions & 2 deletions files/en-us/mdn/tools/unsupported_get_api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ MDN's platform, [Yari](https://github.com/mdn/yari), doesn't provide a supported

Given the URL for a particular MDN article, by making an HTTP GET request to the corresponding URL with `/index.json` appended, you can retrieve associated JSON data.

For example, for the MDN article at:
For example, consider the following MDN article:

[https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch](/en-US/docs/Web/API/Fetch_API/Using_Fetch)

...you can retrieve its associated JSON data at:
You can retrieve its associated JSON data at:

[https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch/index.json](/en-US/docs/Web/API/Fetch_API/Using_Fetch/index.json)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ let removing = browser.browsingData.remove(
- `removalOptions`
- : `object`. A {{WebExtAPIRef("browsingData.RemovalOptions")}} object, which may be used to control how far back in time to remove data, and whether to remove data from hosted web apps and extensions, or just normal web pages.
- `dataTypes`
- : `object`. A {{WebExtAPIRef("browsingData.DataTypeSet")}} object, describing the types of data to remove (e.g. history, downloads, ...).
- : `object`. A {{WebExtAPIRef("browsingData.DataTypeSet")}} object, describing the types of data to remove (e.g. history, downloads, ).

### Return value

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ browser-compat: webextensions.api.browsingData.settings
---
{{AddonSidebar()}}

Browsers have a built-in "Clear History" feature, which enables the user to clear various types of browsing data. This has a UI that enables the user to select what type of data to remove (e.g. history, downloads, ...) and how far back in time to remove data.
Browsers have a built-in "Clear History" feature, which enables the user to clear various types of browsing data. This has a UI that enables the user to select what type of data to remove (e.g. history, downloads, ) and how far back in time to remove data.

This function returns the current value of these settings.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ Perform the following steps:
1. Save the PKCS #11 module to a permanent location on your local computer
2. Select **Tools > Options** or select the **Firefox menu** and then **Options**
3. Once the Options page opens, select **Privacy & Security**
4. Scroll down to the bottom of the page and under **Certificates** click or tap on **Security Devices...
![](device_manager.png)**
4. Scroll down to the bottom of the page and under **Certificates** click or tap on **Security Devices…**
![](device_manager.png)
5. Click or tap the **Load** button
![](load_device_driver.png)
6. Enter a name for the security module, such as "_My Client Database_"

> **Warning:** Be careful about using international characters as there is currently a bug in Firefox where international characters may cause problems.

7. Choose **Browse...** to find the location of the PKCS #11 module on your local computer, and then click or tap **OK** to confirm.
7. Choose **Browse** to find the location of the PKCS #11 module on your local computer, and then click or tap **OK** to confirm.

## Provisioning PKCS #11 modules

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The "api_script" property indicates the path to the JavaScript file that contain

Once you have downloaded the example:

Navigate to about:debugging, click on **Load Temporary Add-on...** and double-click on the extension's manifest.
Navigate to about:debugging, click on **Load Temporary Add-on** and double-click on the extension's manifest.

The default code included with the example allows you to load a `userScript` which will "eat" the content of pages matching the Hosts entry. Make any changes you want to make before clicking the **Register script** button at the bottom of the panel.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -163,12 +163,12 @@ Details of all the keys you can include are given in the table below.
<p>
Files are injected in the order given. This means that, for example,
if you include jQuery here followed by another content script, like
this...
this:
</p>
<pre class="brush: json">
"js": ["jquery.js", "my-content-script.js"]</pre
>
<p>...then <code>"my-content-script.js"</code> can use jQuery.</p>
<p>Then, <code>"my-content-script.js"</code> can use jQuery.</p>
<p>
The files are injected after any files in
<code><a href="#css">css</a></code
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/mozilla/firefox/releases/6/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Firefox 6, based on Gecko 6.0, was released on August 16, 2011. This article pro

### JavaScript

- In the past, it was possible to use the `new` operator on several built-in functions (eval, parseInt, Date.parse...) that should not have allowed it, according to the specification. This behavior is no longer supported. Using the `new` operator in this way was never officially supported and was not widely done, so it's unlikely that this change affects you.
- In the past, it was possible to use the `new` operator on several built-in functions (`eval()`, `parseInt()`, `Date.parse()`, …) that should not have allowed it, according to the specification. This behavior is no longer supported. Using the `new` operator in this way was never officially supported and was not widely done, so it's unlikely that this change affects you.
- ECMAScript 2015 [WeakMaps](/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap) have been added as a prototype implementation.

### SVG
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/mozilla/firefox/releases/60/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This article provides information about the changes in Firefox 60 that will affe

- In the CSS Pane rules view (see [Examine and edit CSS](https://firefox-source-docs.mozilla.org/devtools-user/page_inspector/how_to/examine_and_edit_css/index.html)), the keyboard shortcuts for precise value increments (increase/decrease by 0.1) have changed from `Alt` + `Up`/`Down` to `Ctrl` + `Up`/`Down` on Linux and Windows, to avoid clashes with default OS-level shortcuts (see {{bug("1413314")}}).
- Also in the CSS Pane rules view, [CSS variable names](/en-US/docs/Web/CSS/Using_CSS_custom_properties) will now auto-complete ({{bug(1422635)}}). If you enter `var(` into a property value and then type a dash (`-`), any variables you have declared in your CSS will then appear in an autocomplete list.
- In [Responsive Design Mode](https://firefox-source-docs.mozilla.org/devtools-user/responsive_design_mode/index.html), a _Reload when..._ dropdown has been added to allow users to enable/disable automatic page reloads when touch simulation is toggled, or simulated user agent is changed. See [Controlling page reload behavior](https://firefox-source-docs.mozilla.org/devtools-user/responsive_design_mode/index.html#controlling-page-reload-behavior) for more details ({{bug(1428816)}}).
- In [Responsive Design Mode](https://firefox-source-docs.mozilla.org/devtools-user/responsive_design_mode/index.html), a _Reload when_ dropdown has been added to allow users to enable/disable automatic page reloads when touch simulation is toggled, or simulated user agent is changed. See [Controlling page reload behavior](https://firefox-source-docs.mozilla.org/devtools-user/responsive_design_mode/index.html#controlling-page-reload-behavior) for more details ({{bug(1428816)}}).
- The `view_source.tab` preference has been removed so you can no longer toggle [View Source](https://firefox-source-docs.mozilla.org/devtools-user/view_source/index.html) mode between appearing in a new tab or new window. Page sources will always appear in new tabs from now on ({{bug(1418403)}}).

### HTML
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/mozilla/firefox/releases/61/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This article provides information about the changes in Firefox 61 that will affe
- In addition, hovering over a CSS variable name brings up a tooltip showing what color value is stored in that variable ({{bug(1431949)}}).

- The main toolbox's toolbar has been redesigned. Highlights are better responsiveness for narrow and wide viewports with a new overflow dropdown, cleaned up meatball menu, and sortable tabs to let you move up your most used panels ({{bug(1226272)}}).
- The [Network Monitor](https://firefox-source-docs.mozilla.org/devtools-user/network_monitor/index.html)'s toolbar now includes a dropdown menu providing easier access to the 'Copy All As HAR' and 'Save All As HAR' commands, as well as an 'Import...' option ({{bug(1403530)}}).
- The [Network Monitor](https://firefox-source-docs.mozilla.org/devtools-user/network_monitor/index.html)'s toolbar now includes a dropdown menu providing easier access to the 'Copy All As HAR' and 'Save All As HAR' commands, as well as an 'Import' option ({{bug(1403530)}}).
- The Network Monitor's details pane now includes a [Cache tab](https://firefox-source-docs.mozilla.org/devtools-user/network_monitor/index.html#cache), which displays information about previously cached resources ({{bug(859051)}}).
- The Network Monitor's main toolbar got redesigned to be more responsive on smaller viewports and visually aligned with the Console.
- The Network Monitor's main toolbar now includes a [Throttling](https://firefox-source-docs.mozilla.org/devtools-user/network_monitor/index.html#throttling) dropdown which was only available in the [Responsive Design Mode](https://firefox-source-docs.mozilla.org/devtools-user/responsive_design_mode/index.html#network-throttling) before. It allows you to throttle your network speed to emulate various different network speed conditions ({{bug(1349559)}}).
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/mozilla/firefox/releases/68/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ This article provides information about the changes in Firefox 68 that will affe

- The [Accessibility Inspector](https://firefox-source-docs.mozilla.org/devtools-user/accessibility_inspector/index.html) now includes a new _Check for issues_ feature, which will include a number of audit tools to highlight accessibility problems on your web pages. The first available check is _contrast_, for highlighting color contrast problems.
- The preference that controls the visibility of internal extensions (system add-ons and hidden extensions) on the [about:debugging](https://firefox-source-docs.mozilla.org/devtools-user/about_colon_debugging/index.html) page has been changed from `devtools.aboutdebugging.showSystemAddons` to `devtools.aboutdebugging.showHiddenAddons` ({{bug(1544372)}}).
- [Responsive design mode](https://firefox-source-docs.mozilla.org/devtools-user/responsive_design_mode/index.html) has been redesigned — the _Device Settings_ dialog (device selection menu > _Edit List..._) is now more intuitive and simpler to use ({{bug(1487857)}}).
- [Responsive design mode](https://firefox-source-docs.mozilla.org/devtools-user/responsive_design_mode/index.html) has been redesigned — the _Device Settings_ dialog (device selection menu > _Edit List_) is now more intuitive and simpler to use ({{bug(1487857)}}).

#### Removals

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/related/criteria_for_inclusion/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Therefore, if you want to consider a non-web standard technology for inclusion i

## The criteria

To be applicable for consideration, technologies should...
To be applicable for consideration, technologies should

### Be open and not proprietary

Expand Down
4 changes: 2 additions & 2 deletions files/en-us/related/project_guidelines/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,15 @@ Once your team is assembled, you'll need to get them all to [create MDN accounts

Write down a plan for the work — what needs to be done, and when? What milestones do you need to reach so that progress is healthy? If the project is large, you should consider getting one of your team members to be a project manager for the project, and using a project tracking tool like [Trello](https://trello.com/). You should also consider writing a sub-project plan for an initial release that encompasses the minimum set of documentation that is useful to publish (a _minimum viable product_), do that first, and then follow up with further additions later.

If the documentation resource is small, then this probably isn't so critical, but you still need to keep a record of what has been done and what hasn't, what stage each part of the documentation is at (e.g. not started, in progress, draft written, reviewed, done...), and who is working on what.
If the documentation resource is small, then this probably isn't so critical, but you still need to keep a record of what has been done and what hasn't, what stage each part of the documentation is at (e.g. not started, in progress, draft written, reviewed, done), and who is working on what.

## Guidelines and standards

There are [guidelines available on MDN](/en-US/docs/MDN/Guidelines) that state how we expect documents to be written, and how to use the tools on the site to create them.

Since this is a project in its own right, you may have additional guidelines on language or code styles that you expect to be followed. Feel free to keep a record of these, and even host them on a page inside your own project pages.

In terms of standards, you are expected to maintain a reasonable level of quality for your documentation to stay on MDN. Your MDN rep will work with you on this to make you clear on what is expected. It is a good idea to produce a prototype showing what each type of page in your documentation should look like (e.g. an element or method reference page, a code example...) so that people have a template to follow.
In terms of standards, you are expected to maintain a reasonable level of quality for your documentation to stay on MDN. Your MDN rep will work with you on this to make you clear on what is expected. It is a good idea to produce a prototype showing what each type of page in your documentation should look like (e.g. an element or method reference page, a code example) so that people have a template to follow.

> **Note:** MDN is primarily an English site (en-US). The primary language for your resource should be in US English. If this really doesn't make sense for your project (e.g. it might be for a tool usable in a specific non-English locale), then talk to us about it, and we'll see how we can accommodate this.

Expand Down
Loading