diff --git a/docs/add-ons/forum/boards.md b/docs/add-ons/forum/boards.md deleted file mode 100755 index 6b2f5bb69..000000000 --- a/docs/add-ons/forum/boards.md +++ /dev/null @@ -1,124 +0,0 @@ - - -# Forum Boards - -[TOC] - -The Discussion Forum module allows you to create multiple forum "boards" enabling you to run separate forums on one installation. Each board can have its own URL, making it possible for you to have separate boards for each site, or even run multiple distinct boards on a single site. - -Aliases allow you to use alternative URLs from which to display your boards. - -## Managing Boards - -The "Forum Boards" are displayed in the left navigation. From there you can add new boards and edit or delete existing ones. - -### Adding/Editing a Forum Board - -#### Enable board - -When set to **enable**, this forum board will be accessible to member roles with proper permissions - -#### Name - -Full descriptive name of this board. - -#### Short name - -The "short name" for the forum board, used in the board= parameter of the Forum tag when running forums through regular templates. No spaces. Underscores and dashes are allowed. - -#### Forum directory - -URL location to the forum. This is the URL to the main forum page. - -#### Forum URL segment - -Word that triggers forum display. Cannot be the same as a template or template group. The trigger word causes the forum to be processed apart from standard templates. If you are outputting the forum via tag on a standard template, this field should be blank. - -#### Default theme - -Forum theme for this forum. - -#### Allow PHP? - -Allows the use of standard PHP within forum templates. - -#### PHP parsing stage - -When set to **output**, PHP will be parsed after the template. - -#### Attachments per post - -Maximum attachments allowed per post. - -#### Upload directory - -URL location of this upload directory. - -#### Allowed file types? - -The type of files that can be uploaded as attachments. - -#### File size - -Maximum file size in megabytes. - -#### Image width - -Maximum image width in pixels. - -#### Image height - -Maximum image height in pixels. - -#### Enable thumbnail creation? - -When set to **enable**, clickable thumbnails will be shown in posts. - -#### Thumbnail width - -Maximum thumbnail width in pixels. - -#### Thumbnail height - -Maximum thumbnail height in pixels. - -## Forum Board Alias Details - -### Forum Board Alias Settings - -The Forum Board Alias settings are essentially the same as the General Settings for a normal forum board. The difference is that an existing forum board is selected as the one being aliased. This enables you to display a forum board on different sites / locations within the same ExpressionEngine installation as the normal location. - -#### Forum Board Label - -The label that is displayed for the forum board alias. - -#### Forum Board Short Name - -The "short name" for the forum board alias, used in the board= parameter of the Forum tag when running forums through regular templates. - -#### Forum URL - -The base URL where the forum board alias will be displayed. - -#### Site for Forum - -If the [Multiple Site Manager](msm/overview.md) is enabled, this allows you to determine which Site the forum board belongs to. - -#### Forum Triggering Word - -When this word is encountered in your URL it will display your forum. The word you choose cannot be the name of an existing template group. - -#### Enable Forum Board - -Yes / No. Whether or not the forum board alias is turned on. - -#### Forum Board Being Aliased - -The Forum Board that this Alias points to. diff --git a/docs/add-ons/forum/channel-forum.md b/docs/add-ons/forum/channel-forum.md deleted file mode 100755 index 3f58b8ef2..000000000 --- a/docs/add-ons/forum/channel-forum.md +++ /dev/null @@ -1,24 +0,0 @@ - - -# Associating Channel Entries with Forum Topics - -## Publish Page and the "Forum Tab" - -When creating a new channel entry there is a `publish_forum_tab`. Entering data in the Forum Topic Title and Forum Topic Text in that tab will cause the new forum topic to be created upon publish, and associated with that channel entry. - -Alternatively, if there is an existing forum topic to link to this entry, then you may enter that forum topic's ID into the Forum Topic ID input. - -A new forum topic may only be created when creating a new channel entry. When editing an existing channel entry, only the Forum Topic ID will be present to associate an existing forum post with this existing channel entry. - -NOTE: **Note:** When a new entry is created and there is content in the Forum tab, the Forum information will be posted immediately regardless of the entry date, status, or other entry parameters. - -## Forum Topic Variable Pairs - -To link the Forum Topic to the Channel Entry on the front-end use the `channel_entries_conditional_variables` of the Channel Entries Tag, including `{if forum_topic}` and `{if not_forum_topic}`. diff --git a/docs/add-ons/forum/global-variables.md b/docs/add-ons/forum/global-variables.md deleted file mode 100755 index 4dd007ff0..000000000 --- a/docs/add-ons/forum/global-variables.md +++ /dev/null @@ -1,54 +0,0 @@ - - -# Discussion Forum Global Variables - -Most of the variables used in the forum are specific to their individual templates. Those variables can be found by examining the default themes. - -Below is a list of global variables that may be used throughout the forum templates: - -- {charset} -- {current_id} (category id, forum id, thread id, etc.) -- {current_page} (current pagination index) -- {current_request} (viewthread, viewforum, etc.) -- {error_message} -- {forum_build} -- {forum_name} -- {forum_url} -- {include:body_extra} -- {include:head_extra} -- {include:spellcheck_js} -- {module_version} -- {page_title} -- {password_max_length} -- {path:advanced_search} -- {path:atom} -- {path:do_search} -- {path:forgot} -- {path:forum_home} -- {path:image_url} -- {path:login} -- {path:logout} -- {path:mark_all_read} -- {path:memberlist} -- {path:private_messages} -- {path:recent_poster} -- {path:register} -- {path:rss} -- {path:smileys} -- {path:spellcheck_iframe} -- {path:theme_css} -- {path:view_active_topics} -- {path:view_new_topics} -- {path:view_pending_topics} -- {path:your_control_panel} -- {path:your_profile} -- {recent_poster} -- {screen_name} -- {site_url} diff --git a/docs/add-ons/forum/helper.md b/docs/add-ons/forum/helper.md deleted file mode 100755 index fe3e9cb11..000000000 --- a/docs/add-ons/forum/helper.md +++ /dev/null @@ -1,273 +0,0 @@ - - -# Forum Helper - -[TOC] - -The forum helper tag allows you to display the status of recent support forum posts in your standard Templates. You could use this to list recent threads in a sidebar on your site's main page, for instance. - -NOTE: **Note:** This tag is for use in any of your ExpressionEngine templates that are accessible via the TEMPLATES page in the control panel. It is not available for use in your forum templates. If you would like to show the support helper in your forum templates please use the **{include:support_helper}** tag, which corresponds to the Archive Template: "Support Helper Tables". - -At its simplest, posts to support forums can be displayed along with the current reply status, making it easy for users to identify recent posts that have not been successfully solved or replied to by staff: - - - - - - - - {exp:forum:forum_helper orderby="post_date" sort="desc" limit="50"} - - - - - - {/exp:forum:topic_titles} -
TitleStatusLast reply
{title}{"status"} - Last response: {last_post_date format="%m/%d/%Y %h:%i %a"}
- By: {last_author} -
- -You can also break out the different statuses into their own display grids using variable pairs: - - {exp:forum:forum_helper orderby="post_date" sort="desc" limit="50"} - {status_group status="new"} - {status_header} -

{status}

- - - - - - {/status_header} - - - - - {status_footer} -
TitleLast reply
{title} - Last response: {last_post_date format="%m/%d/%Y %h:%i %a"}
- By: {last_author}
- {/status_footer} - {/status_group} - {status_group status="not new"} - {status_header} -

{status}

- - - - - - - {/status_header} - - - - - - {status_footer} -
TitleStatusLast reply
{title}{status} - Last response: {last_post_date format="%m/%d/%Y %h:%i %a"}
- By: {last_author} -
- {/status_footer} - {/status_group} - {/exp:forum:forum_helper} - -## Parameters - -[TOC=3] - -### `boards=` - - boards="2" - -Allows you to specify which boards to pull topics from by Board ID number. Board ID 1 will be used if no value is specified. - -As with many other parameters that use ID specification, you can stack boards to get topics from any number of boards: - - boards="2|3|4" - -Or use "not" to exclude boards: - - boards="not 1|4" - -### `forums=` - - forums="3" - -Allows you to specify which forums to pull topics from by Forum ID number. If no value is specified, the Topic Titles tag will pull from all forums in the specified boards. - -As with many other parameters that use ID specification, you can stack forums to get topics from specific forums only: - - forums="3|14|16" - -Or use "not" to exclude forums: - - forums="not 9|12" - -### `limit=` - - limit="30" - -Allows you to limit the number of topics displayed. The limit will default to 10 topics if a value is not specified. - -### `orderby=` - - orderby="post_date" - -The "order" parameter sets the display order of the forum topics. Setting options for this parameter include: - -- orderby="post_date" -- orderby="recent_post" -- orderby="title" - -### `sort=` - - sort="asc" - sort="desc" - -The sort order can be "asc" (ascending order or "oldest item first" for dates) or "desc" (descending order or "newest item first" for dates). If you do not use a sort order the default is desc. - -### `status=` - - status="awaiting_staff" - -Allows you to specify the statuses to include. The default will be 'new' if a value is not specified. - -## Variables - -[TOC=3] - -### `{author}` - -The screen name of the thread author. - -### `{auto_thread_path}` - -This variable is replaced by a path built with the URL set in the "Forum URL" general preference setting for the board that the topic belongs to. For example, this: - - {title} - -Would be rendered like this: - - My forum topic - -### `{board_label}` - -The name of the board the topic belongs to, taken from the "Forum Board Label" general preference setting. - -### `{board_name}` - -The short name of the board the topic belongs to, taken from the "Forum Board Short Name" general preference setting. - -### `{body}` - -The contents of the topic. - -NOTE: **Note:** This variable will use the formatting preferences of the forum that the topic belongs to. - -### `{forum_name}` - -The Forum Name of the specific forum that the topic belongs to. - -### `{forum_url}` - -This variable is replaced with the URL set in the "Forum URL" general preference setting for the board that the topic belongs to. - -### `{last_author}` - -The screen name of the most recent user to leave a reply in the thread. If there are no replies then the last author will be the author of the thread itself. - -### `{last_author_profile_path='forums/member'}` - -The URL to the member profile for the last user to leave a reply in the thread. If there are no replies then it will be for the author of the thread itself. For example, this: - - {last_author} - -Would be rendered like this: - - Fred Smith - -### `{last_post_date}` - - {last_post_date format="%m/%d/%Y %h:%i %a"} - -The date on which the last (most recent) post in the thread was made. As with other date variables, these require the "format" parameter in order to define how the date should be displayed. See the [date variable formatting](templates/date-variable-formatting.md) page for more information. - -### `{last_post_id}` - -The id of the last reply made to the thread. Will hold a value of 0 if no replies have been made. Can be used to build links to the last reply, e.g.: - - View latest reply - -### `{last_post_relative_date}` - -The date on which the last (most recent) post in the thread was made, displayed relative to the current time. For instance, if you used this: - - Posted {last_post_relative_date} ago - -It might be displayed as: - - Posted 1 hour and 23 minutes ago - -### `{last_reply}` - -If available, the contents of the most recent reply to the thread. - -NOTE: **Note:** This variable will use the formatting preferences of the forum that the topic belongs to. - -### `{profile_path}` - - {profile_path='forums/member'} - -The URL to the member profile of the thread author. For example, this: - - {author} - -Would be rendered like this: - - Fred Smith - -### `{status}` - -The current status of the post. - -### `{thread_path}` - - {thread_path='forums/viewthread'} - -The URL to the thread at the specified Template. For example, this: - - {title} - -Would be rendered like this: - - My Forum Thread - -### `{title}` - -The title for the thread. - -### `{topic_date}` - - {topic_date format="%m/%d/%Y %h:%i %a"} - -The date on which the thread was posted. As with other date variables, these require the "format" parameter in order to define how the date should be displayed. See the [date variable formatting](templates/date-variable-formatting.md) page for more information. - -### `{topic_relative_date}` - -The date on which the thread was posted, displayed relative to the current time. For instance, if you used this: - - Posted {topic_relative_date} ago - -It might be displayed as: - - Posted 1 hour and 23 minutes ago diff --git a/docs/add-ons/forum/index.md b/docs/add-ons/forum/index.md deleted file mode 100755 index 73fe68556..000000000 --- a/docs/add-ons/forum/index.md +++ /dev/null @@ -1,24 +0,0 @@ - - -# Discussion Forum - -The ExpressionEngine Discussion Forum Module allows you to create and manage a full-featured forum on your site. This includes everything from posting and replying to editing threads and private messaging other users. The Module also allows you to easily administer your forum both for setup and to create and assign Moderators and Administrators. You can even easily change the look and feel of your forum by simply applying another "theme" to it. - -## Features and Management - -- [Setting Up Your Forums for the First Time](add-ons/forum/setup.md) -- [Forum Boards and Aliases](add-ons/forum/boards.md) -- [User Management](add-ons/forum/user-management.md) -- [Forum Themes](add-ons/forum/themes.md) -- [Forum Global Variables](add-ons/forum/global-variables.md) -- [Signatures, Avatars and Member Photos](add-ons/forum/signatures.md) -- [Displaying Recent Forum Topics in non-forum templates](add-ons/forum/recent-topics.md) -- [Associating Channel Entries with Forum Topics](add-ons/forum/channel-forum.md) -- [Other Features](add-ons/forum/other-features.md) diff --git a/docs/add-ons/forum/other-features.md b/docs/add-ons/forum/other-features.md deleted file mode 100755 index 5b1517433..000000000 --- a/docs/add-ons/forum/other-features.md +++ /dev/null @@ -1,43 +0,0 @@ - - -# Other Features - -[TOC] - -## Using PHP in the Forum Templates - -You can enable PHP to be used in the Forum Templates if you wish. This is done under Default Preferences. You can do this if you wish to include other PHP scripts, such as banner ads. As with regular ExpressionEngine Templates, you can choose whether the [PHP is executed](templates/overview.md#php-in-templates) on "Input" or "Output". - -## Running the Forums Through Regular Templates - -By default, the Forum Module utilizes its own light-weight template display engine, rather than utilizing main templating system in ExpressionEngine. The consequence of this, though, is that you can't use general EE Tags, global variables, conditionals, or similar in the forum templates since they won't be parsed. - -In the Default Preferences you set a "triggering" word for the forums, which by default is "forums". When the trigger word is encountered in the URL by ExpressionEngine, your forums will display. Your trigger word cannot be the same as any existing Template Group name. - -If you absolutely must, there _is_ a way to run your Forum through the standard EE template engine: - -1. Create a Template as normal in the main Templates tab of the Control Panel. Name it as you want. -2. Inside that new Template, place this code and **only** this code: - - {exp:forum} - -If you have multiple forums, you can specify which forum to load using the "board" parameter, like so: - - {exp:forum board="board_name"} - -And you can also specify a theme using the "theme" parameter: - - {exp:forum theme="my_theme"} - -Your forum will then be run inside the regular EE template engine, which means that you can include standard EE Tags in the forum theme Templates. The forum is then accessed through whichever Template you created above, so the Template name is used in place of the "trigger" word mentioned earlier. Note that due to the nature of forum URLs, segment globals are not parsed when used in the forum templates. - -The down side of this approach is that it adds more processing overhead, so it's not recommended unless users really need this capability. Since the forum can't be cached, on very busy sites this can create some unwanted server load. - -Do not cache the Template you create for the forum. If you do so, your forum will not behave dynamically. diff --git a/docs/add-ons/forum/recent-topics.md b/docs/add-ons/forum/recent-topics.md deleted file mode 100755 index 7b739c269..000000000 --- a/docs/add-ons/forum/recent-topics.md +++ /dev/null @@ -1,229 +0,0 @@ - - -# Displaying Recent Forum Topics - -[TOC] - -While the Discussion Forum module is fairly self-contained, it is possible to display a simple list of "recent forum topics" in your standard Templates. You could use this to list recent threads in a sidebar on your site's main page, for instance. An example: - -NOTE: **Note:** This tag is for use in any of your ExpressionEngine templates that are accessible via the TEMPLATES page in the control panel. It is not available for use in your forum templates. If you would like to show recent topics in your forum templates please use the **{include:recent_posts}** tag, which corresponds to the Archive Template: "Recent Post Table". - - - - - - - - - - - - {exp:forum:topic_titles orderby="post_date" sort="desc" limit="10"} - - - - - - - - - {/exp:forum:topic_titles} -
TitleAuthorPosted OnPostsViewsLast Post Info
{title}{author}{topic_date format="%m/%d/%Y %h:%i %a"}{post_total}{views}On: {last_post_date format="%m/%d/%Y %h:%i %a"}
- By: {last_author}
- -## Parameters - -[TOC=3] - -### `boards=` - - boards="2" - -Allows you to specify which boards to pull topics from by Board ID number. Board ID 1 will be used if no value is specified. - -As with many other parameters that use ID specification, you can stack boards to get topics from any number of boards: - - boards="2|3|4" - -Or use "not" to exclude boards: - - boards="not 1|4" - -### `forums=` - - forums="3" - -Allows you to specify which forums to pull topics from by Forum ID number. If no value is specified, the Topic Titles tag will pull from all forums in the specified boards. - -As with many other parameters that use ID specification, you can stack forums to get topics from specific forums only: - - forums="3|14|16" - -Or use "not" to exclude forums: - - forums="not 9|12" - -### `limit=` - - limit="30" - -Allows you to limit the number of topics displayed. The limit will default to 10 topics if a value is not specified. - -### `orderby=` - - orderby="post_date" - -The "order" parameter sets the display order of the forum topics. Setting options for this parameter include: - -- orderby="post_date" -- orderby="recent_post" -- orderby="title" - -### `sort=` - - sort="asc" ``sort="desc"`` - -The sort order can be "asc" (ascending order or "oldest item first" for dates) or "desc" (descending order or "newest item first" for dates). If you do not use a sort order the default is desc. - -## Variables - -[TOC=3] - -### `{author}` - -The screen name of the thread author. - -### `{auto_thread_path}` - -This variable is replaced by a path built with the URL set in the "Forum URL" general preference setting for the board that the topic belongs to. For example, this: - - {title} - -Would be rendered like this: - - My forum topic - -### `{board_label}` - -The name of the board the topic belongs to, taken from the "Forum Board Label" general preference setting. - -### `{board_name}` - -The short name of the board the topic belongs to, taken from the "Forum Board Short Name" general preference setting. - -### `{body}` - -The contents of the topic. - -NOTE: **Note:** This variable will use the formatting preferences of the forum that the topic belongs to. - -### `{forum_name}` - -The Forum Name of the specific forum that the topic belongs to. - -### `{forum_url}` - -This variable is replaced with the URL set in the "Forum URL" general preference setting for the board that the topic belongs to. - -### `{last_author}` - -The screen name of the most recent user to leave a reply in the thread. If there are no replies then the last author will be the author of the thread itself. - -### `{last_author_profile_path}` - - {last_author_profile_path='forums/member'} - -The URL to the member profile for the last user to leave a reply in the thread. If there are no replies then it will be for the author of the thread itself. For example, this: - - {last_author} - -Would be rendered like this: - - Fred Smith - -### `{last_post_date}` - - {last_post_date format="%m/%d/%Y %h:%i %a"} - -The date on which the last (most recent) post in the thread was made. As with other date variables, these require the "format" parameter in order to define how the date should be displayed. See the [date variable formatting](templates/date-variable-formatting.md) page for more information. - -### `{last_post_id}` - -The id of the last reply made to the thread. Will hold a value of 0 if no replies have been made. Can be used to build links to the last reply, e.g.: - - View latest reply - -### `{last_post_relative_date}` - -The date on which the last (most recent) post in the thread was made, displayed relative to the current time. For instance, if you used this: - - Posted {last_post_relative_date} ago - -It might be displayed as: - - Posted 1 hour and 23 minutes ago - -### `{last_reply}` - -If available, the contents of the most recent reply to the thread. - -NOTE: **Note:** This variable will use the formatting preferences of the forum that the topic belongs to. - -### `{post_total}` - -The total number of posts in the thread. - -### `{profile_path}` - - {profile_path='forums/member'} - -The URL to the member profile of the thread author. For example, this: - - {author} - -Would be rendered like this: - - Fred Smith - -### `{thread_path}` - - {thread_path='forums/viewthread'} - -The URL to the thread at the specified Template. For example, this: - - {title} - -Would be rendered like this: - - My Forum Thread - -### `{title}` - -The title for the thread. - -### `{topic_date}` - - {topic_date format="%m/%d/%Y %h:%i %a"} - -The date on which the thread was posted. As with other date variables, these require the "format" parameter in order to define how the date should be displayed. See the [date variable formatting](templates/date-variable-formatting.md) page for more information. - -### `{topic_relative_date}` - -The date on which the thread was posted, displayed relative to the current time. For instance, if you used this: - - Posted {topic_relative_date} ago - -It might be displayed as: - - Posted 1 hour and 23 minutes ago - -### `{views}` - -The number of times the thread has been viewed. diff --git a/docs/add-ons/forum/setup.md b/docs/add-ons/forum/setup.md deleted file mode 100755 index d53da0fe8..000000000 --- a/docs/add-ons/forum/setup.md +++ /dev/null @@ -1,64 +0,0 @@ - - -# Discussion Forum Setup - -[TOC] - -When setting up a new forum, it is typically best to do things in a certain order. - -## Create a Forum Board - -Before you can begin setting up your forums, you will need to have at least one [forum board](add-ons/forum/boards.md) for your forums to belong to. - -## Set Permissions - -There are seven types of permissions you can set. It should be obvious what each type of permission allows. - -- Can View Forum -- Can View Hidden Forums -- Can View Posts -- Can Post -- Can Report -- Can Upload -- Can Search - -For each type of permission, you can determine whether or not it is available for any of your Member Roles. Check a checkbox in a permission column for a Role row if you want that Role to have that permission. For instance, you might not want to allow a particular Role to be able to post in your forum. If that's the case, then make sure the "Can Post" checkbox is unchecked for that Role. - -The Discussion Forum module requires membership in order to post in the forums. Non logged-in users (the "Guest" Primary Role) cannot post to the forums. - -The "blank" boxes in the last column and last row allow you to easily select or de-select an entire column or row. - -Member Roles are managed under `Members --> Member Roles` since Roles are used throughout your site and not just as part of the forum. - -## Add a New Category - -Once you've set the preferences and permissions you can start to add the actual forums. First, you'll need to create at least one "Category" for your forum. Let's imagine that your site is about sports and politics. So, you first go to the Create New Category link in the Forum Manager. Here you could create a "Sports" category. Later, you can create separate forums for different types of sports. You might also create a "Politics" category. - -A "category" in the Forum Module is simply a way to organize one or more forums together. - -## Add your Forums - -Now that you've created one or more categories, you can create forums inside them. Use the Create New Forum link under the category in which you're interested. For instance, under the Sports category, you could click that link and then create a "Football" forum. You might also create "Basketball", "Baseball", "Rugby", and "Hockey" forums in that category. - -In the Politics category you might create "Democrat", "Independent", and "Republican" forums. - -When creating your forums, you can set the "Status" for the forum. There are three statuses: - -- **Live**: This is the normal state for a forum. It allows new postings. -- **Read Only**: A Read Only forum does not permit new posts. You could use this status if you have a forum that you still want to keep the contents available for viewing but don't want anything new added. You can think of this as a sort of "archival" mode. -- **Hidden**: A Hidden forum is one that is only viewable by people given permission to do so (via the forum permissions, as mentioned earlier). - -## Customizing Particular Forums - -After a forum has been created, you can use the Edit link for that forum to adjust its settings. - -## Changing the Display Order of Forums and Categories - -Often, you won't create your categories and forums in the ultimate order in which you'd like them displayed. In the main Forum Manager screen you can use the drag handles to change the order of things. Changing the order of forums will change the order of those forums within the category. You can use the drag handles for the categories to change the order in which the categories are displayed. diff --git a/docs/add-ons/forum/signatures.md b/docs/add-ons/forum/signatures.md deleted file mode 100755 index 040b0c36d..000000000 --- a/docs/add-ons/forum/signatures.md +++ /dev/null @@ -1,29 +0,0 @@ - - -# Signatures and Avatars - -Users in your forum can create Avatars and Signatures that are attached to their forum activity. Avatars are small images that get displayed along with the user's name in posts and replies they make. Signatures are small pieces of text and/or an image that is displayed at the bottom of each post the user makes. Signatures often contain a link to the user's site or a favorite quote. Avatars and Signatures are used throughout ExpressionEngine and are not specific to the forum. - -Avatar settings can be updated in the Control Panel by going to the [Avatar Settings](/control-panel/settings/avatars.md) located at `Settings --> Avatars`. - -Signature images are _disabled_ by default. However, Signature images can be enabled via the [`sig_allow_img_upload` config override](/general/system-configuration-overrides.md#sig_allow_img_upload). - -## Available config overrides for Forum Signatures: - -NOTE:**Note:** These settings only exist as config overrides and do not have matching Control Panel settings. - -- [`sig_allow_img_upload`](/general/system-configuration-overrides.md#sig_allow_img_upload) -- [`sig_allow_img_hotlink`](/general/system-configuration-overrides.md#sig_allow_img_hotlink) -- [`sig_img_max_height`](/general/system-configuration-overrides.md#sig_img_max_height) -- [`sig_img_max_kb`](/general/system-configuration-overrides.md#sig_img_max_kb) -- [`sig_img_max_width`](/general/system-configuration-overrides.md#sig_img_max_width) -- [`sig_img_path`](/general/system-configuration-overrides.md#sig_img_path) -- [`sig_img_url`](/general/system-configuration-overrides.md#sig_img_url) -- [`sig_maxlength`](/general/system-configuration-overrides.md#sig_maxlength) \ No newline at end of file diff --git a/docs/add-ons/forum/themes.md b/docs/add-ons/forum/themes.md deleted file mode 100755 index 15a941a26..000000000 --- a/docs/add-ons/forum/themes.md +++ /dev/null @@ -1,29 +0,0 @@ - - -# Forum Themes - -**Control Panel Location:** `Developer --> Templates --> Forums` - -The ExpressionEngine Forums make use of "themes" to determine how they are displayed. The Forum Module comes with several "default" themes. - -Theme assets such as images are located in your installation under `themes/ee/forum/` in a folder named after the theme. - -The theme templates are located in `system/ee/templates/_themes/forum`, also in a folder named after the theme. - -In order to edit the Templates: - -1. Copy `themes/ee/forum/theme_name/` to `themes/user/forum/custom_theme_name/` -2. Copy `system/ee/templates/_themes/forum/theme_name` to `system/user/templates/_themes/forum/custom_theme_name/` - -NOTE: **Note:** The contents of `themes/ee/` and `system/ee` are replaced every update, and any changes made there will be lost. All customization needs to happen in `themes/user/` and `system/user/`. - -To make edits to the templates from inside the Control Panel, set the `system/user/templates/_theme/forum/` folders and files to be writable. See [File Permissions](troubleshooting/general.md#file-permissions) for details. Only themes in the `system/user/templates/_theme/forum/` folder will be available for editing in the Control Panel. - -You can easily switch the default theme used by the forum by choosing a new one under Default Preferences. diff --git a/docs/add-ons/forum/user-management.md b/docs/add-ons/forum/user-management.md deleted file mode 100755 index bdab5effe..000000000 --- a/docs/add-ons/forum/user-management.md +++ /dev/null @@ -1,45 +0,0 @@ - - -# Forum User Management - -[TOC] - -In addition to the regular permissions you set up for your Member Roles earlier (see above), there are two special levels that you can assign to users: Administrator and Moderator. You can assign the Administrator or Moderator level to either an entire Role or simply to individual members of your site. In this way you have flexibility as to how you assign these special privileges. - -You may also set up "Member Ranks", which are sort of steps that users can reach, upon which they gain particular titles. - -You access these areas under the User Management tab in the Forum Module. - -## Administrators - -The Administrators section is accessed by clicking the orange icon associated with a forum board. Administrators are **very** powerful users. Administrators have all rights when it comes to the forums. They can ban users, delete posts, move threads, close threads, etc. They have the same rights that a member of the "Super Admin" Role does, except they can't ban SuperAdmins or delete threads made by a SuperAdmin. - -Administrators in the forums are **very** powerful. Be extremely careful when assigning this privilege to a member or Member Role. - -## Moderators - -The Administrators section is accessed by clicking the blue icon associated with a forum board. Moderators are special members or Member Roles. You can add Moderators on a forum-by-forum basis and assign them permissions _above and beyond_ those you normally assign through the regular forum permissions. - -There are six additional permissions that you can grant a Moderator: - -- **Can Edit Posts**: The Moderator can edit posts by other members in addition to their own. -- **Can Move Posts**: The Moderator can move posts between forums. For instance, if a thread was started in the wrong forum the Moderator can move it to the correct one. -- **Can Delete Posts**: The Moderator can delete posts. -- **Can Change Post Status**: The Moderator can change the status of a post, so they can close a post to new replies. -- **Can Post Announcements**: The Moderator can post an "announcement" that shows up in all forums. -- **Can View IP Addresses**: The Moderator can see the IP address of all users who leave posts or replies. - -Remember, these permissions are **in addition** to any that may already be assigned to the Member Role when the forum was set up. - -## Member Ranks - -Here you can set up levels or steps that users of the forums can reach. For instance, you might set it so that all users who have less than 50 posts are labeled as "New Member". Those with 51-200 might be "Regular Member". - -When you create a Member Rank, you assign it a title, set a minimum number of posts that must be reached in order for that Rank to apply, and then set how many "stars" will appear for users of that Rank. diff --git a/docs/add-ons/ip-to-nation.md b/docs/add-ons/ip-to-nation.md deleted file mode 100755 index bc3f08bf9..000000000 --- a/docs/add-ons/ip-to-nation.md +++ /dev/null @@ -1,57 +0,0 @@ - - -# IP to Nation - -[TOC] - -**Control Panel Location:** `Developer --> Add-Ons --> IP to Nation` - -The IP to Nation module enables you to determine which country an IP address is associated with. You can do two things with this information: - -1. **Ban entire countries.** When a country is banned, someone with an IP address from that country is not permitted to submit comments, referrer data, or use the email/tell-a-friend forms. -2. **Show a flag icon** ![image0](_images/flag-us.gif) within your comments or entries to indicate the country of the person who submitted the entry. - -## Database Updates - -To update your installation, simply make sure that you are running the latest version of ExpressionEngine, and visit the `Developer --> Add-Ons --> IP to Nation` page in your Control Panel and click the Update IP Database button. The update may take a few seconds; do not click any links or refresh the page while the auto-update is taking place. - -## Banning Countries - -To look up the country associated with an IP address, or to ban a country, go to `Developer --> Add-Ons --> IP to Nation` in your Control Panel and enter an IP address in the "Search for an IP address" field. - -To ban a country, make sure your IP database is updated, then find the country you wish to ban in the "Banned countries" checklist. Make a selection and click Save Banlist. - -## World Flags Tag - -In order to use the world flag feature, please first visit the Modules page of the control panel and make sure your IP to Nation module is installed. - -NOTE: **Note:** Please [download the flag icons](https://expressionengine.com/asset/file/world_flags.zip) from ExpressionEngine.com. Once downloaded, unzip the archive, then upload the "world_flags" folder to your server. The folder can go anywhere since you'll set the URL in the tag as described below. - -The "world flags" tag can be used within your {exp:comment:entries} or {exp:channel:entries} like this: - - {exp:ip_to_nation:world_flags image_url="https://example.com/images/world_flags/"} - {ip_address} - {/exp:ip_to_nation:world_flags} - -## Parameters - -### `image_url=` - -This URL to your "world_flags" folder. - -Make sure you include the folder name in the URL and include a trailing slash: - - https://example.com/images/world_flags/ - -### `type="text"` - -You can optional set the tag to output the name of the country as text by using the type="text" parameter. - -NOTE: **Note:** This product includes GeoLite data created by MaxMind, available from . diff --git a/docs/add-ons/pro-search.md b/docs/add-ons/pro-search.md index bbc5a68c0..f3003e59a 100644 --- a/docs/add-ons/pro-search.md +++ b/docs/add-ons/pro-search.md @@ -11,4 +11,4 @@ ExpressionEngine’s native `channel:entries` tag allows you to fetch and filter entries in many ways by setting its parameters. The native Search module allows for filtering by keyword, but is limited in its capabilities. Pro Search combines the two into one module and then throw in extra features, filters, and a performance boost. That is Low Search. -NOTE:**Note:** Documentation for Pro Search is still being migrated. Until this is complete, please refernce the [Low Search documentation on EEHarbor's website](https://eeharbor.com/low-search). For any tags, simply replace `low_search` with `pro_search`. \ No newline at end of file +NOTE:**Note:** Documentation for Pro Search is still being migrated. Until this is complete, please refernce the [Low Search documentation on EEHarbor's website](https://eeharbor.com/low-search/documentation). For any tags, simply replace `low_search` with `pro_search`. \ No newline at end of file diff --git a/docs/add-ons/pro-search/collections.md b/docs/add-ons/pro-search/collections.md index 109c6a865..c48559e9d 100644 --- a/docs/add-ons/pro-search/collections.md +++ b/docs/add-ons/pro-search/collections.md @@ -12,16 +12,21 @@ Collections are used by the Keywords filter. A Collection generates an index whi ## Settings -`Channel` - The Channel to which the collection is related. -`Collection label` - Full name of the search collection. -`Collection name` - Short name of the search collection. -`Language` - The language of the search collection. Defining a language will add the words in the collection to the lexicon. -`Modifier` - Number used to multiply the relevance score of each entry in this search collection. +### Channel +The Channel to which the collection is related. + +### Collection label +Full name of the search collection. + +### Collection name +Short name of the search collection. + +### Language +The language of the search collection. Defining a language will add the words in the collection to the lexicon. + +### Modifier +Number used to multiply the relevance score of each entry in this search collection. + ### Adding weight to fields @@ -64,25 +69,18 @@ http://example.com/index.php?ACT=99&key=12345 The following variables can be added to the call to that URL either via GET or POST: -#### Variables - -`ACT` - The build index action ID, as given. Required -`build` - What you need to build, either index, lexicon or both (the default). -`collection_id` - Comma separated list of collection IDs to build. -`entry_id` - Comma separated list of entry IDs to build. -`key` - Your Low Search license key. Required +- `ACT` - The build index action ID, as given. Required +- `build` - What you need to build, either index, lexicon or both (the default). +- `collection_id` - Comma separated list of collection IDs to build. +- `entry_id` - Comma separated list of entry IDs to build. +- `key` - Your Low Search license key. Required -Examples +**Examples:** -http://example.com/index.php?ACT=99&key=12345&collection_id=3 +`http://example.com/index.php?ACT=99&key=12345&collection_id=3` -http://example.com/index.php?ACT=99&key=12345&entry_id=14,15,16&build=lexicon +`http://example.com/index.php?ACT=99&key=12345&entry_id=14,15,16&build=lexicon` -http://example.com/index.php?ACT=99&key=12345&collection_id=1,2&build=index +`http://example.com/index.php?ACT=99&key=12345&collection_id=1,2&build=index` -Note: Building the index or lexicon via this URL will not happen in batches. \ No newline at end of file +NOTE:**Note:** Building the index or lexicon via this URL will not happen in batches. \ No newline at end of file diff --git a/docs/add-ons/pro-search/lexicon.md b/docs/add-ons/pro-search/lexicon.md index 688f14c5f..167748d46 100644 --- a/docs/add-ons/pro-search/lexicon.md +++ b/docs/add-ons/pro-search/lexicon.md @@ -16,6 +16,6 @@ To add words, click the Add words tab on the lexicon page in the Control Panel, To remove words, click the Find words tab on the lexicon page in the Control Panel, enter the word you want to remove, make sure the correct language is selected, and hit return. A list of matching words will appear on the page. Then click on the word you want to remove. -Finding words in this manner also supports partial matches. For example, use lion to look up the exact word, or use lion* to look for words that start with lion. +Finding words in this manner also supports partial matches. For example, use `lion` to look up the exact word, or use `lion*` to look for words that start with `lion`. -NOTE**Note:** Only 3+-letter non-digit words will be added to the lexicon. \ No newline at end of file +NOTE:**Note:** Only 3+-letter non-digit words will be added to the lexicon. \ No newline at end of file diff --git a/docs/add-ons/pro-search/settings.md b/docs/add-ons/pro-search/settings.md index ddd390784..c9e783cc5 100644 --- a/docs/add-ons/pro-search/settings.md +++ b/docs/add-ons/pro-search/settings.md @@ -6,52 +6,61 @@ @copyright Copyright (c) 2003-2020, Packet Tide, LLC (https://packettide.com) @license https://expressionengine.com/license Licensed under Apache License, Version 2.0 --> -# Global settings - -`Encode query` - Set to No to use GET variables instead of an encoded query in the URI for the search results page. Read more about encoded queries vs. GET variables. Defaults to Yes. -`Default result page` - If a result page is not explicitly given, Pro Search will fall back to this page. You can optionally use %s to place the encoded search query anywhere in the URI. Defaults to search/results. -`Search Log size` - Searches are logged in the Pro Search Log. You can set the maximum amount of recent searches to log. Set to 0 to disable logging altogether. Defaults to 500. -`Collection batch size` - Building a search collection index or lexicon can be strenuous for your web server. To alleviate the load, you can set a batch size. Indexes will be built in batches of this size. Defaults to 100. -`Excerpt length` - The maximum amount of words to display in the search excerpt. Set to 0 to display the full excerpt. Defaults to 50. -`Filters` - All Filters that are available. All filters are enabled by default. You can optionally disable unused filters. - -### Encoded queries vs. GET variables +# Pro Search Settings + +[TOC] + +## Global settings + +### Encode query +Set to No to use GET variables instead of an encoded query in the URI for the search results page. Read more about encoded queries vs. GET variables. Defaults to Yes. + +### Default result page +If a result page is not explicitly given, Pro Search will fall back to this page. You can optionally use %s to place the encoded search query anywhere in the URI. Defaults to search/results. + +### Search Log size +Searches are logged in the Pro Search Log. You can set the maximum amount of recent searches to log. Set to 0 to disable logging altogether. Defaults to 500. + +### Collection batch size +Building a search collection index or lexicon can be strenuous for your web server. To alleviate the load, you can set a batch size. Indexes will be built in batches of this size. Defaults to 100. + +### Excerpt length +The maximum amount of words to display in the search excerpt. Set to 0 to display the full excerpt. Defaults to 50. + +## Filters +All Filters that are available. All filters are enabled by default. You can optionally disable unused filters. + +## Encoded queries vs. GET variables Not all ExpressionEngine installations let you use GET variables. That’s why Pro Search uses an encoded and URI-safe segment to pass on a search query to the results page. An encoded query looks something like this: -domain.com/search/results/eyJrZXl3b3JkcyI6ImhlbGxvIHdvcmxkIn0 +`domain.com/search/results/eyJrZXl3b3JkcyI6ImhlbGxvIHdvcmxkIn0` The same query with GET variables would look like this: -domain.com/search/results?keywords=hello+world +`domain.com/search/results?keywords=hello+world` -Using GET variables is not possible if the uri_protocol config setting is set to QUERY_STRING. It can also cause unexpected behaviour if you’re using the second exception (the question mark) in your .htaccess file when hiding index.php. If you cannot, use the encoded query instead, as this will always work. +Using GET variables is not possible if the `uri_protocol` config setting is set to QUERY_STRING. It can also cause unexpected behaviour if you’re using the second exception (the question mark) in your `.htaccess` file when hiding `index.php`. If you can, use the encoded query instead as this will always work. NOTE:**Note:** When using GET variables, make sure Dynamic Channel Query Caching is turned off. -### Keywords filter settings +## Keywords filter settings The following settings apply specifically to the Keywords filter. -`Highlight keywords` +### Highlight keywords Choose a tag which is used to highlight keywords in the search excerpt. Options are ``, ``, ``, and ``. Choosing any of these tags will allow you to choose to highlight keywords in the Title as well. Defaults to do not highlight. -`Minimum word length` +### Minimum word length The ft_min_word_len setting of your MySQL installation determines the minimum length of words indexed by the Full Text index. Setting that value here will trigger an alternative search algorithm when the search term is smaller than this size. Defaults to 4. Do not alter unless you have customised your MySQL installation. -`Stop words` +### Stop words By default, MySQL keeps a list of stop words, which are ignored in the Full Text index. An alternative search method is triggered when the search query contains one or more of these words. Do not alter unless you have customised your MySQL installation. -`Ignore words` +### Ignore words A list of words that will be removed from the given keywords so as not to trigger the alternative search method. These ignore words will only be stripped from the keywords for non-exact searches. Additionally, these words will not be added to the lexicon. diff --git a/docs/add-ons/pro-search/shortcuts.md b/docs/add-ons/pro-search/shortcuts.md index acd501683..8c2fd66fd 100644 --- a/docs/add-ons/pro-search/shortcuts.md +++ b/docs/add-ons/pro-search/shortcuts.md @@ -14,7 +14,7 @@ For example, a complicated search query can result in a long URL like this one: `domain.com/search/eyJyZXN1bHRfcGFnZSI6Im5ld3NcL3NlYXJjaCIsImtleXdvcmRzIjoiaGVsbG8gd29ybGQiLCJjb2xsZWN0aW9uIjoibmV3cyJ9` -If you save this search and name it hello, you will be able to trigger the same search results using this URL: +If you save this search and name it "hello", you will be able to trigger the same search results using this URL: `domain.com/search/hello` diff --git a/docs/add-ons/pro-variables.md b/docs/add-ons/pro-variables.md index 378861948..5da5166f6 100644 --- a/docs/add-ons/pro-variables.md +++ b/docs/add-ons/pro-variables.md @@ -9,6 +9,6 @@ # Pro Variables -ExpressionEngine’s native `channel:entries` tag allows you to fetch and filter entries in many ways by setting its parameters. The native Variables module allows for filtering by keyword, but is limited in its capabilities. Pro Variables combines the two into one module and then throw in extra features, filters, and a performance boost. That is Low Variables. +ExpressionEngine’s native `channel:entries` tag allows you to fetch and filter entries in many ways by setting its parameters. The native Variables module allows for filtering by keyword, but is limited in its capabilities. Pro Variables combines the two into one module and then throw in extra features, filters, and a performance boost. -NOTE:**Note:** Documentation for Pro Variables is still being migrated. Until this is complete, please refernce the [Low Variables documentation on EEHarbor's website](https://eeharbor.com/low-variables). For any tags, simply replace `low_variables` with `pro_variables`. \ No newline at end of file +NOTE:**Note:** Documentation for Pro Variables is still being migrated. Until this is complete, please refernce the [Low Variables documentation on EEHarbor's website](https://eeharbor.com/low-variables/documentation). For any tags, simply replace `low_variables` with `pro_variables`. \ No newline at end of file diff --git a/docs/add-ons/simple-commerce/control-panel.md b/docs/add-ons/simple-commerce/control-panel.md deleted file mode 100755 index 1020fde8a..000000000 --- a/docs/add-ons/simple-commerce/control-panel.md +++ /dev/null @@ -1,22 +0,0 @@ - - -# Simple Commerce Control Panel - -**Control Panel Location:** `Developer --> Add-Ons --> Simple Commerce` - -The Simple Commerce Module's control panel allows you to easily create and track your store's items as well as set and maintain your PayPal account options. - -## Simple Commerce Control Panel Areas - -- [Managing Store Items](add-ons/simple-commerce/items.md) -- [Managing Store Purchases](add-ons/simple-commerce/purchases.md) -- [Store Email Templates](add-ons/simple-commerce/email-templates.md) -- [Instant Payment Notification](add-ons/simple-commerce/ipn.md) -- [PayPal Settings](add-ons/simple-commerce/paypal-settings.md) diff --git a/docs/add-ons/simple-commerce/email-templates.md b/docs/add-ons/simple-commerce/email-templates.md deleted file mode 100755 index 83e58500e..000000000 --- a/docs/add-ons/simple-commerce/email-templates.md +++ /dev/null @@ -1,98 +0,0 @@ - - -# Simple Commerce – Email Templates - -[TOC] - -**Control Panel Location:** `Developer --> Add-Ons --> Simple Commerce --> Email Templates` - -Email templates allow you to create highly customized notification templates that you can associate with store items. Email templates can be created and used for both administrator notifications and customer notifications. - -## Email Templates Home Page Options - -### Add Email Template - -The **Create New** button allows you to create email notification templates. - -### Edit Email Templates - -To edit email templates, click the edit button in the toolbar next to the name of the email template you wish to edit. - -## Add / Edit Email Template - -Below is an example of a typical administrator purchase notification email. - - Purchase completed! QTY {quantity} - {item_name} - Total Payment: {payment_gross} - PayPal TransactionFee: {payment_fee} - -------------------------- - Buyer ({payer_status}): {first_name} {last_name} {payer_business_name} - Address ({address_status}): {address_name} {address_street} {address_city}, {address_state} {address_zip} {address_country} - -### Name - -A descriptive name for the email template. This will be shown in the email template drop-down menus of the store [item creation](add-ons/simple-commerce/items.md) form. - -### Email Subject - -The subject that will be used for the notification email. - -### Email Body - -The message body that will be used for the notification email. - -### Available Variables - -The following variables can be used anywhere in either the email subject or the email body. - -- {address_city} -- {address_country} -- {address_name} -- {address_state} -- {address_status} -- {address_street} -- {address_zip} -- {business} -- {custom} -- {exchange_rate} -- {first_name} -- {invoice} -- {item_name} -- {item_number} -- {last_name} -- {mc_currency} -- {mc_fee} -- {mc_gross} -- {memo} -- {notify_version} -- {num_cart_items} -- {option_name1} -- {option_name2} -- {option_selection1} -- {option_selection2} -- {payer_business_name} -- {payer_email} -- {payer_id} -- {payer_status} -- {payment_date} -- {payment_fee} -- {payment_status} -- {payment_type} -- {pending_reason} -- {quantity} -- {reason_code} -- {receiver_email} -- {receiver_id} -- {settle_amount} -- {settle_currency} -- {tax} -- {txn_id} -- {txn_type} -- {verify_sign} diff --git a/docs/add-ons/simple-commerce/index.md b/docs/add-ons/simple-commerce/index.md deleted file mode 100755 index 6b608cde0..000000000 --- a/docs/add-ons/simple-commerce/index.md +++ /dev/null @@ -1,321 +0,0 @@ - - -# Simple Commerce - -[TOC] - -The Simple Commerce Module is a basic but flexible module that easily integrates ExpressionEngine with PayPal. - -- Integrates with ExpressionEngine's Channel Module to define items for sale -- Tracks purchases automatically utilizing PayPal's [Instant Payment Notification](https://www.paypal.com/us/smarthelp/article/what-is-instant-payment-notification-(ipn)-faq2933) -- Lets you create any number of customized email notification templates for both the administrator and customers, even a different email template for _every item_! -- Add and Edit multiple items at once -- Ability to assign sale prices to items, and easily mark items "on sale" -- Allows purchases of items to change the user's primary role -- Supports PayPal Encrypted Payments -- Tab delimited export of items and purchases - -## Simple Commerce Purchase Tag - -The Simple Commerce Purchase tag is the primary tag used to display information about items in your store. It is designed to be used within a Channel Entries tag, as store items are actually Channel Entries. - -Here is a simple example: - - {exp:simple_commerce:purchase entry_id="{entry_id}" success="site/success" cancel="site/index"} -

{item_name}

- -

{item_sale_price}

- - {if item_type == "purchase"} -

Buy Now

-

Add to Cart

-

View Cart

- {/if} - {if item_type == "subscription"} -

Subscribe Now

- {/if} - {/exp:simple_commerce:purchase} - -## Parameters - -[TOC=3] - -### `cancel=` - - cancel="store/cancel" - -You may specify a particular Template to display if a purchase is cancelled mid-transaction. This takes a standard "Template_Group/Template" as input, or you may provide a full URL, e.g. . If this parameter is not supplied, your site's main index template will be displayed. - -### `country_code=` - - country_code="DE" - -This parameter controls the language that will be used on the initial PayPal shopping cart / log in screen when someone makes a purchase from your store. Use the two letter country abbreviation, following the [ISO 3166 standard](https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes). If no parameter is given, a default of 'US' will be used. - -### `currency=` - - currency="USD" - -The three letter representation of the currency for the item prices in the store, using the ISO 4217 standard. Default is "USD" (U.S. Dollars). For other currencies, please refer to [Wikipedia's ISO 4127 listing](https://en.wikipedia.org/wiki/ISO_4217#Active_codes). - -### `decimal=` - - decimal="," - -Change the decimal separator for display. For example, instead of display 3.95, you can have the price outputted as 3,95. - -### `entry_id=` - - entry_id="{entry_id}" - -**REQUIRED**. As the Simple Commerce Purchase tag is designed to be used inside a Channel Entries tag, the {entry_id} variable of the Channel Entries tag will normally be used to provide the value. You may also use a specific entry id to display an item's information outside of a Channel Entries tag. - -### `show_disabled=` - - show_disabled="yes" - -Allows the Simple Commerce Purchase tag to output information for store items that are not enabled. This can be used in conjunction with an item_enabled conditional to display information for enabled / disabled items. e.g.: - - {if item_enabled == 'n'} -

NOT AVAILABLE

- {if:else} -

{item_sale_price}

-

Buy Now

-

Add to Cart

-

View Cart

- {/if} - -### `success=` - - success="store/thank_you" - -**REQUIRED**. You must specify a particular Template to display after a successful purchase transaction. This takes a standard "Template_Group/Template" as input, or you may provide a full URL, e.g. [https://example.com/store/thank\\\_you/](https://example.com/store/thank_you/). - -## Variables - -[TOC=3] - -### Item Details - -### `{item_id}` - -The store item's id. - -### `{item_name}` - -The descriptive name of the item. - -### `{item_enabled}` - -Whether or not the store item is enabled (y/n). This can be useful if you use custom queries to access information about your store items. If the item is not enabled ("n"), the {exp:simple_commerce:purchase} tag will not output information for that item. - -### `{item_purchases}` - -The number of times the item has been purchased. - -### `{item_regular_price}` - -The item's regular price. - -### `{item_sale_price}` - -The item's sale price. - -### `{item_use_sale}` - -Whether or not the item is on sale (y/n). Useful in conditionals and custom queries. If the item is marked as on sale, the PayPal purchase links will automatically use the sale price. - -### `{item_type}` - -Whether item is a recurring item (subscription/purchase). Useful in conditionals and custom queries. - -NOTE: **Note:** Recurring payments cannot be made using the shopping cart. Thus item_type conditionals should be used if you offer cart links and are mixing recurring and non-recurring items. - -### Purchase Links - -### `{add_to_cart_url}` - - Add to Cart - -The PayPal URL to add the item to the PayPal shopping cart. The example shown is a typical usage as a popup link. Recurring payments _cannot_ be made using the cart. - -NOTE: **Note:** If using encrypted payments, this link may be cutoff in some browsers. Purchase buttons are recommended as an alternative. - -### `{buy_now_url}` - - Buy Now - -NOTE: **Note:** If using encrypted payments, this link may be cutoff in some browsers. Purchase buttons are recommended as an alternative. - -### `{view_cart_url}` - - View Cart - -The PayPal URL to view the contents of the shopping cart. The example shown is a typical usage as a popup link. - -### `{subscribe_now_url}` - - Subscribe Now - -The "Subscribe Now" PayPal URL. The example shown is a typical usage as a popup link. - -NOTE: **Note:** If using encrypted payments, this link may be cutoff in some browsers. Purchase buttons are recommended as an alternative. - -## Purchase Buttons - -Purchase buttons are variable pairs, and enclose the text used for the button label. - -### `{add_to_cart_button}` - - {add_to_cart_button}Add to Cart{/add_to_cart_button} - -A button that adds the item to the PayPal shopping cart. - -### `{buy_now_button}` - - {buy_now_button}Buy Now{/buy_now_button} - -A "Buy Now" PayPal button. - -### `{view_cart_button}` - - {view_cart_button}View Cart{/view_cart_button} - -A button to view the contents of the shopping cart. - -## Recurring Payments - -The Simple Commerce Module supports [Paypal Subscriptions and Recurring Payments](https://www.paypal.com/us/cgi-bin/?cmd=p/xcl/rec/subscr-intro-outside) (offsite link). Using recurring payments, you can offer your users automatically recurring subscriptions. For purchases managed through the module, you can specify emails to be sent upon a recurring purchase, emails to be sent when a recurring payment is canceled, and alter a member's group assignment based on their subscription status. - -NOTE: **Note:** Automatic emails and member role changes rely on [Instant Payment Notification](add-ons/simple-commerce/ipn.md). New subscription automated features will only work for purchases made by logged-in members of your site. Subscription termination automatic features will only work for purchases made by members. - -### Recurring Payment Variables in Template Tags - -Paypal does not allow recurring payments to be added to the shopping cart. It is therefore important to use the [item_type](#item_type) variable in a conditional if you use shopping cart links. - -### Recurring Payment Subscription Expiration Date - -There is no set expiration date for a recurring payment. In the control panel display, ongoing recurring payments will be marked as such. An expiration date is provided only for subscriptions that have been terminated. - -### How Recurring Payments may be terminated - -PayPal will send an instant payment notification if the purchaser has canceled their subscription. You may also cancel a subscription through the PayPal control panel, triggering an instant payment notification. See the PayPal documentation for details. - -## Testing Purchases - -When setting up your Simple Commerce store, it can be valuable to test your settings by running fake purchases through your store. PayPal makes this possible with a "sandbox" area, where fictitious purchases can be made without anyone's credit card or PayPal account actually being used. - -### Setting up a Developer Account with PayPal - -To use the sandbox area, you will have to set up a free developer account with PayPal. - -1. Point your browser to -2. Click "Sandbox" and then "Create Test Accounts". Sandbox accounts are not tied to your PayPal account on www.paypal.com in any way. - 1. Create a Premier Account for Merchant. You can usually use the same information that your real merchant account uses. Remember that nothing on the Sandbox is tied to real world information or accounts. - 2. Create a Personal Account for a test purchaser. Keep this account's login information handy, as you will be using it to make test purchases. -3. Launch Sandbox for the Premier Account - 1. Set up [Instant Payment Notification](add-ons/simple-commerce/ipn.md). - 2. Add a Bank Account. Enter a fictional name, PayPal will automatically create fake account numbers for you. - 3. Confirm the Bank Account. Simply click confirm--no test deposits are made. -4. Launch Sandbox for the Personal Account - 1. Add a Credit Card. Again, you can use fictitious information, and allow PayPal to provide the false account numbers automatically. - -### Debug Mode - -In order for the Simple Commerce module to create purchase links that utilize PayPal's Sandbox area instead of the real PayPal site, you need to enable the module's debug mode. To do so, open mod.simple_commerce.php, and near the top where the class variables are defined, set \$debug to TRUE. - - var $debug = TRUE; - -Remember to set this variable to FALSE when you wish to take your store live and route purchases to the real PayPal website. - -## Encrypted Website Payments - -The Simple Commerce Module has the ability to utilize PayPal's Encrypted Website Payments feature. In order to use these features, there are some additional steps you will need to take to set up Encrypted Website Payments with PayPal. A brief background on the process will also be beneficial. - -### How Encrypted Payments Work - -After exchanging public certificates with PayPal, the button or link parameters of a purchase are encrypted with PayPal's public key, and digitally signed with the merchant's private key. When a purchase request is made from the encrypted form or link, PayPal checks the authenticity of the information by using the merchant's uploaded public certificate. PayPal then decrypts the information with their private key, and the purchase transaction is allowed to continue. - -The steps required to use Encrypted Website Payments with PayPal are to: - -1. [Generate a private key](#generate-a-private-key) -2. [Generate a public certificate](#generate-a-public-certificate) -3. [Upload your public certificate to PayPal](#upload-your-public-certificate-to-paypal) -4. [Update your Certificate ID in your Simple Commerce control panel](#update-your-certificate-id) -5. [Download PayPal's public certificate](#download-paypals-public-certificate) -6. [Update the paths to the files in your Simple Commerce control panel](#update-paths-to-your-certificates-and-key) - -For the most security, you may also wish to set up your PayPal account so that it [only accepts encrypted payments](#accept-encrypted-payments-only). - -PayPal accepts only X.509 public certificates in OpenSSL PEM format, from any established certificate authority, such as [VeriSign](https://www.verisign.com/) You can also create your own private key and public certificate using the open source software [OpenSSL](https://www.openssl.org/). Most \*nix based operating systems (including Macintosh OS X) will already have this software compiled and ready to use. If you are running Windows, there are [pre-compiled binaries](https://wiki.openssl.org/index.php/Binaries) available. The sections that follow describe creating your public certificate and private key using OpenSSL. - -### Generate a private key - -The **private key** is the portion of the encryption method that is kept secret and not sent to anyone. To create your private key, key in the following at the command line: - - openssl genrsa -out private_key.pem 1024 - -"private_key.pem" is the name of the file that will be created in the directory you are running the command from. You will need to upload this file to _your server only_. - -NOTE: **Note:** ExpressionEngine must have read access to the directory you upload the private key to, but for security it is highly recommended that you use a location above the public HTML folder on your account so that it is not accessible via the web. - -### Generate a public certificate - -The **public certificate** is the portion of the encryption method that you provide PayPal to enable them to accept encrypted payments for you. To create your public certificate, key in the following at the command line: - - openssl req -new -key private_key.pem -x509 -days 730 -out public_certificate.pem - -"private_key.pem" is the name of the private key file generated in step one. This command needs to be ran from the same directory, or provide a path to the private key file. "public_certificate.pem" is the name of the public certificate file that will be created in the directory you are running the command from. - -You will be prompted to answer some questions. You should answer these questions with the same information used by the PayPal merchant account. Once the public certificate is created, you must upload it to your server. - -NOTE: **Note:** ExpressionEngine must have read access to the directory you upload the public certificate to, but for security it is highly recommended that you use a location above the public HTML folder on your account so that it is not accessible via the web. - -### Upload your public certificate to PayPal - -You must also upload your public certificate to PayPal at the following URL: , or as follows: - -1. Log into your PayPal account -2. Click the Profile subtab -3. In the Seller Preferences column, click Encrypted Payment Settings. -4. Click Add -5. Click browse and select the public certificate file you just created - -When you have successfully uploaded your public certificate to PayPal, it will be displayed under "Your Public Certificates". You will need information from this screen in the following step. - -### Update your Certificate ID - -In the Encrypted Payment Settings section of your PayPal Seller Preferences, the "Cert ID" column of the table showing your uploaded public certificates displays the certificate ID that PayPal assigned to the certificate. In your Simple Commerce control panel [PayPal Settings](add-ons/simple-commerce/paypal-settings.md), key in your certificate ID to the field marked **ID Given to Public Certificate by PayPal**. - -### Download PayPal's public certificate - -In the same area of PayPal's website that you used in step 3 to upload your public certificate, download PayPal's public certificate. Upload this file to your server. - -NOTE: **Note:** ExpressionEngine must have read access to the directory you upload the public certificate to, but for security it is highly recommended that you use a location above the public HTML folder on your account so that it is not accessible via the web. - -### Update paths to your certificates and key - -In your Simple Commerce control panel [PayPal Settings](add-ons/simple-commerce/paypal-settings.md), update the paths for the certificates and key, as well as the folder used to temporarily store encrypted files. As indicated in the notes, this path must be readable by ExpressionEngine, but should not be accessible from the web. - -### Accept encrypted payments only - -For maximum security, you may wish to set up PayPal so that your account only accepts encrypted payments. This will make it impossible for people to alter the price or information for a purchase unless they obtain your public certificate and private key (keep them safe!). - -To block unencrypted payments, log in to PayPal and navigate to My Selling Tools > Website preferences (under “Selling online” heading) > Encrypted Website Payments, and then select "On" next to "Block Non-encrypted Website Payments". - -## Control Panel - -See the [Simple Commerce Control Panel](add-ons/simple-commerce/control-panel.md) page for more information on: - -- [Managing Store Items](add-ons/simple-commerce/items.md) -- [Managing Store Purchases](add-ons/simple-commerce/purchases.md) -- [Store Email Templates](add-ons/simple-commerce/email-templates.md) -- [Instant Payment Notification](add-ons/simple-commerce/ipn.md) -- [PayPal Settings](add-ons/simple-commerce/paypal-settings.md) diff --git a/docs/add-ons/simple-commerce/ipn.md b/docs/add-ons/simple-commerce/ipn.md deleted file mode 100755 index 6f4c3f879..000000000 --- a/docs/add-ons/simple-commerce/ipn.md +++ /dev/null @@ -1,24 +0,0 @@ - - -# Simple Commerce – Instant Payment Notification - -The Simple Commerce Module and PayPal's IPN (Instant Payment Notification) allow you to fully integrate PayPal with your store, automatically keeping track of purchases, and sending notification emails to both administrators and customers. - -PayPal's Instant Payment Notification service processes transactions on their server, and notifies ExpressionEngine when the transaction is complete, so purchases are not recorded in your store until they are finalized. - -NOTE: **Note:** While you can still use Simple Commerce generated PayPal links to sell items to users browsing your site as guests, the Instant Payment Notification features, such as transaction recording and email notifications, will only work for purchases made by logged-in members of your site. - -NOTE: **Note:** In order for PayPal to be able to send payment notifications to your site, your site needs to be online and accessible to the public. If anything would prevent an unauthenticated user from visiting your site, PayPal will be unable to send payment notifications. - -## Enabling PayPal Instant Payment Notification - -Please refer to [PayPal's instructions](https://www.paypal.com/us/smarthelp/article/what-is-instant-payment-notification-(ipn)-faq2933) for the latest information. To enable Instant Payment Notification, login to PayPal, and select "Payment Notifications" from the Profile submenu. Provide PayPal with the **Instant Payment Notification (IPN) URL** found in the Simple Commerce preferences. - -NOTE: **Note:** For ExpressionEngine to reliably track PayPal transactions within Simple Commerce, you must enter your primary PayPal email address as the **PayPal Account** in the Simple Commerce preferences. diff --git a/docs/add-ons/simple-commerce/items.md b/docs/add-ons/simple-commerce/items.md deleted file mode 100755 index 4964f6871..000000000 --- a/docs/add-ons/simple-commerce/items.md +++ /dev/null @@ -1,100 +0,0 @@ - - -# Simple Commerce – Managing Store Items - -[TOC] - -**Control Panel Location:** `Developer --> Add-Ons --> Simple Commerce` - -The Items screen gives you at a glance an overview of your store items, their price, sale status, and number of purchases. You may select items to edit or delete by checking the boxes on the right and selecting the appropriate action from the drop-down menu next to the Submit button. Items may be added by clicking the **Create New** button on the top right. - -## Items Home Page Options - -### Create New Item - -The **Create New** button allows you to select channel entries to add as items to your store. - -### Edit Items - -To edit items, click the edit button in the toolbar next to the name of the item you wish to edit. - -### Export Items - -To export items, click the export button next to "All Items" to export and download a tab-delimited file of all of your store items, for easy import into other applications. - -## Adding Items - -To add a new item, click **Create New** from the Items screen. You will be presented with a familiar looking screen, one that looks much like the [Edit section of the Control Panel](control-panel/entry-manager.md), and can in fact perform searches here using the same methods. - -To add Store Items, simply check the boxes to the right of the items you wish to add to your store, make sure **Add Item** is selected in the bulk action drop-down menu, and then click Submit. - -## Adding / Editing Item Details - -When editing a store item or adding a new one, you will be presented with the following form. If you selected multiple items, you will be able to see and edit the details for each item all from the same page. - -### Enable Item? - -When checked, the item will be enabled and available for purchase. If unchecked, the `simple_commerce_purchase_tag` will not show details, purchase links, or buttons for this item. - -### Regular Price - -This is the price the item will normally be sold for. Required. - -### Sale Price - -When on sale, the item will be sold for this price. Required, even if the price is the same as the regular price. - -### Use Sale Price? - -When checked, the item will be sold at the Sale Price instead of the Regular Price - -### Admin Email Address - -Send administrator email notifications for this item to the specified email address. - -### Admin Email Template - -The [email template](add-ons/simple-commerce/email-templates.md) that will be used to generate administrator notification emails for this item. - -### Customer Email Template - -The [email template](add-ons/simple-commerce/email-templates.md) that will be used to generate customer notification emails for this item. - -### New Member Group - -If selected, a member who purchases this item will automatically be moved to the designated member role for this item. - -For example, you could have a member role called "member_paid" and when a current registered member purchases an item called "Yearly Membership" the member primary role would be automatically switched to the "member_paid" role. - -### Admin Cancel Email Template - -For subscription items only, this is the [email template](add-ons/simple-commerce/email-templates.md) that will be used to generate administrator notification when a subscription runs out. - -### Customer Cancel Email Template - -For subscription items only, this is the [email template](add-ons/simple-commerce/email-templates.md) that will be used to generate customer notification e-mails when their subscription runs out for this item. - -### Unsubscribe Member Group - -For subscription items, you can designate a primary role to move the member to if their subscription runs out. - -For example, if you move members to the 'member_paid' group when the purchase a 'Yearly Membership', you could have a member role 'member_unpaid' selected here. Once their subscription runs out, they will automatically be switched to the unpaid role. - -### Recurring Subscription? - -If checked, the item is designated as a [recurring payment](add-ons/simple-commerce/index.md#recurring-payments). - -### Frequency of Subscription - -The number of time periods between each recurrence of a subscription. If you set a recurring payment time period, this value is required. - -For example, if the subscription payment unit is 'Weeks' and the subscription frequency is '2', purchasers will be billed by PayPal every 2 weeks. - -For subscription items, you must set the time period used to calculate the duration of the subscription. In conjunction with the subscription frequency setting, this determines the automatic billing cycle for subscription items. diff --git a/docs/add-ons/simple-commerce/paypal-settings.md b/docs/add-ons/simple-commerce/paypal-settings.md deleted file mode 100755 index f31757a18..000000000 --- a/docs/add-ons/simple-commerce/paypal-settings.md +++ /dev/null @@ -1,54 +0,0 @@ - - -# Simple Commerce – PayPal Settings - -**Control Panel Location:** `Developer --> Add-Ons --> Simple Commerce --> Settings` - -## PayPal Account Email - -Specify the primary email address associated with the PayPal account processing payments for store purchases. - -## Encryption Settings - -### Encrypt PayPal Buttons and Links? - -Enable encryption for PayPal purchase links and buttons created by Simple Commerce. - -NOTE: **Important:** Enabling this requires that your server have [OpenSSL](https://php.net/manual/en/ref.openssl.php) support compiled in PHP. Ask your server administrator for this information. - -NOTE: **Note:** Enabling this requires that you use a public certificate and private key. Please read the section on `simple_commerce_encrypted_payments` for full details. To be the most effective, you should set your PayPal account settings to only accept encrypted payments. - -### Public Certification ID - -Specify the unique ID that is supplied by PayPal after providing them with a public certificate. - -### Public Certificate Path - -Specify the path to the public certificate file. Please read the section on `simple_commerce_encrypted_payments` for full details. - -NOTE: **Note:** ExpressionEngine must have read access to this directory, but for security we highly recommended you use a location above web root so that the certificate and key files are not accessible via the web. - -### Private Key Path - -Specify the path to the private key file. Please read the section on `simple_commerce_encrypted_payments` for full details. - -NOTE: **Note:** ExpressionEngine must have read access to this directory, but for security we highly recommended you use a location above web root so that the certificate and key files are not accessible via the web. - -### PayPal Certificate Path - -Specify the path to the PayPal-provided certificate file. Please read the section on `simple_commerce_encrypted_payments` for full details. - -NOTE: **Note:** ExpressionEngine must have read access to this directory, but for security we highly recommended you use a location above web root so that the certificate and key files are not accessible via the web. - -### Temporary Encrypted Files Path - -Specify the path to the temporarily stored encrypted files. Please read the section on `simple_commerce_encrypted_payments` for full details. - -NOTE: **Note:** ExpressionEngine must have read access to this directory, but for security we highly recommended you use a location above web root so that the certificate and key files are not accessible via the web. diff --git a/docs/add-ons/simple-commerce/purchases.md b/docs/add-ons/simple-commerce/purchases.md deleted file mode 100755 index fcc4a7b7e..000000000 --- a/docs/add-ons/simple-commerce/purchases.md +++ /dev/null @@ -1,50 +0,0 @@ - - -# Simple Commerce – Managing Store Purchases - -**Control Panel Location:** `Developer --> Add-Ons --> Simple Commerce --> Purchases` - -The Purchases screen gives you at a glance an overview of your store purchases, the purchaser, date, and price of purchases. You may select items to edit or delete by checking the boxes on the right and selecting the appropriate action from the drop-down menu next to the Submit button. Purchases may be added by clicking the **Create New** button on the top right. - -## Purchases Home Page Options - -### Create New Purchase - -The **Create New** button allows you to manually add purchases to your store. This can be useful if you want to keep track of purchases made before you began using the Simple Commerce system, or that come from a source other than PayPal. - -### Edit Purchases - -To edit purchases, click the edit button in the toolbar in the row of the purchase you wish to edit. - -### Export Purchases - -To export purchases, click the export button next to "All Purchases" to export and download a tab-delimited file of all of your purchases, for easy import into other applications. The details of the PayPal transaction are output to the file as a serialized array. - -## Adding / Editing Purchases - -### Purchase Identification Number (TXN ID) - -The transaction id (TXN ID) provided by PayPal for the completed purchase. - -### Screen Name - -The screen name of the member who purchased the item. - -### Item Purchased - -The item that was purchased. - -### Date of Purchase - -The date of the purchase. - -### Price - -The price payed for the item purchased. diff --git a/docs/add-ons/structure/overview.md b/docs/add-ons/structure/overview.md new file mode 100644 index 000000000..5498790d8 --- /dev/null +++ b/docs/add-ons/structure/overview.md @@ -0,0 +1,16 @@ + + +# Structure + +Structure is a powerful add-on that lets you create pages, generate navigation, manage content through a simple interface and build robust sites faster than ever. + +It forgoes the default template_group/template setup and creates “static” and “listing” pages that are all editable through a tree sitemap view. With Structure enabled, traditional page style content and multiple entry pages can live within the same area. + +NOTE:**Note:** Documentation for Structure is still being migrated. Until this is complete, please refernce the [Structure documentation on EEHarbor's website](https://eeharbor.com/structure/documentation). \ No newline at end of file diff --git a/docs/toc_sections/_advanced_usage_toc.yml b/docs/toc_sections/_advanced_usage_toc.yml index e03153dd1..d675385c8 100644 --- a/docs/toc_sections/_advanced_usage_toc.yml +++ b/docs/toc_sections/_advanced_usage_toc.yml @@ -39,44 +39,40 @@ href: add-ons/email.md - name: Emoji href: add-ons/emoji.md - - name: Discussion Forum - items: - - name: Overview - href: add-ons/forum/index.md - - name: Setup - href: add-ons/forum/setup.md - - name: Boards - href: add-ons/forum/boards.md - - name: Themes - href: add-ons/forum/themes.md - - name: Global Variables - href: add-ons/forum/global-variables.md - - name: User Management - href: add-ons/forum/user-management.md - - name: Associating Channel Entries with Forum Topics - href: add-ons/forum/channel-forum.md - - name: Recent Forum Topics - href: add-ons/forum/recent-topics.md - - name: Signatures and Avatars - href: add-ons/forum/signatures.md - - name: Helper - href: add-ons/forum/helper.md - - name: Other Features - href: add-ons/forum/other-features.md - name: HTTP Header href: add-ons/http-header.md - - name: IP to Nation - href: add-ons/ip-to-nation.md - name: Metaweblog API href: add-ons/metaweblog-api.md - name: Moblog href: add-ons/moblog.md - name: Pages href: add-ons/pages.md +# - name: Pro Search +# items: +# - name: Overview +# href: add-ons/pro-search/overview.md +# - name: Collections +# href: add-ons/pro-search/collections.md +# - name: Settings +# href: add-ons/pro-search/settings.md +# - name: Lexicon +# href: add-ons/pro-search/lexicon.md +# - name: Shortcuts +# href: add-ons/pro-search/shortcuts.md +# - name: Parameters +# href: add-ons/pro-search/parameters.md +# - name: Filters +# href: add-ons/pro-search/filters.md +# - name: Tags +# href: add-ons/pro-search/tags.md +# - name: Examples +# href: add-ons/pro-search/examples.md +# - name: Find and Replace +# href: add-ons/pro-search/find-and-replace.md - name: Pro Search href: add-ons/pro-search.md - name: Pro Variables - href: add-ons/pro-search.md + href: add-ons/pro-variables.md - name: Query href: add-ons/query.md - name: Request @@ -87,26 +83,12 @@ href: add-ons/rss-parser.md - name: Rich Text Editor href: add-ons/rte.md - - name: Simple Commerce - items: - - name: Overview - href: add-ons/simple-commerce/index.md - - name: Control Panel - href: add-ons/simple-commerce/control-panel.md - - name: Email Templates - href: add-ons/simple-commerce/email-templates.md - - name: Instant Payment Notification - href: add-ons/simple-commerce/ipn.md - - name: Managing Store Items - href: add-ons/simple-commerce/items.md - - name: PayPal Settings - href: add-ons/simple-commerce/paypal-settings.md - - name: Managing Store Purchases - href: add-ons/simple-commerce/purchases.md - name: Spam href: add-ons/spam.md - name: Statistics href: add-ons/statistics.md + - name: Structure + href: add-ons/structure/overview.md - name: Emoticon (Deprecated) href: add-ons/emoticon.md