Skip to content

Commit 139ee4a

Browse files
committed
Merge branch 'master' into self-hosted
2 parents a5f1ce5 + 499f449 commit 139ee4a

File tree

66 files changed

+592
-604
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+592
-604
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,27 @@ As follows:
88

99
1. Review the [documentation collaboration procedures](https://docs.textpattern.com/brand/user-docs-collaboration). The who, what, when, where, (you know why), and how of it all.
1010
2. Review the [user documentation guidelines](https://docs.textpattern.com/brand/user-docs-guide). These provide near everything you need to know for writing and editing documentation, specifically.
11-
3. Review the [editorial style guide](https://docs.textpattern.com/brand/editorial-style-guide). This is Textpatterns baseline editorial guidelines across all project sites and written material. Here will be high-level rules about orthographical style, spelling, punctuation, brand name usage, and so on. (If you get a 404, the document is still under major revision. Skip to next item and please come back later.)
11+
3. Review the [editorial style guide](https://docs.textpattern.com/brand/editorial-style-guide). This is Textpattern's baseline editorial guidelines across all project sites and written material. Here will be high-level rules about orthographical style, spelling, punctuation, brand name usage, and so on. (If you get a 404, the document is still under major revision. Skip to next item and please come back later.)
1212
4. Continue according to skill level or interest…
1313
* If drafting new pages (and/or editing existing pages): Clone this repository (we assume you know how). If aiming to draft something new, ensure you have already [proposed the page](https://github.com/textpattern/textpattern.github.io/issues/new?assignees=&labels=&template=propose-new-page.md&title=proposed%3A+) and got consensus. And use the [documentation page template](https://docs.textpattern.com/brand/user-docs-page-template) to start easier.
14-
* If editing existing pages only: Clone repository or use GitHubs web interface, explained in next section.
14+
* If editing existing pages only: Clone repository or use GitHub's web interface, explained in next section.
1515

1616
Whether you clone the repository or use the web interface to make changes, a pull request will be initiated and reviewed by repository owners.
1717

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 youre still inclined, contact the assignee(s), if any remain indicated on the issue, and enquire about the documents status. Version control is a wonderful thing, but there is a collaborative editorial workflow in place too. We dont 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.
1919

20-
## Editing via GitHubs web interface
20+
## Editing via GitHub's web interface
2121

22-
If you want to help *edit existing pages*, and have a GitHub account but would rather not fork or clone around, you can work directly via GitHubs web interface.
22+
If you want to help *edit existing pages*, and have a GitHub account but would rather not fork or clone around, you can work directly via GitHub's web interface.
2323

2424
Proceed as follows:
2525

2626
1. See steps 1 through 3 in the list above.
2727
2. Inform collaborators of what you think needs done via an issue, in this way:
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 youre 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.
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.
2929
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.
3030
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). Youll then be in document edit mode.
32-
5. Make your revisions. Ensure youre 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.
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+
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.
3333
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.
3434
7. Check your changes in the front-end of the document to ensure any formatting or styles used were applied correctly.

_includes/atts-global.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ <h3 id="common-global-attributes">Common global attributes</h3>
2525
<dd><strong>Default:</strong> {% if include.class == null %}unset{% else %}{{ include.class }}{% endif %}.</dd>
2626

2727
<dt><code>default="value"</code></dt>
28-
<dd>The value to display if the tags output is blank.</dd>
28+
<dd>The value to display if the tag's output is blank.</dd>
2929
<dd><strong>Values:</strong> Any.</dd>
3030
<dd><strong>Default:</strong> {% if include.default == null %}unset{% else %}{{ include.default }}{% endif %}.</dd>
3131

_includes/index-lists-tags.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
There are standard HTML tags, and there are Textpatterns *super tags!* Feel the power.
1+
There are standard HTML tags, and there are Textpattern's *super tags!* Feel the power.
22

33
<section>
44

_layouts/collection.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939

4040
{{ content }}
4141

42-
<p class="alert-block information footnote report-issues">If you notice any kind of problem with this pages construction or content (outdated information, typos, broken links, or whatever), <a rel="external" target="_blank" href="https://github.com/textpattern/textpattern.github.io/issues/new?assignees=&labels=&template=discuss-existing-page.md&title=page%3A+{{ page.url }}">open an issue</a> to have it sorted. Or <a rel="external" target="_blank" href="https://github.com/textpattern/textpattern.github.io/blob/master/README.md">have a go at it</a> yourself. :)</p>
42+
<p class="alert-block information footnote report-issues">If you notice any kind of problem with this page's construction or content (outdated information, typos, broken links, or whatever), <a rel="external" target="_blank" href="https://github.com/textpattern/textpattern.github.io/issues/new?assignees=&labels=&template=discuss-existing-page.md&title=page%3A+{{ page.url }}">open an issue</a> to have it sorted. Or <a rel="external" target="_blank" href="https://github.com/textpattern/textpattern.github.io/blob/master/README.md">have a go at it</a> yourself. :)</p>
4343
</div>
4444

4545
{% include footer.html %}

_layouts/document.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252

5353
</article>
5454

55-
<p class="alert-block information footnote report-issues">If you notice any kind of problem with this pages construction or content (outdated information, typos, broken links, or whatever), <a rel="external" target="_blank" href="https://github.com/textpattern/textpattern.github.io/issues/new?assignees=&labels=&template=discuss-existing-page.md&title=page%3A+{{ page.url }}">open an issue</a> to have it sorted. Or <a rel="external" target="_blank" href="https://github.com/textpattern/textpattern.github.io/blob/master/README.md">have a go at it</a> yourself. :)</p>
55+
<p class="alert-block information footnote report-issues">If you notice any kind of problem with this page's construction or content (outdated information, typos, broken links, or whatever), <a rel="external" target="_blank" href="https://github.com/textpattern/textpattern.github.io/issues/new?assignees=&labels=&template=discuss-existing-page.md&title=page%3A+{{ page.url }}">open an issue</a> to have it sorted. Or <a rel="external" target="_blank" href="https://github.com/textpattern/textpattern.github.io/blob/master/README.md">have a go at it</a> yourself. :)</p>
5656
</div>
5757

5858
{% include footer.html %}

_layouts/landing.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848

4949
</article>
5050

51-
<p class="alert-block information footnote report-issues">If you notice any kind of problem with this pages construction or content (outdated information, typos, broken links, or whatever), <a rel="external" target="_blank" href="https://github.com/textpattern/textpattern.github.io/issues/new?assignees=&labels=&template=discuss-existing-page.md&title=page%3A+{{ page.url }}">open an issue</a> to have it sorted. Or <a rel="external" target="_blank" href="https://github.com/textpattern/textpattern.github.io/blob/master/README.md">have a go at it</a> yourself. :)</p>
51+
<p class="alert-block information footnote report-issues">If you notice any kind of problem with this page's construction or content (outdated information, typos, broken links, or whatever), <a rel="external" target="_blank" href="https://github.com/textpattern/textpattern.github.io/issues/new?assignees=&labels=&template=discuss-existing-page.md&title=page%3A+{{ page.url }}">open an issue</a> to have it sorted. Or <a rel="external" target="_blank" href="https://github.com/textpattern/textpattern.github.io/blob/master/README.md">have a go at it</a> yourself. :)</p>
5252
</div>
5353

5454
{% include footer.html %}

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

Lines changed: 1 addition & 1 deletion
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/articles-panel.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: The Articles panel shows a list of all your existing articles, toge
88

99
# Articles panel
1010

11-
The Articles panel will show a list of all your existing articles together with basic information (Such as ID, Posted, Title, Author, etc.).
11+
The Articles panel shows a list of all your existing articles with an overview of each article's metadata, including the author, publication time and date, assigned section, and any categories.
1212

1313
On this page:
1414

@@ -18,33 +18,35 @@ On this page:
1818
* [Perform changes on selected articles](#perform-changes-on-selected-articles)
1919
* [Pages and articles listed per page](#pages-and-articles-listed-per-page)
2020

21-
On this panel you can do two things:
21+
On this panel you can do four things:
2222

2323
1. Open an article for editing
24-
2. Perform batch changes on selected articles
24+
2. Perform bulk changes on selected articles
25+
3. Search articles
26+
4. Change the column display options
2527

2628
## Create a new article
2729

2830
This button will take you directly to the [Write panel](/administration/write-panel).
2931

3032
## Search function
3133

32-
Because the article list can get pretty long, a search function is available at the top of the list. You can use the search function to locate an article directly by a search phrase or to filter the view on your articles by particular criteria, thus reducing the number of articles in the resulting list.
34+
Because the article list can get pretty long, a search function is available at the top of the list. You can use the search function to locate an article directly by a search phrase or to filter the view on existing articles by particular criteria, thus reducing the number of articles in the resulting list.
3335

3436
The Search function has two components:
3537

3638
1. A text field for entering the search query
3739
2. A drop-down list to specify which area is to be searched
3840

39-
Query text entered in the textarea will be treated as a *complete phrase* (e.g. "time stamp" will find exactly that. Text containing only "time" or "stamp", "time, stamp" or "timestamp" will not be in the results).
41+
Query text entered in the search box will be treated as a *complete phrase* (e.g. "time stamp" will find exactly that. Text containing only "time" or "stamp", "time, stamp" or "timestamp" will not be in the results).
4042

41-
You don't need to wildcard query text at the beginning or the end (e.g. "time" will find "parttime", "times", "timestamp" as well). But you can use wildcard ? within a query.
43+
You don't need to wildcard query text at the beginning or the end (e.g. "time" will find "parttime", "times", "timestamp" as well). But you can use wildcard '?' within a query.
4244

4345
After entering your search criteria you start searching by selecting the search button. As a result you will be given a new list of articles which meet the criteria.
4446

4547
As a default the search will find matches for all criteria. But you can do more refined searches by selecting another area to search in via the drop-down list toggle button.
4648

47-
**Examples:** You can search (or list) an article by its ID number or date posted. You can list all articles of an author, you even don't need the full author ID. Choose 'Author' and typing "adm" possibly is enough for the admin (provided no other author has "adm" in their ID). You can list all 'Drafts' (choose 'Status' and type "dr").
49+
**Examples:** You can search (or list) an article by its ID number or date posted. You can list all articles of an author, you don't need the full author ID. Choose 'Author' and typing "adm" possibly is enough for the admin (provided no other author has "adm" in their ID). You can list all 'Drafts' (choose 'Status' and type "dr").
4850

4951
## List of articles
5052

@@ -54,7 +56,7 @@ Beneath the search area there is the table, or list, of existing articles. Each
5456

5557
In the first column you will find a checkbox for each article. Here you can select articles you want to change in a bulk manner. You can mark articles by checking the checkbox or you can use the checkbox in the head bar of the list to mark all articles on that page.
5658

57-
In order to quickly select ranges of articles select the checkbox of the first article you want to mark, press and hold the shift key, then select the checkbox of the last article in the range. All articles between will be checked too. You can add ranges to your selection by repeating these steps.
59+
In order to quickly select ranges of articles select the checkbox of the first article you want to mark, press and hold the Shift key, then select the checkbox of the last article in the range. All articles between will be checked too. You can add ranges to your selection by repeating these steps.
5860

5961
For performing changes now you go to the drop-down list 'With selected…' and choose the function you want to perform. After selecting the options you want to perform press 'Go' to start the changes.
6062

administration/comments-panel.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ By default Textpattern will hide comments which are automatically identified and
7474

7575
In the first column you will find a checkbox for each comment. Here you can select comments you want to change in a bulk manner. You can mark comments by checking the checkbox or you can use the checkbox in the head bar of the list to mark all comments on that page.
7676

77-
In order to quickly select ranges of comments select the checkbox of the first comment you want to mark, press and hold the shift key, then select the checkbox of the last comment in the range. All comments between will be checked too. You can add ranges to your selection by repeating these steps.
77+
In order to quickly select ranges of comments select the checkbox of the first comment you want to mark, press and hold the Shift key, then select the checkbox of the last comment in the range. All comments between will be checked too. You can add ranges to your selection by repeating these steps.
7878

7979
For performing changes now you go to the drop-down list 'With selected…' and choose the function you want to perform. After selecting the options you want to perform press 'Go' to start the changes.
8080

administration/diagnostics-panel.md

Lines changed: 1 addition & 1 deletion
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).

0 commit comments

Comments
 (0)