Skip to content

Commit

Permalink
[WIP] Add ids for the preamble and deprecated id list
Browse files Browse the repository at this point in the history
The SPDX License List FAQ [1] tries to draw attention to the information
written before the tables on the SPDX License List Web page [2]. The FAQ
does this for a reason: “This is based on my observation that many
people seem to view the webpage at https://spdx.org/licenses/ - and just
look at the list (literally) there, skipping over the other information
at the top of the page that explains context, bigger picture, etc.” [3]

At the moment, the FAQ tries to draw attention to those sections in an
awkward and slightly incorrect way [4]. This commit gives those sections
ids so that spdx/license-list-XML#<PR> can add direct links to them.

[1]: <https://github.com/spdx/license-list-XML/blob/main/DOCS/faq.md>
[2]: <https://spdx.org/licenses/>
[3]: <spdx/license-list-XML#1809 (comment)>
[4]: <spdx/license-list-XML#1809 (comment)>

TODO:
• Replace <PR> with the actual spdx/license-list-XML pull request number
  • Loading branch information
Jayman2000 committed Feb 12, 2023
1 parent 1052dfa commit 0b2ea0a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions resources/htmlTemplate/TocHTMLTemplate.html
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ <h1><a href="/" title="Home" rel="home">Software Package Data Exchange (SPDX)</a

<div id="page" class="page">

<h1>SPDX License List</h1>
<h1 id="preamble">SPDX License List</h1>

<p>The SPDX License List is an integral part of the SPDX Specification. The SPDX License List itself is a list of commonly found licenses and exceptions used in free and open or collaborative software, data, hardware, or documentation. The SPDX License List includes a standardized short identifier, the full name, the license text, and a canonical permanent URL for each license and exception.
</p>
Expand Down Expand Up @@ -175,7 +175,7 @@ <h1>SPDX License List</h1>
</table>

<hr />
<h2>Deprecated License Identifiers</h2>
<h2 id="deprecated">Deprecated License Identifiers</h2>
<p>SPDX endeavors to never change the SPDX license identifiers. However, sometimes there has been a compelling reason to deprecate a license identifier, such as to accommodate improved SPDX license expressions or when we have found a duplicate license. When a license identifier is "deprecated" on the SPDX License List, it effectively means that there is an updated license identifier and the deprecated license identifier, while remaining valid, should no longer be used. The URL to each deprecated license is retained and those license pages are updated to note the deprecation. Some reasons for deprecation are as follows:
<ul style="list-style-type: square; padding: 5px;">
<li style="margin:5px 0 5px 10px;">Release 2.0 of the SPDX Specification introduced <strong><a href="https://spdx.org/specifications">License Expressions</a></strong> that supports the ability to identify common variations of SPDX-identified licenses without the need to define each potential variation as a distinct license on the SPDX License List. This new syntax supports the ability to declare an SPDX-identified <a href="./exceptions-index.html"><strong>license exception</strong></a> using the "WITH" operator (e.g. GPL-2.0-or-later WITH Autoconf-exception-2.0), as well as the ability to use a simple "+" operator after a license short identifier to indicate "or later version". SPDX has defined a list of license exceptions to use after the "WITH" operator. As a result, a number of licenses formerly included on the SPDX License List have been deprecated, and correct usage employs the License Expression syntax as of v2.0. </li>
Expand Down

0 comments on commit 0b2ea0a

Please sign in to comment.