From 059c825c365ae6f8ae2d7fd42ef5501c2685e369 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Allan=20Nordh=C3=B8y?= Date: Sun, 19 Apr 2020 15:08:01 +0000 Subject: [PATCH 1/4] Glossary reworked Co-Authored-by: William Desportes Signed-off-by: William Desportes --- doc/glossary.rst | 105 ++++++++++++++++++++++++++--------------------- 1 file changed, 58 insertions(+), 47 deletions(-) diff --git a/doc/glossary.rst b/doc/glossary.rst index b225d4d106..02abbb3834 100644 --- a/doc/glossary.rst +++ b/doc/glossary.rst @@ -16,7 +16,7 @@ From Wikipedia, the free encyclopedia Access Control List Blowfish - a keyed, symmetric block cipher, designed in 1993 by Bruce Schneier. + a keyed, symmetric block cipher, designed in 1993 by `Bruce Schneier `_. .. seealso:: @@ -26,14 +26,14 @@ From Wikipedia, the free encyclopedia .. seealso:: bzip2 - a free software/open-source data compression algorithm and program developed by Julian Seward. + a libre software data compression algorithm and program developed by Julian Seward. .. seealso:: CGI Common Gateway Interface is an important World Wide Web technology that enables a client web browser to request data from a program executed on - the Web server. + the web server. .. seealso:: @@ -65,7 +65,7 @@ From Wikipedia, the free encyclopedia DB look at :term:`database` - database + Database an organized collection of data. .. seealso:: @@ -73,13 +73,13 @@ From Wikipedia, the free encyclopedia Engine look at :term:`Storage Engines` - extension + PHP extension a PHP module that extends PHP with additional functionality. .. seealso:: FAQ - Frequently Asked Questions is a list of commonly asked question and there + Frequently Asked Questions is a list of commonly asked question and their answers. .. seealso:: @@ -89,7 +89,7 @@ From Wikipedia, the free encyclopedia .. seealso:: - foreign key + Foreign key a column or group of columns in a database row that points to a key column or group of columns forming a key of another database row in some (usually different) table. @@ -105,14 +105,14 @@ From Wikipedia, the free encyclopedia look at :term:`GD` GZip - gzip is short for GNU zip, a GNU free software file compression program. + GZip is short for GNU zip, a GNU libre software file compression program. .. seealso:: host any machine connected to a computer network, a node that has a hostname. - .. seealso:: + .. seealso:: hostname the unique name by which a network-attached device is known on a network. @@ -120,21 +120,21 @@ From Wikipedia, the free encyclopedia .. seealso:: HTTP - HyperText Transfer Protocol is the primary method used to transfer or + Hypertext Transfer Protocol is the primary method used to transfer or convey information on the World Wide Web. .. seealso:: - https + HTTPS a :term:`HTTP`-connection with additional security measures. - .. seealso:: + .. seealso:: IEC International Electrotechnical Commission IIS - Internet Information Services is a set of Internet-based services for + Internet Information Services is a set of internet-based services for servers using Microsoft Windows. .. seealso:: @@ -142,10 +142,10 @@ From Wikipedia, the free encyclopedia Index a feature that allows quick access to the rows in a table. - .. seealso:: + .. seealso:: IP - Internet Protocol is a data-oriented protocol used by source and + "Internet Protocol" is a data-oriented protocol used by source and destination hosts for communicating data across a packet-switched internetwork. @@ -166,17 +166,20 @@ From Wikipedia, the free encyclopedia ISAPI Internet Server Application Programming Interface is the API of Internet Information Services (IIS). - .. seealso:: + .. seealso:: ISP An Internet service provider is a business or organization that offers users access to the Internet and related services. - .. seealso:: + .. seealso:: ISO International Standards Organization + .. seealso:: `ISO organization website `_ + .. seealso:: + JPEG a most commonly used standard method of lossy compression for photographic images. @@ -189,19 +192,19 @@ From Wikipedia, the free encyclopedia look at :term:`Index` LATEX - a document preparation system for the TEX typesetting program. + a document preparation system for the TeX typesetting program. .. seealso:: Mac - Apple Macintosh is a line of personal computers is designed, developed, manufactured, and marketed by Apple Computer. + Apple Macintosh is a line of personal computers designed, developed, manufactured, and marketed by Apple Inc. - .. seealso:: + .. seealso:: - Mac OS X + macOS the operating system which is included with all currently shipping Apple Macintosh computers in the consumer and professional markets. - .. seealso:: + .. seealso:: mbstring The PHP `mbstring` functions provide support for languages represented by multi-byte character sets, most notably UTF-8. @@ -223,7 +226,7 @@ From Wikipedia, the free encyclopedia .. seealso:: module - some sort of extension for the Apache Webserver. + modular extension for the Apache HTTP Server httpd. .. seealso:: @@ -231,15 +234,18 @@ From Wikipedia, the free encyclopedia an Apache module implementing a Fast CGI interface; PHP can be run as a CGI module, FastCGI, or directly as an Apache module. + .. seealso:: + MySQL a multithreaded, multi-user, SQL (Structured Query Language) Database Management System (DBMS). .. seealso:: - mysqli + MySQLi the improved MySQL client PHP extension. - .. seealso:: + .. seealso:: `PHP manual for MySQL Improved Extension `_ + .. seealso:: mysql the MySQL client PHP extension. @@ -252,30 +258,33 @@ From Wikipedia, the free encyclopedia .. seealso:: OS X - look at :term:`Mac OS X`. + look at :term:`macOS`. - .. seealso:: + .. seealso:: PDF Portable Document Format is a file format developed by Adobe Systems for representing two-dimensional documents in a device-independent and resolution-independent format. - .. seealso:: + .. seealso:: PEAR the PHP Extension and Application Repository. - .. seealso:: + .. seealso:: `PEAR website `_ + .. seealso:: `Wikipedia page for PEAR `_ PCRE - Perl Compatible Regular Expressions is the perl-compatible regular + Perl-Compatible Regular Expressions is the Perl-compatible regular expression functions for PHP .. seealso:: + .. seealso:: `PHP manual for Perl-Compatible Regular Expressions `_ + .. seealso:: PHP - short for "PHP: Hypertext Preprocessor", is an open-source, reflective + short for "PHP: Hypertext Preprocessor", is a libre software, reflective programming language used mainly for developing server-side applications and dynamic web content, and more recently, a broader range of software applications. @@ -285,15 +294,15 @@ From Wikipedia, the free encyclopedia port a connection through which data is sent and received. - .. seealso:: + .. seealso:: primary key A primary key is an index over one or more fields in a table with unique values for every single row in this table. Every table should have - a primary key for easier accessing/identifying data in this table. There + a primary key for easier accessing/identifying data in this table. There can only be one primary key per table and it is named always **PRIMARY**. In fact, a primary key is just an :term:`unique key` with the name - **PRIMARY**. If no primary key is defined MySQL will use first *unique + **PRIMARY**. If no primary key is defined MySQL will use first *unique key* as primary key if there is one. You can create the primary key when creating the table (in phpMyAdmin @@ -335,7 +344,8 @@ From Wikipedia, the free encyclopedia Common table types are InnoDB and MyISAM, though many others exist and may be desirable in some situations. - .. seealso:: + .. seealso:: `MySQL doc chapter about Alternative Storage Engines `_ + .. seealso:: socket a form of inter-process communication. @@ -343,10 +353,10 @@ From Wikipedia, the free encyclopedia .. seealso:: SSL - Secure Sockets Layer is a cryptographic protocol which provides secure - communication on the Internet. + Secure Sockets Layer, (now superseded by TLS) is a cryptographic protocol + which provides secure communication on the Internet. - .. seealso:: + .. seealso:: Stored procedure a subroutine available to applications accessing a relational database system @@ -361,26 +371,27 @@ From Wikipedia, the free encyclopedia table a set of data elements (cells) that is organized, defined and stored as horizontal rows and vertical columns where each item can be uniquely - identified by a label or key or by it's position in relation to other + identified by a label or key or by its position in relation to other items. .. seealso:: tar - a type of archive file format: the Tape ARchive format. + a type of archive file format, from "Tape Archive". - .. seealso:: + .. seealso:: TCP Transmission Control Protocol is one of the core protocols of the Internet protocol suite. - .. seealso:: + .. seealso:: TCPDF PHP library to generate PDF files. .. seealso:: + .. seealso:: trigger a procedural code that is automatically executed in response to certain events on a particular table or view in a database @@ -399,10 +410,10 @@ From Wikipedia, the free encyclopedia .. seealso:: - Webserver - A computer (program) that is responsible for accepting HTTP requests from clients and serving them Web pages. + Web server + A computer (program) that is responsible for accepting HTTP requests from clients and serving them web pages. - .. seealso:: + .. seealso:: XML Extensible Markup Language is a W3C-recommended general-purpose markup @@ -414,9 +425,9 @@ From Wikipedia, the free encyclopedia ZIP a popular data compression and archival format. - .. seealso:: + .. seealso:: Zlib - an open-source, cross-platform data compression library by Jean-loup Gailly and Mark Adler. + a libre software, cross-platform data compression library by `Jean-loup Gailly `_ and `Mark Adler `_. .. seealso:: From bc4b60d3b9b4b3d3c88acb904de5683218eca94d Mon Sep 17 00:00:00 2001 From: William Desportes Date: Fri, 6 Nov 2020 19:34:24 +0100 Subject: [PATCH 2/4] Revert changes around "libre" software wording in the glossary See: #16087 Signed-off-by: William Desportes --- doc/glossary.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/glossary.rst b/doc/glossary.rst index 02abbb3834..ef84021f94 100644 --- a/doc/glossary.rst +++ b/doc/glossary.rst @@ -26,7 +26,7 @@ From Wikipedia, the free encyclopedia .. seealso:: bzip2 - a libre software data compression algorithm and program developed by Julian Seward. + a free software/open-source data compression algorithm and program developed by Julian Seward. .. seealso:: @@ -105,7 +105,7 @@ From Wikipedia, the free encyclopedia look at :term:`GD` GZip - GZip is short for GNU zip, a GNU libre software file compression program. + GZip is short for GNU zip, a GNU free software file compression program. .. seealso:: @@ -284,7 +284,7 @@ From Wikipedia, the free encyclopedia .. seealso:: PHP - short for "PHP: Hypertext Preprocessor", is a libre software, reflective + short for "PHP: Hypertext Preprocessor", is an open-source, reflective programming language used mainly for developing server-side applications and dynamic web content, and more recently, a broader range of software applications. @@ -428,6 +428,6 @@ From Wikipedia, the free encyclopedia .. seealso:: Zlib - a libre software, cross-platform data compression library by `Jean-loup Gailly `_ and `Mark Adler `_. + an open-source, cross-platform data compression library by `Jean-loup Gailly `_ and `Mark Adler `_. .. seealso:: From 29c7f39a655ae1415abf407ac02b8be307f46daf Mon Sep 17 00:00:00 2001 From: William Desportes Date: Fri, 6 Nov 2020 19:37:53 +0100 Subject: [PATCH 3/4] Fix broken wikipedia link Ref: 059c825c365ae6f8ae2d7fd42ef5501c2685e369 Signed-off-by: William Desportes --- doc/glossary.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/glossary.rst b/doc/glossary.rst index ef84021f94..1760cbb5a2 100644 --- a/doc/glossary.rst +++ b/doc/glossary.rst @@ -273,7 +273,7 @@ From Wikipedia, the free encyclopedia the PHP Extension and Application Repository. .. seealso:: `PEAR website `_ - .. seealso:: `Wikipedia page for PEAR `_ + .. seealso:: `Wikipedia page for PEAR `_ PCRE Perl-Compatible Regular Expressions is the Perl-compatible regular From 93b00f86e18a128b0b44ee162b562c515f3ae6ad Mon Sep 17 00:00:00 2001 From: William Desportes Date: Fri, 6 Nov 2020 19:39:32 +0100 Subject: [PATCH 4/4] Fix broken references to terms Ref: 059c825c365ae6f8ae2d7fd42ef5501c2685e369 Signed-off-by: William Desportes --- doc/config.rst | 2 +- doc/faq.rst | 2 +- doc/setup.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/config.rst b/doc/config.rst index d43f418e36..7bcb33a2bb 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -32,7 +32,7 @@ your site specific code to be included on start and end of each page. .. warning:: :term:`Mac` users should note that if you are on a version before - :term:`Mac OS X`, PHP does not seem to + :term:`macOS`, PHP does not seem to like :term:`Mac` end of lines character (``\r``). So ensure you choose the option that allows to use the \*nix end of line character (``\n``) in your text editor before saving a script you have diff --git a/doc/faq.rst b/doc/faq.rst index 14dba0a332..c178390c6f 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -1311,7 +1311,7 @@ by the recent versions of the most browsers. 5.12 Mac OS X Safari browser changes special characters to "?". --------------------------------------------------------------- -This issue has been reported by a :term:`Mac OS X` user, who adds that Chimera, +This issue has been reported by a :term:`macOS` user, who adds that Chimera, Netscape and Mozilla do not have this problem. .. _faq5_13: diff --git a/doc/setup.rst b/doc/setup.rst index 39c284992c..7405ee36f8 100644 --- a/doc/setup.rst +++ b/doc/setup.rst @@ -11,7 +11,7 @@ page can be used for this. .. warning:: :term:`Mac` users should note that if you are on a version before - :term:`Mac OS X`, StuffIt unstuffs with :term:`Mac` formats. So you'll have + :term:`macOS`, StuffIt unstuffs with :term:`Mac` formats. So you'll have to resave as in BBEdit to Unix style ALL phpMyAdmin scripts before uploading them to your server, as PHP seems not to like :term:`Mac`-style end of lines character ("``\r``").