You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ As follows:
15
15
16
16
Whether you clone the repository or use the web interface to make changes, a pull request will be initiated and reviewed by repository owners.
17
17
18
-
**Important!** Before making any changes to documentation pages, look at the [open issues](https://github.com/textpattern/textpattern.github.io/issues) list to see if anyone else is already assigned on the page *and* the issue appears with a ‘drafting’ or ‘editing’ [label](https://github.com/textpattern/textpattern.github.io/labels) on it, or any other label that suggest someone is actively focused on the document. If so, do not touch those pages until such labels are removed. At that point, if you’re still inclined, contact the assignee(s), if any remain indicated on the issue, and enquire about the document’s status. Version control is a wonderful thing, but there is a collaborative editorial workflow in place too. We don’t want to make roll-backs unnecessarily.
18
+
**Important!** Before making any changes to documentation pages, look at the [open issues](https://github.com/textpattern/textpattern.github.io/issues) list to see if anyone else is already assigned on the page *and* the issue appears with a 'drafting’ or 'editing’ [label](https://github.com/textpattern/textpattern.github.io/labels) on it, or any other label that suggest someone is actively focused on the document. If so, do not touch those pages until such labels are removed. At that point, if you’re still inclined, contact the assignee(s), if any remain indicated on the issue, and enquire about the document’s status. Version control is a wonderful thing, but there is a collaborative editorial workflow in place too. We don’t want to make roll-backs unnecessarily.
19
19
20
20
## Editing via GitHub’s web interface
21
21
@@ -28,7 +28,7 @@ Proceed as follows:
28
28
1. Search [all issues](https://github.com/textpattern/textpattern.github.io/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aall) (both open and closed) to see if an issue already exists for the page you’re concerned about (subject pattern is `page: {title of page}`). If it does exist, use that issue to discuss the objective, re-opening it if necessary.
29
29
2. If no issue already exists for the page, open a new issue using the [Propose new page](https://github.com/textpattern/textpattern.github.io/issues/new?assignees=&labels=&template=propose-new-page.md&title=proposed%3A+) template. This will be the dedicated issue for the page going forward.
30
30
3. When clear how to best make revisions, via issue discussion, go to the page in the documentation tree, likely organized in one of the following subdirectories: [*administration*](https://github.com/textpattern/textpattern.github.io/tree/master/administration), [*development*](https://github.com/textpattern/textpattern.github.io/tree/master/development), [*faqs*](https://github.com/textpattern/textpattern.github.io/tree/master/faqs), [*tags*](https://github.com/textpattern/textpattern.github.io/tree/master/tags), or [*themes*](https://github.com/textpattern/textpattern.github.io/tree/master/themes). (The [*brand*](https://github.com/textpattern/textpattern.github.io/tree/master/brand) directory is for editors only.)
31
-
4. Click the pencil icon at top-right of the document (the hover text will read, ‘Edit this file’). You’ll then be in document edit mode.
31
+
4. Click the pencil icon at top-right of the document (the hover text will read, 'Edit this file’). You’ll then be in document edit mode.
32
32
5. Make your revisions. Ensure you’re following conventions for [strings formatting](https://docs.textpattern.com/brand/user-docs-guide#formatting-interface-strings) and [marking up pre-defined content](https://docs.textpattern.com/brand/user-docs-guide#markup-and-styling) elements.
33
33
6. Hit the **Commit changes** button when finished. This will initiate a pull request. The request will be reviewed (and likely merged) by a repository owner.
34
34
7. Check your changes in the front-end of the document to ensure any formatting or styles used were applied correctly.
Copy file name to clipboardExpand all lines: administration/preferences-panel.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ Site preferences are global settings for your Textpattern site. They include set
21
21
22
22
### Site name
23
23
24
-
**Site name** is the title of your website. By default, Textpattern fills this field with ‘My Site’, though it can be changed to your preference.
24
+
**Site name** is the title of your website. By default, Textpattern fills this field with 'My Site’, though it can be changed to your preference.
25
25
26
26
A travel-centric website, for example, might be:
27
27
@@ -37,12 +37,12 @@ Brewster's Java Joint
37
37
38
38
**Site URL** is the homepage address where your Textpattern site is viewed. This should be set to your domain or hostname without the <i>http(s)://</i> protocol and without the trailing forward slash (<i>/</i>).
39
39
40
-
If you use ‘<i>www</i>’, then use this pattern:
40
+
If you use '<i>www</i>’, then use this pattern:
41
41
42
42
www.example.com
43
43
{:.example}
44
44
45
-
If you enforce dropping the ‘<i>www</i>’ by way of a rewrite rule, use this pattern:
45
+
If you enforce dropping the '<i>www</i>’ by way of a rewrite rule, use this pattern:
46
46
47
47
example.com
48
48
{:.example}
@@ -70,15 +70,15 @@ Use plain text only (i.e. no markup), as it is HTML-escaped before output.
70
70
71
71
The **Production status** choice defines the level of error reporting and diagnostic information provided by Textpattern. There are three options:
72
72
73
-
‘Live’ is best suited for production (live) websites and uses fewest server resources. In 'Live' mode, no errors or diagnostics will be displayed to your visitors.
73
+
'Live’ is best suited for production (live) websites and uses fewest server resources. In 'Live' mode, no errors or diagnostics will be displayed to your visitors.
74
74
75
-
‘Testing’ is best suited for the initial setup and design of a stable release of Textpattern. Any PHP errors and selected Textpattern warnings will be displayed on public pages. Browser caching is disabled. Performance information will be included in HTML comments at the end of every Textpattern page, including:
75
+
'Testing’ is best suited for the initial setup and design of a stable release of Textpattern. Any PHP errors and selected Textpattern warnings will be displayed on public pages. Browser caching is disabled. Performance information will be included in HTML comments at the end of every Textpattern page, including:
76
76
77
77
* the time it took the server to build the page ("Runtime")
78
78
* the number of database queries executed
79
79
* approximate peak memory usage
80
80
81
-
‘Debugging’ is best suited for diagnosing problems in Textpattern pages, forms, plugins and PHP code. PHP notices will be displayed, in addition to the errors and warnings shown in 'Testing' mode. Browser caching is disabled. Performance information will be included in HTML comments at the end of every Textpattern page, including:
81
+
'Debugging’ is best suited for diagnosing problems in Textpattern pages, forms, plugins and PHP code. PHP notices will be displayed, in addition to the errors and warnings shown in 'Testing' mode. Browser caching is disabled. Performance information will be included in HTML comments at the end of every Textpattern page, including:
82
82
83
83
* the time it took the server to build the page ("Runtime")
84
84
* the number of database queries executed
@@ -125,19 +125,19 @@ Select which HTML [doctype](https://www.w3.org/wiki/Doctypes_and_markup_styles)
125
125
126
126
The Logging preference allows you to select what kinds of visiting activity Textpattern should record when such activity occurs. The recorded information is displayed in the [Visitor logs panel](/administration/visitor-logs-panel) for you to review. The selection menu has three options.
127
127
128
-
Select ‘None’ if you don’t want Textpattern to log visitor information at all. This is the default selection. When ‘None’ is selected, all logging functionality throughout the back end will be hidden in the interface and the **Visitor logs** panel link will be removed from the list of panel options in the Admin region. This helps keep unwanted functionality from being a distraction. The logging functionality all comes back again if the preference is changed to ‘Yes’.
128
+
Select 'None’ if you don’t want Textpattern to log visitor information at all. This is the default selection. When 'None’ is selected, all logging functionality throughout the back end will be hidden in the interface and the **Visitor logs** panel link will be removed from the list of panel options in the Admin region. This helps keep unwanted functionality from being a distraction. The logging functionality all comes back again if the preference is changed to 'Yes’.
129
129
130
-
Select ‘All hits’ if you want the logger to collect information for all site visits.
130
+
Select 'All hits’ if you want the logger to collect information for all site visits.
131
131
132
-
Select ‘Referrers only’ if you only want to log information about visitors from another location. This option allows you to see what kind of traffic your site is getting, while at the same time eliminating any log entries that might result from your own access to the site (e.g. while making any site updates; generally you do not need to see your own activity on your site).
132
+
Select 'Referrers only’ if you only want to log information about visitors from another location. This option allows you to see what kind of traffic your site is getting, while at the same time eliminating any log entries that might result from your own access to the site (e.g. while making any site updates; generally you do not need to see your own activity on your site).
133
133
134
134
### Logs expire after how many days?
135
135
136
136
When you are using Textpattern for logging (see above), you can set how long (in days) those logs should be kept. '7' will keep the logs available for seven days.
137
137
138
138
### Accept comments?
139
139
140
-
This is a global setting for whether or not you want to allow your articles to accept comments. When set to ‘No’, all comments functionality throughout the administration side will be hidden from view in the interface, and the Comments panel link will be removed from the list of panel options in the Content region. This helps keep unwanted functionality from being a distraction. The comments functionality all comes back again if the preference is changed to ‘Yes’.
140
+
This is a global setting for whether or not you want to allow your articles to accept comments. When set to 'No’, all comments functionality throughout the administration side will be hidden from view in the interface, and the Comments panel link will be removed from the list of panel options in the Content region. This helps keep unwanted functionality from being a distraction. The comments functionality all comes back again if the preference is changed to 'Yes’.
141
141
142
142
## Admin preferences
143
143
@@ -217,11 +217,11 @@ This preference setting does not affect the status or articles created or edited
217
217
218
218
Setting this preference to 'Yes' will ensure that long article titles lines never have only the last word on a new line. Instead, the two last words will appear on a new line.
219
219
220
-
This setting can prove problematic in responsive pages at smaller page widths, because the non-breaking space character between the last two words may cause titles to overspill their parent container. In that case, set this preference to ‘No’.
220
+
This setting can prove problematic in responsive pages at smaller page widths, because the non-breaking space character between the last two words may cause titles to overspill their parent container. In that case, set this preference to 'No’.
221
221
222
222
### Use excerpts on articles?
223
223
224
-
By choosing ‘No’ the excerpt field will not be shown to authors on the [Write panel](/administration/write-panel#excerpt).
224
+
By choosing 'No’ the excerpt field will not be shown to authors on the [Write panel](/administration/write-panel#excerpt).
Copy file name to clipboardExpand all lines: brand/author-prefixes-and-registration.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ description: Anyone in the community wanting to build and share themes and/or pl
8
8
9
9
# Author prefixes and registration
10
10
11
-
Anyone in the Textpattern community who wants to build and share themes and/or plugins must register and use an ‘author’ prefix. A prefix is a three-character (alphanumeric) indication of who the author is, and precedes a theme or plugin name as an assurance that no two themes or plugins will have the same Name value and trip up the software.
11
+
Anyone in the Textpattern community who wants to build and share themes and/or plugins must register and use an 'author’ prefix. A prefix is a three-character (alphanumeric) indication of who the author is, and precedes a theme or plugin name as an assurance that no two themes or plugins will have the same Name value and trip up the software.
12
12
13
13
**Contents**
14
14
@@ -23,7 +23,7 @@ Guidelines, courtesies, and points of fact about choosing and registering an aut
23
23
24
24
**You must have a [Textpattern community forum](https://forum.textpattern.com/) account**. Provide the link to your forum profile when registering a prefix.
25
25
26
-
**You can only have one prefix.***One*. (You may see two or three people in the lists having multiple prefixes. Ignore it. Housecleaning is coming eventually.) In other cases, an author will adopt the themes or plugins of another that has abandoned or ‘retired’ from the community and their products are still considered useful. Adoption means the adopter is willing to maintain the themes or plugins, as appropriate, for community use. This is the preferred, respectful practice against simply changing plugin names.
26
+
**You can only have one prefix.***One*. (You may see two or three people in the lists having multiple prefixes. Ignore it. Housecleaning is coming eventually.) In other cases, an author will adopt the themes or plugins of another that has abandoned or 'retired’ from the community and their products are still considered useful. Adoption means the adopter is willing to maintain the themes or plugins, as appropriate, for community use. This is the preferred, respectful practice against simply changing plugin names.
27
27
28
28
**Your prefix should be three alphanumeric characters.** Not less and not more. (Ignore any you see in the lists that defy this convention.)
29
29
@@ -57,7 +57,7 @@ Owners are identified by their Textpattern community forum usernames. Usernames
57
57
* A **(?)** next to a username means no forum profile is found and the status of the prefix is questionable. If an external link is known, it will be on the '?'. **These prefixes can be challenged for new ownership.**
58
58
* A **(!)** next to a username means the indicated author has adopted all the original authors’ abandoned/orphaned themes and/or plugins, whichever the adopter is qualified to maintain.
59
59
* <spanclass="success">Green</span> prefixes mean the author has long since left the community *and* no themes or plugins remain usable or adopted with that prefix anymore. **These prefixes can be claimed by a new author.**
60
-
* <spanclass="error">Red</span> prefixes are off limits until further notice (notably ‘foo’ and ‘dca’).
60
+
* <spanclass="error">Red</span> prefixes are off limits until further notice (notably 'foo’ and 'dca’).
61
61
* <spanclass="warning">Yellow</span> prefixes are used internally by Textpattern and are off limits.
0 commit comments