From 85e1987fd835659684801d141545a2e875120c23 Mon Sep 17 00:00:00 2001
From: Tom Homer
Date: Fri, 24 Nov 2017 12:05:28 -0500
Subject: [PATCH] In Config Docs changed references from Story to Article where
needed
For feature #423
---
public_html/docs/english/config.html | 166 ++++++++++++++-------------
1 file changed, 84 insertions(+), 82 deletions(-)
diff --git a/public_html/docs/english/config.html b/public_html/docs/english/config.html
index 8948b2ff8..88ad3d7e0 100644
--- a/public_html/docs/english/config.html
+++ b/public_html/docs/english/config.html
@@ -35,7 +35,7 @@ Configuration options
- Site
-- Stories and Trackback
+- Articles and Trackback
- Theme
- Blocks
- Users and Submissions
@@ -109,7 +109,7 @@
meta_tags |
disabled |
- Enabled - The meta tags for stories and topics will be displayed. If none are found, then the default will be used. The default will also be used for any page that doesn't have meta tags.
+ | Enabled - The meta tags for articles and topics will be displayed. If none are found, then the default will be used. The default will also be used for any page that doesn't have meta tags.
Enabled (Default for Homepage only) - The same as Enabled except, the defaults are used only for the Homepage.
Disabled - Meta tags are not used. |
@@ -200,16 +200,16 @@
Description |
backend |
1 |
- Create a feed file for the stories in rdf_file (0=no, 1=yes) |
+ Create a feed file for the articles in rdf_file (0=no, 1=yes) |
rdf_file |
HTML path with "/backend/geeklog.rss" suffix |
File system path for the feed file. This file allows you to share your site's headlines with others |
rdf_limit |
10 |
- Limit the number of stories to export to the news feed. If the value for this setting is a number, the feed will hold this many stories. If the number is followed by a lower-case 'h' (e.g. 24h) it denotes the number of hours from which to chose the stories. |
+ Limit the number of articles to export to the news feed. If the value for this setting is a number, the feed will hold this many articles. If the number is followed by a lower-case 'h' (e.g. 24h) it denotes the number of hours from which to chose the articles. |
rdf_storytext |
0 |
- If this value is 1, then the entire introtext of the stories will be included in the news feed. Any number greater than 1 limits the introtext to that many characters (e.g. a value of 80 would only include the first 80 characters from the introtext in the feed). If set to 0, the introtext is not included in the feed. |
+ If this value is 1, then the entire introtext of the articles will be included in the news feed. Any number greater than 1 limits the introtext to that many characters (e.g. a value of 80 would only include the first 80 characters from the introtext in the feed). If set to 0, the introtext is not included in the feed. |
rdf_language |
en-gb |
Value for the feed's language tag. Depending on your site's language and operating system, this may differ from the language setting in the locale (see above). Example: The PHP locale setting for German is 'de_DE' while the correct language setting for a German RSS feed would be 'de-DE' (note the dash instead of the underscore). |
@@ -263,7 +263,7 @@
path_images |
/path/to/geeklog/public_html/images/ |
Path where Geeklog expects to find its images, including
- user photos and images for stories. |
+ user photos and images for articles.
path_editors |
/path/to/geeklog/public_html/editors/ |
Path where all WYSIWYG editors reside. |
@@ -346,9 +346,9 @@
If true the last topic the user visited will be set on the advanced search page and used automatically in the search block. If false, "All" topics will be set when the user visits the advance search page, and will be used when searching via the search block. |
-
+
-
+
Variable |
@@ -357,15 +357,15 @@
---|
maximagesperarticle |
5 |
- max. number of images you can have in a story |
+ max. number of images you can have in a article |
limitnews |
10 |
- Number of stories to limit the index page to, this same number will appear in the older stuff block |
+ Number of articles to limit the index page to, this same number will appear in the older stuff block |
minnews |
1 |
- Minimum numbers of stories than can appear on a topic page |
+ Minimum numbers of articles than can appear on a topic page |
contributedbyline |
1 |
@@ -374,28 +374,28 @@
hideviewscount |
0 |
Whether to show (= 0) or to hide (= 1) the number of views
- a story has had. |
+ a article has had.
hideemailicon |
0 |
- When set to 1, this will disable the ability to send a story by email. It
- will also hide the email icon from stories and the "Email Article To a
- Friend" from the Story Options block. |
+ When set to 1, this will disable the ability to send a article by email. It
+ will also hide the email icon from articles and the "Email Article To a
+ Friend" from the Article Options block. |
hideprintericon |
0 |
- When set to 1, this will disable display of a story in a "printer
- friendly" format. It will also hide the printer icon from stories and
- the "View Printable Version" from the Story Options
+ | When set to 1, this will disable display of a article in a "printer
+ friendly" format. It will also hide the printer icon from articles and
+ the "View Printable Version" from the Article Options
block. |
allow_page_breaks |
1 |
- Allow usage of the [page_break] tag in stories (when set to 1), so that stories can spread over multiple pages. |
+ Allow usage of the [page_break] tag in articles (when set to 1), so that articles can spread over multiple pages. |
page_break_comments |
last |
- When the [page_break] tag is allowed in stories (see above), where should the story's comments be displayed: 'last' = on the story's last page only, 'first' = on the first page only, 'all' = on every page. |
+ When the [page_break] tag is allowed in articles (see above), where should the article's comments be displayed: 'last' = on the article's last page only, 'first' = on the first page only, 'all' = on every page. |
article_image_align |
right |
@@ -403,19 +403,19 @@
show_topic_icon |
1 |
- Default setting for new stories and story submissions: Whether to show the topic icon (1) or not (0). |
+ Default setting for new articles and article submissions: Whether to show the topic icon (1) or not (0). |
draft_flag |
0 |
- Default setting for new stories created by Story Admins: Whether the story's draft flag should be set (1) or not (0). |
+ Default setting for new articles created by Story Admins: Whether the article's draft flag should be set (1) or not (0). |
frontpage |
0 |
- Default setting for new stories and story submissions: Whether the story should appear on the site's frontpage (1) or only in its topic's page (0). Please note that for stories submitted to the archive topic, this setting will be ignored and the story will not appear on the frontpage. |
+ Default setting for new articles and article submissions: Whether the article should appear on the site's frontpage (1) or only in its topic's page (0). Please note that for articles submitted to the archive topic, this setting will be ignored and the article will not appear on the frontpage. |
hide_no_news_msg |
0 |
- When set to 1, hide the "No News To Display" message on the index page (e.g. when viewing a topic without any stories in it) |
+ When set to 1, hide the "No News To Display" message on the index page (e.g. when viewing a topic without any articles in it) |
hide_main_page_navigation |
false |
@@ -426,22 +426,22 @@
onlyrootfeatures |
0 |
- This restricts the featuring of stories to root user(s). If you have several story admins who can create content that is not visible to other story admins,
+ | This restricts the featuring of articles to root user(s). If you have several article admins who can create content that is not visible to other article admins,
and such a content is featured, another admin might think its ok to feature his own content. To prevent
that two admins unknowingly take features from each other away, only a user who can see all content (= root)
- should be able to feature a story. |
+ should be able to feature a article.
aftersave_story |
'list' |
- Which page to go to after a story has been saved:
+ | Which page to go to after a article has been saved:
- - 'item': display the story
- - 'list': show admin's list of stories (default)
+ - 'item': display the article
+ - 'list': show admin's list of articles (default)
- 'home': display the site's homepage
- 'admin': go to the "Admin Home" page, i.e. Command & Control
- Note: This option is ignored for story submissions. Editing
- a story submission will always send you back to the submission queue (i.e.
+ Note: This option is ignored for article submissions. Editing
+ a article submission will always send you back to the submission queue (i.e.
"Admin Home" aka Command & Control). |
related_topics |
@@ -474,7 +474,7 @@
-
+
Variable |
@@ -487,7 +487,7 @@
---|
trackback_code |
0 |
- Default value for new stories: Trackback enabled (0) or disabled (-1) |
+ Default value for new articles: Trackback enabled (0) or disabled (-1) |
trackbackspeedlimit |
300 |
@@ -511,7 +511,7 @@
How to handle multiple trackbacks and pingbacks from the same source: 0 = keep only the first, reject any further trackbacks / pingbacks; 1 = overwrite, i.e. only keep the latest trackback / pingback; 2 = allow multiple trackbacks / pingbacks, i.e. list them all |
-
+
Variable |
@@ -533,14 +533,14 @@
pingback_self |
0 |
Pingbacks are sent out automatically to all the
- URLs linked from a story - which includes stories on your own site that
+ URLs linked from a article - which includes articles on your own site that
you may have linked in the article. This option lets you specify how these
"self pingbacks" are to be handled: 0 = skip them, i.e. don't send pingbacks
- to stories on your own site; 1 = allow them, but obey the speed limit;
+ to articles on your own site; 1 = allow them, but obey the speed limit;
2 = allow them and ignore the speed limit.
- If your article contains more than one link to other stories on your site,
+ If your article contains more than one link to other articles on your site,
then option 1 is probably of limited use, as it would only pingback the
- first linked story and run into the speed limit for the others. |
+ first linked article and run into the speed limit for the others.
ping_enabled |
true |
@@ -623,9 +623,9 @@
showfirstasfeatured |
0 |
- When set to 1, this will render the first story on any page
- using the templates for a featured story, even if that story is not
- featured. This will even be applied to the first story on page 2 of a
+ | When set to 1, this will render the first article on any page
+ using the templates for a featured article, even if that article is not
+ featured. This will even be applied to the first article on page 2 of a
topic page, for example. |
template_comments |
@@ -684,11 +684,11 @@
showstorycount |
1 |
- Show the number of stories in a topic in the Sections block (0=no, 1=yes) |
+ Show the number of articles in a topic in the Sections block (0=no, 1=yes) |
showsubmissioncount |
1 |
- Show the number of story submissions for a topic in the Sections block (0=no, 1=yes) |
+ Show the number of article submissions for a topic in the Sections block (0=no, 1=yes) |
hide_home_link |
0 |
@@ -724,7 +724,7 @@
newstoriesinterval |
86400 |
- Stories are "new" if they are this many seconds old. |
+ Articles are "new" if they are this many seconds old. |
newcommentsinterval |
172800 |
@@ -736,7 +736,7 @@
hidenewstories |
0 |
- Set to 1 to hide new stories from the What's New block. |
+ Set to 1 to hide new articles from the What's New block. |
hidenewcomments |
0 |
@@ -787,12 +787,12 @@
allow_username_change |
0 |
If set to 1, users will be allowed to change their username
- (login name). Stories and comments posted under the old username will
+ (login name). Articles and comments posted under the old username will
automatically show the new username. |
allow_account_delete |
0 |
- If set to 1, users will be allowed to delete their accounts. Stories and comments posted under that account will be kept and show up as being posted by "Anonymous". |
+ If set to 1, users will be allowed to delete their accounts. Articles and comments posted under that account will be kept and show up as being posted by "Anonymous". |
hide_author_exclusion |
Can be 1 or 0 |
@@ -1011,7 +1011,7 @@
from the following settings.
submitloginrequired |
0 |
- When set to 1, only registered users can submit stories
+ | When set to 1, only registered users can submit articles
and items handled by plugins, e.g. links and events |
commentsloginrequired |
0 |
@@ -1032,7 +1032,7 @@
form to send an email to another user
emailstoryloginrequired |
0 |
- When set to 1, only registered users can email stories |
+ When set to 1, only registered users can email articles |
directoryloginrequired |
0 |
When set to 1, only registered users can access the list of past articles |
@@ -1113,12 +1113,12 @@ Users and Submissions: Submission Settings
storysubmission |
1 |
- Enable (1) or disable (0) the story submission queue |
+ Enable (1) or disable (0) the article submission queue |
listdraftstories |
0 |
When set to 1, this will display an additional block on the
- submissions page (moderation.php) that lists all the stories that
+ submissions page (moderation.php) that lists all the articles that
have the 'draft' flag set. |
postmode |
@@ -1131,12 +1131,12 @@ Users and Submissions: Submission Settings
skip_preview |
0 |
- If 1, allows submission of stories and comments without previewing (i.e. the submission form will always have a Preview and a Submit button). |
+ If 1, allows submission of articles and comments without previewing (i.e. the submission form will always have a Preview and a Submit button). |
advanced_editor |
false |
Enable (if set to true ) a WYSIWYG editor for
- story and comment submissions and static pages. Geeklog ships with CKeditor. |
advanced_editor_name |
@@ -1145,8 +1145,8 @@ Users and Submissions: Submission Settings
wikitext_editor |
false |
- Allow using wiki syntax in stories. This adds a third option,
- "Wiki-style format", to the Post Mode dropdown in the story editor
+ | Allow using wiki syntax in articles. This adds a third option,
+ "Wiki-style format", to the Post Mode dropdown in the article editor
(implemented using the PEAR::Text_Wiki package). |
remove_4byte_chars |
@@ -1183,7 +1183,7 @@
comment_code |
0 |
- Default value for new stories: Comments enabled (0) or disabled (-1) |
+ Default value for new articles: Comments enabled (0) or disabled (-1) |
comment_edit |
0 |
@@ -1202,25 +1202,25 @@
article_comment_close_enabled |
0 |
- Whether or not stories should be closed for comments after
+ | Whether or not articles should be closed for comments after
a certain amount of days (see next option). This is only the default
- setting for new stories and can be changed separately for each
- story. |
+ setting for new articles and can be changed separately for each
+ article.
article_comment_close_days |
30 |
- Number of days after which a story is to be automatically
+ | Number of days after which a article is to be automatically
closed for comments, i.e. no new comments can be posted after that many
days.
Note that this is only the default value to which the "Disable Comments"
- option is set when creating a new story. It will not take effect unless it
- has also been enabled for the story. |
+ option is set when creating a new article. It will not take effect unless it
+ has also been enabled for the article.
comment_close_rec_stories |
0 |
- Number of most recent stories for which comment posting is
- allowed. Posting a new story will automatically close comments for the
- oldest of these stories. Set to 0 to disable this option. |
+ Number of most recent articles for which comment posting is
+ allowed. Posting a new article will automatically close comments for the
+ oldest of these articles. Set to 0 to disable this option. |
allow_reply_notifications |
0 |
@@ -1285,7 +1285,7 @@
allow_user_scaling |
1 |
When unscaled images are kept (see above), this option lets
- the user chose between using the scaled or unscaled image in the story, i.e.
+ the user chose between using the scaled or unscaled image in the article, i.e.
enables the [unscaledX] image tag (in addition to the
[imageX] tag). |
@@ -1502,7 +1502,7 @@
date |
%A, %B %d %Y @ %I:%M %p %Z |
- Date format used for most of the site, including story displays. See Date format used for most of the site, including article displays. See date formats below. |
daytime |
@@ -1518,7 +1518,7 @@
dateonly |
%d-%b |
Short date format (day and month only), to be used e.g. in the
- Upcoming Events and Older Stories blocks. See date
+ Upcoming Events and Older Articles blocks. See date
formats below. |
timeonly |
@@ -1533,7 +1533,7 @@
hour_mode |
12 |
Which format to use when submitting or editing an object
- with a time setting (e.g. the publish time of a story). Can be 12 (for the
+ with a time setting (e.g. the publish time of a article). Can be 12 (for the
12 hour am/pm format) or 24 (for the 24 hour format). |
thousand_separator |
@@ -1633,13 +1633,13 @@
notification |
array() |
Send an email notification to $_CONF['site_email']
- when a new story, comment, trackback or pingback has been submitted
+ when a new article, comment, trackback or pingback has been submitted
or a new user has registered with the site (or a user updated their account). The array() can hold
- any combination of the strings 'story', 'comment',
+ any combination of the strings 'article', 'comment',
'trackback', 'pingback', 'user', and 'user_update' (separated
by commas), depending on which notification(s) you want.
- Example: array('story','user'); would
- send notifications when a new story has been submitted or a new user has
+ Example: array('article','user'); would
+ send notifications when a new article has been submitted or a new user has
registered. No notifications would be sent, for example, for new
comments. |
@@ -1660,7 +1660,7 @@
0 |
If set to 1, disables the autotags. I.e. the
- special tags in square brackets (e.g. [story:]) will not be interpreted
+ special tags in square brackets (e.g. [article:]) will not be interpreted
any more. |
clickable_links |
@@ -1740,13 +1740,13 @@
emailstories |
0 |
- Let users get stories e-mailed to them (0=no, 1=yes), aka Daily Digest.
+ | Let users get articles e-mailed to them (0=no, 1=yes), aka Daily Digest.
Please note that this requires cron and the use of PHP as a shell script. |
emailstorieslength |
1 |
When emailstories (above) is enabled, send only the title and the
- link to the new stories (0), or send the entire introtext (1) or send
+ link to the new articles (0), or send the entire introtext (1) or send
the first n characters from the introtext (where n = any other number) |
emailstoriesperdefault |
@@ -1765,7 +1765,7 @@
user_html |
<p>, <b>, <i>, <a>, <em>, <br>, <tt>, <hr>, <ol>, <ul>, <li>, <code>, <pre> |
HTML tags and attributes that normal users are allowed to
- use in story submissions and comments. |
+ use in article submissions and comments.
admin_html |
additional HTML tags, e.g. for tables |
@@ -1843,7 +1843,7 @@
atom_max_stories |
10 |
- Max. number of stories returned when an Atom feed is
+ | Max. number of articles returned when an Atom feed is
requested through the webservices API. |
@@ -2112,7 +2112,7 @@
Geeklog includes a simple but useful URL rewriting feature which can help
make your site more crawler friendly (i.e. the URLs of your site are more
likely to be picked up by the search engine's indexing bots). This feature is
-supported for URLs to stories, topics, static pages, the article directory, and links.
+supported for URLs to articles, topics, static pages, the article directory, and links.
URL rewriting means that your URLs will look like this
https://www.geeklog.net/article.php/20021022234959146
@@ -2130,7 +2130,9 @@
This feature enhances the above URL Rewriting feature and makes
public_html/index.php work like a front controller. So, in order to use URL Routing feature,
- you have to enable URL Rewriting beforehand. Currently, the following rules are predefined.
+ you have to enable URL Rewriting beforehand. Remember URL Routing currently only works with
+ whatever URL Rewriting supports (articles, topics, static pages, the article directory, and links plugin).
+ Currently, the following rules are predefined.
Rule | Route | Priority |
@@ -2170,8 +2172,8 @@
Look at the first row in the table. This means if you access "http://yourdomain/index.php/article/@sid/print",
- then you will be redirected to "http://yourdomain/article.php?story=@sid&mode=print".
- @sid is a story ID.
+ then you will be redirected to "http://yourdomain/article.php?article=@sid&mode=print".
+ @sid is a article ID.
Then, look at the third row. You will see an at mark (@), followed by alphabetical
letters. This is a placeholder. For instance, when you access
"http://yourdomain/index.php/archives/all/2016/1", @topic matches "all", @year matches "2016",