Skip to content

Commit

Permalink
templates/lreq_doc/lreq_template Various improvements, mainly to fron…
Browse files Browse the repository at this point in the history 
…t matter
  • Loading branch information
@r12a
r12a committed Jul 10, 2024
1 parent 6630110 commit a1273ed
Showing 1 changed file with 29 additions and 31 deletions.
60 changes: 29 additions & 31 deletions templates/lreq_doc/lreq_template.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8">

<title>XX_LANGNAME Layout Requirements</title>
<title>XX_SCRIPTNAME Script Resources</title>
<script src="https://www.w3.org/Tools/respec/respec-w3c" class="remove" defer></script>
<script class="remove">
var respecConfig = {
Expand All @@ -27,9 +27,8 @@
],


group: "i18n",

github: "w3c/XX_REPONAME",
group: "i18n",
github: "w3c/XX_REPONAME",


postProcess: [
Expand All @@ -54,13 +53,13 @@

<body>
<div id="abstract">
<p>This document describes or points to requirements for the layout and presentation of text in languages that use the XX_SCRIPTNAME script. The target audience is developers of Web standards and technologies, such as HTML, CSS, Mobile Web, Digital Publications, and Unicode, as well as implementers of web browsers, ebook readers, and other applications that need to render XX_LANGNAME text.</p>
<p>This document points to resources for the layout and presentation of text in languages that use the XX_SCRIPTNAME script. The target audience includes developers of Web standards and technologies, such as HTML, CSS, Mobile Web, Digital Publications, and Unicode, as well as implementers of web browsers, ebook readers, and other applications that need to render XX_SCRIPTNAME text.</p>
</div>

<div id="sotd">
<p>This document describes 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 about how to support users of XX_SCRIPTNAME script languages. Currently the document focuses on the XX_SCRIPTNAME script as used for XX_LANGNAME. The information here is developed in conjunction with a <a href="https://www.w3.org/TR/XX_GAPSHORTNAME/">document that summarises gaps</a> in support on the Web for XX_LANGNAME.</p>
<p>This document points to resources 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 about how to support languages written using the XX_SCRIPTNAME script. The information here is developed in conjunction with a <a href="https://www.w3.org/TR/XX_GAPSHORTNAME/">document that summarises gaps</a> where the Web fails to adequately support the XX_SCRIPTNAME script.</p>

<p>The editor's draft of this document is being developed by the <a href="https://w3c.github.io/mlreq/">XX_TASKFORCENAME Layout Task Force</a>, part of the W3C <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>
<p>The editor's draft of this document is being developed in the GitHub repository <a href="https://w3c.github.io/XX_REPONAME/">XX_TASKFORCENAME (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>

<p>To make it easier to track comments, please raise separate issues or emails for each comment, and point to the section you are commenting on using a URL.</p>
</div>
Expand Down Expand Up @@ -90,11 +89,11 @@ <h2>Introduction</h2>
<section id="h_acknowledgements">
<h3>Contributors</h3>

<p>The initial version of this document was prepared by Richard Ishida.</p>
<p>This document was created by Richard Ishida.</p>

<p>Thanks to the following people who contributed information that is used in this document (contributors' names listed in in alphabetic order): XXXX.</p>
<p>The following people contributed information that was used in preparing this document (in alphabetic order): XXXX.</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%3Aopen+is%3Aissue">discussions related to XX_SCRIPTNAME script</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 @@ -105,11 +104,15 @@ <h3>Contributors</h3>
<section id="h_about_this_document">
<h3>About this document</h3>

<p>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.</p>

<p>The document focuses on typographic layout issues. For a deeper understanding of XX_LANGNAME using the XX_SCRIPTNAME script and how it works see<cite>XX_ORTHOG Orthography Notes</cite>, which includes topics such as: <a href="https://r12a.github.io/scripts/XX_ORTH_DIR/PATH.html#phonology">Phonology</a>, <a href="https://r12a.github.io/scripts/XX_ORTH_DIR/PATH.html#vowels">Vowels</a>, <a href="https://r12a.github.io/scripts/XX_ORTH_DIR/PATH.html#consonants">Consonants</a>, <a href="https://r12a.github.io/scripts/XX_ORTH_DIR/PATH.html#encoding">Encoding choices</a>, and <a href="https://r12a.github.io/scripts/XX_ORTH_DIR/PATH.html#numbers">Numbers</a>.</p>
<p>This document points to resources for XX_SCRIPTNAME script layout and text support on the Web and in eBooks. These resources provide information for developers of Web technologies such as CSS, HTML and digital publications, and for application developers, about how to support languages written using the XX_SCRIPTNAME script. They include requirements, tests, GitHub discussions, type samples, and more,</p>

<p>This document should contain no reference to a particular technology. For example, it should not say &quot;CSS does/doesn't do such and such&quot;, 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.</p>
<p>The document focuses on typographic layout issues. For a deeper understanding of the XX_SCRIPTNAME script and how it works see <cite>XX_ORTHOG Orthography Notes</cite>, which includes topics such as:
<a href="https://r12a.github.io/scripts/XX_ORTH_DIR/PATH.html#phonology">Phonology</a>,
<a href="https://r12a.github.io/scripts/XX_ORTH_DIR/PATH.html#vowels">Vowels</a>,
<a href="https://r12a.github.io/scripts/XX_ORTH_DIR/PATH.html#consonants">Consonants</a>,
<a href="https://r12a.github.io/scripts/XX_ORTH_DIR/PATH.html#encoding">Encoding choices</a>, and
<a href="https://r12a.github.io/scripts/XX_ORTH_DIR/PATH.html#numbers">Numbers</a>.
</p>
</section>


Expand All @@ -120,9 +123,9 @@ <h3>About this document</h3>
<section id="h_gap_analysis">
<h3>Gap analysis</h3>

<p>This document should be used alongside a separate document, <a href="https://www.w3.org/TR/XX_GAPSHORTNAME/"><cite>XX_LANGNAME Gap Analysis</cite></a>, which describes gaps in support for XX_LANGNAME on the Web, and prioritises and describes the impact of those gaps on the user.</p>
<p>This document should be used alongside a separate document, <a href="https://www.w3.org/TR/XX_GAPSHORTNAME/"><cite>XX_SCRIPTNAME Gap Analysis</cite></a>, which describes gaps in language support for users of the XX_SCRIPTNAME script, and prioritises and describes the impact of those gaps on the user.</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%22doc%3Aarab_ks%22" target="_blank">Filter it for Kashmiri</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>
</section>


Expand All @@ -132,13 +135,11 @@ <h3>Gap analysis</h3>


<section id="h_info_requests">
<h3>Other related resources</h3>

<p>To complement any content authored specifically for this document, the sections in the document also point to related, external information, tests, GitHub discussions, etc.</p>
<h3>Related resources</h3>

<p>The document <a href="https://www.w3.org/TR/typography/"><cite>Language enablement index</cite></a> points to this document and others, and provides a central location for developers and implementers to find information related to various scripts.</p>

<p>The <abbr title="World Wide Web Consortium">W3C</abbr> also has a repository with discussion threads related to the XX_SCRIPTNAME script, including requests from developers to the user community for information about how scripts/languages work, and a notification system that tracks issues in <abbr title="World Wide Web Consortium">W3C</abbr> working groups related to the XX_SCRIPTNAME script. See a list of <a target="_blank" href="https://github.com/w3c/XX_REPONAME/issues?q=is%3Aissue+is%3Aopen+label%3Aquestion+">unresolved questions</a> for XX_LANGNAME experts. Each section below points to related discussions. See also the <a href="https://w3c.github.io/XX_REPONAME/home">repository home page</a>.</p>
<p>The <abbr title="World Wide Web Consortium">W3C</abbr> also has a repository with discussion threads related to the XX_SCRIPTNAME script, including requests from developers to the user community for information about how scripts/languages work, and a notification system that tracks issues in <abbr title="World Wide Web Consortium">W3C</abbr> working groups related to the XX_SCRIPTNAME script. See a list of <a target="_blank" href="https://github.com/w3c/XX_REPONAME/issues?q=is%3Aissue+is%3Aopen+label%3Aquestion+">unresolved questions</a> for XX_SCRIPTNAME experts. Each section below points to related discussions. See also the <a href="https://w3c.github.io/XX_REPONAME/home">repository home page</a>.</p>
</section>
</section>

Expand Down Expand Up @@ -199,7 +200,7 @@ <h2>XX_SCRIPTNAME Script Overview</h2>
<h2 style="color:red; font-size:150%; background-color: yellow;" id="h_all_topics">All topics</h2>


<aside class="prompts">Links reveal results regardless of topic, for issues, tests, and samples. </aside>
<aside class="prompts">Links reveal all results, regardless of topic, for issues, tests, and samples. </aside>



Expand Down Expand Up @@ -266,6 +267,8 @@ <h2 id="h_text_direction">Text direction</h2>
<section id="h_vertical_text">
<h3>Vertical text</h3>

<aside class="prompts">Are the script requirements for vertically oriented text met? What about if you mix vertical text with scripts that are normally only horizontal? Do you need a switch to use different characters in vertical vs. horizontal text? Does the browser support short runs of horizontal text in vertical lines (tate-chu-yoko in Japanese) as expected? Is the orientation of characters and the directional ordering of characters supported as needed?</aside>


<dl class="reslinks">
<dt>Requirements</dt>
Expand Down Expand Up @@ -333,6 +336,8 @@ <h3>Vertical text</h3>
<section id="h_bidi_text">
<h3>Bidirectional text</h3>

<aside class="prompts">If this script runs right-to-left, are there any issues when handling that? Is bidirectional text adequately supported? What about numbers and expressions? Do the Unicode bidi controls and HTML markup provide the support needed? Is isolation of directional runs problematic?</aside>


<dl class="reslinks">
<dt>Requirements</dt>
Expand Down Expand Up @@ -566,6 +571,9 @@ <h3>Context-based shaping &amp; positioning</h3>
<section class="h_cursive">
<h3>Cursive text</h3>

<aside class="prompts">If this script is cursive (eg. Arabic, N’Ko, Syriac, etc), are there problems or needed features related to the handling of cursive text? Do cursive links break if parts of a word are marked up or styled? Do Unicode joiner and non-joiner characters behave as expected?</aside>


<dl class="reslinks">
<dt>Requirements</dt>
<dd>
Expand Down Expand Up @@ -939,14 +947,6 @@ <h3>Grapheme/word segmentation &amp; selection</h3>
<section id="h_characters_and_phrases">
<h2>Punctuation &amp; inline features</h2>

<aside class="prompts">This section describes typographic features related to word boundaries, phrase &amp; section boundaries, bracketed text, quotations &amp; citations, emphasis, abbreviation, ellipsis &amp; repetition, inline notes &amp; annotations, other punctuation, and other inline text decoration.</aside>









<section id="h_phrase">
Expand Down Expand Up @@ -1458,8 +1458,6 @@ <h3>Data formats &amp; numbers</h3>
<h2>Line &amp; paragraph layout</h2>


<aside class="prompts">This section describes typographic features related to line breaking &amp; hyphenation, text alignment &amp; justification, text spacing, baselines, line height, counters, lists, and styling initials.</aside>

<section id="h_line_breaking">
<h3>Line breaking &amp; hyphenation</h3>

Expand Down

0 comments on commit a1273ed

Please sign in to comment.