Skip to content

Commit 989a687

Browse files
committed
uniformity: ‘administration’ not ‘admin’
see style guide pls thx
1 parent da03226 commit 989a687

28 files changed

+102
-102
lines changed

_recycle/out-of-scope-tutorials/unicode_support.textile

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ h4(#utf-8_support_in_textpattern). UTF-8 support in Textpattern
3636

3737
Textpattern supports UTF-8 as best as is possible under the circumstances (also see the explanation under the _The Quick Guide for the End-User_ section above). What this currently means is when you install Textpattern it will (if you are using MySQL4.1 and above) create the tables in the database as UTF-8 (with the default UTF-8 collation of utf8_general_ci). Textpattern uses MySQL's fulltext indexing to provide its search-functionality, this means if you are using characters outside of the ASCII range your search will likely only function properly with MySQL4.1 and above (but Textpattern will still work with MySQL versions 4.0.x and 3.x in general).
3838

39-
Currently Textpattern tries to be as conservative as possible in the use of PHP's string-functions. So articles are only processed by Textile which only replaces distinct syntax that it recognizes and otherwise leaves the text alone. The i18n-strings that Textpattern uses for the admin-side (and some parts of the public-side) are also in UTF-8 and stay mostly untouched.
39+
Currently Textpattern tries to be as conservative as possible in the use of PHP's string-functions. So articles are only processed by Textile which only replaces distinct syntax that it recognizes and otherwise leaves the text alone. The i18n-strings that Textpattern uses for the administration-side (and some parts of the public-side) are also in UTF-8 and stay mostly untouched.
4040

4141
*Note:* Textpattern does not rely on the mb_strings extension for PHP. Future versions may well take advantage of it where available, but it won't be a requirement.
4242

administration/diagnostics-panel.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Locale
102102
: The language and character set you have configured.
103103

104104
Site / Admin language
105-
: Language designations for the front-side and admin-side areas.
105+
: Language designations for the front-side and administration-side areas.
106106

107107
Web server
108108
: Your web server type (e.g. Apache, Nginx).

administration/extensions-region.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,21 @@ layout: document
33
category: Administration
44
published: true
55
title: Extensions region
6-
description: The extensions administration region appears to the higher user roles if any of the admin-side plugins that employ it are installed.
6+
description: The extensions administration region appears to the higher user roles if any of the administration-side plugins that employ it are installed.
77
---
88

99
# Extensions region
1010

11-
The Extensions administration region is not an out-of-the-box feature. It appears to the higher [user roles](/administration/user-roles-and-privileges) if any of the admin-side plugins that employ it are installed.
11+
The Extensions administration region is not an out-of-the-box feature. It appears to the higher [user roles](/administration/user-roles-and-privileges) if any of the administration-side plugins that employ it are installed.
1212

13-
When relevant, the Extensions administration region will be seen in the administration navigation from all admin-side views *except* when you are in context of the [Plugins panel](/administration/plugins-panel), even for the administrator. This behaviour ensures being able to safely deactivate and/or remove outdated or buggy plugins if they are causing problems. To access the Extensions administration region from the Plugins panel, move to anywhere else in the admin-side first, and the Extensions administration region will appear in the navigation again.
13+
When relevant, the Extensions administration region will be seen in the administration navigation from all administration-side views *except* when you are in context of the [Plugins panel](/administration/plugins-panel), even for the administrator. This behaviour ensures being able to safely deactivate and/or remove outdated or buggy plugins if they are causing problems. To access the Extensions administration region from the Plugins panel, move to anywhere else in the administration-side first, and the Extensions administration region will appear in the navigation again.
1414

1515
When you upload a plugin that uses the Extensions administration region, a new panel option will appear under the region that provides the plugin's associated functionality or configuration controls.
1616

1717
## Unconventional panel placement
1818

1919
The use of the Extensions administration region is a convention adopted by plugin developers to put administration-side plugin preferences and other functional controls in a logical place, and that's a good thing when it can be done.
2020

21-
Not all administration-side plugins use the Extensions administration region, however. Some plugins will add their associated admin-side panel in one of the core regions. This may happen when panel placement is decided with respect to functional context over convention. Another reason may be a concern for having too many plugin panels under the Extensions administration region, though this is likely a moot issue for most Textpattern users.
21+
Not all administration-side plugins use the Extensions administration region, however. Some plugins will add their associated administration-side panel in one of the core regions. This may happen when panel placement is decided with respect to functional context over convention. Another reason may be a concern for having too many plugin panels under the Extensions administration region, though this is likely a moot issue for most Textpattern users.
2222

2323
[Related: Home administration region](/administration/home-region)

administration/home-region.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ layout: document
33
category: Administration
44
published: true
55
title: Home region
6-
description: The Home administration region appears to the higher user roles if any of the admin-side plugins that employ it are installed.
6+
description: The Home administration region appears to the higher user roles if any of the administration-side plugins that employ it are installed.
77
---
88

99
# Home region
1010

11-
The Home administration region is not an out-of-the-box feature. It appears to the higher [user roles](/administration/user-roles-and-privileges) if any of the admin-side plugins that employ it are installed.
11+
The Home administration region is not an out-of-the-box feature. It appears to the higher [user roles](/administration/user-roles-and-privileges) if any of the administration-side plugins that employ it are installed.
1212

13-
When relevant, the Home administration region will be seen in the administration navigation from all admin-side views *except* when you are in context of the [Plugins panel](/administration/plugins-panel) even for the administrator. This behaviour ensures being able to safely deactivate and/or remove outdated or buggy plugins if they are causing problems. To access the Home administration region from the Plugins panel, move to anywhere else in the admin-side first, and the Home administration region will appear in the navigation again
13+
When relevant, the Home administration region will be seen in the administration navigation from all administration-side views *except* when you are in context of the [Plugins panel](/administration/plugins-panel) even for the administrator. This behaviour ensures being able to safely deactivate and/or remove outdated or buggy plugins if they are causing problems. To access the Home administration region from the Plugins panel, move to anywhere else in the administration-side first, and the Home administration region will appear in the navigation again
1414

1515
When you upload a plugin that uses the Home administration region, a new panel option will appear under the region that provides the plugin's associated functionality or configuration controls.
1616

administration/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,6 @@ The [Extensions](/administration/extensions-region) region is one you may see in
165165

166166
## Changing default login panel
167167

168-
The default admin-side landing location changes once you initially set your language preferences. You'll find yourself landing on the [Write](/administration/write-panel) panel from that point on, which is the default panel under the Content region.
168+
The default administration-side landing location changes once you initially set your language preferences. You'll find yourself landing on the [Write](/administration/write-panel) panel from that point on, which is the default panel under the Content region.
169169

170170
You can change the default landing panel to whichever one you want using the **Default panel** preference under the Admin area of the [Preferences](/administration/preferences-panel) panel.

administration/languages-panel.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ On this page:
2222

2323
## Site language
2424

25-
The primary language that the website will be targeted at. You can choose from any of the installed language packs. This is used on the public site and as the default admin-side language for users (unless changed in the 'User language' option - see below).
25+
The primary language that the website will be targeted at. You can choose from any of the installed language packs. This is used on the public site and as the default administration-side language for users (unless changed in the 'User language' option - see below).
2626

2727
## User language
2828

29-
From Textpattern version 4.7 onwards, each user within the admin-side can be choose their specific language for the admin panels. You can choose from any of the installed language packs. This does not affect the 'Site language'.
29+
From Textpattern version 4.7 onwards, each user within the administration-side can be choose their specific language for the admin panels. You can choose from any of the installed language packs. This does not affect the 'Site language'.
3030

3131
## List of available languages
3232

administration/users-panel.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ On this page:
1818
* [Administrator controls](#administrator-controls)
1919
* [User data form](#user-data-form)
2020
* [Extending user account functionality](#extending-user-account-functionality)
21-
* [Admin-side management and data extension](#admin-side-management-and-data-extension)
21+
* [Administration-side management and data extension](#administration-side-management-and-data-extension)
2222
* [Autonomous registration, log in, and data access/submission](#autonomous-registration-log-in-and-data-accesssubmission)
2323

2424
## User accounts table
@@ -61,19 +61,19 @@ It's common for site owners of multi-user sites to extend Textpattern's core fun
6161

6262
There are two convenient contexts for talking about user accounts extension:
6363

64-
1. Admin-side management and data extension
64+
1. Administration-side management and data extension
6565
2. Autonomous (self) registration, log in, and data access/submission
6666

67-
### Admin-side management and data extension
67+
### Administration-side management and data extension
6868

69-
The most popular approach for admin-side extension of user accounts, indeed what should nearly be core functionality, is to install and use two plugins that work together:
69+
The most popular approach for administration-side extension of user accounts, indeed what should nearly be core functionality, is to install and use two plugins that work together:
7070

7171
* [smd_user_manager](https://forum.textpattern.com/viewtopic.php?id=36558) - This plugin provides a much richer set of features for managing user accounts, including modifying the core user roles and privileges.
7272
* [smd_bio](https://forum.textpattern.com/viewtopic.php?id=31496) - This plugin extends the user account data itself, so you can create user bios or profiles having any data structure you want and display that data on the front-side of a website.[^5]
7373

7474
### Autonomous registration, log in, and data access/submission
7575

76-
There are situations (membership communities, employee intranets, magazine article contributions, etc.) where people may not need physical access to the admin-side, but still need user accounts to access specific information, contribute content, or edit their own account details. Various plugins can help with the initial setup of this front-side access, which effectively abstracts the admin-side UI panels away from such users. Depending on what you need or want to do, there are various plugins to try:
76+
There are situations (membership communities, employee intranets, magazine article contributions, etc.) where people may not need physical access to the administration-side, but still need user accounts to access specific information, contribute content, or edit their own account details. Various plugins can help with the initial setup of this front-side access, which effectively abstracts the administration-side UI panels away from such users. Depending on what you need or want to do, there are various plugins to try:
7777

7878
* [cbe_frontauth](https://forum.textpattern.com/viewtopic.php?id=36552) - A plugin that enables front-side log in abilities for *existing* account holders. This plugin is often used in combination with [cbe_members](https://forum.textpattern.com/viewtopic.php?id=37760).
7979
* [mem_self_register](https://forum.textpattern.com/viewtopic.php?id=8520) - A plugin similar to cbe_frontauth, but also enables the ability to register an account too. This plugin is often used in combination with [mem_form](https://forum.textpattern.com/viewtopic.php?id=25247).

administration/write-panel.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: The Write panel reveals the various features for managing articles
1010

1111
<img class="img--bordered" width="680" height="422" alt="Figure 2" src="/img/47x/admin-panel-write.png" srcset="/img/47x/admin-panel-write.png 1x, /img/47x/[email protected] 2x">
1212

13-
The Write panel is the default panel of the administration side of Textpattern; it opens when you log in to the admin-side (see Figure 1). The exceptions are when 1) you log in after a new update of your Textpattern installation, in which case you're initially routed to the [Languages panel](/administration/languages-panel), or 2) if you change the default panel to something else via the preference for it in the **Admin** section of the [Preferences panel](/administration/preferences-panel). (The Languages and Preferences panels are both under the main Admin menu.)
13+
The Write panel is the default panel of the administration side of Textpattern; it opens when you log in to the administration-side (see Figure 1). The exceptions are when 1) you log in after a new update of your Textpattern installation, in which case you're initially routed to the [Languages panel](/administration/languages-panel), or 2) if you change the default panel to something else via the preference for it in the **Admin** section of the [Preferences panel](/administration/preferences-panel). (The Languages and Preferences panels are both under the main Admin menu.)
1414

1515
The Write panel reveals the editing fields for article content, and various controls for managing content display and publication, such as content organization, date and time, associated images, how you want to format your text, and so on.
1616

brand/editorial-guide.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ Avoid using 'admin' as an abbreviation unless you are specifically referring to
221221

222222
* The top-level Admin section, as labeled in the navigation for it. (In the 'Classic' theme, this defaults to the Users panel.)
223223
* The Admin section of the Preferences panel.
224-
* The Admin-side theme preference in the Admin section of the Preferences panel.
224+
* The Administration-side theme preference in the Admin section of the Preferences panel.
225225

226226
Any other use of 'admin' can lead to confusion about what is meant. Whether you mean *administration* or *administrator*, write it out fully every time so the meaning and context is perfectly clear.
227227

@@ -419,23 +419,23 @@ Keep links in body copy to a minimum. Ensure links that are used are focused on
419419

420420
## Terminology
421421

422-
Textpattern terms as admin-side panel and link references
423-
When using the name of any admin-side panel to mean the location of that panel, it should always be a non-italicised link to the given wiki page it's referring to, and the link should only be on the word itself, i.e. the link text should be the same as the name of the wiki page it's pointing to.
422+
Textpattern terms as administration-side panel and link references
423+
When using the name of any administration-side panel to mean the location of that panel, it should always be a non-italicised link to the given wiki page it's referring to, and the link should only be on the word itself, i.e. the link text should be the same as the name of the wiki page it's pointing to.
424424

425425
Correct → Most of your content is created in the Write panel.
426426

427427
Wrong → Most of your content is created in the Write panel.
428428

429429
Wrong → Most of your content is created in the Write panel.
430-
There are two exceptions to the rule in bold above. Wiki pages for the Images and Comments panels are titled "Images (panel)" and "Comments (admin-side)", respectively. These are necessary (though inconsistently named) titles to avoid wiki page title conflicts with Tag pages having the same names. But they are unattractive, so we use custom links to these pages via wiki syntax.
430+
There are two exceptions to the rule in bold above. Wiki pages for the Images and Comments panels are titled "Images (panel)" and "Comments (administration-side)", respectively. These are necessary (though inconsistently named) titles to avoid wiki page title conflicts with Tag pages having the same names. But they are unattractive, so we use custom links to these pages via wiki syntax.
431431

432432
Correct → Photos and other images are uploaded in the Images panel.
433433

434434
Correct → You can edit article comments in the Comments panel.
435435

436436
Wrong → Photos and other images are uploaded in the Images (panel).
437437

438-
Wrong → You can edit article comments in the Comments (admin-side) panel.
438+
Wrong → You can edit article comments in the Comments (administration-side) panel.
439439

440440
Textpattern terms as semantical (non-linked) references
441441
Certain panel names—often considered to be Textpattern's semantical features—have a lot of similarity with general web terms, and thus can be easily confused if not clearly distinguished in documentation. Textpattern terms used in context of semantics, but not linked to panel documentation pages, should be capitalised and italicised.

build/creating-administration-themes.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Delete the _screenshot.png_ file if not needed, or replace it with one you will
6262

6363
**Step 4:**
6464

65-
Log in to the back-end. Go to Admin > Preferences > Admin, look for the **Admin-side theme** preference and select the newly added theme (step 3).
65+
Log in to the back-end. Go to Admin > Preferences > Admin, look for the **Administration-side theme** preference and select the newly added theme (step 3).
6666

6767
**Step 5:**
6868

development/admin-side-events-and-steps.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
layout: document
33
category: Development
44
published: true
5-
title: Admin-side events and steps
6-
description: These are the main events and steps that Textpattern uses as you interact with the admin-side interface.
5+
title: Administration-side events and steps
6+
description: These are the main events and steps that Textpattern uses as you interact with the administration-side interface.
77
---
88

9-
# Admin-side events and steps
9+
# Administration-side events and steps
1010

11-
These are the main events and steps that Textpattern uses as you interact with the admin-side interface. An *event* is usually the panel or plugin name, e.g. `prefs` or `image`. A *step* is Textpattern terminology for an action that occurs on that panel, for example `save` or `image_edit`.
11+
These are the main events and steps that Textpattern uses as you interact with the administration-side interface. An *event* is usually the panel or plugin name, e.g. `prefs` or `image`. A *step* is Textpattern terminology for an action that occurs on that panel, for example `save` or `image_edit`.
1212

1313
Although they are not direct [callbacks](/development/core-callbacks-reference), you may hook into these events and steps from a plugin to perform an action.
1414

0 commit comments

Comments
 (0)