Skip to content

Commit a5f1ce5

Browse files
committed
Merge branch 'master' into self-hosted
2 parents 6675249 + 9bd69c1 commit a5f1ce5

File tree

5 files changed

+62
-33
lines changed

5 files changed

+62
-33
lines changed

_includes/head.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
<link rel="apple-touch-icon" href="/apple-touch-icon.png">
1111
<link rel="manifest" href="/site.webmanifest">
1212
<meta name="color-scheme" content="dark light">
13-
<meta name="theme-color" content="#ffda44">
13+
<meta name="theme-color" content="#ffffff" media="(prefers-color-scheme: light)">
14+
<meta name="theme-color" content="#363d44" media="(prefers-color-scheme: dark)">
1415
<meta name="application-name" content="Textpattern CMS Documentation">
1516
<script defer src="https://textpattern.com/assets/js/app.js"></script>

administration/diagnostics-panel.md

Lines changed: 54 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -38,81 +38,106 @@ Textpattern version
3838
Last update
3939
: The date/time you last updated your installation.
4040

41+
Site URL
42+
: Your domain name and top-level domain (i.e. `example.com`). Corresponds with 'Site URL' setting in the 'Site' section of the [Preferences panel](/administration/preferences-panel#site-url).
43+
44+
Admin URL
45+
: The Textpattern admin interface URL. This is typically the `/textpattern` directory from the Site URL (i.e. `example.com/textpattern`).
46+
4147
Document root
4248
: The path to the web server's public (document root) directory, specifically.
4349

4450
$path_to_site
45-
: The path to wherever your installation is (e.g. in document root or in a sub-directory thereof).
51+
: The path to wherever your installation is (e.g. in document root or in a subdirectory thereof).
4652

4753
Textpattern path
4854
: The path to your installation's `/textpattern` directory.
4955

5056
Article URL pattern
5157
: The pattern of URL type you set. Corresponds with the 'Article URL pattern' setting in the 'Site' section of the [Preferences panel](/administration/preferences-panel#article-url-pattern).
5258

59+
Production status
60+
: The status of your site: Live, Testing or Debugging.
61+
5362
Temporary directory path
5463
: The path of your `/tmp` directory relative to document root.
5564

56-
Site URL
57-
: Your domain name and top-level domain (i.e. `example.com`). Corresponds with 'Site URL' setting in the 'Site' section of the [Preferences panel](/administration/preferences-panel#site-url).
58-
5965
PHP version
60-
: The version number of your PHP install.</td>
66+
: The version number of your PHP instance.</td>
6167

6268
GD Graphics Library
6369
: The version number of your GD Graphics Library install.
6470

65-
Server TZ
66-
: The server's 'default timezone'; determined by a [specific order of preferences](https://secure.php.net/manual/en/function.date-default-timezone-get.php).
71+
Server time zone
72+
: The server's 'default time zone'; determined by a [specific order of preferences](https://secure.php.net/manual/en/function.date-default-timezone-get.php).
6773

6874
Server local time
6975
: The local date/time of your web server (`yyyy-mm-dd hh:mm:ss`).
7076

71-
Automatically adjust Daylight Saving Time setting?
72-
: Whether Textpattern will adjust DST automatically (`0`=no, `1`=yes). Corresponds with the 'Automatically adjust Daylight Saving Time setting?' setting in the 'Site' section of the [Preferences panel](/administration/preferences-panel#automatically-adjust-daylight-saving-time-setting).
73-
7477
Daylight Savings Time enabled?
7578
: Whether Daylight Savings Time is enabled (`0`=no, `1`=yes). Corresponds with the 'Daylight Savings Time enabled?' setting in the 'Site' section of the [Preferences panel](/administration/preferences-panel#daylight-savings-time-enabled).
7679

77-
Time zone
80+
Automatically adjust Daylight Saving Time setting?
81+
: Whether Textpattern will adjust DST automatically (`0`=no, `1`=yes). Corresponds with the 'Automatically adjust Daylight Saving Time setting?' setting in the 'Site' section of the [Preferences panel](/administration/preferences-panel#automatically-adjust-daylight-saving-time-setting).
82+
83+
Time zone (GMT offset in seconds)
7884
: Your time zone relative to Greenwich Mean Time (GMT). Corresponds with the 'Time zone' setting in the 'Site' section of the [Preferences panel](/administration/preferences-panel#time-zone). The output includes an offset value in parentheses, which helps developers determine if time-specific problems might stem from a wrong or outdated [tz database](https://en.wikipedia.org/wiki/Tz_database).
7985

8086
MySQL
81-
: The version number and build of your MySQL database server.
87+
: The version number and build of your MySQL (or derivative) database server.
88+
89+
Database server time
90+
: The database server time. Note this can be the same as the server local time, or different if the database is located on another host.
91+
92+
Database server time offset
93+
: The time offset between the database server and the server local time.
94+
95+
Database server time zone
96+
: todo:explanation
97+
98+
Database session time zone
99+
: todo:explanation
82100

83101
Locale
84102
: The language and character set you have configured.
85103

86-
Server
104+
Site / Admin language
105+
: Language designations for the front-side and admin-side areas.
106+
107+
Web server
87108
: Your web server type (e.g. Apache, Nginx).
88109

89110
PHP server API
90-
: todo:explanation
111+
: How the web server interfaces with PHP. For Apache servers, this may me `mod_php` or similar. For Nginx, this may be `fpm-fcgi` (PHP-FPM or FastCGI).
112+
113+
PHP SSL version
114+
: The SSL/TLS library used by PHP. Note this may differ from the sytem SSL/TLS library.
91115

92116
RFC 2616 headers
93117
: todo:explanation
94118

95119
Server OS
96120
: The name and version number of the server's operating system.
97121

98-
Active plugins
99-
: A comma-separated list of all plugins (with version numbers) that are installed *and<* turned on.
100-
101122
Admin-side theme
102123
: The name and version number of the active administration side theme. The default is 'Hive'.
103124

104-
The installation and server data is followed by the contents of your `.htaccess` file (from the installation directory). For purposes here we show the [file contents from the current version code](https://github.com/textpattern/textpattern/blob/main/.htaccess) below:
125+
Active plugins
126+
: A comma-separated list of all plugins (with version numbers) that are installed *and<* turned on.
127+
128+
For Apache servers (and derivatives), the installation and server data is followed by the contents of your `.htaccess` file (from the installation directory). For purposes here we show the [file contents from the current version code](https://github.com/textpattern/textpattern/blob/main/.htaccess) below:
105129

106130
~~~ apacheconf
107131
# BEGIN Textpattern
108-
#DirectoryIndex index.php index.html
109132
110-
#Options +FollowSymLinks
111-
#Options -Indexes
112-
#ErrorDocument 403 default
133+
#DirectoryIndex index.php index.html
113134
114135
<IfModule mod_rewrite.c>
115136
RewriteEngine On
137+
138+
# Enable the `FollowSymLinks` option below if it isn't already.
139+
#Options +FollowSymlinks
140+
116141
#RewriteBase /relative/web/path/
117142
118143
RewriteCond %{REQUEST_FILENAME} -f [OR]
@@ -122,20 +147,23 @@ The installation and server data is followed by the contents of your `.htaccess`
122147
RewriteCond %{REQUEST_URI} !=/favicon.ico
123148
RewriteRule ^(.*) index.php
124149
125-
RewriteCond %{HTTP:Authorization} !^$
150+
RewriteCond %{HTTP:Authorization} !^$
126151
RewriteRule .* - [E=REMOTE_USER:%{HTTP:Authorization}]
127152
</IfModule>
128153
129-
#php_value register_globals 0
130-
131154
<IfModule mod_mime.c>
132155
AddType image/svg+xml svg svgz
133156
AddEncoding gzip svgz
134157
</IfModule>
158+
159+
# For additional Apache-compatible web server configuration settings to enhance
160+
# site performance and security, we recommend:
161+
# https://github.com/h5bp/server-configs-apache/blob/master/dist/.htaccess
162+
135163
# END Textpattern
136164
~~~
137165

138-
Over time your `.htaccess` file will change as you add your own `mod_rewrite` rules, or whatever, and the changes will reflect in the diagnostics info display.
166+
Over time your `.htaccess` file may change as you add your own `mod_rewrite` rules, or whatever, and the changes will reflect in the diagnostics info display.
139167

140168
### High info display
141169

development/the-pluggable-ui-function.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ In this section:
123123

124124
`admin_side > footer`
125125
* **When it occurs:** When the theme's footer bar is rendered.
126-
* **What it allows:** Alteration of the footer area of each panel. Theme authors do this by writing a `footer()` function in their theme's PHP file.
126+
* **What it allows:** Alteration of the footer area of each panel. Theme authors do this by writing a `footer()` function in their theme's PHP file.
127127

128128
### UI elements
129129

@@ -372,8 +372,8 @@ In this section:
372372
### Preferences panel
373373

374374
`prefs_ui > gmtoffset`
375-
* **When it occurs:** The timezone selector on the Preferences panel.
376-
* **What it allows:** Addition or alteration of the timezone selector.
375+
* **When it occurs:** The time zone selector on the Preferences panel.
376+
* **What it allows:** Addition or alteration of the time zone selector.
377377
* **Argument \#3:** The HTML of the select input.
378378
* **Argument \#4:** The name of the HTML element being drawn. `timezone_key` in this case.
379379
* **Argument \#5:** The current value of the HTML element being drawn.

installation/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ The zip package will have a folder/file tree matching that in the [Textpattern r
116116

117117
If you intend to use Textpattern to manage the entire website, you'll upload the install package to your web root (i.e. the root of your web domain). For many hosts, the path to the root looks like this: */users/home/{username}/web/public/*, where {username} is your user account name. You would upload the Textpattern package to the `/public` directory (equal to `yourexample.com`).
118118

119-
You may, of course, install it in a sub-directory if you're only using Textpattern to run a blog, for example, as part of a larger site (generally people who do that end up [moving the installation](/installation/moving-textpattern) later).
119+
You may, of course, install it in a subdirectory if you're only using Textpattern to run a blog, for example, as part of a larger site (generally people who do that end up [moving the installation](/installation/moving-textpattern) later).
120120

121121
You will use FTP, or Secure-FTP (SFTP) if your web host requires it, to upload the package to your desired web server location. Two capable clients are WinSCP for Windows and Transmit for Mac.
122122

@@ -136,7 +136,7 @@ You should now be looking at the default installation screen, which shows the Te
136136

137137
Choose the language you want and select the **Submit** button.
138138

139-
[^3]: If you don't see this screen, check your URL path. Should it be `https` or `www.`? Did you install in a sub-directory? Is there a typo?
139+
[^3]: If you don't see this screen, check your URL path. Should it be `https` or `www.`? Did you install in a subdirectory? Is there a typo?
140140

141141
[^4]: You can change the UI language any time after setup in the [Preferences panel](/administration/preferences-panel).
142142

setup/troubleshooting-diagnostics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ GD Graphics Library
185185
: The version number of your GD Graphics Library install.
186186

187187
Server TZ
188-
: The server's 'default timezone'; determined by a [specific order of preferences](https://secure.php.net/manual/en/function.date-default-timezone-get.php).
188+
: The server's 'default time zone'; determined by a [specific order of preferences](https://secure.php.net/manual/en/function.date-default-timezone-get.php).
189189

190190
Server local time
191191
: The local date/time of your web server (`yyyy-mm-dd hh:mm:ss`).

0 commit comments

Comments
 (0)