From a811f23efa171fbe332fec93fb217ef0eaf51721 Mon Sep 17 00:00:00 2001 From: r12a Date: Wed, 3 Jul 2024 08:48:48 +0100 Subject: [PATCH] templates for gap & lreq, Improve intro --- .../gap-analysis/gap-analysis_template.html | 34 +++++++++++++------ templates/lreq_doc/lreq_template.html | 26 ++++++-------- 2 files changed, 34 insertions(+), 26 deletions(-) diff --git a/templates/gap-analysis/gap-analysis_template.html b/templates/gap-analysis/gap-analysis_template.html index 9634c24..72b6dca 100644 --- a/templates/gap-analysis/gap-analysis_template.html +++ b/templates/gap-analysis/gap-analysis_template.html @@ -88,29 +88,41 @@

Introduction

-

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.

-

This page documents difficulties people encounter when trying to use the xxx language with the xxx script on the Web.

-

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.

-

A summary of this report and others can be found as part of the language matrix.

+
+

Contributors

+

The original version of this document was created by Richard Ishida.

+

The original version of this document was created by XXXX. It was extended by Richard Ishida.

+ +

Other contributors can be found in the GitHub contributors list.

+
- +
+

About this document

+ +

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.

+ +

This page documents difficulties people encounter when trying to use the xxx language with the xxx script on the Web.

+ +

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.

+ +

A summary of this report and others can be found as part of the language matrix.

+
+ + diff --git a/templates/lreq_doc/lreq_template.html b/templates/lreq_doc/lreq_template.html index 81ca02e..23e49bd 100644 --- a/templates/lreq_doc/lreq_template.html +++ b/templates/lreq_doc/lreq_template.html @@ -90,6 +90,10 @@

Contributors

About this document

The aim of this document is to describe the basic requirements for XX_SCRIPTNAME script layout and text support on the Web and in eBooks. These requirements provide information for Web technologies such as CSS, HTML and digital publications, and for application developers, about how to support users of the XX_SCRIPTNAME script. The document currently focuses on texts using the XX_LANGNAME language.

+ +

The document focuses on typographic layout issues. For a deeper understanding of XX_LANGNAME using the XX_SCRIPTNAME script and how it works seeXX_ORTHOG Orthography Notes, which includes topics such as: Phonology, Vowels, Consonants, Encoding choices, and Numbers.

+ +

This document should contain no reference to a particular technology. For example, it should not say "CSS does/doesn't do such and such", and it should not describe how a technology, such as CSS, should implement the requirements. It is technology agnostic, so that it will be evergreen, and it simply describes how the script works. The gap analysis document is the appropriate place for all kinds of technology-specific information.

@@ -100,13 +104,9 @@

About this document

Gap analysis

-

This document is pointed to by a separate document, XX_LANGNAME Gap Analysis, which describes gaps in support for XX_LANGNAME on the Web, and prioritises and describes the impact of those gaps on the user.

+

This document should be used alongside a separate document, XX_LANGNAME Gap Analysis, which describes gaps in support for XX_LANGNAME on the Web, and prioritises and describes the impact of those gaps on the user.

-

Wherever an unsupported feature is indentified through the gap analysis process, the requirements for that feature need to be documented. The gap reports will typically point back to this document for more information.

- -

As gaps in support for XX_LANGNAME are captured, the gaps can be brought to the attention of the relevant spec developer or the browser implementator community. The progress of such work is tracked in the Gap Analysis Pipeline.

- -

This document should contain no reference to a particular technology. For example, it should not say "CSS does/doesn't do such and such", and it should not describe how a technology, such as CSS, should implement the requirements. It is technology agnostic, so that it will be evergreen, and it simply describes how the script works. The gap analysis document is the appropriate place for all kinds of technology-specific information.

+

Gap reports are brought to the attention of spec and browser implementers, and are tracked via the Gap Analysis Pipeline. (Filter it for Kashmiri)

@@ -524,7 +524,7 @@

Context-based shaping & positioning

Gap analysis
@@ -775,7 +775,7 @@

Characters & encoding

• Encoding choices -
  • Character usage
    • +
  • Character usage: XX_SCRIPTNAME
    • @@ -1312,7 +1312,7 @@

    Text decoration & other inline features

  • All XX_LANGNAME issues on this topic in the XX_REPONAME repo
    • -
  • XX_SPECTYPEISSUE issues on this topic in W3C specs
    • +
  • XX_SPECTYPEISSUE issues on this topic in W3C specs
    • @@ -1332,7 +1332,7 @@

    Text decoration & other inline features

    @@ -2148,11 +2148,7 @@

    Forms & user interaction

    Change log