Skip to content

Add translatable acronym entities #5695

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jordikroon merged 7 commits into from
Jul 23, 2026
+183 −0
Merged

Add translatable acronym entities #5695

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1b382c5
Add acronyms entity file for doc-en
jordikroon Jul 21, 2026
ae14753
style: format acronym entities on single lines
jordikroon Jul 21, 2026
d0e0ebc
Re-order by alphabet
jordikroon Jul 22, 2026
462b3c2
Rename acronym entities file and update naming convention
jordikroon Jul 22, 2026
79cd102
correct and standardize acronym expansion
jordikroon Jul 22, 2026
16ba6e8
migrate acronyms from global.ent
jordikroon Jul 22, 2026
0d15b78
remove unused xlink namespace ref
jordikroon Jul 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
183 changes: 183 additions & 0 deletions entities/entities.acronyms.ent
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,183 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!--

This is a translatable XML Entity file.
See doc-base/scripts/text-entities.php for details.

Everything about acronyms resides in this file, as two kinds of
entities:

- Acronym definitions, entities named after the acronym itself
(for example &php;), which render the term wrapped in an
<acronym> tag;
- Acronym expansions, entities named acronym.expansion.<term>,
where <term> is the exact text used inside <acronym> tags,
holding the expanded meaning of the term.

Besides being collected by text-entities.php like any other
entity file, this file is also read directly, as a plain XML
document, by automated tools:

- PhD loads it to generate the expansion tooltips of <acronym>
tags (see phd/phpdotnet/phd/Package/PHP/XHTML.php);
- doc-base/scripts/qa/check-acronyms.php uses it to report
statistics about defined and used acronyms.

Because of these direct uses, some extra restrictions apply:

- The contents of acronym.expansion.* entities must be plain
text: no child XML elements;
- No entity in this file may contain references to other
entities;
- Entities that are not acronym definitions or expansions do not
belong in this file, and are ignored by the tools above.

Both groups should be listed in alphabetical order.

-->

<entities xmlns = "http://docbook.org/ns/docbook"
translate = "yes">

<!-- Acronym definitions -->

<entity name="api"><acronym>API</acronym></entity>
<entity name="ascii"><acronym>ASCII</acronym></entity>
<entity name="ca"><acronym>CA</acronym></entity>
<entity name="cgi"><acronym>CGI</acronym></entity>
<entity name="cli"><acronym>CLI</acronym></entity>
<entity name="cli.sapi"><acronym>CLI</acronym> <acronym>SAPI</acronym></entity>
<entity name="curl"><acronym>cURL</acronym></entity>
<entity name="der"><acronym>DER</acronym></entity>
<entity name="dns"><acronym>DNS</acronym></entity>
<entity name="dom"><acronym>DOM</acronym></entity>
<entity name="fpm"><acronym>FPM</acronym></entity>
<entity name="ftp"><acronym>FTP</acronym></entity>
<entity name="ftps"><acronym>FTPS</acronym></entity>
<entity name="hmac"><acronym>HMAC</acronym></entity>
<entity name="hsts"><acronym>HSTS</acronym></entity>
<entity name="html"><acronym>HTML</acronym></entity>
<entity name="http"><acronym>HTTP</acronym></entity>
<entity name="https"><acronym>HTTPS</acronym></entity>
<entity name="ip"><acronym>IP</acronym></entity>
<entity name="ipv4"><acronym>IPv4</acronym></entity>
<entity name="ipv6"><acronym>IPv6</acronym></entity>
<entity name="json"><acronym>JSON</acronym></entity>
<entity name="ldap"><acronym>LDAP</acronym></entity>
<entity name="pdo"><acronym>PDO</acronym></entity>
<entity name="pem"><acronym>PEM</acronym></entity>
<entity name="phar"><acronym>Phar</acronym></entity>
<entity name="php"><acronym>PHP</acronym></entity>
<entity name="pop3"><acronym>POP3</acronym></entity>
<entity name="rtsp"><acronym>RTSP</acronym></entity>
<entity name="sapi"><acronym>SAPI</acronym></entity>
<entity name="sftp"><acronym>SFTP</acronym></entity>
<entity name="smtp"><acronym>SMTP</acronym></entity>
<entity name="spl"><acronym>SPL</acronym></entity>
<entity name="ssh"><acronym>SSH</acronym></entity>
<entity name="ssl"><acronym>SSL</acronym></entity>
<entity name="tcp"><acronym>TCP</acronym></entity>
<entity name="tls"><acronym>TLS</acronym></entity>
<entity name="udp"><acronym>UDP</acronym></entity>
<entity name="uri"><acronym>URI</acronym></entity>
<entity name="url"><acronym>URL</acronym></entity>
<entity name="xml"><acronym>XML</acronym></entity>

<!-- Acronym expansions -->

<entity name="acronym.expansion.AKA">Also Known As</entity>
<entity name="acronym.expansion.API">Application Programming Interface</entity>
<entity name="acronym.expansion.ASCII">American Standard Code for Information Interchange</entity>
<entity name="acronym.expansion.BMP">Bitmap</entity>
<entity name="acronym.expansion.CA">Certificate Authority</entity>
<entity name="acronym.expansion.CGI">Common Gateway Interface</entity>
<entity name="acronym.expansion.CLI">Command Line Interpreter/Interface</entity>
<entity name="acronym.expansion.CSPRNG">Cryptographically Secure Pseudorandom Number Generator</entity>
<entity name="acronym.expansion.CSR">Certificate Signing Request</entity>
<entity name="acronym.expansion.CSS">Cascading Style Sheets</entity>
<entity name="acronym.expansion.CSV">Comma-Separated Values</entity>
<entity name="acronym.expansion.cURL">Client URL Library</entity>
<entity name="acronym.expansion.CVS">Concurrent Versions System</entity>
<entity name="acronym.expansion.DER">Distinguished Encoding Rules</entity>
<entity name="acronym.expansion.DLL">Dynamic Link Library</entity>
<entity name="acronym.expansion.DNF">Disjunctive Normal Form</entity>
<entity name="acronym.expansion.DNS">Domain Name System</entity>
<entity name="acronym.expansion.DOM">Document Object Model</entity>
<entity name="acronym.expansion.DSSSL">Document Style Semantics and Specification Language</entity>
<entity name="acronym.expansion.EOF">End Of File</entity>
<entity name="acronym.expansion.EXIF">Exchangeable Image File Format</entity>
<entity name="acronym.expansion.FAQ">Frequently Asked Questions</entity>
<entity name="acronym.expansion.FPM">FastCGI Process Manager</entity>
<entity name="acronym.expansion.FTP">File Transfer Protocol</entity>
<entity name="acronym.expansion.FTPS">File Transfer Protocol SSL/Secure</entity>
<entity name="acronym.expansion.GD">Graphics Draw</entity>
<entity name="acronym.expansion.GIF">Graphics Interchange Format</entity>
<entity name="acronym.expansion.GLE">getLastError</entity>
<entity name="acronym.expansion.GMP">GNU Multiple Precision</entity>
<entity name="acronym.expansion.HIS">Hyperwave Information Server</entity>
<entity name="acronym.expansion.HKDF">HMAC-based Key Derivation Function</entity>
<entity name="acronym.expansion.HMAC">Hash-based Message Authentication Code</entity>
<entity name="acronym.expansion.HSTS">HTTP Strict Transport Security</entity>
<entity name="acronym.expansion.HTML">HyperText Markup Language</entity>
<entity name="acronym.expansion.HTTP">Hypertext Transfer Protocol</entity>
<entity name="acronym.expansion.HTTPS">Hypertext Transfer Protocol Secure</entity>
<entity name="acronym.expansion.IDE">Integrated Development Environment</entity>
<entity name="acronym.expansion.IFD">Image File Directory</entity>
<entity name="acronym.expansion.IFF">Interchange File Format</entity>
<entity name="acronym.expansion.IMAP">Internet Message Access Protocol</entity>
<entity name="acronym.expansion.IP">Internet Protocol</entity>
<entity name="acronym.expansion.IPv4">Internet Protocol version 4</entity>
<entity name="acronym.expansion.IPv6">Internet Protocol version 6</entity>
<entity name="acronym.expansion.JB2">Joint Bi-level Image Experts Group</entity>
<entity name="acronym.expansion.JP2">JPEG-2000</entity>
<entity name="acronym.expansion.JPC">JPEG 2000 Code Stream</entity>
<entity name="acronym.expansion.JPEG">Joint Photographic Experts Group</entity>
<entity name="acronym.expansion.JSON">JavaScript Object Notation</entity>
<entity name="acronym.expansion.LDAP">Lightweight Directory Access Protocol</entity>
<entity name="acronym.expansion.LFS">Large File Support</entity>
<entity name="acronym.expansion.MIME">Multipurpose Internet Mail Extensions</entity>
<entity name="acronym.expansion.MP">Multiple Precision</entity>
<entity name="acronym.expansion.MSDN">Microsoft Developer Network</entity>
<entity name="acronym.expansion.NNTP">Network News Transfer Protocol</entity>
<entity name="acronym.expansion.PBKDF2">Password-Based Key Derivation Function 2</entity>
<entity name="acronym.expansion.PDF">Portable Document Format</entity>
<entity name="acronym.expansion.PDO">PHP Data Objects</entity>
<entity name="acronym.expansion.PECL">PHP Extension Community Library</entity>
<entity name="acronym.expansion.PEM">Privacy-Enhanced Mail</entity>
<entity name="acronym.expansion.Phar">PHP archive</entity>
<entity name="acronym.expansion.PHP">PHP: Hypertext Preprocessor</entity>
<entity name="acronym.expansion.PKCS">Public-Key Cryptography Standards</entity>
<entity name="acronym.expansion.PNG">Portable Network Graphics</entity>
<entity name="acronym.expansion.POP3">Post Office Protocol version 3</entity>
<entity name="acronym.expansion.POSIX">Portable Operating System Interface</entity>
<entity name="acronym.expansion.PSD">Photoshop Document</entity>
<entity name="acronym.expansion.QoS">Quality of Service</entity>
<entity name="acronym.expansion.RGB">Red-Green-Blue</entity>
<entity name="acronym.expansion.RTSP">Real-Time Streaming Protocol</entity>
<entity name="acronym.expansion.SAPI">Server Application Programming Interface</entity>
<entity name="acronym.expansion.SASL">Simple Authentication and Security Layer</entity>
<entity name="acronym.expansion.SFTP">SSH/Secure File Transfer Protocol</entity>
<entity name="acronym.expansion.SMTP">Simple Mail Transfer Protocol</entity>
<entity name="acronym.expansion.SNMP">Simple Network Management Protocol</entity>
<entity name="acronym.expansion.SPL">Standard PHP Library</entity>
<entity name="acronym.expansion.SSH">Secure Shell Protocol</entity>
<entity name="acronym.expansion.SSL">Secure Sockets Layer</entity>
<entity name="acronym.expansion.SWF">Shockwave Flash</entity>
<entity name="acronym.expansion.TCP">Transmission Control Protocol</entity>
<entity name="acronym.expansion.TIFF">Tagged Image File Format</entity>
<entity name="acronym.expansion.TLS">Transport Layer Security</entity>
<entity name="acronym.expansion.TNS">Transparent Network Substrate</entity>
<entity name="acronym.expansion.UDF">User Defined Functions</entity>
<entity name="acronym.expansion.UDP">User Datagram Protocol</entity>
<entity name="acronym.expansion.Unicode">Unique, Universal, and Uniform character encoding</entity>
<entity name="acronym.expansion.URI">Uniform Resource Identifier</entity>
<entity name="acronym.expansion.URL">Uniform Resource Locator</entity>
<entity name="acronym.expansion.WBMP">Wireless Bitmap</entity>
<entity name="acronym.expansion.WSDL">Web Services Description Language</entity>
<entity name="acronym.expansion.XBM">X Bitmap</entity>
<entity name="acronym.expansion.XML">Extensible Markup Language</entity>
<entity name="acronym.expansion.XPath">XML Path Language</entity>
<entity name="acronym.expansion.XSLT">Extensible Stylesheet Language Transformations</entity>

</entities>