Skip to content

Commit

Permalink
Fix links in manual of style (#292)
Browse files Browse the repository at this point in the history 
I ran the link checker on the manual of style.

Note that there are still some broken links as some references appear
outdated, but I think those should be addressed in a more in depth
review and refresh of this document.

---------

Co-authored-by: Tantek Çelik <[email protected]>
  • Loading branch information
@vivienlacourba @tantek
vivienlacourba and tantek authored Jan 16, 2025
1 parent 4442afe commit 3f6773b
Showing 1 changed file with 56 additions and 53 deletions.
109 changes: 56 additions & 53 deletions manual-of-style/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,35 @@
<head>
<meta charset="utf-8">
<title>W3C Manual of Style</title>
<script src='https://www.w3.org/Tools/respec/respec-w3c' async class='remove'>
<script src='https://www.w3.org/Tools/respec/respec-w3c.js' async class='remove'>
</script>
<script class='remove'>
var respecConfig = {
specStatus: "base",
editors: [{
<script class='remove'>
var respecConfig = {
specStatus: "base",
editors: [
{
name: "Philippe Le Hegaret",
url: "https://www.w3.org/People/LeHegaret",
},{
},
{
name: "Coralie Mercier",
url: "https://www.w3.org/People/Coralie",
}],
edDraftURI: "https://w3c.github.io/manual-of-style/",
license: 'w3c-software-doc',
github: "https://github.com/w3c/manual-of-style/",
otherLinks: [{
key: 'Mailing list',
data: [{
value: '[email protected]',
href: 'https://lists.w3.org/Archives/Public/spec-prod/'
}]
}],
xref: [ "i18n-glossary" ]
};
}
],
latestVersion: "https://www.w3.org/guide/manual-of-style/",
edDraftURI: null,
license: 'w3c-software-doc',
github: "w3c/guide",
otherLinks: [{
key: 'Mailing list',
data: [{
value: '[email protected]',
href: 'https://lists.w3.org/Archives/Public/spec-prod/'
}]
}],
xref: [ "i18n-glossary" ]
};
</script>

</head>

<body>
Expand All @@ -43,7 +46,7 @@
<section id="sotd">

</section>
<section id="Introduction">
<section id="Introduction">
<h2>Introduction</h2>

<p>Written for editors and authors of W3C technical reports, this
Expand Down Expand Up @@ -85,7 +88,7 @@ <h2>Introduction</h2>
platforms is far more important than using jazzy features. At some
point, what we write becomes history and is preserved on the Web
through the W3C <cite><a href=
"/policies/uri-persistence/">Persistence
"https://www.w3.org/policies/uri-persistence/">Persistence
Policy</a></cite> [<cite><a href=
"#ref-PERSISTENCE">PERSISTENCE</a></cite>].</p>
</section>
Expand Down Expand Up @@ -123,11 +126,11 @@ <h2>Validation</h2>
<h2>Accessibility</h2>

<ul>
<li>Follow the <cite><a href="https://www.w3.org/WAI/intro/wcag.php">Web Content Accessibility Guidelines</a></cite>
<li>Follow the <cite><a href="https://www.w3.org/WAI/standards-guidelines/wcag/">Web Content Accessibility Guidelines</a></cite>
(<abbr>WCAG</abbr>). Can
simpler words express your ideas? Is your text marked up with
structural elements? Are alternatives provided for auditory and visual
content? See also <a href="https://www.w3.org/WAI/eval/Overview.html">evaluation tools</a>.</li>
content? See also <a href="https://www.w3.org/WAI/test-evaluate/">evaluation tools</a>.</li>
</ul>
</section>
<section id="I18n">
Expand All @@ -146,7 +149,7 @@ <h3>Write for a global audience</h3>
<li>Avoid idioms that are U.S.- or English-specific in favor of more neutral language.</li>
<li>Choose examples that reflect a global audience. For example:
<ul>
<li>When creating user stories or other examples that feature people, choose example names that come from different cultures and regions. You can find suggestions <a href="https://www.w3.org/TR/international-specs#personal_name_examples">here</a> in [[INTERNATIONAL-SPECS]].</li>
<li>When creating user stories or other examples that feature people, choose example names that come from different cultures and regions. You can find suggestions <a href="https://www.w3.org/TR/international-specs/#personal_name_examples">here</a> in [[INTERNATIONAL-SPECS]].</li>
<li>Choose more generic terms for field names, such as "postal code" instead of (U.S.-specific) "ZIP code" or "given name" instead of "first name".</li>
</ul>
<li>In general, use [=locale-neutral=] representations of data values, such as dates, numbers, currency values, and so forth.</li>
Expand All @@ -156,7 +159,7 @@ <h3>Write for a global audience</h3>
<li id="Dates">For time and date values, choose an unambiguous representation:
<ul>
<li>For date values that appear in prose, spell out the month (for example, <kbd>6 May 2003</kbd> or <kbd>September 23, 2016</kbd>). All numeric dates such as <kbd translate="no">5/6/03</kbd> or <kbd translate="no">6/5/03</kbd> are ambiguous. Some cultures will read the first example as "June 5" while other cultures will read the second example as that date.</li>
<li>For date values that appear in data, use a format derived from ISO8601, such as those found in [[RFC3339]] or those found in <cite><a href="http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/#date" title="Section 3.2.9 of the XML Schema Datatypes">XML Schema Part 2: Datatypes</a></cite> ([[XMLSchema-2]].</li>
<li>For date values that appear in data, use a format derived from ISO8601, such as those found in [[RFC3339]] or those found in <cite><a href="https://www.w3.org/TR/2004/REC-xmlschema-2-20041028/#date" title="Section 3.2.9 of the XML Schema Datatypes">XML Schema Part 2: Datatypes</a></cite> ([[XMLSchema-2]].</li>
</ul></li>
</ul>
</section>
Expand Down Expand Up @@ -255,10 +258,10 @@ <h3>Translations</h3>

<li>Read the <cite>W3C Intellectual Property <abbr title=
"Frequently Asked Questions list">FAQ</abbr></cite>, <cite><a href=
"/copyright/intellectual-rights/#translate">Can I
"https://www.w3.org/copyright/intellectual-rights/#translate">Can I
translate one of your specifications into another language?</a></cite>
and <cite><a href=
"/copyright/intellectual-rights/#official">Can I
"https://www.w3.org/copyright/intellectual-rights/#official">Can I
create the "official" translation?</a></cite> ([<cite><a href=
"#ref-IPRFAQ">IPRFAQ</a></cite>] sections 5.6 and 5.7).</li>
</ul>
Expand Down Expand Up @@ -294,7 +297,7 @@ <h3>Translations</h3>
<h2>The Parts of a Technical Report</h2>

<p id="Template">As of November 2005, <a href=
"/Guide/pubrules">pubrules</a> [<cite><a href=
"https://www.w3.org/pubrules/doc">pubrules</a> [<cite><a href=
"#ref-PUBRULES">PUBRULES</a></cite>] includes a technical report
template.</p>

Expand Down Expand Up @@ -480,7 +483,7 @@ <h3>Entries on an errata
conformance of documents or software</li>

<li>Any normative corrections; see the section on <a href=
"https://www.w3.org/2023/Process-20231103/#errata">Errata
"https://www.w3.org/policies/process/20231103/#errata">Errata
Management</a> in the <cite>W3C Process Document</cite>
([<cite><a href="#ref-PROCESS">PROCESS</a></cite>] section 6.2.4) for
more information about normative corrections</li>
Expand All @@ -496,7 +499,7 @@ <h2>References</a></h2>
<section id="extractor">
<h3>Bibliography Extractor</h3>

<p>The <a href="http://www.specref.org/">SpecRef</a> tool, an Open-Source, Community-Maintained Database of
<p>The <a href="https://www.specref.org/">SpecRef</a> tool, an Open-Source, Community-Maintained Database of
Web Standards &amp; Related References, contains an exhaustive of references.</p>

<p>The <cite><a href=
Expand Down Expand Up @@ -644,15 +647,15 @@ <h3>References Section</h3>
<h3>Normative and Informative
References</h3>

<p>See <a href="https://www.w3.org/Guide/process/tilt/normative-references.html">Normative References</a> and considerations by the Team.</p>
<p>See <a href="https://www.w3.org/guide/process/tilt/normative-references.html">Normative References</a> and considerations by the Team.</p>

</section>
</section>
<section id="Revisions">
<h2>Revisions</h2>

<p>See the <cite><a href=
"https://www.w3.org/2023/Process-20231103/#rec-modify">W3C Process
"https://www.w3.org/policies/process/20231103/#rec-modify">W3C Process
Document</a></cite> ([<cite><a href="#ref-PROCESS">PROCESS</a></cite>]
section 6.3.11) for instructions on modifying a W3C Recommendation.</p>

Expand Down Expand Up @@ -775,8 +778,8 @@ <h3>Spelling</h3>
W3C's spell checker.</li>

<li>Free dictionaries are also available on the <a title=
"Ispell home page at UCLA" href=
"http://fmg-www.cs.ucla.edu/fmg-members/geoff/ispell.html">Ispell home
"Ispell home page" href=
"https://www.cs.hmc.edu/~geoff/ispell.html">Ispell home
page</a> [<cite><a href="#ref-ISPELL">ISPELL</a></cite>] for UNIX and
the <a title="Excalibur home page at Bucknell" href=
"http://www.eg.bucknell.edu/~excalibr/excalibur.html">Excalibur home
Expand Down Expand Up @@ -910,8 +913,8 @@ <h3>Using Examples</h3>
<li>
<p>Use <abbr title="Cascading Style Sheets">CSS</abbr> with
<code>div</code> elements to mark up examples, as is done in the
<a href="https://www.w3.org/TR/html51/document-metadata.html#example-2ced58ee"
title="Section 4.2. Document metadata">HTML 5.1</a>
<a href="https://html.spec.whatwg.org/multipage/semantics.html#document-metadata"
title="Section 4.2. Document metadata">HTML Living Standard</a>
([<cite><a href="#ref-HTML">HTML</a></cite>], section
4.2):</p>
</li>
Expand All @@ -933,7 +936,7 @@ <h3>Images</h3>
<li>Match image size to markup <code>width</code> and
<code>height</code> (or images will be distorted).</li>

<li>See the <a href="https://www.w3.org/TR/WCAG20-GENERAL/">Web Content Accessibility
<li>See the <a href="https://www.w3.org/TR/WCAG20-TECHS/">Web Content Accessibility
Guidelines Techniques</a> for information about providing alternative
text (<code>alt</code>) and long descriptions (<code>longdesc</code>)
for images. Also, don't forget to spell-check your alternative
Expand Down Expand Up @@ -1014,7 +1017,7 @@ <h3>Large Documents</h3>
<h3>Inclusive terminology</h3>

<p>Following the <a
href="/policies/code-of-conduct/#expected-behavior">W3C Code of Conduct</a>,
href="https://www.w3.org/policies/code-of-conduct/#expected-behavior">W3C Code of Conduct</a>,
<abbr title="World Wide Web Consortium">W3C</abbr> specifications are expected to be
inclusive and facilitate diversity. As such, editors and authors are strongly encouraged
to use a neutral and inclusive language to ensure the best environment possible for the
Expand Down Expand Up @@ -1046,7 +1049,7 @@ <h2>Internet Media Types</h2>

<ul>
<li>For information about defining a new Internet media type (formerly known as <abbr title="Multipurpose Internet Mail Extensions">MIME</abbr> type) in your specification, see <cite><a href=
"http://www.w3.org/2002/06/registering-mediatype">How to Register an Internet Media Type for a W3C Specification</a></cite> [<cite><a href="#ref-REGISTER-1">REGISTER-1</a></cite>].</li>
"https://www.w3.org/2002/06/registering-mediatype">How to Register an Internet Media Type for a W3C Specification</a></cite> [<cite><a href="#ref-REGISTER-1">REGISTER-1</a></cite>].</li>

<li>For information about referring to existing Internet media types (registered or not), see the email message <cite><a href=
"https://lists.w3.org/Archives/Public/www-tag/2006Aug/0012">TAG Position on Use of Unregistered Media Types in W3C Recommendations</a></cite> [<cite><a href="#ref-REGISTER-2">REGISTER-2</a></cite>].</li>
Expand Down Expand Up @@ -1396,9 +1399,9 @@ <h2>References</h2>

<dt id="ref-EDITORS">[EDITORS]</dt>

<dd><a href="https://www.w3.org/Guide/editor/">W3C Editors Home
<dd><a href="https://www.w3.org/guide/editor/">W3C Editors Home
Page</a>, 2024. This list of resources for editors is on-line at
https://www.w3.org/Guide/editor/.</dd>
https://www.w3.org/guide/editor/.</dd>

<dt id="ref-GRM">[GRM]</dt>

Expand All @@ -1424,9 +1427,9 @@ <h2>References</h2>

<dt id="ref-M-W">[M-W]</dt>

<dd><cite><a href="http://www.m-w.com/">Merriam-Webster OnLine:
<dd><cite><a href="https://www.merriam-webster.com/">Merriam-Webster OnLine:
Collegiate Dictionary</a></cite>, 10th Edition. Merriam-Webster,
Incorporated, 2000. This book is on-line at http://www.m-w.com.</dd>
Incorporated, 2000. This book is on-line at https://www.merriam-webster.com/.</dd>

<dt id="ref-MANAGE">[MANAGE]</dt>

Expand All @@ -1452,7 +1455,7 @@ <h2>References</h2>

<dt id="ref-PROCESS">[PROCESS]</dt>

<dd><cite><a href="https://www.w3.org/2023/Process-20231103/">World
<dd><cite><a href="https://www.w3.org/policies/process/20231103/">World
Wide Web Consortium Process Document</a></cite>, Elika J. Etemad / fantasai,
Florian Rivoal, Editors.
W3C, 3 November 2023. The latest version of this document is
Expand All @@ -1468,10 +1471,10 @@ <h2>References</h2>

<dt id="ref-PUBRULES">[PUBRULES]</dt>

<dd><cite><a href="https://www.w3.org/Guide/pubrules">Technical Report
<dd><cite><a href="https://www.w3.org/pubrules/doc">Technical Report
Publication Policy</a></cite>, the W3C Team. W3C,
2000-2017. This document is on-line at
https://www.w3.org/Guide/pubrules.</dd>
2000-2025. This document is on-line at
https://www.w3.org/pubrules/doc.</dd>

<dt id="ref-REF-TITLES">[REF-TITLES]</dt>

Expand All @@ -1496,10 +1499,10 @@ <h2>References</h2>
<dt id="ref-SPEC-PROD">[SPEC-PROD]</dt>

<dd>[email protected]. W3C, 1998-2001. <a href=
"https://www.w3.org/Mail/Lists">Subscribe</a> to this public mailing
list at http://www.w3.org/Mail/Lists and view its <a href=
"https://lists.w3.org/Archives/Public/">Subscribe</a> to this public mailing
list at https://lists.w3.org/Archives/Public/ and view its <a href=
"https://lists.w3.org/Archives/Public/spec-prod/">archive</a> at
https://lists.w3.org/Archives/Public/spec-prod.</dd>
https://lists.w3.org/Archives/Public/spec-prod/.</dd>

<dt id="ref-STYLE-GUIDE">[STYLE-GUIDE]</dt>

Expand Down Expand Up @@ -1566,9 +1569,9 @@ <h3>External Links</h3>
<dt id="ref-ISPELL">[ISPELL]</dt>

<dd><a href=
"http://fmg-www.cs.ucla.edu/fmg-members/geoff/ispell.html">International
"https://www.cs.hmc.edu/~geoff/ispell.html">International
Ispell</a>, G. Kuenning et al. 1971-2001. The Ispell home page is
http://fmg-www.cs.ucla.edu/fmg-members/geoff/ispell.html.</dd>
https://www.cs.hmc.edu/~geoff/ispell.html.</dd>

<dt id="ref-SCHEMA-DATATYPES">[SCHEMA-DATATYPES]</dt>

Expand Down

0 comments on commit 3f6773b

Please sign in to comment.