From 4e5e82a911561f645cee4b005af297b509934dc0 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 5 Sep 2022 02:04:01 -0400 Subject: [PATCH] fix: MD049 consistent emphasis style (#20105) * fix: MD049 consistent emphasis style * fix: MD049 consistent emphasis style * Update files/en-us/learn/server-side/django/forms/index.md Co-authored-by: Jean-Yves Perrier * Update files/en-us/web/accessibility/mobile_accessibility_checklist/index.md Co-authored-by: Jean-Yves Perrier * Update files/en-us/mozilla/add-ons/webextensions/chrome_incompatibilities/index.md Co-authored-by: Jean-Yves Perrier * Apply suggestions from code review * Update files/en-us/learn/server-side/django/forms/index.md * Format MathML * Apply suggestions from code review Co-authored-by: Jean-Yves Perrier --- .markdownlint.json | 4 +- files/en-us/glossary/base64/index.md | 2 +- files/en-us/glossary/data_structure/index.md | 2 +- files/en-us/glossary/flex_container/index.md | 2 +- .../using_github_pages/index.md | 4 +- .../building_blocks/styling_tables/index.md | 2 +- .../javascript/first_steps/variables/index.md | 2 +- .../learn/server-side/django/forms/index.md | 6 +- .../django/skeleton_website/index.md | 8 +- .../tutorial_local_library_website/index.md | 4 +- .../index.md | 2 +- .../tutorial_local_library_website/index.md | 4 +- .../introduction/index.md | 2 +- .../automated_testing/index.md | 2 +- .../mdn/writing_guidelines/howto/tag/index.md | 2 +- files/en-us/mdn/writing_guidelines/index.md | 2 +- .../api_property_subpage_template/index.md | 2 +- .../page_types/aria_page_template/index.md | 2 +- .../chrome_incompatibilities/index.md | 2 +- .../aria/roles/columnheader_role/index.md | 2 +- .../web/accessibility/aria/roles/index.md | 4 +- .../aria/roles/tab_role/index.md | 2 +- .../mobile_accessibility_checklist/index.md | 2 +- .../index.md | 2 +- files/en-us/web/api/abstractrange/index.md | 2 +- .../audioworkletprocessor/process/index.md | 2 +- files/en-us/web/api/fontface/index.md | 2 +- .../using_the_gamepad_api/index.md | 2 +- .../working_with_the_history_api/index.md | 2 +- .../web/api/htmlaudioelement/audio/index.md | 2 +- .../web/api/htmlelement/offsettop/index.md | 4 +- .../web/api/htmlimageelement/align/index.md | 2 +- .../web/api/htmlimageelement/border/index.md | 2 +- .../web/api/htmlimageelement/hspace/index.md | 2 +- .../web/api/htmlimageelement/name/index.md | 2 +- .../web/api/htmlimageelement/vspace/index.md | 2 +- .../api/htmlmediaelement/texttracks/index.md | 2 +- .../api/idbobjectstore/getallkeys/index.md | 4 +- .../api/intersection_observer_api/index.md | 2 +- .../applyconstraints/index.md | 2 +- .../web/api/pannernode/orientationx/index.md | 2 +- .../performanceresourcetiming/tojson/index.md | 2 +- .../binarytype/index.md | 2 +- .../getavailability/index.md | 4 +- files/en-us/web/api/request/text/index.md | 2 +- files/en-us/web/api/response/text/index.md | 2 +- .../web/api/rtcdtmfsender/tonebuffer/index.md | 2 +- .../generatecertificate/index.md | 2 +- .../shownotification/index.md | 8 +- files/en-us/web/api/texttracklist/index.md | 2 +- files/en-us/web/api/transformstream/index.md | 2 +- files/en-us/web/api/url/pathname/index.md | 2 +- .../en-us/web/api/videoframe/format/index.md | 8 +- files/en-us/web/api/vreyeparameters/index.md | 4 +- files/en-us/web/api/web_audio_api/index.md | 4 +- .../web_audio_api/using_audioworklet/index.md | 2 +- .../web_audio_api/using_iir_filters/index.md | 2 +- .../index.md | 12 +- .../compressedtexsubimage3d/index.md | 2 +- .../copytexsubimage3d/index.md | 2 +- .../teximage3d/index.md | 2 +- .../texsubimage3d/index.md | 2 +- .../webgl_model_view_projection/index.md | 2 +- .../drawbufferswebgl/index.md | 2 +- .../compressedteximage2d/index.md | 2 +- .../compressedtexsubimage2d/index.md | 2 +- .../copyteximage2d/index.md | 2 +- .../copytexsubimage2d/index.md | 2 +- .../webglrenderingcontext/teximage2d/index.md | 2 +- .../texsubimage2d/index.md | 2 +- .../web/api/webrtc_api/connectivity/index.md | 2 +- .../writing_websocket_server/index.md | 2 +- .../bounded_reference_spaces/index.md | 2 +- .../webxr_device_api/fundamentals/index.md | 2 +- .../startup_and_shutdown/index.md | 10 +- .../boundsgeometry/index.md | 2 +- files/en-us/web/api/xrcylinderlayer/index.md | 2 +- .../web/api/xrdepthinformation/width/index.md | 2 +- files/en-us/web/api/xrlayer/index.md | 2 +- .../getoffsetreferencespace/index.md | 5 +- .../web/api/xrsession/depthusage/index.md | 2 +- .../api/xrsession/interactionmode/index.md | 2 +- files/en-us/web/css/@charset/index.md | 2 +- files/en-us/web/css/@media/hover/index.md | 2 +- files/en-us/web/css/_colon_nth-child/index.md | 4 +- .../web/css/background-position-y/index.md | 2 +- .../en-us/web/css/content-visibility/index.md | 2 +- files/en-us/web/css/css_flow_layout/index.md | 2 +- .../web/css/gradient/radial-gradient/index.md | 2 +- files/en-us/web/css/grid-area/index.md | 4 +- files/en-us/web/css/pseudo-classes/index.md | 8 +- files/en-us/web/css/scroll-behavior/index.md | 2 +- .../css/scroll-padding-inline-end/index.md | 2 +- .../web/css/scroll-padding-right/index.md | 2 +- .../en-us/web/css/scroll-padding-top/index.md | 2 +- .../web/guide/html/editable_content/index.md | 2 +- files/en-us/web/html/element/i/index.md | 2 +- .../web/html/element/input/number/index.md | 2 +- files/en-us/web/html/inline_elements/index.md | 2 +- files/en-us/web/http/cookies/index.md | 2 +- .../content-security-policy/base-uri/index.md | 2 +- files/en-us/web/http/headers/upgrade/index.md | 2 +- .../web/javascript/data_structures/index.md | 2 +- .../control_flow_and_error_handling/index.md | 2 +- .../guide/keyed_collections/index.md | 2 +- .../regular_expressions/cheatsheet/index.md | 2 +- .../regular_expressions/quantifiers/index.md | 2 +- .../javascript/reference/functions/index.md | 2 +- .../reference/global_objects/boolean/index.md | 2 +- .../global_objects/math/hypot/index.md | 111 ++++++++++++------ .../global_objects/math/trunc/index.md | 2 +- .../reference/global_objects/weakmap/index.md | 4 +- .../reference/lexical_grammar/index.md | 2 +- .../operators/function_star_/index.md | 2 +- .../reference/operators/grouping/index.md | 4 +- .../javascript/reference/strict_mode/index.md | 2 +- .../web/media/formats/image_types/index.md | 2 +- 117 files changed, 228 insertions(+), 192 deletions(-) diff --git a/.markdownlint.json b/.markdownlint.json index 9ec5ab23676bd19..9dad7588271f720 100644 --- a/.markdownlint.json +++ b/.markdownlint.json @@ -99,7 +99,9 @@ "MD046": { "style": "fenced" }, - "MD049": false, + "MD049": { + "style": "underscore" + }, "MD050": { "style": "asterisk" }, diff --git a/files/en-us/glossary/base64/index.md b/files/en-us/glossary/base64/index.md index 83cdeeb03faa6ec..294fa4ddbc8b1da 100644 --- a/files/en-us/glossary/base64/index.md +++ b/files/en-us/glossary/base64/index.md @@ -12,7 +12,7 @@ tags: - atob() - btoa() --- -**Base64** is a group of similar [binary-to-text encoding](https://en.wikipedia.org/wiki/Binary-to-text_encoding) schemes that represent binary data in an ASCII string format by translating it into a radix-64 representation. The term *Base64* originates from a specific [MIME content transfer encoding](https://en.wikipedia.org/wiki/MIME#Content-Transfer-Encoding). +**Base64** is a group of similar [binary-to-text encoding](https://en.wikipedia.org/wiki/Binary-to-text_encoding) schemes that represent binary data in an ASCII string format by translating it into a radix-64 representation. The term _Base64_ originates from a specific [MIME content transfer encoding](https://en.wikipedia.org/wiki/MIME#Content-Transfer-Encoding). Base64 encoding schemes are commonly used when there is a need to encode binary data that needs to be stored and transferred over media that are designed to deal with ASCII. This is to ensure that the data remain intact without modification during transport. Base64 is commonly used in a number of applications including email via [MIME](https://en.wikipedia.org/wiki/MIME), and storing complex data in [XML](/en-US/docs/Web/XML). diff --git a/files/en-us/glossary/data_structure/index.md b/files/en-us/glossary/data_structure/index.md index a492d3aec0b431c..ffce635296c1e7c 100644 --- a/files/en-us/glossary/data_structure/index.md +++ b/files/en-us/glossary/data_structure/index.md @@ -6,7 +6,7 @@ tags: - Data structure - Glossary --- -**Data structure** is a particular way of organizing *data* so that it can be used efficiently. +**Data structure** is a particular way of organizing _data_ so that it can be used efficiently. ## See also diff --git a/files/en-us/glossary/flex_container/index.md b/files/en-us/glossary/flex_container/index.md index 1c17e55433c59da..5006a1bdda9fe10 100644 --- a/files/en-us/glossary/flex_container/index.md +++ b/files/en-us/glossary/flex_container/index.md @@ -28,4 +28,4 @@ A value of `flex` causes the element to become a block level flex container, and - CSS Flexbox Guide: _[Basic Concepts of Flexbox](/en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Basic_Concepts_of_Flexbox)_ - CSS Flexbox Guide: _[Aligning items in a flex container](/en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Aligning_Items_in_a_Flex_Container)_ - CSS Flexbox Guide: _[Mastering wrapping of flex items](/en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Mastering_Wrapping_of_Flex_Items)_ -- Firefox Developer Tools > How to: *[CSS Flexbox Inspector: Examine Flexbox layouts](https://firefox-source-docs.mozilla.org/devtools-user/page_inspector/how_to/examine_flexbox_layouts/index.html)* +- Firefox Developer Tools > How to: _[CSS Flexbox Inspector: Examine Flexbox layouts](https://firefox-source-docs.mozilla.org/devtools-user/page_inspector/how_to/examine_flexbox_layouts/index.html)_ diff --git a/files/en-us/learn/common_questions/using_github_pages/index.md b/files/en-us/learn/common_questions/using_github_pages/index.md index 08cdc21d116748f..60c7fe065274d6c 100644 --- a/files/en-us/learn/common_questions/using_github_pages/index.md +++ b/files/en-us/learn/common_questions/using_github_pages/index.md @@ -28,7 +28,7 @@ You can store any code you like in a GitHub repository, but to use the GitHub Pa The other thing you need to do before moving on is to initialise your code directory as a Git repository. To do this: -1. Point the command line to your `test-site` directory (or whatever you called the directory containing your website). For this, use the `cd` command (i.e. "*c*hange *d*irectory"). Here's what you'd type if you've put your website in a directory called `test-site` on your desktop: +1. Point the command line to your `test-site` directory (or whatever you called the directory containing your website). For this, use the `cd` command (i.e. "**c**hange **d**irectory"). Here's what you'd type if you've put your website in a directory called `test-site` on your desktop: ```bash cd Desktop/test-site @@ -86,7 +86,7 @@ This may seem a bit scary at first, but don't worry — you'll soon get the hang git push -u origin main ``` -4. Now you need to turn GitHub pages on for your repository. To do this, from the homepage of your repository choose _Settings_, then select _Pages_ from the sidebar on the left. Underneath *Source*, choose the "main" branch. The page should refresh. +4. Now you need to turn GitHub pages on for your repository. To do this, from the homepage of your repository choose _Settings_, then select _Pages_ from the sidebar on the left. Underneath _Source_, choose the "main" branch. The page should refresh. 5. Go to the GitHub Pages section again, and you should see a line of the form "Your site is ready to be published at `https://xxxxxx`." 6. If you click on this URL, you should go to a live version of your example, provided the home page is called `index.html` — it goes to this entry point by default. If your site's entry point is called something else, for example `myPage.html`, you'll need to go to `https://xxxxxx/myPage.html`. diff --git a/files/en-us/learn/css/building_blocks/styling_tables/index.md b/files/en-us/learn/css/building_blocks/styling_tables/index.md index 734c6e316d4e592..5abd15946984d36 100644 --- a/files/en-us/learn/css/building_blocks/styling_tables/index.md +++ b/files/en-us/learn/css/building_blocks/styling_tables/index.md @@ -137,7 +137,7 @@ th, td { The most important parts to note are as follows: -- A {{cssxref("table-layout")}} value of `fixed` is generally a good idea to set on your table, as it makes the table behave a bit more predictably by default. Normally, table columns tend to be sized according to how much content they contain, which produces some strange results. With `table-layout: fixed`, you can size your columns according to the width of their headings, and then deal with their content as appropriate. This is why we've selected the four different headings with the `thead th:nth-child(n)` ({{cssxref(":nth-child")}}) selector ("Select the *n*th child that is a {{htmlelement("th")}} element in a sequence, inside a {{htmlelement("thead")}} element") and given them set percentage widths. The entire column width follows the width of its heading, making for a nice way to size your table columns. Chris Coyier discusses this technique in more detail in [Fixed Table Layouts](https://css-tricks.com/fixing-tables-long-strings/). +- A {{cssxref("table-layout")}} value of `fixed` is generally a good idea to set on your table, as it makes the table behave a bit more predictably by default. Normally, table columns tend to be sized according to how much content they contain, which produces some strange results. With `table-layout: fixed`, you can size your columns according to the width of their headings, and then deal with their content as appropriate. This is why we've selected the four different headings with the `thead th:nth-child(n)` ({{cssxref(":nth-child")}}) selector ("Select the n-th child that is a {{htmlelement("th")}} element in a sequence, inside a {{htmlelement("thead")}} element") and given them set percentage widths. The entire column width follows the width of its heading, making for a nice way to size your table columns. Chris Coyier discusses this technique in more detail in [Fixed Table Layouts](https://css-tricks.com/fixing-tables-long-strings/). We've coupled this with a {{cssxref("width")}} of 100%, meaning that the table will fill any container it is put in, and be nicely responsive (although it would still need some more work to get it looking good on narrow screen widths). diff --git a/files/en-us/learn/javascript/first_steps/variables/index.md b/files/en-us/learn/javascript/first_steps/variables/index.md index baf6bf5418c2c22..e8d164c3fb3f906 100644 --- a/files/en-us/learn/javascript/first_steps/variables/index.md +++ b/files/en-us/learn/javascript/first_steps/variables/index.md @@ -421,7 +421,7 @@ If you can't do as much with `const` as you can with `let`, why would you prefer In this course, we adopt the following principle about when to use `let` and when to use `const`: -*Use `const` when you can, and use `let` when you have to.* +_Use `const` when you can, and use `let` when you have to._ This means that if you can initialize a variable when you declare it, and don't need to reassign it later, make it a constant. diff --git a/files/en-us/learn/server-side/django/forms/index.md b/files/en-us/learn/server-side/django/forms/index.md index 45c7ad35bab91ee..45adf468f3b274f 100644 --- a/files/en-us/learn/server-side/django/forms/index.md +++ b/files/en-us/learn/server-side/django/forms/index.md @@ -581,9 +581,9 @@ The `AuthorDelete` class doesn't need to display any of the fields, so these don ### Templates -The "create" and "update" views use the same template by default, which will be named after your model: *model_name*\_**form.html** (you can change the suffix to something other than **\_form** using the `template_name_suffix` field in your view, for example `template_name_suffix = '_other_suffix'`) +The "create" and "update" views use the same template by default, which will be named after your model: `model_name_form.html` (you can change the suffix to something other than **\_form** using the `template_name_suffix` field in your view, for example, `template_name_suffix = '_other_suffix'`) -Create the template file **locallibrary/catalog/templates/catalog/author_form.html** and copy in the text below. +Create the template file `locallibrary/catalog/templates/catalog/author_form.html` and copy the text below. ```html {% extends "base_generic.html" %} @@ -601,7 +601,7 @@ Create the template file **locallibrary/catalog/templates/catalog/author_form.ht This is similar to our previous forms and renders the fields using a table. Note also how again we declare the `{% csrf_token %}` to ensure that our forms are resistant to CSRF attacks. -The "delete" view expects to find a template named with the format *model_name*\_**confirm_delete.html** (again, you can change the suffix using `template_name_suffix` in your view). Create the template file **locallibrary/catalog/templates/catalog/author_confirm_delete.html** and copy in the text below. +The "delete" view expects to find a template named with the format _`model_name_confirm_delete.html` (again, you can change the suffix using `template_name_suffix` in your view). Create the template file `locallibrary/catalog/templates/catalog/author_confirm_delete.html` and copy the text below. ```html {% extends "base_generic.html" %} diff --git a/files/en-us/learn/server-side/django/skeleton_website/index.md b/files/en-us/learn/server-side/django/skeleton_website/index.md index 459fcb029c5bd6a..f1a33ab3f4d3915 100644 --- a/files/en-us/learn/server-side/django/skeleton_website/index.md +++ b/files/en-us/learn/server-side/django/skeleton_website/index.md @@ -53,7 +53,7 @@ To get started: 3. Register the new applications to include them in the project. 4. Hook up the **url/path** mapper for each application. -For the [Local Library website](/en-US/docs/Learn/Server-side/Django/Tutorial_local_library_website), the website and project folders are named *locallibrary*, and includes one application named _catalog_. +For the [Local Library website](/en-US/docs/Learn/Server-side/Django/Tutorial_local_library_website), the website and project folders are named _locallibrary_, and includes one application named _catalog_. The top-level folder structure will therefore be as follows: ```bash @@ -240,7 +240,7 @@ urlpatterns = [ The URL mappings are managed through the `urlpatterns` variable, which is a Python _list_ of `path()` functions. Each `path()` function either associates a URL pattern to a _specific view_, which will be displayed when the pattern is matched, or with another list of URL pattern testing code (in this second case, the pattern becomes the "base URL" for patterns defined in the target module). The `urlpatterns` list initially defines a single function that maps all URLs with the pattern _admin/_ to the module `admin.site.urls`, which contains the Administration application's own URL mapping definitions. -> **Note:** The route in `path()` is a string defining a URL pattern to match. This string might include a named variable (in angle brackets), e.g. `'catalog//'`. This pattern will match a URL like **catalog/_any_chars_/** and pass *any_chars* to the view as a string with parameter name `id`. We discuss path methods and route patterns further in later topics. +> **Note:** The route in `path()` is a string defining a URL pattern to match. This string might include a named variable (in angle brackets), e.g. `'catalog//'`. This pattern will match a URL like **catalog/_any_chars_/** and pass _`any_chars`_ to the view as a string with the parameter name `id`. We discuss path methods and route patterns further in later topics. To add a new list item to the `urlpatterns` list, add the following lines to the bottom of the file. This new item includes a `path()` that forwards requests with the pattern `catalog/` to the module `catalog.urls` (the file with the relative URL **catalog/urls.py**). @@ -313,7 +313,7 @@ urlpatterns = [ ## Testing the website framework -At this point we have a complete skeleton project. The website doesn't actually *do* anything yet, but it's worth running it to make sure that none of our changes have broken anything. +At this point we have a complete skeleton project. The website doesn't actually _do_ anything yet, but it's worth running it to make sure that none of our changes have broken anything. Before we do that, we should first run a _database migration_. This updates our database (to include any models in our installed applications) and removes some build warnings. @@ -330,7 +330,7 @@ python3 manage.py migrate > **Warning:** You'll need to run these commands every time your models change in a way that will affect the structure of the data that needs to be stored (including both addition and removal of whole models and individual fields). -The `makemigrations` command *creates* (but does not apply) the migrations for all applications installed in your project. You can specify the application name as well to just run a migration for a single project. This gives you a chance to check out the code for these migrations before they are applied. If you're a Django expert, you may choose to tweak them slightly! +The `makemigrations` command _creates_ (but does not apply) the migrations for all applications installed in your project. You can specify the application name as well to just run a migration for a single project. This gives you a chance to check out the code for these migrations before they are applied. If you're a Django expert, you may choose to tweak them slightly! The `migrate` command is what applies the migrations to your database. Django tracks which ones have been added to the current database. diff --git a/files/en-us/learn/server-side/django/tutorial_local_library_website/index.md b/files/en-us/learn/server-side/django/tutorial_local_library_website/index.md index c0e5965e49b696c..7bf5b8e5e520788 100644 --- a/files/en-us/learn/server-side/django/tutorial_local_library_website/index.md +++ b/files/en-us/learn/server-side/django/tutorial_local_library_website/index.md @@ -60,9 +60,9 @@ You have learned about some of these topics already, and touched briefly on othe ## The LocalLibrary website -*LocalLibrary* is the name of the website that we'll create and evolve over the course of this series of tutorials. As you'd expect, the purpose of the website is to provide an online catalog for a small local library, where users can browse available books and manage their accounts. +_LocalLibrary_ is the name of the website that we'll create and evolve over the course of this series of tutorials. As you'd expect, the purpose of the website is to provide an online catalog for a small local library, where users can browse available books and manage their accounts. -This example has been carefully chosen because it can scale to show as much or as little detail as we need, and can be used to show off almost any Django feature. More importantly, it allows us to provide a *guided* path through the most important functionality in the Django web framework: +This example has been carefully chosen because it can scale to show as much or as little detail as we need, and can be used to show off almost any Django feature. More importantly, it allows us to provide a _guided_ path through the most important functionality in the Django web framework: - In the first few tutorial articles we will define a simple _browse-only_ library that library members can use to find out what books are available. This allows us to explore the operations that are common to almost every website: reading and displaying content from a database. - As we progress, the library example naturally extends to demonstrate more advanced Django features. For example we can extend the library to allow users to reserve books, and use this to demonstrate how to use forms, and support user authentication. diff --git a/files/en-us/learn/server-side/express_nodejs/displaying_data/bookinstance_detail_page_and_challenge/index.md b/files/en-us/learn/server-side/express_nodejs/displaying_data/bookinstance_detail_page_and_challenge/index.md index 5e12645008b39dd..fae5a1705764130 100644 --- a/files/en-us/learn/server-side/express_nodejs/displaying_data/bookinstance_detail_page_and_challenge/index.md +++ b/files/en-us/learn/server-side/express_nodejs/displaying_data/bookinstance_detail_page_and_challenge/index.md @@ -81,7 +81,7 @@ Run the application and open your browser to `http://localhost:3000/`. Select th ## Challenge -Currently most *dates* displayed on the site use the default JavaScript format (e.g. _Tue Oct 06 2020 15:49:58 GMT+1100 (AUS Eastern Daylight Time))_. The challenge for this article is to improve the appearance of the date display for `Author` lifespan information (date of death/birth) and for _BookInstance detail_ pages to use the format: Oct 6th, 2016. +Currently most _dates_ displayed on the site use the default JavaScript format (e.g. _Tue Oct 06 2020 15:49:58 GMT+1100 (AUS Eastern Daylight Time))_. The challenge for this article is to improve the appearance of the date display for `Author` lifespan information (date of death/birth) and for _BookInstance detail_ pages to use the format: Oct 6th, 2016. > **Note:** You can use the same approach as we used for the _Book Instance List_ (adding the virtual property for the lifespan to the `Author` model and use [luxon](https://www.npmjs.com/package/luxon) to format the date strings). diff --git a/files/en-us/learn/server-side/express_nodejs/tutorial_local_library_website/index.md b/files/en-us/learn/server-side/express_nodejs/tutorial_local_library_website/index.md index 272bde71928f5dc..9c5bff892819a4d 100644 --- a/files/en-us/learn/server-side/express_nodejs/tutorial_local_library_website/index.md +++ b/files/en-us/learn/server-side/express_nodejs/tutorial_local_library_website/index.md @@ -58,9 +58,9 @@ You have learnt about some of these topics already, and touched briefly on other ## The LocalLibrary website -*LocalLibrary* is the name of the website that we'll create and evolve over the course of this series of tutorials. As you'd expect, the purpose of the website is to provide an online catalog for a small local library, where users can browse available books and manage their accounts. +_LocalLibrary_ is the name of the website that we'll create and evolve over the course of this series of tutorials. As you'd expect, the purpose of the website is to provide an online catalog for a small local library, where users can browse available books and manage their accounts. -This example has been carefully chosen because it can scale to show as much or little detail as we need, and can be used to show off almost any Express feature. More importantly, it allows us to provide a *guided* path through the functionality you'll need in any website: +This example has been carefully chosen because it can scale to show as much or little detail as we need, and can be used to show off almost any Express feature. More importantly, it allows us to provide a _guided_ path through the functionality you'll need in any website: - In the first few tutorial articles we will define a simple _browse-only_ library that library members can use to find out what books are available. This allows us to explore the operations that are common to almost every website: reading and displaying content from a database. - As we progress, the library example naturally extends to demonstrate more advanced website features. For example we can extend the library to allow new books to be created, and use this to demonstrate how to use forms and support user authentication. diff --git a/files/en-us/learn/tools_and_testing/client-side_javascript_frameworks/introduction/index.md b/files/en-us/learn/tools_and_testing/client-side_javascript_frameworks/introduction/index.md index 07139c2552569a2..99f713532520647 100644 --- a/files/en-us/learn/tools_and_testing/client-side_javascript_frameworks/introduction/index.md +++ b/files/en-us/learn/tools_and_testing/client-side_javascript_frameworks/introduction/index.md @@ -306,7 +306,7 @@ Popular examples include [Wordpress](https://wordpress.com/), [Joomla](https://w ### Server-side rendering -**Server-side rendering** (**SSR**) is an application architecture in which it is the *server*'s job to render a single-page application. This is the opposite of _client-side rendering_, which is the most common and most straightforward way to build a JavaScript application. Server-side rendering is easier on the client's device, because you're only sending a rendered HTML file to them, but it can be difficult to set up compared to a client-side-rendered application. +**Server-side rendering** (**SSR**) is an application architecture in which it is the _server_'s job to render a single-page application. This is the opposite of _client-side rendering_, which is the most common and most straightforward way to build a JavaScript application. Server-side rendering is easier on the client's device, because you're only sending a rendered HTML file to them, but it can be difficult to set up compared to a client-side-rendered application. All of the frameworks covered in this module support server-side rendering as well as client-side rendering. Check out [Next.js](https://nextjs.org/) for React, [Nuxt.js](https://nuxtjs.org/) for Vue (yes, it is confusing, and no, these projects are not related!), [FastBoot](https://github.com/ember-fastboot/ember-cli-fastboot) for Ember, and [Angular Universal](https://angular.io/guide/universal) for Angular. diff --git a/files/en-us/learn/tools_and_testing/cross_browser_testing/automated_testing/index.md b/files/en-us/learn/tools_and_testing/cross_browser_testing/automated_testing/index.md index 693b02789d6a1e7..9a88ca47c669ecd 100644 --- a/files/en-us/learn/tools_and_testing/cross_browser_testing/automated_testing/index.md +++ b/files/en-us/learn/tools_and_testing/cross_browser_testing/automated_testing/index.md @@ -703,7 +703,7 @@ Let's get started with a TestingBot Trial. #### The basics: Manual tests -The [TestingBot dashboard](https://app.saucelabs.com/dashboard/manual) lists the various options you can choose from. For now, make sure you are on the *Live Web Testing* tab. +The [TestingBot dashboard](https://app.saucelabs.com/dashboard/manual) lists the various options you can choose from. For now, make sure you are on the _Live Web Testing_ tab. 1. Enter the URL of the page you want to test. 2. Choose the browser/OS combination you want to test by selecting the combination in the grid. diff --git a/files/en-us/mdn/writing_guidelines/howto/tag/index.md b/files/en-us/mdn/writing_guidelines/howto/tag/index.md index c9d43663b286ea7..e5d0116dd564708 100644 --- a/files/en-us/mdn/writing_guidelines/howto/tag/index.md +++ b/files/en-us/mdn/writing_guidelines/howto/tag/index.md @@ -12,7 +12,7 @@ tags: Please use tags properly as explained below. If you don't, our automated tools will not correctly generate lists of content, landing pages, and cross-linking of articles. -> **Warning:** Note to translators and localizers: You should *not* translate any tags listed on this page. They are used for specific purposes such as certain site management tasks and automated data processing, and translating them would break these processes. +> **Warning:** Note to translators and localizers: You should _not_ translate any tags listed on this page. They are used for specific purposes such as certain site management tasks and automated data processing, and translating them would break these processes. Tags used on MDN Web Docs can be classified into the following categories based on what the tags are used for or the information they convey: diff --git a/files/en-us/mdn/writing_guidelines/index.md b/files/en-us/mdn/writing_guidelines/index.md index 56cbe511f46ee8a..aa38c49978c5314 100644 --- a/files/en-us/mdn/writing_guidelines/index.md +++ b/files/en-us/mdn/writing_guidelines/index.md @@ -8,7 +8,7 @@ tags: --- {{MDNSidebar}} -MDN Web Docs is an open-source project. The sections outlined below describe our guidelines for *what* we document and *how* we do it on MDN Web Docs. To learn about _how to contribute_, see our [contribution guidelines](/en-US/docs/MDN/Community). +MDN Web Docs is an open-source project. The sections outlined below describe our guidelines for _what_ we document and _how_ we do it on MDN Web Docs. To learn about _how to contribute_, see our [contribution guidelines](/en-US/docs/MDN/Community). - [What we write](/en-US/docs/MDN/Writing_guidelines/What_we_write) diff --git a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_property_subpage_template/index.md b/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_property_subpage_template/index.md index 4fa4cc7274f0f53..1f02c1c6bbc2b9c 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_property_subpage_template/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_property_subpage_template/index.md @@ -38,7 +38,7 @@ browser-compat: path.to.feature.NameOfTheProperty > - **title** > - : Title heading displayed at top of page. > Format as _NameOfTheParentInterface_**.**_NameOfTheProperty_. -> For example, the [capabilities](/en-US/docs/Web/API/VRDisplay/capabilities) property of the [VRDisplay](/en-US/docs/Web/API/VRDisplay) interface has a *title* of *VRDisplay.capabilities*. +> For example, the [`capabilities`](/en-US/docs/Web/API/VRDisplay/capabilities) property of the [`VRDisplay`](/en-US/docs/Web/API/VRDisplay) interface has a `title` of `VRDisplay.capabilities`. > - **slug** > - : The end of the URL path after `https://developer.mozilla.org/en-US/docs/`). > This will be formatted like `Web/API/NameOfTheParentInterface/NameOfTheProperty`. diff --git a/files/en-us/mdn/writing_guidelines/page_structures/page_types/aria_page_template/index.md b/files/en-us/mdn/writing_guidelines/page_structures/page_types/aria_page_template/index.md index bdafc26ece24856..7dcda29b157e8a9 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/page_types/aria_page_template/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/page_types/aria_page_template/index.md @@ -12,7 +12,7 @@ tags: ### Title and slug -An ARIA role page should have a _title_ and _slug_ of *ARIA:Name*Of*TheRole*. For example, the [button role](/en-US/docs/Web/Accessibility/ARIA/Roles/button_role) has a _title_ and _slug_ of _ARIA/NameOfTheRole_role_ and the [aria-labelledby](/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-labelledby) attribute has a title of _ARIA-labelledby Attribute._ +An ARIA role page should have a `title` and `slug` of `ARIA: Name Of The Role`. For example, the [button role](/en-US/docs/Web/Accessibility/ARIA/Roles/button_role) has a `title` and `slug` of `ARIA/NameOfTheRole_role` and the [aria-labelledby](/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-labelledby) attribute has a `title` of `aria-labelledby`. ### Top macros diff --git a/files/en-us/mozilla/add-ons/webextensions/chrome_incompatibilities/index.md b/files/en-us/mozilla/add-ons/webextensions/chrome_incompatibilities/index.md index 49e217b0f6075c7..a14df6aaa0a373c 100644 --- a/files/en-us/mozilla/add-ons/webextensions/chrome_incompatibilities/index.md +++ b/files/en-us/mozilla/add-ons/webextensions/chrome_incompatibilities/index.md @@ -78,7 +78,7 @@ The rest of this page summarizes these and other incompatibilities. ); ``` -### Firefox supports both the *chrome* and *browser* namespaces +### Firefox supports both the chrome and browser namespaces As a porting aid, the Firefox implementation of WebExtensions supports `chrome`, using callbacks, as well as `browser`, using promises. This means that many Chrome extensions will just work in Firefox without any changes. diff --git a/files/en-us/web/accessibility/aria/roles/columnheader_role/index.md b/files/en-us/web/accessibility/aria/roles/columnheader_role/index.md index 87d416530626d28..a021ef311843e31 100644 --- a/files/en-us/web/accessibility/aria/roles/columnheader_role/index.md +++ b/files/en-us/web/accessibility/aria/roles/columnheader_role/index.md @@ -18,7 +18,7 @@ The `columnheader` value of the ARIA role attribute identifies an element as bei ## Description -An element with *role="columnheader"* nested as a descendant for an element with *role="row"*, is a static tabular structure of a column header cell in a tabular container, either a table or grid, or other chart that needs to show data relationships. To be supported, the columnheader must be nested in an element with the [role of `row`](/en-US/docs/Web/Accessibility/ARIA/Roles/row_role). +An element with `role="columnheader"` nested as a descendant for an element with `role="row"`, is a static tabular structure of a column header cell in a tabular container, either a table or grid, or other chart that needs to show data relationships. To be supported, the columnheader must be nested in an element with the [role of `row`](/en-US/docs/Web/Accessibility/ARIA/Roles/row_role). ### Associated WAI-ARIA roles, states, and properties diff --git a/files/en-us/web/accessibility/aria/roles/index.md b/files/en-us/web/accessibility/aria/roles/index.md index 3ed19b1c9642a2b..78cc9810d044ae7 100644 --- a/files/en-us/web/accessibility/aria/roles/index.md +++ b/files/en-us/web/accessibility/aria/roles/index.md @@ -10,9 +10,9 @@ tags: --- ARIA roles provide semantic meaning to content, allowing screen readers and other tools to present and support interaction with object in a way that is consistent with user expectations of that type of object. ARIA roles can be used to describe elements that don't natively exist in HTML or exist but don't yet have full browser support. -By default, many semantic elements in HTML have a role; for example, `` has the "radio" role. Non-semantic elements in HTML do not have a role; `
` and `` without added semantics return *null*. The `role` attribute can provide semantics. +By default, many semantic elements in HTML have a role; for example, `` has the "radio" role. Non-semantic elements in HTML do not have a role; `
` and `` without added semantics return `null`. The `role` attribute can provide semantics. -ARIA roles are added to HTML elements using `role="`*role type*`"`, where *role type* is the name of a role in the ARIA specification. Some roles require the inclusion of associated ARIA states or properties; others are only valid in association with other roles. +ARIA roles are added to HTML elements using `role="role type"`, where _role type_ is the name of a role in the ARIA specification. Some roles require the inclusion of associated ARIA states or properties; others are only valid in association with other roles. For example, `
    ` will be announced as a 'tab panel' by screen readers. However, if the tab panel doesn't have nested tabs, the element with the tabpanel role is not in fact a tab panel and accessibility has actually been negatively impacted. diff --git a/files/en-us/web/accessibility/aria/roles/tab_role/index.md b/files/en-us/web/accessibility/aria/roles/tab_role/index.md index a3592a6b3e670ff..f0d8379cfd4e861 100644 --- a/files/en-us/web/accessibility/aria/roles/tab_role/index.md +++ b/files/en-us/web/accessibility/aria/roles/tab_role/index.md @@ -21,7 +21,7 @@ The ARIA `tab` role indicates an interactive element inside a `tablist` that, wh An element with the `tab` role controls the visibility of an associated element with the [`tabpanel`](/en-US/docs/Web/Accessibility/ARIA/Roles/tabpanel_role) role. The common user experience pattern is a group of visual tabs above, or to the side of, a content area, and selecting a different tab changes the content and makes the selected tab more prominent than the other tabs. -Elements with the role `tab` *must* either be a child of an element with the `tablist` role, or have their `id` as part of the [`aria-owns`](/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-owns) property of a `tablist`. This combination identifies to assistive technology that the element is part of a group of related elements. Some assistive technology will provide a count of the number of `tab` role elements inside a `tablist`, and inform users of which `tab` they currently have targeted. Further, an element with the `tab` role *should* contain the [`aria-controls`](/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-controls) property identifying a corresponding `tabpanel` (that has a `tabpanel` role) by that element's `id`. When an element with the `tabpanel` role has focus, or a child of it has focus, that indicates that the connected element with the `tab` role is the active tab in a `tablist`. +Elements with the role `tab` _must_ either be a child of an element with the `tablist` role, or have their `id` as part of the [`aria-owns`](/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-owns) property of a `tablist`. This combination identifies to assistive technology that the element is part of a group of related elements. Some assistive technology will provide a count of the number of `tab` role elements inside a `tablist`, and inform users of which `tab` they currently have targeted. Further, an element with the `tab` role _should_ contain the [`aria-controls`](/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-controls) property identifying a corresponding `tabpanel` (that has a `tabpanel` role) by that element's `id`. When an element with the `tabpanel` role has focus, or a child of it has focus, that indicates that the connected element with the `tab` role is the active tab in a `tablist`. When elements with the `tab` role are selected or active they should have their [`aria-selected`](/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-selected) attribute set to `true`. Otherwise, their `aria-selected` attribute should be set to `false`. When a `tab` is selected or active, its corresponding controlled `tabpanel` should have its [`aria-expanded`](/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-expanded) attribute set to `true` and its `hidden` attribute set to `false`, otherwise the reverse. diff --git a/files/en-us/web/accessibility/mobile_accessibility_checklist/index.md b/files/en-us/web/accessibility/mobile_accessibility_checklist/index.md index cdcbb5faea259ed..a43fedcc0db1199 100644 --- a/files/en-us/web/accessibility/mobile_accessibility_checklist/index.md +++ b/files/en-us/web/accessibility/mobile_accessibility_checklist/index.md @@ -40,7 +40,7 @@ This document provides a concise checklist of accessibility requirements for mob - Text equivalent must be provided for every non-strictly presentational non-text element within the app. - - Use _alt_ and _title_ where appropriate (*s*ee Steve Faulkner's post about [Using the HTML title attribute](https://www.tpgi.com/using-the-html-title-attribute-updated/) for a good guide.) + - Use _alt_ and _title_ where appropriate (read Steve Faulkner's post about [Using the HTML title attribute](https://www.tpgi.com/using-the-html-title-attribute-updated/) for a good guide.) - If the above attributes are not applicable, use appropriate [ARIA States and Properties](https://www.w3.org/TR/wai-aria-1.1/#state_prop_def) such as `aria-label`, `aria-labelledby`, or `aria-describedby`. - Images of text must be avoided. diff --git a/files/en-us/web/accessibility/understanding_colors_and_luminance/index.md b/files/en-us/web/accessibility/understanding_colors_and_luminance/index.md index b84366b32c90a27..b824b13275cf34d 100644 --- a/files/en-us/web/accessibility/understanding_colors_and_luminance/index.md +++ b/files/en-us/web/accessibility/understanding_colors_and_luminance/index.md @@ -101,7 +101,7 @@ In a typical eye exam for acuity (ability to focus), legibility at a particular This is the minimum for "just making out" letters at \~70% accuracy. That is legibility, not readability. For readability, the lower case [x-height](https://kazdesignworks.com/graphic-design-terms-x-height-and-cap-height/) needs to be a minimum of twice that [cap height](https://kazdesignworks.com/graphic-design-terms-x-height-and-cap-height/). This is called the critical font size for readability. -This means that while a 5.5px font may be the minimum for 20/20 legibility, the minimum for *read*ability is 15.6px (in print, about 12pt, the typical standard in books). And this is for normal vision. Someone with 20/40 needs twice that, about a 31px font. This is why the [WCAG standard requires](https://www.w3.org/TR/UNDERSTANDING-WCAG20/visual-audio-contrast-scale.html) that users have the ability to zoom text larger. +This means that while a 5.5px font may be the minimum for 20/20 legibility, the minimum for readability is 15.6px (in print, about 12pt, the typical standard in books). And this is for normal vision. Someone with 20/40 needs twice that, about a 31px font. This is why the [WCAG standard requires](https://www.w3.org/TR/UNDERSTANDING-WCAG20/visual-audio-contrast-scale.html) that users have the ability to zoom text larger. While text that is too small is hard to read, so is text that is too big. Above approximately 96px, reading speed decreases. Also, very large fonts make it difficult for a user to enlarge the smaller text on the page, as most browsers presently zoom all text regardless. diff --git a/files/en-us/web/api/abstractrange/index.md b/files/en-us/web/api/abstractrange/index.md index ceb45a84e2380d9..f3894a0fa06f3e3 100644 --- a/files/en-us/web/api/abstractrange/index.md +++ b/files/en-us/web/api/abstractrange/index.md @@ -135,7 +135,7 @@ The resulting document fragment looks like this: ![A DocumentFragment representing the cloned content](dom-fragment.svg) -Notice especially that the contents of this fragment are all *below* the shared common parent of the topmost nodes within it. The parent `
    ` is not needed to replicate the cloned content, so it isn't included. +Notice especially that the contents of this fragment are all _below_ the shared common parent of the topmost nodes within it. The parent `
    ` is not needed to replicate the cloned content, so it isn't included. ## Example diff --git a/files/en-us/web/api/audioworkletprocessor/process/index.md b/files/en-us/web/api/audioworkletprocessor/process/index.md index 21a324aedff9956..cdbc6c5add62208 100644 --- a/files/en-us/web/api/audioworkletprocessor/process/index.md +++ b/files/en-us/web/api/audioworkletprocessor/process/index.md @@ -35,7 +35,7 @@ invoked to do so. > channels. However, plans are already in place to revise the specification to allow the > size of the audio blocks to be changed depending on circumstances (for example, if the > audio hardware or CPU utilization is more efficient with larger block sizes). -> Therefore, you *must always check the size of the sample array* rather than +> Therefore, you _must always check the size of the sample array_ rather than > assuming a particular size. > > This size may even be allowed to change over time, so you mustn't look at just the diff --git a/files/en-us/web/api/fontface/index.md b/files/en-us/web/api/fontface/index.md index 51274d13ccf9097..21d8eb31ae4119c 100644 --- a/files/en-us/web/api/fontface/index.md +++ b/files/en-us/web/api/fontface/index.md @@ -44,7 +44,7 @@ The **`FontFace`** interface represents a single usable font face. It allows con - {{domxref("FontFace.style")}} - : A string that retrieves or sets the _style_ of the font. It is equivalent to the {{cssxref("@font-face/font-style", "font-style")}} descriptor. - {{domxref("FontFace.unicodeRange")}} - - : A string that retrieves or sets the *range of unicode codepoints* encompassing the font. It is equivalent to the {{cssxref("@font-face/unicode-range", "unicode-range")}} descriptor. + - : A string that retrieves or sets the _range of unicode codepoints_ encompassing the font. It is equivalent to the {{cssxref("@font-face/unicode-range", "unicode-range")}} descriptor. - {{domxref("FontFace.variant")}} - : A string that retrieves or sets the _variant_ of the font. It is equivalent to the {{cssxref("@font-face/font-variant", "font-variant")}} descriptor. - {{domxref("FontFace.variationSettings")}} diff --git a/files/en-us/web/api/gamepad_api/using_the_gamepad_api/index.md b/files/en-us/web/api/gamepad_api/using_the_gamepad_api/index.md index 90959c62952faf7..0c16aca9faa2bda 100644 --- a/files/en-us/web/api/gamepad_api/using_the_gamepad_api/index.md +++ b/files/en-us/web/api/gamepad_api/using_the_gamepad_api/index.md @@ -14,7 +14,7 @@ browser-compat: api.Gamepad HTML provides the necessary components for rich, interactive game development. Technologies like ``, WebGL, `