Skip to content

Commit

Permalink
templates/gap-analysis/gap-analysis_template Various improvements, ma…
Browse files Browse the repository at this point in the history 
…inly to front matter
  • Loading branch information
@r12a
r12a committed Jul 10, 2024
1 parent a1273ed commit 379a040
Showing 1 changed file with 34 additions and 30 deletions.
64 changes: 34 additions & 30 deletions templates/gap-analysis/gap-analysis_template.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,39 +71,40 @@

<body>
<div id="abstract">
<p>This document describes and prioritises gaps for the support of XXX on the Web and in eBooks. In particular, it is concerned with text layout. It checks that needed features are supported in W3C specifications, in particular HTML and CSS and those relating to digital publications. It also checks whether the features have been implemented in browsers and ereaders. <strong>This is a preliminary analysis.</strong></p>
<p>This document describes and prioritises gaps for the support of the XX_SCRIPTNAME script on the Web and in eBooks. In particular, it is concerned with text layout. It checks that needed features are supported in W3C specifications, such as HTML and CSS and those relating to digital publications. It also checks whether the features have been implemented in browsers and ereaders.</p>
</div>


<div id="sotd">
<p>This document describes and prioritises gaps for the support of XXX on the Web and in eBooks. In particular, it is concerned with text layout. It checks that needed features are supported in W3C specifications, in particular HTML and CSS and those relating to digital publications. It also checks whether the features have been implemented in browsers and ereaders.
<!-- This document complements the document <a href="https://www.w3.org/TR/xxx-lreq/">XXXX Layout Requirements</a>, which describes the requirements for areas where gaps appear.-->
It is linked to from the <a href="https://w3c.github.io/typography/gap-analysis/language-matrix.html">language matrix</a> that tracks Web support for many languages.</p>
<p>This document is an individual contribution, and is not currently a work item in any group, however, you can contact the <a href="https://www.w3.org/International/core/">Internationalization Working Group</a> for more information. We welcome contributions to this and/or other documents.</p>
<p>This document describes and prioritises gaps for the support of the XX_SCRIPTNAME script on the Web and in eBooks. In particular, it is concerned with text layout. It checks that needed features are supported in W3C specifications, in particular HTML and CSS and those relating to digital publications. It also checks whether the features have been implemented in browsers and ereaders.
It is linked to from the <a href="https://www.w3.org/International/typography/gap-analysis/language-matrix.html">language matrix</a> that tracks Web support for many languages.</p>

<p>The editor's draft of this document is being developed in the GitHub repository <a href="https://w3c.github.io/XX_REPONAME/home">XX_REPOTITLE Language Enablement (XX_ACRONYM)</a>, with contributors from the <abbr title="World Wide Web Consortium">W3C</abbr> <a href="https://www.w3.org/International/i18n-activity/i18n-ig/">Internationalization Interest Group</a>. It is published by the <a href="https://www.w3.org/International/i18n-activity/i18n-wg/">Internationalization Working Group</a>. The end target for this document is a Working Group Note.</p>
</div>





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







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


<section id="contributors">
<h2>Contributors</h2>

<p>The original version of this document was created by Richard Ishida.</p>
<p>The original version of this document was created by XXXX. It was extended by Richard Ishida.</p>
<p>This document was created by Richard Ishida.</p>
<!--
<p>Special thanks to the following people who contributed to this document (contributors' names listed in in alphabetic order).</p>
<p class="acknowledgement">This Person, That Person, etc</p>
<p>The following people contributed information to the gap reports in this document (in alphabetic order): This Person, That Person, etc</p>
-->
<p data-lang="en">Other contributors can be found in the <a href="https://github.com/w3c/XXXX/graphs/contributors">GitHub contributors list</a>.</p>
<p data-lang="en">See also the <a href="https://github.com/w3c/XX_REPONAME/graphs/contributors">GitHub contributors list</a> for the XX_LANGNAME Language Enablement project, and the <a href="https://github.com/w3c/XX_REPONAME/issues?q=is%3Aissue+label%3As%3AXX_SCRIPTTAG">discussions related to the XX_SCRIPTNAME script</a>.</p>
</section>


Expand All @@ -116,11 +117,9 @@ <h2>About this document</h2>

<p>The W3C needs to make sure that the needs of scripts and languages around the world are built in to technologies such as HTML, CSS, SVG, etc. so that Web pages and eBooks can look and behave as people expect around the world.</p>

<p>This page documents difficulties people encounter when trying to use the xxx language with the xxx script on the Web.</p>
<p>This page documents difficulties that people encounter when trying to use languages written in the XX_SCRIPTNAME script on the Web.</p>

<p>Having identified an issue, it investigates the current status with regards to web specifications and implementations by user agents (browsers, e-readers, etc.), and attempts to prioritise the severity of the issue for web users.</p>

<p>A summary of this report and others can be found as part of the <a href="https://w3c.github.io/typography/gap-analysis/language-matrix.html" style="font-size: 140%;">language matrix</a>.</p>
</section>


Expand All @@ -129,20 +128,6 @@ <h2>About this document</h2>



<section id="workflow">
<h3>Work flow</h3>

<p><span style="font-weight:bold; font-size: 140%;">This version of the document is a preliminary analysis</span></p>

<p>Gap analysis work usually starts with a <strong>preliminary analysis</strong>, conducted quickly by one or a small group of experts. Then a more <strong>detailed analysis</strong> is carried out, involving a wider range of experts. The detailed analysis may involve the development of tests, in order to illustrate issues and track results for browsers. The next phase is <strong>ongoing maintenance</strong>. It is expected that the resulting document will not be frozen: as gaps are fixed, this should be noted in the document. It is also possible that new gaps are noticed or arise, and they can be added to this document when that happens.</p>

<!--p>As the gap analysis develops, the requirements for features that are problematic should be described in the companion document, <a href="https://www.w3.org/TR/xxx-lreq/">Xxxx Layout Requirements</a>. Links to the appropriate part of that document should be added to this document as the material is created. Note that the requirements document should not contain any technology-specific information: all of that belongs here.</p-->
</section>





<section id="prioritization">
<h3>Prioritization</h3>

Expand All @@ -166,6 +151,21 @@ <h3>Prioritization</h3>

<p>A cell can be scored as OK if the feature in question is specified in an appropriate specification, and is supported by user agents. A specification that is in CR or later and has two implementations in 'major' browsers will count. This means that the feature may not be supported in all browsers yet. (At some point in the future we may try to distinguish, visually, whether support is available in a specification but still pending in major browsers or applications.) </p>
</section>






<section id="related">
<h2>Related information</h2>

<p>A summary of this report and others can be found as part of the <a href="https://www.w3.org/International/typography/gap-analysis/language-matrix.html" target="_blank">Language Matrix</a>.</p>

<p>Gap reports are brought to the attention of spec and browser implementers, and are tracked via the <a href="https://github.com/orgs/w3c/projects/95" target="_blank">Gap Analysis Pipeline</a>. (<a href="https://github.com/orgs/w3c/projects/95/views/1?filterQuery=label%3A%22s%3AXX_SCRIPTTAG%22" target="_blank">Filter for XX_SCRIPTNAME script items</a>)</p>

<p>See also <a href="https://www.w3.org/TR/XX_SCRIPTTAG-lreq/" target="_blank">XX_SCRIPTNAME Script Resources</a> for information about the XX_SCRIPTNAME script.</p>
</section>
</section>


Expand All @@ -176,6 +176,10 @@ <h3>Prioritization</h3>







<section id="direction">
<h2>Text direction</h2>

Expand Down

0 comments on commit 379a040

Please sign in to comment.