Joomla! Documentation - User contributions [en]

Plugin/Events/User

2018-07-01T00:16:22Z

Dextercowley:

<noinclude><languages /></noinclude>

<translate>

In a standard installation of Joomla! we have several predefined User events which, when triggered, call functions in the associated plugins.
</translate>

==onUserAuthorisation==
<translate>
===Description=== 
This event authorises that a particular user should be able to login.
The system triggers this event after the user has been authenticated and before he has been signed in the website. It is possible to be triggered by plugin types '''User''' and '''Authentication'''.
</translate>

<translate>
===Parameters=== 
* '''$user''' - an object [http://api.joomla.org/cms-3/classes/JAuthenticationResponse.html JAuthenticationResponse]
* '''$options''' - an associative array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string, ["action"] => string
</translate>

<translate>
===Return Value=== 
JAuthenticationResponse or NULL (NULL if you would like to miss the authorisation)
</translate>

<translate>===Used in files=== </translate>
*<tt>libraries/joomla/user/authentication.php</tt>

<translate>===Example=== </translate>
*<tt>[https://github.com/ITPrism/Plugin-User-FaceControl/blob/master/facecontrol.php Plugin User - Face Control]</tt>

==onUserAuthorisationFailure==
<translate>
===Description=== 
The system triggers this event when the user has been authenticated but he has not been authorised to login. You should only use this event in '''User''' plugins.
</translate>

<translate>
===Parameters=== 
* '''$user''' - an object [http://api.joomla.org/cms-3/classes/JAuthenticationResponse.html JAuthenticationResponse]
</translate>

<translate>
===Return Value=== 
void (it does not return any value or object)
</translate>

<translate>===Used in files=== </translate>
*<tt>libraries/cms/application/cms.php</tt>

==onUserLogin==
<translate>
===Description=== 
This event is triggered after the user is authenticated against the Joomla! user-base.


If you need to abort the login process (authentication), you will need to use [[Plugin/Events/Authentication#onUserAuthenticate|onUserAuthenticate]] instead.
</translate>

<translate>
===Parameters=== 
* '''$user''' - an associative array of [http://api.joomla.org/cms-3/classes/JAuthenticationResponse.html JAuthenticationResponse] type (see link for array keys)
* '''$options''' - an associative array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string
</translate>

<translate>
===Return Value=== 
Boolean
</translate>

<translate>===Used in files=== </translate>
*<tt>libraries/joomla/application/application.php</tt>
*<tt>plugins/user/joomla.php</tt>

<translate>===Example=== </translate>
*<tt>plugins/user/example.php</tt>

==onUserLogout==

<translate>
===Description=== 
This event is triggered before the user is logged out of the system.


If any plugin returns false, the global logout fails and the onUserLogoutFailure event is fired; if it succeeds, onUserAfterLogout event is triggered instead.


NOTE: as of 3.3.6, returning false does not work correctly, because stock components perform their logout operation during the onUserLogout event. So even if your plugin returns false, the stock ones have already run anyway. Thus, the user will be "mostly" logged out even if you return false. There is no actual way to cleanly abort logout.
</translate>

<translate>
===Parameters=== 
* '''$credentials''' - an associative array containing these keys: ["username"] => string, ["id"] => int
* '''$options''' - an associative array containing this key: ["clientid"] => int
</translate>

<translate>
===Return Value=== 
Boolean
</translate>

<translate>===Used in files=== </translate>
*<tt>libraries/cms/application/cms.php</tt>
*<tt>plugins/user/joomla/joomla.php</tt>
*<tt>plugins/system/logout.php</tt>
*<tt>plugins/system/remember/remember.php</tt>

<translate>===Example=== </translate>
*<tt>plugins/user/example.php</tt>

==onUserLoginFailure==

<translate>
===Description=== 
This event is triggered whenever a user authentication request is failed by any plugin.
</translate>

<translate>
===Parameters=== 
Two parameters. The credentials array for the user (see onAuthenticate), and the JAuthenticationResponse that caused the failure.
</translate>

<translate>
===Return Value=== 
Unknown. The return value appears to be ignored in any case.
</translate>

<translate>===Used in file=== </translate>
*<tt>libraries/joomla/application/user/authentication.php</tt>

==onUserAfterLogin==

<translate>
===Description=== 
This event is triggered whenever a user is successfully logged in.
</translate>

<translate>
===Parameters=== 
Options is array with:
</translate>
* remember
* return
* entry_url
* action
* user - JUser Object
* responseType

<translate>
===Return Value=== 
Boolean
</translate>

<translate>===Used in files=== </translate>
*<tt>libraries/legacy/application/application.php</tt>
*<tt>libraries/cms/application/cms.php</tt>
*<tt>plugins/authentication/cookie/cookie.php</tt>

==onUserBeforeSave==

<translate>
===Description=== 
This event is triggered before an update of a user record.


The old and new user parameters are provided; commonly-used members are: username, name, email, password, password_clear.


The password array entry is the hashed password value. If the user has just changed the password, you may retrieve the cleartext password from $newUser['password_clear']. (It will be set to "" if the password has not been changed.)
</translate>

<translate>
===Parameters=== 
* '''$oldUser''' - An associative array of the columns in the user table (current values).
* '''$isnew''' - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
* '''$newUser''' - An associative array of the columns in the user table (new values).
</translate>

<translate>
===Return Value=== 
Boolean. Whether the user-save should proceed or not. Any plugin that returns false aborts the save.
</translate>

<translate>===Used in file=== </translate>
*<tt>libraries/joomla/user/user.php</tt>

<translate>===Example=== </translate>
*<tt>plugins/user/example.php</tt>

==onUserAfterSave==

<translate>
===Description=== 
This event is triggered after an update of a user record, or when a new user has been stored in the database.


Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].
</translate>

<translate>
===Parameters=== 
* '''$user''' - An associative array of the columns in the user table.
* '''$isnew''' - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
* '''$success''' - Boolean to identify if the store was successful
* '''$msg''' - Error message if store failed
Note: The old values that were just updated are not available here or afterwards. In case you need the old values, use onBeforeStoreUser().
</translate>

<translate>
===Return Value=== 
None
</translate>

<translate>===Used in file=== </translate>
*<tt>libraries/joomla/user/user.php</tt>

<translate>===Example=== </translate>
*<tt>plugins/user/example.php</tt>

==onUserBeforeDelete==

<translate>
===Description=== 
The event is triggered when a user is about to be deleted from the system.
</translate>

<translate>
===Parameters=== 
* '''$user''' - An associative array of the columns in the user table.
</translate>

<translate>
===Return Value=== 
None. If you want to prevent the user from being deleted, you may abort the delete by redirecting back to the User Manager. For example:
<source lang="php">
if ($this->deleteNotAllowed($data))
{
$url = JRoute::_('index.php?option=com_users&view=users', false);
$msg = JText::sprintf('PLG_USER_DELETE_NOT_ALLOWED', $data['username']);
$app = Factory::getApplication();
$app->enqueueMessage($msg, 'error');
$app->redirect($url);
}
</source>
</translate>

<translate>===Used in files=== </translate>
*<tt>libraries/joomla/user/user.php</tt>
*<tt>plugins/user/joomla.php</tt>

<translate>===Example=== </translate>
*<tt>plugins/user/example.php</tt>

==onUserAfterDelete==

<translate>
===Description=== 
The event is triggered after a user has been deleted from the system.
</translate>

<translate>
===Parameters=== 
* '''$user''' - An associative array of the columns in the user table.
* '''$succes''' - Boolean to identify if the deletion was successful
* '''$msg''' - Error message if delete failed ([http://api.joomla.org/cms-3/classes/JError.html JError] object detailing the error, if any)
</translate>

<translate>
===Return Value=== 
None.
</translate>

<translate>
===Used in files=== 
</translate>
*<tt>libraries/joomla/user/user.php</tt>
*<tt>plugins/user/joomla.php</tt>

<translate>
===Example=== 
</translate>
*<tt>plugins/user/example.php</tt>

<translate>
==Order of execution== 
</translate>

<translate>
To modify Joomla! login process upon your needs (e.g. creating AJAX output for login), it may be useful to know the order of the events to be fired.</translate>

{| class="wikitable"
|-
! <translate>
Wrong credentials</translate> !! <translate>
CORRECT CREDENTIALS and the user is not blocked (is activated)</translate> !! <translate>
CORRECT CREDENTIALS and the user is blocked (is not activated)</translate>
|-
| <pre>
onUserAuthenticate
<translate>
returns
TRUE or FALSE</translate>
|
|
\ /
onUserLoginFailure</pre> || <pre>
onUserAuthenticate
<translate>
returns
TRUE or FALSE</translate>
|
|
\ /
onUserLogin <translate>
returns FALSE -> END
returns TRUE</translate>
|
|
\ /
onUserAfterLogin</pre> || <pre>
onUserAuthenticate
<translate>
returns
TRUE or FALSE</translate>
|
|
\ /
onUserLogin
<translate>
returns
TRUE or FALSE</translate>
|
|
\ /
END</pre>
|}

<translate>
'''Example idea'''</translate>
<translate>
Let's assume you want to preform Ajax login. You have already overriden a mod_login form so it's posted to Joomla! via an AJAX call. You added a field named '''ajax''' to the form.</translate>
<translate>
So when the form is posted and authentication is failed, your custom plugin must return some JSON data.</translate>

<source lang="php">
public function onUserLoginFailure($response)
{
$input = JFactory::getApplication()->input;

// If a non-ajax form was posted, we do not modify the behavior
if (!$input->post->get('ajax', false))
{
return;
}

$app = JFactory::getApplication();
$task_failed = false;

// Fill this array with the data you want to return, e.g. $response['status'] may be useful
// Check libraries/joomla/user/authentication.php for available status codes
$data = array('status' => $response['status']);

// At least here in the plugin it's a must to send proper headers
JFactory::getApplication()->setHeader('Content-Type', 'application/json', true)->sendHeaders();
echo new JResponseJson($data, $response['error_message'], $task_failed);

// Closing app is a must here to return JSON immideately
$app->close();
}
</source>

<noinclude>
<translate>

[[Category:Plugin Development]]
[[Category:Specifications]]
</translate>
</noinclude>

Deploying an Update Server

2013-11-12T00:27:07Z

Dextercowley: make it clear that client is required for modules

{{version/tutor|2.5,3.x}}

== Introduction ==
This tutorial is designed to teach developers how to create an update server for integration with the update system introduced in Joomla!. By adding an update server listing to your extension's manifest, developers enable users to update their extensions via the Extension Manager's Update (see [[Help25:Extensions Extension Manager Update|Joomla 2.5]] and [[Help31:Extensions Extension Manager Update|Joomla 3.x]] helpscreens) view with only a few clicks.

== Defining an update server ==
In order to use this feature, an update server must be defined in your extension's manifest. This definition can be used in all Joomla! 2.5 and newer compatible extensions but is not available for templates. You can use two options for your server type; collection or extension. These will be explained in detail shortly. This code should be added to the extension manifest file, within the root "extension" element. The update server is defined as follows for each type:

<source lang="xml">
<extension>
<...>
<updateservers>
<server type="collection">http://example.com/list.xml</server>
<server type="extension" priority="2" name="My Extension's Updates">http://example.com/extension.xml</server>
</updateservers>
</extension>
</source>

Multiple servers can be defined within the <updateservers> tag.

== Server types ==
=== Collection ===
The collection server type allows developers to define an extension's manifest to pull updates from a collection. This type of server can be used if the developer wants to define all of their extension's updates in a single file (not recommended) or if their extension has multiple sub-extensions which are not distributed or updated at the same time (such as a package extension type). The below example is the collection definition used by the updater when processing core Joomla! updates:

<source lang="xml">
<extensionset name="Joomla Core" description="Joomla! Core">
<extension name="Joomla" element="joomla" type="file" version="1.7.0" detailsurl="http://update.joomla.org/core/extension.xml"/>
</extensionset>
</source>

All definitions must be defined between <extensionset> tags in your collection manifest. The <extensionset> tag has two optional parameters; name and description. For each extension that this collection references, a separate <extension> tag is required. The <extension> tag has the following parameters, all of which are required for updates to properly process:

* '''name''' - The name of the extension
* '''element''' - The untranslated extension name i.e. mod_custom
* '''type''' - The extension type (component, module, plugin, etc.)
* '''version''' - The latest version of the extension
* '''detailsurl''' - The URL of the XML file which contains that extension's individual update definitions

=== Extension ===
The extension server type allows developers to define an extension's manifest to pull updates from a single extension's manifest. All collection manifests eventually point to this XML file. All updates in this file must be defined after an <updates> tag at the beginning of the file. The below example is the update definition for the Joomla! 1.7.0 release:

<source lang="xml">
<update>
<name>Joomla! 1.7</name>
<description>Joomla! 1.7 CMS</description>
<element>joomla</element>
<type>file</type>
<version>1.7.0</version>
<infourl title="Joomla!">http://www.joomla.org/</infourl>
<downloads>
<downloadurl type="full" format="zip">http://joomlacode.org/gf/download/frsrelease/15279/66552/Joomla_1.6.5_to_1.7.0_Package.zip</downloadurl>
</downloads>
<tags>
<tag>stable</tag>
</tags>
<maintainer>Sam Moffatt</maintainer>
<maintainerurl>http://sammoffatt.com.au</maintainerurl>
<section>Testing</section>
<targetplatform name="joomla" version="1.6"/>
</update>
</source>

The following section describes the elements of a single update entity.

* '''name''' - The name of the extension, this name will appear in the Name column of the Extension Manager's Update view (required)
* '''description''' - A short description of the extension (optional) -- if you choose to use <![CDATA[]]>, double-quotes will break the HTML formatting. Use single quotes with your HTML entities.
* '''element''' - The installed name of the extension (required). For plugins, this needs to be same as plugin attribute value for main file in plugin manifest. For <filename plugin="pluginname">pluginname.php</filename>, element value should be '''pluginname'''.
* '''type''' - The type of extension (component, module, plugin, etc.) (required)
* '''folder''' - Specific to plugins, this tag describes the type of plugin being updated (content, system, etc.) (required for plugins)
* '''client''' Required for modules as of 3.2.0. - The client ID of the extension, which can be found by looking inside the #__extensions table. To date, use 0 for "site" and 1 for "administrator". Plugins and front-end modules are automatically installed with a client of 0 (site), but you will need to specify the client in an update or it will default to 1 (administrator) and then found update would not be shown because it would not match any extension. Components are automatically installed with a client of 1, which is currently the default.
** ''Warning'': The tag name is <'''client'''> for Joomla! 2.5 and <'''client_id'''> for 1.6 and 1.7. If you use <client_id> (rather than <client>) on a 2.5 site, it will be ignored.
* '''version''' - The version of the release (required)
* '''infourl''' - A URL to point users to containing information about the update (optional) (In CMS 2.5, if set, this URL will be displayed in the update view)
* '''downloads''' - The section which lists all download locations
** '''downloadurl''' - The URL to download the extension from; the <downloadurl> tag has two required parameters:
*** '''type''' - The type of package (full or upgrade)
*** '''format''' - The format of the package (zip, tar, etc.)
* '''tags''' - Optional (unknown use)
* '''maintainer''' - The name of the extension maintainer (similar to the <author> tag in a manifest) (optional)
* '''maintainerurl''' - The website of the extension maintainer (similar to the <authorUrl> tag in a manifest) (optional)
* '''section''' - Optional (unknown use)
* '''targetplatform''' - A tag to define platform requirements, requires the following elements
** '''name''' - The name of the platform dependency; as of this writing, it should ONLY be "joomla"
** '''version''' - The version of Joomla! the extension supports
** '''min_dev_level''' and '''max_dev_level''' - These attributes were added in 3.0.1 to allow you to select a target platform based on the developer level ("z" in x.y.z). They are optional. You can specifiy either one or both. If omitted, all developer levels are matched. For example, the following matches versions 4.0.0 and 4.0.1. <code><targetplatform name="joomla" version="4.0" min_dev_level="0" max_dev_level="1"/></code>
*** '''Note:''' If your extension is Joomla! 2.5 and/or 3.1 compatible, you will be required to have separate <update> definitions for each version due to the manner in which the updater checks the version if you specify a number. However to show your extension on all Joomla versions that support automatic updates add <code><targetplatform name="joomla" version=".*"/></code>. If you want your extension to show on all {{JVer|3.x}} versions then rather than specifying a version in the version tag add in <code><targetplatform name="joomla" version="3.[012345]"/></code>. This will show the update to all 3.x versions.

A separate <update> definition will be required for each version of your extension you release.

The values of '''element''', '''type''', '''client_id''' and '''folder''' should match those in the table #__extensions.

'''Important for plugins:''' Plugins have to include <folder> and <client> elements to work properly

== Troubleshooting ==
* '''SQL update script is not executed during update.'''
:If the SQL update script (for example, in the folder <code>sql/updates/mysql</code>) does not get executed during the update process, it could be because there is no version number in the <code>#__schemas</code> table for this extension ''prior to the update''. This value is determined by the last script name in the SQL updates folder. If this value is blank, no SQL scripts will be executed during that update cycle. To make sure this value is set correctly, make sure you have a SQL script in this folder with its name as the version number (for example, 1.2.3.sql if the version is 1.2.3). The file can be empty or just have a SQL comment line. This should be done in the old version -- the one before the update. Alternatively, you can add this value to the <code>#__schemas</code> using a SQL query.

== Supporting Tools ==
Maintaining your update server files can be difficult depending on the manner in which you set up your files. An extension which can help you to maintain this is the Akeeba Release System, available free of charge from https://www.akeebabackup.com

== Contributors ==
*[[User:mbabker|Michael Babker]]
*[[User:Renekorss|Rene Korss]]
[[Category:Development]]

Bug Tracking Process

2013-11-10T17:27:28Z

Dextercowley: removed old 2.5 tracker

{{RightTOC|33%}}
This article documents the current Joomla! bug tracking process from the time a new bug is reported to the time it is closed.

Joomla! bugs are tracked in the follower tracker:
;*[http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemBrowse&tracker_id=8103 Joomla! CMS Issue Tracker] - Active.
:This is for issues with supported Joomla Versions. As of November 2013, this is version 2.5 and 3.2.

==Reporting Issues==

[[Image:ReportingIssues.png|1024px]]

The process is normally started in one of two ways: the bug is added to the respective tracker, or a user reports the bug in the [http://forum.joomla.org/viewforum.php?f=199 Joomla! Bug Forum] for the given maintenance release.

=== Issues reported on the forum ===

JBS members scan the forums to determine when issues need to be put into the tracker. If the issue can be reproduced, is clearly a bug, and there are step-by-step instructions for how to reproduce it, it can be entered into the tracker with a status of Confirmed. If it is not as clear-cut, it can be entered with a status of Open, so that other JBS members will know it needs further investigation.

=== Issues directly reported to the tracker ===

When an issue is added to the tracker, the status will be either
1. Open
2. Confirmed
3. or Pending
depending on the situation. If the issue needs more investigation, then it should be set to Open. If the issue (1) is a bug and (2) can be reproduced and (3) has good test instructions, it should be set to Confirmed. If it meets the three Confirmed criteria and also has a good patch attached, it should be set to Pending. See below for more information about the status codes.

=== Issue Priorities ===

Most issues are priority 3, or Normal. The artifacts are prioritized according to the following characteristics:

'''Critical (1):'''
The trunk is not working at all. Significant parts of the source are broken preventing key operations. Examples would be login, installation, extension installers, javascript errors that prevent you from moving a save or similar action, etc. Also includes the generation of Fatal PHP errors and major security issues in a prerelease (Security issues for a stable release should NOT be reported in the tracker but instead reported to the security team security@joomla.org).

'''Major (2):'''
Parts of the source are obstructing operation in a serious way or causing a major loss in advertised function. Examples would includes PHP notices and warnings and reported javascript errors. Major issues will also typically prevent the release cycle from moving from Beta to Release Candidate (RC), or Release Candidate to General Availability (GA).

'''Normal: (3)'''
Issues that are hindering advertised behavior but the application is still workable. Examples would include parameters not working as advertised, language files not loading as expected, etc.

'''Minor (4):'''
Minor loss of function and generally annoying behavior. May include less common platform or browser specific problems that while they may be technically major in those environments, they represent a minority. Also include missing translation strings.

'''Trivial (5):'''
Cosmetic problems, misspelled words, graphically misaligned object, less common issues with parameters, etc.

== Resolving Issues ==

The bug squad takes care of the Joomla releases. For example, that means getting the 3.0.1, 3.0.2, 3.0.3, 3.0.4 etc releases ready by fixing problems that come up. The idea is to make the release increasingly stable and take care of issues that come up. At the same time, it is vitally important not to break anything that is working. That's called software regression and it's not something you want at this stage.

In the trackers there are several common statuses, mainly: open, confirmed, pending, ready to commit.

* '''Open''' means it's reported, but it hasn't been determined for sure whether it is a real bug or not. Many Open issues are not actually bugs. If the issue fits into one of the categories below, then the status is changed as indicated and the bug is closed:
** Cannot be reproduced. We have tried the same thing the reported did but the software appears to work correctly. (In many cases, more information is needed to be able to reproduce a bug. See "Information Required" below.) Change status to '''Unable to confirm'''.
** Has already been reported in a different issue number. Change status to '''Duplicate report''' and add the number on the duplicates tab.
** Is a known limitation of the software. Change status to '''Known issue'''.
** Is a feature request, a mistake made by a user, or is the way the software is intended to work. Change status to '''Not a bug'''.
** Is a bug with an extension or some other external program or a server issue that will not be addressed. Change status to '''Not Joomla! core'''.
* '''Information Required''' is used if we need more information ''from the person who reported the issue'' to decide about the issue. For example, there are questions about how to reproduce the problem or other questions about the issue. If we get the information we need, then we can continue processing the issue. If we don't get the information within two weeks, then we can change the status to Unable to confirm (or another of the closed status codes if that is more applicable).
* '''Needs Review''' is used if we need a JBS Coordinator, Development Coordinator, or other experienced developer to review the issue. This is different from Information Required, which means that we need more information from the person who reported the issue.
* '''Started''' means that JBS has checked the issue, but is not quite sure if the issue is an actual bug (i.e. confirmed), and that there is discussion going on about the issue, which doesn't require additional information ''from the person who reported the issue''. It is a state that's between '''Opened''' and '''Confirmed'''.
* '''Confirmed''' means that JBS has confirmed that this issue is a bug in Joomla! that should be fixed. That's when the JBS tries to solve it or consults with the development team about a solution. ''At this point there should be clear step-by-step test instructions that indicate how to reproduce the problem. For version 1.6, use the Test Instructions field for this information.''
* '''Pending''' means that a patch has been submitted that a JBS member or development coordinator or appropriate leadership team member believes fixes the bug. If needed, additional test instructions are entered for the issue. Every Pending issue should have instructions that tell the tester how to reproduce the problem and make sure the patch fixes the problem.
* '''In Progress''' means that an issue is being worked on. This will most likely be a situation where the issue was set to Pending but there were problems with the patch that require additional work. It also may be a case where the issue is complex and will take some time to solve. JBS members can participate in In Progress issues but generally should not start coding before discussing with others working on the issue already.
* '''Ready to commit''' means that (in general) two separate people have successfully tested the same patch file, and it works correctly with the patch. Note that, for some issues that are more complex or higher impact, we may need more than two people to test or may need to test on multiple platforms. For simple issues, such as fixing typos in language strings or comments, one tester is enough.
* '''Fixed in SVN''' means that, after reviewing the code, the JBS commit coordinators have determined that the patch is good and the change has been committed to the Joomla! codebase. At this point, it will be part of the next Joomla! maintenance release.

The flowchart below provides a visual guide to how the process for resolving bugs works.

[[Image:ResolvingIssues.png|800px]]

You do ''not'' need to be a member of the JBS to help fix bugs in Joomla. Anyone can report bugs, test patches, or submit patches. If you want to help with resolving bugs, go to the [http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemBrowse&tracker_id=32 Tracker]. You can help resolve Open issues as outlined above. You can create and submit patches for Confirmed issues. Or you can help test Pending issues. To report about what you have done, login to joomlacode and add a comment. You'll be amazed at how much impact you can have and how good it feels to contribute to the Joomla! project.

If you have any questions, or are interested in joining the JBS, please contact the [http://community.joomla.org/magazine/author/75-mark-dexter.html JBS Coordinator].

<noinclude>[[Category:Development Working Group]][[Category:Bug Squad]]</noinclude>
[[Category:Working Groups]]
[[Category:Bug Tracker]]

Joomla 2.5 version history

2013-11-07T16:36:40Z

Dextercowley: add 2.5.15 and 2.5.16

== Joomla! 2.5.16 ==
* 06 Aug 2013
* [http://www.joomla.org/announcements/release-news/5518-joomla-2-5-16-released.html Release Notes]
* [http://joomlacode.org/gf/project/joomla/frs/?action=FrsReleaseBrowse&frs_package_id=6789 Package and MD5s]
* [[:Category: Version 2.5.16 FAQ|FAQ and known issues]]

== Joomla! 2.5.15 ==
* 06 Aug 2013
* [http://www.joomla.org/announcements/release-news/5517-joomla-2-5-15-released.html Release Notes]
* [http://joomlacode.org/gf/project/joomla/frs/?action=FrsReleaseBrowse&frs_package_id=6784 Package and MD5s]
* [[:Category: Version 2.5.15 FAQ|FAQ and known issues]]

== Joomla! 2.5.14 ==
* 01 Aug 2013
* [http://www.joomla.org/announcements/release-news/5506-joomla-2-5-14-released.html Release Notes]
* [http://joomlacode.org/gf/project/joomla/frs/?action=FrsReleaseBrowse&frs_package_id=6737 Package and MD5s]
* [[:Category: Version 2.5.14 FAQ|FAQ and known issues]]

== Joomla! 2.5.13 ==
* 25 July 2013
* [http://www.joomla.org/announcements/release-news/5503-joomla-2-5-13-released.html Release Notes]
* [http://joomlacode.org/gf/project/joomla/frs/?action=FrsReleaseBrowse&frs_package_id=6730 Package and MD5s]
* [[:Category: Version 2.5.13 FAQ|FAQ and known issues]]

== Joomla! 2.5.12 ==
* Joomla! version 2.5.12 was not publicly released.
* [[:Category: Version 2.5.12 FAQ|FAQ and known issues]]

== Joomla! 2.5.11 ==
* 26 April 2013
* [http://www.joomla.org/announcements/release-news/5498-joomla-2-5-11-released.html Release Notes]
* [http://joomlacode.org/gf/project/joomla/frs/?action=FrsReleaseBrowse&frs_package_id=6673 Package and MD5s]
* [[:Category: Version 2.5.11 FAQ|FAQ and known issues]]

== Joomla! 2.5.10 ==
* 24 April 2013
* [http://www.joomla.org/announcements/release-news/5493-joomla-2-5-10-released.html Release Notes]
* [http://joomlacode.org/gf/project/joomla/frs/?action=FrsReleaseBrowse&frs_package_id=6660 Package and MD5s]
* [[:Category: Version 2.5.10 FAQ|FAQ and known issues]]

== Joomla! 2.5.9 ==
* 4 February 2013
* [http://www.joomla.org/announcements/release-news/5477-joomla-2-5-9-released.html Release Notes]
* [http://joomlacode.org/gf/project/joomla/frs/?action=FrsReleaseBrowse&frs_package_id=6610 Package and MD5s]
* [[:Category: Version 2.5.9 FAQ|FAQ and known issues]]

== Joomla! 2.5.8 ==
* 8 November 2012
* [http://www.joomla.org/announcements/release-news/5470-joomla-2-5-8-released.html Release Notes]
* [http://joomlacode.org/gf/project/joomla/frs/?action=FrsReleaseBrowse&frs_package_id=6545 Package and MD5s]
* [[:Category: Version 2.5.8 FAQ|FAQ and known issues]]

== Joomla! 2.5.7 ==
* 13 September 2012
* [http://www.joomla.org/announcements/release-news/5463-joomla-2-5-7-released.html Release Notes]
* [http://joomlacode.org/gf/project/joomla/frs/?action=FrsReleaseBrowse&frs_package_id=6490 Package and MD5s]
* [[:Category: Version 2.5.7 FAQ|FAQ and known issues]]

== Joomla! 2.5.6 ==
* 19 June 2012
* [http://www.joomla.org/announcements/release-news/5428-joomla-256-released.html Release Notes]
* [http://joomlacode.org/gf/project/joomla/frs/?action=FrsReleaseBrowse&frs_package_id=6376 Package and MD5s]
* [[:Category: Version 2.5.6 FAQ|FAQ and known issues]]

== Joomla! 2.5.5 ==
* 18 June 2012
* [http://www.joomla.org/announcements/release-news/5427-joomla-255-released.html Release Notes]
* [http://joomlacode.org/gf/project/joomla/frs/?action=FrsReleaseBrowse&frs_package_id=6374 Package and MD5s]
* [[:Category: Version 2.5.5 FAQ|FAQ and known issues]]

== Joomla! 2.5.4 ==
* 2 April 2012
* [http://www.joomla.org/announcements/release-news/5418-joomla-254-released.html Release Notes]
* [http://joomlacode.org/gf/project/joomla/frs/?action=FrsReleaseBrowse&frs_package_id=6318 Package and MD5s]
* [[:Category: Version 2.5.4 FAQ|FAQ and known issues]]

== Joomla! 2.5.3 ==
* 15 March 2012
* [http://www.joomla.org/announcements/release-news/5416-joomla-253-released.html Release Notes]
* [http://joomlacode.org/gf/project/joomla/frs/?action=FrsReleaseBrowse&frs_package_id=6302 Package and MD5s]
* [[:Category: Version 2.5.3 FAQ|FAQ and known issues]]

== Joomla! 2.5.2 ==
* 5 March 2012
* [http://www.joomla.org/announcements/release-news/5415-joomla-252-released.html Release Notes]
* [http://joomlacode.org/gf/project/joomla/frs/?action=FrsReleaseBrowse&frs_package_id=6296 Package and MD5s]
* [[:Category: Version 2.5.2 FAQ|FAQ and known issues]]

== Joomla! 2.5.1 ==
* 2 February 2012
* [http://www.joomla.org/announcements/release-news/5410-joomla-251-released.html Release Notes]
* [http://joomlacode.org/gf/project/joomla/frs/?action=FrsReleaseBrowse&frs_package_id=6257 Package and MD5s]
* [[:Category: Version 2.5.1 FAQ|FAQ and known issues]]

== Joomla! 2.5.0 ==
* 24 January 2012
* [http://www.joomla.org/announcements/release-news/5403-joomla-250-released.html Release Notes]
* [http://joomlacode.org/gf/project/joomla/frs/?action=FrsReleaseBrowse&frs_package_id=6231 Package and MD5s]
* [[:Category: Version 2.5.0 FAQ|FAQ and known issues]]

[[Category:Joomla! 2.5]][[Category:Version_History]]

Using Content History in your Component

2013-11-03T22:13:52Z

Dextercowley: add link to final code

In version 3.2, Joomla added the ability to track content history (also called versions) for all core components. This allows you to view and restore from prior versions of an article, banner, category, and other content types. This feature can easily be added to third-party components. This tutorial shows you how to do this. We will illustrate this by adding content history to an example component.

'''Important Note:''' This tutorial assumes that the component uses a JTable sub-class for its "CRUD" (create/update/delete) operations. If the component does not use JTable then the simplest thing to do is to re-work it to use JTable's store() and delete() methods. If you do that, you will be able to use the methods described in this tutorial.

=Set up Working Environment=

# Install a new instance of Joomla version 3.2 on your local workstation.
# Install the example component using the file com_joomprosubs_3.2.0.zip in the Extension Manager: Install screen. You can get the ZIP archive here: https://github.com/joomla/jdoc-examples/raw/master/zip_archives/com_joomprosubs-3.2.0.zip.

At this point, you should be able to see the Joompro Subscriptions component in the Components menu in the back end of Joomla. This is the component before we have added content history to it.

=Add Rows to Content Types Table=
The first thing we need to do is to add two new rows into the #__content_types table. This table stores information about the different tables for each content type. As of Joomla version 3.2, this table is used by the com_tags and com_contenthistory components to get information about each content type for which history is stored. The columns for #__content_types are as follows:

*'''type_id:''' auto-increment id number.
*'''type_title:''' descriptive title for this table.
*'''type_alias:''' <component name>.<type name>. For example: "com_content.article" or "com_content.category".
*'''table:''' JSON string that contains the name of the JTable class and other information about the table.
*'''rules:''' Not used as of Joomla version 3.2.
*'''field_mappings:''' Used by the com_tags component to map database columns from the component table to the ucm_content table.
*'''router:''' Optional location of the component's router, if any.
*'''content_history_options:''' JSON string used to store information for rendering the pop-up windows in the content history component. We will discuss this in detail later in this tutorial.

Our example component uses a table called #__joompro_subscriptions to store each subscription. In addition, it uses the standard Joomla categories. So we will add a row in #__content_types for the category table and one for the component table.

The row for the categories can be copied from the row for "Weblinks Category" (or any other category row). The only columns that need to be changed are <code>type_title</code> and <code>type_alias</code>. The other columns are the same as for <code>com_weblinks.category</code>.

The SQL statement for adding this row is as follows:

<code>INSERT INTO `#__content_types` (`type_id`, `type_title`, `type_alias`, `table`, `rules`, `field_mappings`, `router`, `content_history_options`)
VALUES
(null,
'Subscription Category',
'com_joomprosubs.category',
'{"special":{"dbtable":"#__categories","key":"id","type":"Category","prefix":"JTable","config":"array()"},"common": {"dbtable":"#__ucm_content","key":"ucm_id","type":"Corecontent","prefix":"JTable","config":"array()"}}',
'',
'{"common":{"core_content_item_id":"id","core_title":"title","core_state":"published","core_alias":"alias","core_created_time":"created_time","core_modified_time":"modified_time","core_body":"description", "core_hits":"hits","core_publish_up":"null","core_publish_down":"null","core_access":"access", "core_params":"params", "core_featured":"null", "core_metadata":"metadata", "core_language":"language", "core_images":"null", "core_urls":"null", "core_version":"version", "core_ordering":"null", "core_metakey":"metakey", "core_metadesc":"metadesc", "core_catid":"parent_id", "core_xreference":"null", "asset_id":"asset_id"}, "special":{"parent_id":"parent_id","lft":"lft","rgt":"rgt","level":"level","path":"path","extension":"extension","note":"note"}}',
'WeblinksHelperRoute::getCategoryRoute',
'{"formFile":"administrator\\/components\\/com_categories\\/models\\/forms\\/category.xml", "hideFields":["asset_id","checked_out","checked_out_time","version","lft","rgt","level","path","extension"], "ignoreChanges":["modified_user_id", "modified_time", "checked_out", "checked_out_time", "version", "hits", "path"],"convertToInt":["publish_up", "publish_down"], "displayLookup":[{"sourceColumn":"created_user_id","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},{"sourceColumn":"access","targetTable":"#__viewlevels","targetColumn":"id","displayColumn":"title"},{"sourceColumn":"modified_user_id","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},{"sourceColumn":"parent_id","targetTable":"#__categories","targetColumn":"id","displayColumn":"title"}]}');</code>

For the actual subscriptions, we only need the following information in the content types table:

*'''type_title:''' <code>Subscriptions</code>
*'''type_alias:''' <code>com_joomprosubs.subscription</code>
*'''table:''' <code>{"special":{"dbtable":"#__joompro_subscriptions","key":"id","type":"Subscription","prefix":"JoomprosubsTable"}}</code>. This creates a JSON object as follows:
:special:
::dbtable = #__joompro_subscriptions
::key = id
::type = Subscription
::prefix = JoomprosubsTable

The <code>type_alias</code> column is used by the com_contenthistory component to find the row for each component in the #__content_types table. The <code>table</code> column gives the com_contenthistory component the information it needs to work with the JTable class for each component. The None of the other columns need to be set for now. Note that we will come back to the <code>content_history_options</code> column later in the tutorial to improve the appearance of the pop-up window.

The SQL for adding this second row to the #__content_types table is as follows:

<code>INSERT INTO `#__content_types` (`type_id`, `type_title`, `type_alias`, `table`, `rules`, `field_mappings`, `router`, `content_history_options`)
VALUES
(null,
'Subscriptions',
'com_joomprosubs.subscription',
'{"special":{"dbtable":"#__joompro_subscriptions","key":"id","type":"Subscription","prefix":"JoomprosubsTable"}}',
'', '', '', '');
</code>

These lines should be added to the file <code>administrator/components/com_joomprosubs/sql/install.mysql.utf8.sql</code> so that these rows will be created when the component is installed. You should also run these commands on your database to add the two rows to your #__content_types table before going to the next section. Remember to change the placeholder prefix "#__" to the actual prefix for your database before running the SQL commands on your local database.

'''Tip:''' When creating the values for the JSON strings, one trick is to copy from an existing row and edit the strings.

=Add Component Level Options=
The content history component uses two options as follows.
*'''save_history:''' If Yes, history is saved. Otherwise, no history is saved.
*'''history_limit:''' If > 0, limits the number of different history versions saved in the database. For example, if this is set to 10, then when the 11th history version is saved, the oldest is deleted automatically.

If our example component, we will add the following lines to the file <code>administrator/components/com_joomprosubs/config.xml</code>.

<source lang="xml">

<fieldset name="component">
<field
name="save_history"
type="radio"
class="btn-group btn-group-yesno"
default="1"
label="JGLOBAL_SAVE_HISTORY_OPTIONS_LABEL"
description="JGLOBAL_SAVE_HISTORY_OPTIONS_DESC"
>
<option
value="0">JNO</option>
<option
value="1">JYES</option>
</field>

<field
name="history_limit"
type="text"
filter="integer"
label="JGLOBAL_HISTORY_LIMIT_OPTIONS_LABEL"
description="JGLOBAL_HISTORY_LIMIT_OPTIONS_DESC"
default="5"
/>
</fieldset>
</source>
With this code, we will now be able to add and save these options. Go into the Options for the component and set save_history to Yes and history_limit to 10.

=Update Content History During Table Save and Delete=
Next we need to tell our component to call the content history methods during the save and delete operations. We can do this by adding this line of code to the <code>__construct()</code> method of the <code>JoomprosubsTableSubscription</code> class.

<source lang="php">
JObserverMapper::addObserverClassToClass('JTableObserverContenthistory', 'JoomprosubsTableSubscription', array('typeAlias' => 'com_joomprosubs.subscription'));
</source>

This code registers the content history table as an observer class for our component table. When a row is saved or deleted from our table, the appropriate methods are called automatically for the content history table.

At this point, we should be able to see content history working for the Joomprosubs categories. Test this by adding a new category for the component and then clicking on the Versions button in the toolbar. It should work exactly the same as categories for the core Joomla components.

=Add Versions Button to Tool Bar=
At this point, categories are working completely and we are saving history versions in the #__ucm_history table for our component. However, we need to be able to access these changes on our edit screen. To do this, we need to add the Versions button to the edit screen's toolbar. We do this by adding this code to the file <code>administrator/components/com_joomprosubs/views/subscription/view.html.php</code>, just before the code that adds the "cancel" button, as shown here.

<source lang="php">
else {
if ($this->state->params->get('save_history', 1) && $user->authorise('core.edit')) {
JToolbarHelper::versions('com_joomprosubs.subscription', $this->item->id);
}
JToolBarHelper::cancel('subscription.cancel', 'JTOOLBAR_CLOSE');
}
</source>

This code checks that we have the save_history option set and that we have edit permission for this component. If so, we show the Versions button using the <code>JToolbarHelper::versions()</code> method. This method has two arguments: the type_alias and the primary key of the component item row in the database.

With this code added, we can now go into the Joomprosubs component, add and save a new subscription, and now see the Versions button. If we click on it, we will see the Item Version History modal window open with our saved version.

There are still two things missing, however. One is that we don't have a way to add the Version Note to each version. The second is that we don't currently have meaningful labels for the versions when we use the Preview or Compare features. We will address these in the next two sections of this tutorial.

=Add Version Note Field to Form=
The content history feature adds a new field called "version_note" to the component edit form. This optional field is not saved in the component table. Instead, it is used to label the version in the content history table.

To add this field to our component edit screen, we do changes to two files. First, we add the field to the XML form file <code>administrator/components/com_joomprosubs/models/forms/subscription.xml</code> as follows:

<source lang="xml">
<field name="version_note"
type="text"
label="JGLOBAL_FIELD_VERSION_NOTE_LABEL"
description="JGLOBAL_FIELD_VERSION_NOTE_DESC"
class="inputbox" size="45"
labelclass="control-label"
/>
</source>

We can add it anywhere inside the fieldset element. Because we will place the field "created_by_alias" on the screen, we add it in the XML file after this element.

Second, we add this code to the file <code>administrator/components/com_joomprosubs/views/subscription/tmpl/edit.php</code>, just after the control group for "created_by_alias", as follows:

<source lang="php">
<div class="control-group">
<div class="control-label"><?php echo $this->form->getLabel('version_note'); ?></div>
<div class="controls"><?php echo $this->form->getInput('version_note'); ?></div>
</div>
</source>

Now we can add in a version note and see this in the Item Version History modal window.

=Add Labels to Pop-Up Windows=
At this point, everything works. However, when we use the pop-up Preview or Compare windows in the Item Version History modal, we see the database column names instead of the translated label from the form. Also, we see the category and user id numbers instead of the category name and user name.

We can improve the readability of windows by entering in some additional about our component's table. This information is entered as a JSON-formatted string in the content_history_options column of the #__content_types table. The following information can be entered in this column.
*'''formfile:''' This is the path to the XML JForm file for this form. If you add this, the Preview and Compare views will look up the labels from this XML file. This way the user will see translated labels instead of the database column name.
*'''hideFields:''' Some database columns are not meaningful for the user when viewing the item. For example, asset_id or check_out_time are not things that appear in the form and are not helpful to the user when figuring out the contents of an item. This is entered as an array of column names.
*'''ignoreChanges:''' The content history component uses a "hash" calculation (Sha1) to determine whether an item has changed. This allows you to see which version in history matches the current version. It also prevents duplicate versions from being saved in the content history table (for example, if you press the "save" button without making any changes). For this to work properly, we need to exclude some columns from the hash calculate. The "ignoreChanges" lets you exclude some database columns from the hash so that changes to these columns will not be considered real changes to the item. For example, columns such as "hits" or "modified_time" will change with each save, even if no meaningful data was changed in the item. This is an array of database column names.
*'''convertToInt:''' When the hash value is created, it uses a JSON array of the database column values. In some cases, such as start and stop publishing dates, the value might be blank when a row is first created and then a different value after the item is saved. To get a consistent hash value for the first and subsequent saves, these values can be converted to integers before the hash is created. That way, we don't think a value has changed when it really hasn't. This is an array of database column names.
*'''displayLookup:''' Here we can define how to display more meaningful data, for example, displaying a category title or user name instead of the ID. This is stored as an array of PHP standard class objects. Each object has the following fields.
:*''sourceColumn:'' The column in the form to replace. For example, the "created_user_id" or "catid".
:*''targetTable:'' The database table to get the title or name. For example, "#__users" or "#__categories".
:*''targetColumn:'' The column in the target table to use in the SQL query JOIN statement. For example, "id".
:*''displayColumn:'' The column in the target table to display in the Preview or Compare pop-up window. For example, "name" or "title".

In our example component, we need the following values.
*'''formfile:''' <code>administrator/components/com_joomprosubs/models/forms/subscription.xml</code>.
*'''hideFields:''' checked_out, checked_out_time, params, langauge. The last two columns are not used.
*'''ignoreChanges:''' modified_by, modified, checked_out, checked_out_time.
*'''convertToInt:''' publish_up, publish_down.
*'''displayLookup:''' We look up five fields: catid, group_id, created_by, access, and modified_by. The values for each are as follows.
:*''sourceColumn:'' catid
:*''targetTable:'' #__categories
:*''targetColumn:'' id
:*''displayColumn:'' title

:*''sourceColumn:'' group_id
:*''targetTable:'' #__usergroups
:*''targetColumn:'' id
:*''displayColumn:'' title

:*''sourceColumn:'' created_by
:*''targetTable:'' #__users
:*''targetColumn:'' id
:*''displayColumn:'' name

:*''sourceColumn:'' access
:*''targetTable:'' #__viewlevels
:*''targetColumn:'' id
:*''displayColumn:'' title

:*''sourceColumn:'' modified_by
:*''targetTable:'' #__users
:*''targetColumn:'' id
:*''displayColumn:'' name

The entire JSON string for this column is as follows.

<source>
{"formFile":"administrator\/components\/com_joomprosubs\/models\/forms\/subscription.xml",
"hideFields":["checked_out","checked_out_time","params","language"],
"ignoreChanges":["modified_by", "modified", "checked_out", "checked_out_time"],
"convertToInt":["publish_up", "publish_down"],
"displayLookup":[
{"sourceColumn":"catid","targetTable":"#__categories","targetColumn":"id","displayColumn":"title"},
{"sourceColumn":"group_id","targetTable":"#__usergroups","targetColumn":"id","displayColumn":"title"},
{"sourceColumn":"created_by","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},
{"sourceColumn":"access","targetTable":"#__viewlevels","targetColumn":"id","displayColumn":"title"},
{"sourceColumn":"modified_by","targetTable":"#__users","targetColumn":"id","displayColumn":"name"} ]}
</source>

Note that the slashes are escaped inside the JSON string. In order to get this column correctly into the database when our component is installed, we need to modify the file <code>administrator/components/com_joomprosubs/sql/install.mysql.utf8.sql</code> where we create the #__content_types for for the component as follows:

<source lang="sql">
INSERT INTO `#__content_types` (`type_id`, `type_title`, `type_alias`, `table`, `rules`, `field_mappings`, `router`, `content_history_options`) VALUES
(null, 'Subscriptions', 'com_joomprosubs.subscription', '{"special":{"dbtable":"#__joompro_subscriptions","key":"id","type":"Subscription","prefix":"JoomprosubsTable"}}', '', '', '', '{"formFile":"administrator\\/components\\/com_joomprosubs\\/models\\/forms\\/subscription.xml", "hideFields":["checked_out","checked_out_time","params","language"], "ignoreChanges":["modified_by", "modified", "checked_out", "checked_out_time"], "convertToInt":["publish_up", "publish_down"], "displayLookup":[{"sourceColumn":"catid","targetTable":"#__categories","targetColumn":"id","displayColumn":"title"},{"sourceColumn":"group_id","targetTable":"#__usergroups","targetColumn":"id","displayColumn":"title"},{"sourceColumn":"created_by","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},{"sourceColumn":"access","targetTable":"#__viewlevels","targetColumn":"id","displayColumn":"title"},{"sourceColumn":"modified_by","targetTable":"#__users","targetColumn":"id","displayColumn":"name"} ]}');
</source>

Note that the "/" characters are now preceeded by two escape "\" characters. The first one is the SQL escape character for the second "\" character. The second "\" is the JSON escape character for the "/" character.

With this change to the SQL install file, the changes for content history are complete.

=Update Extension SQL Files=
To tidy things up, should should edit the uninstall SQL file to remove the rows from the #__content_types table. Also, if your component uses the one-click update feature, you should create a SQL file to create these rows when the component is updated.

Hopefully, this tutorial will help you as you update your component to take advantage of the content history feature in Joomla. You can download the com_joomprosubs component with the code for content history added here: https://github.com/joomla/jdoc-examples/raw/master/zip_archives/com_joomprosubs-3.2.1.zip.

[[Category:Development]][[Category:Content History]]
[[Category:Tutorials]]

Using Content History in your Component

2013-11-03T22:11:47Z

Dextercowley: Update link for zip file.

In version 3.2, Joomla added the ability to track content history (also called versions) for all core components. This allows you to view and restore from prior versions of an article, banner, category, and other content types. This feature can easily be added to third-party components. This tutorial shows you how to do this. We will illustrate this by adding content history to an example component.

'''Important Note:''' This tutorial assumes that the component uses a JTable sub-class for its "CRUD" (create/update/delete) operations. If the component does not use JTable then the simplest thing to do is to re-work it to use JTable's store() and delete() methods. If you do that, you will be able to use the methods described in this tutorial.

=Set up Working Environment=

# Install a new instance of Joomla version 3.2 on your local workstation.
# Install the example component using the file com_joomprosubs_3.2.0.zip in the Extension Manager: Install screen. You can get the ZIP archive here: https://github.com/joomla/jdoc-examples/raw/master/zip_archives/com_joomprosubs-3.2.0.zip.

At this point, you should be able to see the Joompro Subscriptions component in the Components menu in the back end of Joomla. This is the component before we have added content history to it.

=Add Rows to Content Types Table=
The first thing we need to do is to add two new rows into the #__content_types table. This table stores information about the different tables for each content type. As of Joomla version 3.2, this table is used by the com_tags and com_contenthistory components to get information about each content type for which history is stored. The columns for #__content_types are as follows:

*'''type_id:''' auto-increment id number.
*'''type_title:''' descriptive title for this table.
*'''type_alias:''' <component name>.<type name>. For example: "com_content.article" or "com_content.category".
*'''table:''' JSON string that contains the name of the JTable class and other information about the table.
*'''rules:''' Not used as of Joomla version 3.2.
*'''field_mappings:''' Used by the com_tags component to map database columns from the component table to the ucm_content table.
*'''router:''' Optional location of the component's router, if any.
*'''content_history_options:''' JSON string used to store information for rendering the pop-up windows in the content history component. We will discuss this in detail later in this tutorial.

Our example component uses a table called #__joompro_subscriptions to store each subscription. In addition, it uses the standard Joomla categories. So we will add a row in #__content_types for the category table and one for the component table.

The row for the categories can be copied from the row for "Weblinks Category" (or any other category row). The only columns that need to be changed are <code>type_title</code> and <code>type_alias</code>. The other columns are the same as for <code>com_weblinks.category</code>.

The SQL statement for adding this row is as follows:

<code>INSERT INTO `#__content_types` (`type_id`, `type_title`, `type_alias`, `table`, `rules`, `field_mappings`, `router`, `content_history_options`)
VALUES
(null,
'Subscription Category',
'com_joomprosubs.category',
'{"special":{"dbtable":"#__categories","key":"id","type":"Category","prefix":"JTable","config":"array()"},"common": {"dbtable":"#__ucm_content","key":"ucm_id","type":"Corecontent","prefix":"JTable","config":"array()"}}',
'',
'{"common":{"core_content_item_id":"id","core_title":"title","core_state":"published","core_alias":"alias","core_created_time":"created_time","core_modified_time":"modified_time","core_body":"description", "core_hits":"hits","core_publish_up":"null","core_publish_down":"null","core_access":"access", "core_params":"params", "core_featured":"null", "core_metadata":"metadata", "core_language":"language", "core_images":"null", "core_urls":"null", "core_version":"version", "core_ordering":"null", "core_metakey":"metakey", "core_metadesc":"metadesc", "core_catid":"parent_id", "core_xreference":"null", "asset_id":"asset_id"}, "special":{"parent_id":"parent_id","lft":"lft","rgt":"rgt","level":"level","path":"path","extension":"extension","note":"note"}}',
'WeblinksHelperRoute::getCategoryRoute',
'{"formFile":"administrator\\/components\\/com_categories\\/models\\/forms\\/category.xml", "hideFields":["asset_id","checked_out","checked_out_time","version","lft","rgt","level","path","extension"], "ignoreChanges":["modified_user_id", "modified_time", "checked_out", "checked_out_time", "version", "hits", "path"],"convertToInt":["publish_up", "publish_down"], "displayLookup":[{"sourceColumn":"created_user_id","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},{"sourceColumn":"access","targetTable":"#__viewlevels","targetColumn":"id","displayColumn":"title"},{"sourceColumn":"modified_user_id","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},{"sourceColumn":"parent_id","targetTable":"#__categories","targetColumn":"id","displayColumn":"title"}]}');</code>

For the actual subscriptions, we only need the following information in the content types table:

*'''type_title:''' <code>Subscriptions</code>
*'''type_alias:''' <code>com_joomprosubs.subscription</code>
*'''table:''' <code>{"special":{"dbtable":"#__joompro_subscriptions","key":"id","type":"Subscription","prefix":"JoomprosubsTable"}}</code>. This creates a JSON object as follows:
:special:
::dbtable = #__joompro_subscriptions
::key = id
::type = Subscription
::prefix = JoomprosubsTable

The <code>type_alias</code> column is used by the com_contenthistory component to find the row for each component in the #__content_types table. The <code>table</code> column gives the com_contenthistory component the information it needs to work with the JTable class for each component. The None of the other columns need to be set for now. Note that we will come back to the <code>content_history_options</code> column later in the tutorial to improve the appearance of the pop-up window.

The SQL for adding this second row to the #__content_types table is as follows:

<code>INSERT INTO `#__content_types` (`type_id`, `type_title`, `type_alias`, `table`, `rules`, `field_mappings`, `router`, `content_history_options`)
VALUES
(null,
'Subscriptions',
'com_joomprosubs.subscription',
'{"special":{"dbtable":"#__joompro_subscriptions","key":"id","type":"Subscription","prefix":"JoomprosubsTable"}}',
'', '', '', '');
</code>

These lines should be added to the file <code>administrator/components/com_joomprosubs/sql/install.mysql.utf8.sql</code> so that these rows will be created when the component is installed. You should also run these commands on your database to add the two rows to your #__content_types table before going to the next section. Remember to change the placeholder prefix "#__" to the actual prefix for your database before running the SQL commands on your local database.

'''Tip:''' When creating the values for the JSON strings, one trick is to copy from an existing row and edit the strings.

=Add Component Level Options=
The content history component uses two options as follows.
*'''save_history:''' If Yes, history is saved. Otherwise, no history is saved.
*'''history_limit:''' If > 0, limits the number of different history versions saved in the database. For example, if this is set to 10, then when the 11th history version is saved, the oldest is deleted automatically.

If our example component, we will add the following lines to the file <code>administrator/components/com_joomprosubs/config.xml</code>.

<source lang="xml">

<fieldset name="component">
<field
name="save_history"
type="radio"
class="btn-group btn-group-yesno"
default="1"
label="JGLOBAL_SAVE_HISTORY_OPTIONS_LABEL"
description="JGLOBAL_SAVE_HISTORY_OPTIONS_DESC"
>
<option
value="0">JNO</option>
<option
value="1">JYES</option>
</field>

<field
name="history_limit"
type="text"
filter="integer"
label="JGLOBAL_HISTORY_LIMIT_OPTIONS_LABEL"
description="JGLOBAL_HISTORY_LIMIT_OPTIONS_DESC"
default="5"
/>
</fieldset>
</source>
With this code, we will now be able to add and save these options. Go into the Options for the component and set save_history to Yes and history_limit to 10.

=Update Content History During Table Save and Delete=
Next we need to tell our component to call the content history methods during the save and delete operations. We can do this by adding this line of code to the <code>__construct()</code> method of the <code>JoomprosubsTableSubscription</code> class.

<source lang="php">
JObserverMapper::addObserverClassToClass('JTableObserverContenthistory', 'JoomprosubsTableSubscription', array('typeAlias' => 'com_joomprosubs.subscription'));
</source>

This code registers the content history table as an observer class for our component table. When a row is saved or deleted from our table, the appropriate methods are called automatically for the content history table.

At this point, we should be able to see content history working for the Joomprosubs categories. Test this by adding a new category for the component and then clicking on the Versions button in the toolbar. It should work exactly the same as categories for the core Joomla components.

=Add Versions Button to Tool Bar=
At this point, categories are working completely and we are saving history versions in the #__ucm_history table for our component. However, we need to be able to access these changes on our edit screen. To do this, we need to add the Versions button to the edit screen's toolbar. We do this by adding this code to the file <code>administrator/components/com_joomprosubs/views/subscription/view.html.php</code>, just before the code that adds the "cancel" button, as shown here.

<source lang="php">
else {
if ($this->state->params->get('save_history', 1) && $user->authorise('core.edit')) {
JToolbarHelper::versions('com_joomprosubs.subscription', $this->item->id);
}
JToolBarHelper::cancel('subscription.cancel', 'JTOOLBAR_CLOSE');
}
</source>

This code checks that we have the save_history option set and that we have edit permission for this component. If so, we show the Versions button using the <code>JToolbarHelper::versions()</code> method. This method has two arguments: the type_alias and the primary key of the component item row in the database.

With this code added, we can now go into the Joomprosubs component, add and save a new subscription, and now see the Versions button. If we click on it, we will see the Item Version History modal window open with our saved version.

There are still two things missing, however. One is that we don't have a way to add the Version Note to each version. The second is that we don't currently have meaningful labels for the versions when we use the Preview or Compare features. We will address these in the next two sections of this tutorial.

=Add Version Note Field to Form=
The content history feature adds a new field called "version_note" to the component edit form. This optional field is not saved in the component table. Instead, it is used to label the version in the content history table.

To add this field to our component edit screen, we do changes to two files. First, we add the field to the XML form file <code>administrator/components/com_joomprosubs/models/forms/subscription.xml</code> as follows:

<source lang="xml">
<field name="version_note"
type="text"
label="JGLOBAL_FIELD_VERSION_NOTE_LABEL"
description="JGLOBAL_FIELD_VERSION_NOTE_DESC"
class="inputbox" size="45"
labelclass="control-label"
/>
</source>

We can add it anywhere inside the fieldset element. Because we will place the field "created_by_alias" on the screen, we add it in the XML file after this element.

Second, we add this code to the file <code>administrator/components/com_joomprosubs/views/subscription/tmpl/edit.php</code>, just after the control group for "created_by_alias", as follows:

<source lang="php">
<div class="control-group">
<div class="control-label"><?php echo $this->form->getLabel('version_note'); ?></div>
<div class="controls"><?php echo $this->form->getInput('version_note'); ?></div>
</div>
</source>

Now we can add in a version note and see this in the Item Version History modal window.

=Add Labels to Pop-Up Windows=
At this point, everything works. However, when we use the pop-up Preview or Compare windows in the Item Version History modal, we see the database column names instead of the translated label from the form. Also, we see the category and user id numbers instead of the category name and user name.

We can improve the readability of windows by entering in some additional about our component's table. This information is entered as a JSON-formatted string in the content_history_options column of the #__content_types table. The following information can be entered in this column.
*'''formfile:''' This is the path to the XML JForm file for this form. If you add this, the Preview and Compare views will look up the labels from this XML file. This way the user will see translated labels instead of the database column name.
*'''hideFields:''' Some database columns are not meaningful for the user when viewing the item. For example, asset_id or check_out_time are not things that appear in the form and are not helpful to the user when figuring out the contents of an item. This is entered as an array of column names.
*'''ignoreChanges:''' The content history component uses a "hash" calculation (Sha1) to determine whether an item has changed. This allows you to see which version in history matches the current version. It also prevents duplicate versions from being saved in the content history table (for example, if you press the "save" button without making any changes). For this to work properly, we need to exclude some columns from the hash calculate. The "ignoreChanges" lets you exclude some database columns from the hash so that changes to these columns will not be considered real changes to the item. For example, columns such as "hits" or "modified_time" will change with each save, even if no meaningful data was changed in the item. This is an array of database column names.
*'''convertToInt:''' When the hash value is created, it uses a JSON array of the database column values. In some cases, such as start and stop publishing dates, the value might be blank when a row is first created and then a different value after the item is saved. To get a consistent hash value for the first and subsequent saves, these values can be converted to integers before the hash is created. That way, we don't think a value has changed when it really hasn't. This is an array of database column names.
*'''displayLookup:''' Here we can define how to display more meaningful data, for example, displaying a category title or user name instead of the ID. This is stored as an array of PHP standard class objects. Each object has the following fields.
:*''sourceColumn:'' The column in the form to replace. For example, the "created_user_id" or "catid".
:*''targetTable:'' The database table to get the title or name. For example, "#__users" or "#__categories".
:*''targetColumn:'' The column in the target table to use in the SQL query JOIN statement. For example, "id".
:*''displayColumn:'' The column in the target table to display in the Preview or Compare pop-up window. For example, "name" or "title".

In our example component, we need the following values.
*'''formfile:''' <code>administrator/components/com_joomprosubs/models/forms/subscription.xml</code>.
*'''hideFields:''' checked_out, checked_out_time, params, langauge. The last two columns are not used.
*'''ignoreChanges:''' modified_by, modified, checked_out, checked_out_time.
*'''convertToInt:''' publish_up, publish_down.
*'''displayLookup:''' We look up five fields: catid, group_id, created_by, access, and modified_by. The values for each are as follows.
:*''sourceColumn:'' catid
:*''targetTable:'' #__categories
:*''targetColumn:'' id
:*''displayColumn:'' title

:*''sourceColumn:'' group_id
:*''targetTable:'' #__usergroups
:*''targetColumn:'' id
:*''displayColumn:'' title

:*''sourceColumn:'' created_by
:*''targetTable:'' #__users
:*''targetColumn:'' id
:*''displayColumn:'' name

:*''sourceColumn:'' access
:*''targetTable:'' #__viewlevels
:*''targetColumn:'' id
:*''displayColumn:'' title

:*''sourceColumn:'' modified_by
:*''targetTable:'' #__users
:*''targetColumn:'' id
:*''displayColumn:'' name

The entire JSON string for this column is as follows.

<source>
{"formFile":"administrator\/components\/com_joomprosubs\/models\/forms\/subscription.xml",
"hideFields":["checked_out","checked_out_time","params","language"],
"ignoreChanges":["modified_by", "modified", "checked_out", "checked_out_time"],
"convertToInt":["publish_up", "publish_down"],
"displayLookup":[
{"sourceColumn":"catid","targetTable":"#__categories","targetColumn":"id","displayColumn":"title"},
{"sourceColumn":"group_id","targetTable":"#__usergroups","targetColumn":"id","displayColumn":"title"},
{"sourceColumn":"created_by","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},
{"sourceColumn":"access","targetTable":"#__viewlevels","targetColumn":"id","displayColumn":"title"},
{"sourceColumn":"modified_by","targetTable":"#__users","targetColumn":"id","displayColumn":"name"} ]}
</source>

Note that the slashes are escaped inside the JSON string. In order to get this column correctly into the database when our component is installed, we need to modify the file <code>administrator/components/com_joomprosubs/sql/install.mysql.utf8.sql</code> where we create the #__content_types for for the component as follows:

<source lang="sql">
INSERT INTO `#__content_types` (`type_id`, `type_title`, `type_alias`, `table`, `rules`, `field_mappings`, `router`, `content_history_options`) VALUES
(null, 'Subscriptions', 'com_joomprosubs.subscription', '{"special":{"dbtable":"#__joompro_subscriptions","key":"id","type":"Subscription","prefix":"JoomprosubsTable"}}', '', '', '', '{"formFile":"administrator\\/components\\/com_joomprosubs\\/models\\/forms\\/subscription.xml", "hideFields":["checked_out","checked_out_time","params","language"], "ignoreChanges":["modified_by", "modified", "checked_out", "checked_out_time"], "convertToInt":["publish_up", "publish_down"], "displayLookup":[{"sourceColumn":"catid","targetTable":"#__categories","targetColumn":"id","displayColumn":"title"},{"sourceColumn":"group_id","targetTable":"#__usergroups","targetColumn":"id","displayColumn":"title"},{"sourceColumn":"created_by","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},{"sourceColumn":"access","targetTable":"#__viewlevels","targetColumn":"id","displayColumn":"title"},{"sourceColumn":"modified_by","targetTable":"#__users","targetColumn":"id","displayColumn":"name"} ]}');
</source>

Note that the "/" characters are now preceeded by two escape "\" characters. The first one is the SQL escape character for the second "\" character. The second "\" is the JSON escape character for the "/" character.

With this change to the SQL install file, the changes for content history are complete.

=Update Extension SQL Files=
To tidy things up, should should edit the uninstall SQL file to remove the rows from the #__content_types table. Also, if your component uses the one-click update feature, you should create a SQL file to create these rows when the component is updated.

Hopefully, this tutorial will help you as you update your component to take advantage of the content history feature in Joomla.

[[Category:Development]][[Category:Content History]]
[[Category:Tutorials]]

Using Content History in your Component

2013-11-03T21:19:55Z

Dextercowley: /* Update Extension SQL Files */

In version 3.2, Joomla added the ability to track content history (also called versions) for all core components. This allows you to view and restore from prior versions of an article, banner, category, and other content types. This feature can easily be added to third-party components. This tutorial shows you how to do this. We will illustrate this by adding content history to an example component.

'''Important Note:''' This tutorial assumes that the component uses a JTable sub-class for its "CRUD" (create/update/delete) operations. If the component does not use JTable then the simplest thing to do is to re-work it to use JTable's store() and delete() methods. If you do that, you will be able to use the methods described in this tutorial.

=Set up Working Environment=

# Install a new instance of Joomla version 3.2 on your local workstation.
# Install the example component using the file com_joomprosubs_3.2.0.zip in the Extension Manager: Install screen. You can get the ZIP archive here: <to be filled in when available>.

At this point, you should be able to see the Joompro Subscriptions component in the Components menu in the back end of Joomla. This is the component before we have added content history to it.

=Add Rows to Content Types Table=
The first thing we need to do is to add two new rows into the #__content_types table. This table stores information about the different tables for each content type. As of Joomla version 3.2, this table is used by the com_tags and com_contenthistory components to get information about each content type for which history is stored. The columns for #__content_types are as follows:

*'''type_id:''' auto-increment id number.
*'''type_title:''' descriptive title for this table.
*'''type_alias:''' <component name>.<type name>. For example: "com_content.article" or "com_content.category".
*'''table:''' JSON string that contains the name of the JTable class and other information about the table.
*'''rules:''' Not used as of Joomla version 3.2.
*'''field_mappings:''' Used by the com_tags component to map database columns from the component table to the ucm_content table.
*'''router:''' Optional location of the component's router, if any.
*'''content_history_options:''' JSON string used to store information for rendering the pop-up windows in the content history component. We will discuss this in detail later in this tutorial.

Our example component uses a table called #__joompro_subscriptions to store each subscription. In addition, it uses the standard Joomla categories. So we will add a row in #__content_types for the category table and one for the component table.

The row for the categories can be copied from the row for "Weblinks Category" (or any other category row). The only columns that need to be changed are <code>type_title</code> and <code>type_alias</code>. The other columns are the same as for <code>com_weblinks.category</code>.

The SQL statement for adding this row is as follows:

<code>INSERT INTO `#__content_types` (`type_id`, `type_title`, `type_alias`, `table`, `rules`, `field_mappings`, `router`, `content_history_options`)
VALUES
(null,
'Subscription Category',
'com_joomprosubs.category',
'{"special":{"dbtable":"#__categories","key":"id","type":"Category","prefix":"JTable","config":"array()"},"common": {"dbtable":"#__ucm_content","key":"ucm_id","type":"Corecontent","prefix":"JTable","config":"array()"}}',
'',
'{"common":{"core_content_item_id":"id","core_title":"title","core_state":"published","core_alias":"alias","core_created_time":"created_time","core_modified_time":"modified_time","core_body":"description", "core_hits":"hits","core_publish_up":"null","core_publish_down":"null","core_access":"access", "core_params":"params", "core_featured":"null", "core_metadata":"metadata", "core_language":"language", "core_images":"null", "core_urls":"null", "core_version":"version", "core_ordering":"null", "core_metakey":"metakey", "core_metadesc":"metadesc", "core_catid":"parent_id", "core_xreference":"null", "asset_id":"asset_id"}, "special":{"parent_id":"parent_id","lft":"lft","rgt":"rgt","level":"level","path":"path","extension":"extension","note":"note"}}',
'WeblinksHelperRoute::getCategoryRoute',
'{"formFile":"administrator\\/components\\/com_categories\\/models\\/forms\\/category.xml", "hideFields":["asset_id","checked_out","checked_out_time","version","lft","rgt","level","path","extension"], "ignoreChanges":["modified_user_id", "modified_time", "checked_out", "checked_out_time", "version", "hits", "path"],"convertToInt":["publish_up", "publish_down"], "displayLookup":[{"sourceColumn":"created_user_id","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},{"sourceColumn":"access","targetTable":"#__viewlevels","targetColumn":"id","displayColumn":"title"},{"sourceColumn":"modified_user_id","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},{"sourceColumn":"parent_id","targetTable":"#__categories","targetColumn":"id","displayColumn":"title"}]}');</code>

For the actual subscriptions, we only need the following information in the content types table:

*'''type_title:''' <code>Subscriptions</code>
*'''type_alias:''' <code>com_joomprosubs.subscription</code>
*'''table:''' <code>{"special":{"dbtable":"#__joompro_subscriptions","key":"id","type":"Subscription","prefix":"JoomprosubsTable"}}</code>. This creates a JSON object as follows:
:special:
::dbtable = #__joompro_subscriptions
::key = id
::type = Subscription
::prefix = JoomprosubsTable

The <code>type_alias</code> column is used by the com_contenthistory component to find the row for each component in the #__content_types table. The <code>table</code> column gives the com_contenthistory component the information it needs to work with the JTable class for each component. The None of the other columns need to be set for now. Note that we will come back to the <code>content_history_options</code> column later in the tutorial to improve the appearance of the pop-up window.

The SQL for adding this second row to the #__content_types table is as follows:

<code>INSERT INTO `#__content_types` (`type_id`, `type_title`, `type_alias`, `table`, `rules`, `field_mappings`, `router`, `content_history_options`)
VALUES
(null,
'Subscriptions',
'com_joomprosubs.subscription',
'{"special":{"dbtable":"#__joompro_subscriptions","key":"id","type":"Subscription","prefix":"JoomprosubsTable"}}',
'', '', '', '');
</code>

These lines should be added to the file <code>administrator/components/com_joomprosubs/sql/install.mysql.utf8.sql</code> so that these rows will be created when the component is installed. You should also run these commands on your database to add the two rows to your #__content_types table before going to the next section. Remember to change the placeholder prefix "#__" to the actual prefix for your database before running the SQL commands on your local database.

'''Tip:''' When creating the values for the JSON strings, one trick is to copy from an existing row and edit the strings.

=Add Component Level Options=
The content history component uses two options as follows.
*'''save_history:''' If Yes, history is saved. Otherwise, no history is saved.
*'''history_limit:''' If > 0, limits the number of different history versions saved in the database. For example, if this is set to 10, then when the 11th history version is saved, the oldest is deleted automatically.

If our example component, we will add the following lines to the file <code>administrator/components/com_joomprosubs/config.xml</code>.

<source lang="xml">

<fieldset name="component">
<field
name="save_history"
type="radio"
class="btn-group btn-group-yesno"
default="1"
label="JGLOBAL_SAVE_HISTORY_OPTIONS_LABEL"
description="JGLOBAL_SAVE_HISTORY_OPTIONS_DESC"
>
<option
value="0">JNO</option>
<option
value="1">JYES</option>
</field>

<field
name="history_limit"
type="text"
filter="integer"
label="JGLOBAL_HISTORY_LIMIT_OPTIONS_LABEL"
description="JGLOBAL_HISTORY_LIMIT_OPTIONS_DESC"
default="5"
/>
</fieldset>
</source>
With this code, we will now be able to add and save these options. Go into the Options for the component and set save_history to Yes and history_limit to 10.

=Update Content History During Table Save and Delete=
Next we need to tell our component to call the content history methods during the save and delete operations. We can do this by adding this line of code to the <code>__construct()</code> method of the <code>JoomprosubsTableSubscription</code> class.

<source lang="php">
JObserverMapper::addObserverClassToClass('JTableObserverContenthistory', 'JoomprosubsTableSubscription', array('typeAlias' => 'com_joomprosubs.subscription'));
</source>

This code registers the content history table as an observer class for our component table. When a row is saved or deleted from our table, the appropriate methods are called automatically for the content history table.

At this point, we should be able to see content history working for the Joomprosubs categories. Test this by adding a new category for the component and then clicking on the Versions button in the toolbar. It should work exactly the same as categories for the core Joomla components.

=Add Versions Button to Tool Bar=
At this point, categories are working completely and we are saving history versions in the #__ucm_history table for our component. However, we need to be able to access these changes on our edit screen. To do this, we need to add the Versions button to the edit screen's toolbar. We do this by adding this code to the file <code>administrator/components/com_joomprosubs/views/subscription/view.html.php</code>, just before the code that adds the "cancel" button, as shown here.

<source lang="php">
else {
if ($this->state->params->get('save_history', 1) && $user->authorise('core.edit')) {
JToolbarHelper::versions('com_joomprosubs.subscription', $this->item->id);
}
JToolBarHelper::cancel('subscription.cancel', 'JTOOLBAR_CLOSE');
}
</source>

This code checks that we have the save_history option set and that we have edit permission for this component. If so, we show the Versions button using the <code>JToolbarHelper::versions()</code> method. This method has two arguments: the type_alias and the primary key of the component item row in the database.

With this code added, we can now go into the Joomprosubs component, add and save a new subscription, and now see the Versions button. If we click on it, we will see the Item Version History modal window open with our saved version.

There are still two things missing, however. One is that we don't have a way to add the Version Note to each version. The second is that we don't currently have meaningful labels for the versions when we use the Preview or Compare features. We will address these in the next two sections of this tutorial.

=Add Version Note Field to Form=
The content history feature adds a new field called "version_note" to the component edit form. This optional field is not saved in the component table. Instead, it is used to label the version in the content history table.

To add this field to our component edit screen, we do changes to two files. First, we add the field to the XML form file <code>administrator/components/com_joomprosubs/models/forms/subscription.xml</code> as follows:

<source lang="xml">
<field name="version_note"
type="text"
label="JGLOBAL_FIELD_VERSION_NOTE_LABEL"
description="JGLOBAL_FIELD_VERSION_NOTE_DESC"
class="inputbox" size="45"
labelclass="control-label"
/>
</source>

We can add it anywhere inside the fieldset element. Because we will place the field "created_by_alias" on the screen, we add it in the XML file after this element.

Second, we add this code to the file <code>administrator/components/com_joomprosubs/views/subscription/tmpl/edit.php</code>, just after the control group for "created_by_alias", as follows:

<source lang="php">
<div class="control-group">
<div class="control-label"><?php echo $this->form->getLabel('version_note'); ?></div>
<div class="controls"><?php echo $this->form->getInput('version_note'); ?></div>
</div>
</source>

Now we can add in a version note and see this in the Item Version History modal window.

=Add Labels to Pop-Up Windows=
At this point, everything works. However, when we use the pop-up Preview or Compare windows in the Item Version History modal, we see the database column names instead of the translated label from the form. Also, we see the category and user id numbers instead of the category name and user name.

We can improve the readability of windows by entering in some additional about our component's table. This information is entered as a JSON-formatted string in the content_history_options column of the #__content_types table. The following information can be entered in this column.
*'''formfile:''' This is the path to the XML JForm file for this form. If you add this, the Preview and Compare views will look up the labels from this XML file. This way the user will see translated labels instead of the database column name.
*'''hideFields:''' Some database columns are not meaningful for the user when viewing the item. For example, asset_id or check_out_time are not things that appear in the form and are not helpful to the user when figuring out the contents of an item. This is entered as an array of column names.
*'''ignoreChanges:''' The content history component uses a "hash" calculation (Sha1) to determine whether an item has changed. This allows you to see which version in history matches the current version. It also prevents duplicate versions from being saved in the content history table (for example, if you press the "save" button without making any changes). For this to work properly, we need to exclude some columns from the hash calculate. The "ignoreChanges" lets you exclude some database columns from the hash so that changes to these columns will not be considered real changes to the item. For example, columns such as "hits" or "modified_time" will change with each save, even if no meaningful data was changed in the item. This is an array of database column names.
*'''convertToInt:''' When the hash value is created, it uses a JSON array of the database column values. In some cases, such as start and stop publishing dates, the value might be blank when a row is first created and then a different value after the item is saved. To get a consistent hash value for the first and subsequent saves, these values can be converted to integers before the hash is created. That way, we don't think a value has changed when it really hasn't. This is an array of database column names.
*'''displayLookup:''' Here we can define how to display more meaningful data, for example, displaying a category title or user name instead of the ID. This is stored as an array of PHP standard class objects. Each object has the following fields.
:*''sourceColumn:'' The column in the form to replace. For example, the "created_user_id" or "catid".
:*''targetTable:'' The database table to get the title or name. For example, "#__users" or "#__categories".
:*''targetColumn:'' The column in the target table to use in the SQL query JOIN statement. For example, "id".
:*''displayColumn:'' The column in the target table to display in the Preview or Compare pop-up window. For example, "name" or "title".

In our example component, we need the following values.
*'''formfile:''' <code>administrator/components/com_joomprosubs/models/forms/subscription.xml</code>.
*'''hideFields:''' checked_out, checked_out_time, params, langauge. The last two columns are not used.
*'''ignoreChanges:''' modified_by, modified, checked_out, checked_out_time.
*'''convertToInt:''' publish_up, publish_down.
*'''displayLookup:''' We look up five fields: catid, group_id, created_by, access, and modified_by. The values for each are as follows.
:*''sourceColumn:'' catid
:*''targetTable:'' #__categories
:*''targetColumn:'' id
:*''displayColumn:'' title

:*''sourceColumn:'' group_id
:*''targetTable:'' #__usergroups
:*''targetColumn:'' id
:*''displayColumn:'' title

:*''sourceColumn:'' created_by
:*''targetTable:'' #__users
:*''targetColumn:'' id
:*''displayColumn:'' name

:*''sourceColumn:'' access
:*''targetTable:'' #__viewlevels
:*''targetColumn:'' id
:*''displayColumn:'' title

:*''sourceColumn:'' modified_by
:*''targetTable:'' #__users
:*''targetColumn:'' id
:*''displayColumn:'' name

The entire JSON string for this column is as follows.

<source>
{"formFile":"administrator\/components\/com_joomprosubs\/models\/forms\/subscription.xml",
"hideFields":["checked_out","checked_out_time","params","language"],
"ignoreChanges":["modified_by", "modified", "checked_out", "checked_out_time"],
"convertToInt":["publish_up", "publish_down"],
"displayLookup":[
{"sourceColumn":"catid","targetTable":"#__categories","targetColumn":"id","displayColumn":"title"},
{"sourceColumn":"group_id","targetTable":"#__usergroups","targetColumn":"id","displayColumn":"title"},
{"sourceColumn":"created_by","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},
{"sourceColumn":"access","targetTable":"#__viewlevels","targetColumn":"id","displayColumn":"title"},
{"sourceColumn":"modified_by","targetTable":"#__users","targetColumn":"id","displayColumn":"name"} ]}
</source>

Note that the slashes are escaped inside the JSON string. In order to get this column correctly into the database when our component is installed, we need to modify the file <code>administrator/components/com_joomprosubs/sql/install.mysql.utf8.sql</code> where we create the #__content_types for for the component as follows:

<source lang="sql">
INSERT INTO `#__content_types` (`type_id`, `type_title`, `type_alias`, `table`, `rules`, `field_mappings`, `router`, `content_history_options`) VALUES
(null, 'Subscriptions', 'com_joomprosubs.subscription', '{"special":{"dbtable":"#__joompro_subscriptions","key":"id","type":"Subscription","prefix":"JoomprosubsTable"}}', '', '', '', '{"formFile":"administrator\\/components\\/com_joomprosubs\\/models\\/forms\\/subscription.xml", "hideFields":["checked_out","checked_out_time","params","language"], "ignoreChanges":["modified_by", "modified", "checked_out", "checked_out_time"], "convertToInt":["publish_up", "publish_down"], "displayLookup":[{"sourceColumn":"catid","targetTable":"#__categories","targetColumn":"id","displayColumn":"title"},{"sourceColumn":"group_id","targetTable":"#__usergroups","targetColumn":"id","displayColumn":"title"},{"sourceColumn":"created_by","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},{"sourceColumn":"access","targetTable":"#__viewlevels","targetColumn":"id","displayColumn":"title"},{"sourceColumn":"modified_by","targetTable":"#__users","targetColumn":"id","displayColumn":"name"} ]}');
</source>

Note that the "/" characters are now preceeded by two escape "\" characters. The first one is the SQL escape character for the second "\" character. The second "\" is the JSON escape character for the "/" character.

With this change to the SQL install file, the changes for content history are complete.

=Update Extension SQL Files=
To tidy things up, should should edit the uninstall SQL file to remove the rows from the #__content_types table. Also, if your component uses the one-click update feature, you should create a SQL file to create these rows when the component is updated.

Hopefully, this tutorial will help you as you update your component to take advantage of the content history feature in Joomla.

[[Category:Development]][[Category:Content History]]
[[Category:Tutorials]]

Using Content History in your Component

2013-11-03T21:17:04Z

Dextercowley: /* Add Labels to Pop-Up Windows */

In version 3.2, Joomla added the ability to track content history (also called versions) for all core components. This allows you to view and restore from prior versions of an article, banner, category, and other content types. This feature can easily be added to third-party components. This tutorial shows you how to do this. We will illustrate this by adding content history to an example component.

'''Important Note:''' This tutorial assumes that the component uses a JTable sub-class for its "CRUD" (create/update/delete) operations. If the component does not use JTable then the simplest thing to do is to re-work it to use JTable's store() and delete() methods. If you do that, you will be able to use the methods described in this tutorial.

=Set up Working Environment=

# Install a new instance of Joomla version 3.2 on your local workstation.
# Install the example component using the file com_joomprosubs_3.2.0.zip in the Extension Manager: Install screen. You can get the ZIP archive here: <to be filled in when available>.

At this point, you should be able to see the Joompro Subscriptions component in the Components menu in the back end of Joomla. This is the component before we have added content history to it.

=Add Rows to Content Types Table=
The first thing we need to do is to add two new rows into the #__content_types table. This table stores information about the different tables for each content type. As of Joomla version 3.2, this table is used by the com_tags and com_contenthistory components to get information about each content type for which history is stored. The columns for #__content_types are as follows:

*'''type_id:''' auto-increment id number.
*'''type_title:''' descriptive title for this table.
*'''type_alias:''' <component name>.<type name>. For example: "com_content.article" or "com_content.category".
*'''table:''' JSON string that contains the name of the JTable class and other information about the table.
*'''rules:''' Not used as of Joomla version 3.2.
*'''field_mappings:''' Used by the com_tags component to map database columns from the component table to the ucm_content table.
*'''router:''' Optional location of the component's router, if any.
*'''content_history_options:''' JSON string used to store information for rendering the pop-up windows in the content history component. We will discuss this in detail later in this tutorial.

Our example component uses a table called #__joompro_subscriptions to store each subscription. In addition, it uses the standard Joomla categories. So we will add a row in #__content_types for the category table and one for the component table.

The row for the categories can be copied from the row for "Weblinks Category" (or any other category row). The only columns that need to be changed are <code>type_title</code> and <code>type_alias</code>. The other columns are the same as for <code>com_weblinks.category</code>.

The SQL statement for adding this row is as follows:

<code>INSERT INTO `#__content_types` (`type_id`, `type_title`, `type_alias`, `table`, `rules`, `field_mappings`, `router`, `content_history_options`)
VALUES
(null,
'Subscription Category',
'com_joomprosubs.category',
'{"special":{"dbtable":"#__categories","key":"id","type":"Category","prefix":"JTable","config":"array()"},"common": {"dbtable":"#__ucm_content","key":"ucm_id","type":"Corecontent","prefix":"JTable","config":"array()"}}',
'',
'{"common":{"core_content_item_id":"id","core_title":"title","core_state":"published","core_alias":"alias","core_created_time":"created_time","core_modified_time":"modified_time","core_body":"description", "core_hits":"hits","core_publish_up":"null","core_publish_down":"null","core_access":"access", "core_params":"params", "core_featured":"null", "core_metadata":"metadata", "core_language":"language", "core_images":"null", "core_urls":"null", "core_version":"version", "core_ordering":"null", "core_metakey":"metakey", "core_metadesc":"metadesc", "core_catid":"parent_id", "core_xreference":"null", "asset_id":"asset_id"}, "special":{"parent_id":"parent_id","lft":"lft","rgt":"rgt","level":"level","path":"path","extension":"extension","note":"note"}}',
'WeblinksHelperRoute::getCategoryRoute',
'{"formFile":"administrator\\/components\\/com_categories\\/models\\/forms\\/category.xml", "hideFields":["asset_id","checked_out","checked_out_time","version","lft","rgt","level","path","extension"], "ignoreChanges":["modified_user_id", "modified_time", "checked_out", "checked_out_time", "version", "hits", "path"],"convertToInt":["publish_up", "publish_down"], "displayLookup":[{"sourceColumn":"created_user_id","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},{"sourceColumn":"access","targetTable":"#__viewlevels","targetColumn":"id","displayColumn":"title"},{"sourceColumn":"modified_user_id","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},{"sourceColumn":"parent_id","targetTable":"#__categories","targetColumn":"id","displayColumn":"title"}]}');</code>

For the actual subscriptions, we only need the following information in the content types table:

*'''type_title:''' <code>Subscriptions</code>
*'''type_alias:''' <code>com_joomprosubs.subscription</code>
*'''table:''' <code>{"special":{"dbtable":"#__joompro_subscriptions","key":"id","type":"Subscription","prefix":"JoomprosubsTable"}}</code>. This creates a JSON object as follows:
:special:
::dbtable = #__joompro_subscriptions
::key = id
::type = Subscription
::prefix = JoomprosubsTable

The <code>type_alias</code> column is used by the com_contenthistory component to find the row for each component in the #__content_types table. The <code>table</code> column gives the com_contenthistory component the information it needs to work with the JTable class for each component. The None of the other columns need to be set for now. Note that we will come back to the <code>content_history_options</code> column later in the tutorial to improve the appearance of the pop-up window.

The SQL for adding this second row to the #__content_types table is as follows:

<code>INSERT INTO `#__content_types` (`type_id`, `type_title`, `type_alias`, `table`, `rules`, `field_mappings`, `router`, `content_history_options`)
VALUES
(null,
'Subscriptions',
'com_joomprosubs.subscription',
'{"special":{"dbtable":"#__joompro_subscriptions","key":"id","type":"Subscription","prefix":"JoomprosubsTable"}}',
'', '', '', '');
</code>

These lines should be added to the file <code>administrator/components/com_joomprosubs/sql/install.mysql.utf8.sql</code> so that these rows will be created when the component is installed. You should also run these commands on your database to add the two rows to your #__content_types table before going to the next section. Remember to change the placeholder prefix "#__" to the actual prefix for your database before running the SQL commands on your local database.

'''Tip:''' When creating the values for the JSON strings, one trick is to copy from an existing row and edit the strings.

=Add Component Level Options=
The content history component uses two options as follows.
*'''save_history:''' If Yes, history is saved. Otherwise, no history is saved.
*'''history_limit:''' If > 0, limits the number of different history versions saved in the database. For example, if this is set to 10, then when the 11th history version is saved, the oldest is deleted automatically.

If our example component, we will add the following lines to the file <code>administrator/components/com_joomprosubs/config.xml</code>.

<source lang="xml">

<fieldset name="component">
<field
name="save_history"
type="radio"
class="btn-group btn-group-yesno"
default="1"
label="JGLOBAL_SAVE_HISTORY_OPTIONS_LABEL"
description="JGLOBAL_SAVE_HISTORY_OPTIONS_DESC"
>
<option
value="0">JNO</option>
<option
value="1">JYES</option>
</field>

<field
name="history_limit"
type="text"
filter="integer"
label="JGLOBAL_HISTORY_LIMIT_OPTIONS_LABEL"
description="JGLOBAL_HISTORY_LIMIT_OPTIONS_DESC"
default="5"
/>
</fieldset>
</source>
With this code, we will now be able to add and save these options. Go into the Options for the component and set save_history to Yes and history_limit to 10.

=Update Content History During Table Save and Delete=
Next we need to tell our component to call the content history methods during the save and delete operations. We can do this by adding this line of code to the <code>__construct()</code> method of the <code>JoomprosubsTableSubscription</code> class.

<source lang="php">
JObserverMapper::addObserverClassToClass('JTableObserverContenthistory', 'JoomprosubsTableSubscription', array('typeAlias' => 'com_joomprosubs.subscription'));
</source>

This code registers the content history table as an observer class for our component table. When a row is saved or deleted from our table, the appropriate methods are called automatically for the content history table.

At this point, we should be able to see content history working for the Joomprosubs categories. Test this by adding a new category for the component and then clicking on the Versions button in the toolbar. It should work exactly the same as categories for the core Joomla components.

=Add Versions Button to Tool Bar=
At this point, categories are working completely and we are saving history versions in the #__ucm_history table for our component. However, we need to be able to access these changes on our edit screen. To do this, we need to add the Versions button to the edit screen's toolbar. We do this by adding this code to the file <code>administrator/components/com_joomprosubs/views/subscription/view.html.php</code>, just before the code that adds the "cancel" button, as shown here.

<source lang="php">
else {
if ($this->state->params->get('save_history', 1) && $user->authorise('core.edit')) {
JToolbarHelper::versions('com_joomprosubs.subscription', $this->item->id);
}
JToolBarHelper::cancel('subscription.cancel', 'JTOOLBAR_CLOSE');
}
</source>

This code checks that we have the save_history option set and that we have edit permission for this component. If so, we show the Versions button using the <code>JToolbarHelper::versions()</code> method. This method has two arguments: the type_alias and the primary key of the component item row in the database.

With this code added, we can now go into the Joomprosubs component, add and save a new subscription, and now see the Versions button. If we click on it, we will see the Item Version History modal window open with our saved version.

There are still two things missing, however. One is that we don't have a way to add the Version Note to each version. The second is that we don't currently have meaningful labels for the versions when we use the Preview or Compare features. We will address these in the next two sections of this tutorial.

=Add Version Note Field to Form=
The content history feature adds a new field called "version_note" to the component edit form. This optional field is not saved in the component table. Instead, it is used to label the version in the content history table.

To add this field to our component edit screen, we do changes to two files. First, we add the field to the XML form file <code>administrator/components/com_joomprosubs/models/forms/subscription.xml</code> as follows:

<source lang="xml">
<field name="version_note"
type="text"
label="JGLOBAL_FIELD_VERSION_NOTE_LABEL"
description="JGLOBAL_FIELD_VERSION_NOTE_DESC"
class="inputbox" size="45"
labelclass="control-label"
/>
</source>

We can add it anywhere inside the fieldset element. Because we will place the field "created_by_alias" on the screen, we add it in the XML file after this element.

Second, we add this code to the file <code>administrator/components/com_joomprosubs/views/subscription/tmpl/edit.php</code>, just after the control group for "created_by_alias", as follows:

<source lang="php">
<div class="control-group">
<div class="control-label"><?php echo $this->form->getLabel('version_note'); ?></div>
<div class="controls"><?php echo $this->form->getInput('version_note'); ?></div>
</div>
</source>

Now we can add in a version note and see this in the Item Version History modal window.

=Add Labels to Pop-Up Windows=
At this point, everything works. However, when we use the pop-up Preview or Compare windows in the Item Version History modal, we see the database column names instead of the translated label from the form. Also, we see the category and user id numbers instead of the category name and user name.

We can improve the readability of windows by entering in some additional about our component's table. This information is entered as a JSON-formatted string in the content_history_options column of the #__content_types table. The following information can be entered in this column.
*'''formfile:''' This is the path to the XML JForm file for this form. If you add this, the Preview and Compare views will look up the labels from this XML file. This way the user will see translated labels instead of the database column name.
*'''hideFields:''' Some database columns are not meaningful for the user when viewing the item. For example, asset_id or check_out_time are not things that appear in the form and are not helpful to the user when figuring out the contents of an item. This is entered as an array of column names.
*'''ignoreChanges:''' The content history component uses a "hash" calculation (Sha1) to determine whether an item has changed. This allows you to see which version in history matches the current version. It also prevents duplicate versions from being saved in the content history table (for example, if you press the "save" button without making any changes). For this to work properly, we need to exclude some columns from the hash calculate. The "ignoreChanges" lets you exclude some database columns from the hash so that changes to these columns will not be considered real changes to the item. For example, columns such as "hits" or "modified_time" will change with each save, even if no meaningful data was changed in the item. This is an array of database column names.
*'''convertToInt:''' When the hash value is created, it uses a JSON array of the database column values. In some cases, such as start and stop publishing dates, the value might be blank when a row is first created and then a different value after the item is saved. To get a consistent hash value for the first and subsequent saves, these values can be converted to integers before the hash is created. That way, we don't think a value has changed when it really hasn't. This is an array of database column names.
*'''displayLookup:''' Here we can define how to display more meaningful data, for example, displaying a category title or user name instead of the ID. This is stored as an array of PHP standard class objects. Each object has the following fields.
:*''sourceColumn:'' The column in the form to replace. For example, the "created_user_id" or "catid".
:*''targetTable:'' The database table to get the title or name. For example, "#__users" or "#__categories".
:*''targetColumn:'' The column in the target table to use in the SQL query JOIN statement. For example, "id".
:*''displayColumn:'' The column in the target table to display in the Preview or Compare pop-up window. For example, "name" or "title".

In our example component, we need the following values.
*'''formfile:''' <code>administrator/components/com_joomprosubs/models/forms/subscription.xml</code>.
*'''hideFields:''' checked_out, checked_out_time, params, langauge. The last two columns are not used.
*'''ignoreChanges:''' modified_by, modified, checked_out, checked_out_time.
*'''convertToInt:''' publish_up, publish_down.
*'''displayLookup:''' We look up five fields: catid, group_id, created_by, access, and modified_by. The values for each are as follows.
:*''sourceColumn:'' catid
:*''targetTable:'' #__categories
:*''targetColumn:'' id
:*''displayColumn:'' title

:*''sourceColumn:'' group_id
:*''targetTable:'' #__usergroups
:*''targetColumn:'' id
:*''displayColumn:'' title

:*''sourceColumn:'' created_by
:*''targetTable:'' #__users
:*''targetColumn:'' id
:*''displayColumn:'' name

:*''sourceColumn:'' access
:*''targetTable:'' #__viewlevels
:*''targetColumn:'' id
:*''displayColumn:'' title

:*''sourceColumn:'' modified_by
:*''targetTable:'' #__users
:*''targetColumn:'' id
:*''displayColumn:'' name

The entire JSON string for this column is as follows.

<source>
{"formFile":"administrator\/components\/com_joomprosubs\/models\/forms\/subscription.xml",
"hideFields":["checked_out","checked_out_time","params","language"],
"ignoreChanges":["modified_by", "modified", "checked_out", "checked_out_time"],
"convertToInt":["publish_up", "publish_down"],
"displayLookup":[
{"sourceColumn":"catid","targetTable":"#__categories","targetColumn":"id","displayColumn":"title"},
{"sourceColumn":"group_id","targetTable":"#__usergroups","targetColumn":"id","displayColumn":"title"},
{"sourceColumn":"created_by","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},
{"sourceColumn":"access","targetTable":"#__viewlevels","targetColumn":"id","displayColumn":"title"},
{"sourceColumn":"modified_by","targetTable":"#__users","targetColumn":"id","displayColumn":"name"} ]}
</source>

Note that the slashes are escaped inside the JSON string. In order to get this column correctly into the database when our component is installed, we need to modify the file <code>administrator/components/com_joomprosubs/sql/install.mysql.utf8.sql</code> where we create the #__content_types for for the component as follows:

<source lang="sql">
INSERT INTO `#__content_types` (`type_id`, `type_title`, `type_alias`, `table`, `rules`, `field_mappings`, `router`, `content_history_options`) VALUES
(null, 'Subscriptions', 'com_joomprosubs.subscription', '{"special":{"dbtable":"#__joompro_subscriptions","key":"id","type":"Subscription","prefix":"JoomprosubsTable"}}', '', '', '', '{"formFile":"administrator\\/components\\/com_joomprosubs\\/models\\/forms\\/subscription.xml", "hideFields":["checked_out","checked_out_time","params","language"], "ignoreChanges":["modified_by", "modified", "checked_out", "checked_out_time"], "convertToInt":["publish_up", "publish_down"], "displayLookup":[{"sourceColumn":"catid","targetTable":"#__categories","targetColumn":"id","displayColumn":"title"},{"sourceColumn":"group_id","targetTable":"#__usergroups","targetColumn":"id","displayColumn":"title"},{"sourceColumn":"created_by","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},{"sourceColumn":"access","targetTable":"#__viewlevels","targetColumn":"id","displayColumn":"title"},{"sourceColumn":"modified_by","targetTable":"#__users","targetColumn":"id","displayColumn":"name"} ]}');
</source>

Note that the "/" characters are now preceeded by two escape "\" characters. The first one is the SQL escape character for the second "\" character. The second "\" is the JSON escape character for the "/" character.

With this change to the SQL install file, the changes for content history are complete.

=Update Extension SQL Files=

[[Category:Development]][[Category:Content History]]
[[Category:Tutorials]]

Using Content History in your Component

2013-11-03T20:15:25Z

Dextercowley: /* Add Labels to Pop-Up Windows -- in progress */

In version 3.2, Joomla added the ability to track content history (also called versions) for all core components. This allows you to view and restore from prior versions of an article, banner, category, and other content types. This feature can easily be added to third-party components. This tutorial shows you how to do this. We will illustrate this by adding content history to an example component.

'''Important Note:''' This tutorial assumes that the component uses a JTable sub-class for its "CRUD" (create/update/delete) operations. If the component does not use JTable then the simplest thing to do is to re-work it to use JTable's store() and delete() methods. If you do that, you will be able to use the methods described in this tutorial.

=Set up Working Environment=

# Install a new instance of Joomla version 3.2 on your local workstation.
# Install the example component using the file com_joomprosubs_3.2.0.zip in the Extension Manager: Install screen. You can get the ZIP archive here: <to be filled in when available>.

At this point, you should be able to see the Joompro Subscriptions component in the Components menu in the back end of Joomla. This is the component before we have added content history to it.

=Add Rows to Content Types Table=
The first thing we need to do is to add two new rows into the #__content_types table. This table stores information about the different tables for each content type. As of Joomla version 3.2, this table is used by the com_tags and com_contenthistory components to get information about each content type for which history is stored. The columns for #__content_types are as follows:

*'''type_id:''' auto-increment id number.
*'''type_title:''' descriptive title for this table.
*'''type_alias:''' <component name>.<type name>. For example: "com_content.article" or "com_content.category".
*'''table:''' JSON string that contains the name of the JTable class and other information about the table.
*'''rules:''' Not used as of Joomla version 3.2.
*'''field_mappings:''' Used by the com_tags component to map database columns from the component table to the ucm_content table.
*'''router:''' Optional location of the component's router, if any.
*'''content_history_options:''' JSON string used to store information for rendering the pop-up windows in the content history component. We will discuss this in detail later in this tutorial.

Our example component uses a table called #__joompro_subscriptions to store each subscription. In addition, it uses the standard Joomla categories. So we will add a row in #__content_types for the category table and one for the component table.

The row for the categories can be copied from the row for "Weblinks Category" (or any other category row). The only columns that need to be changed are <code>type_title</code> and <code>type_alias</code>. The other columns are the same as for <code>com_weblinks.category</code>.

The SQL statement for adding this row is as follows:

<code>INSERT INTO `#__content_types` (`type_id`, `type_title`, `type_alias`, `table`, `rules`, `field_mappings`, `router`, `content_history_options`)
VALUES
(null,
'Subscription Category',
'com_joomprosubs.category',
'{"special":{"dbtable":"#__categories","key":"id","type":"Category","prefix":"JTable","config":"array()"},"common": {"dbtable":"#__ucm_content","key":"ucm_id","type":"Corecontent","prefix":"JTable","config":"array()"}}',
'',
'{"common":{"core_content_item_id":"id","core_title":"title","core_state":"published","core_alias":"alias","core_created_time":"created_time","core_modified_time":"modified_time","core_body":"description", "core_hits":"hits","core_publish_up":"null","core_publish_down":"null","core_access":"access", "core_params":"params", "core_featured":"null", "core_metadata":"metadata", "core_language":"language", "core_images":"null", "core_urls":"null", "core_version":"version", "core_ordering":"null", "core_metakey":"metakey", "core_metadesc":"metadesc", "core_catid":"parent_id", "core_xreference":"null", "asset_id":"asset_id"}, "special":{"parent_id":"parent_id","lft":"lft","rgt":"rgt","level":"level","path":"path","extension":"extension","note":"note"}}',
'WeblinksHelperRoute::getCategoryRoute',
'{"formFile":"administrator\\/components\\/com_categories\\/models\\/forms\\/category.xml", "hideFields":["asset_id","checked_out","checked_out_time","version","lft","rgt","level","path","extension"], "ignoreChanges":["modified_user_id", "modified_time", "checked_out", "checked_out_time", "version", "hits", "path"],"convertToInt":["publish_up", "publish_down"], "displayLookup":[{"sourceColumn":"created_user_id","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},{"sourceColumn":"access","targetTable":"#__viewlevels","targetColumn":"id","displayColumn":"title"},{"sourceColumn":"modified_user_id","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},{"sourceColumn":"parent_id","targetTable":"#__categories","targetColumn":"id","displayColumn":"title"}]}');</code>

For the actual subscriptions, we only need the following information in the content types table:

*'''type_title:''' <code>Subscriptions</code>
*'''type_alias:''' <code>com_joomprosubs.subscription</code>
*'''table:''' <code>{"special":{"dbtable":"#__joompro_subscriptions","key":"id","type":"Subscription","prefix":"JoomprosubsTable"}}</code>. This creates a JSON object as follows:
:special:
::dbtable = #__joompro_subscriptions
::key = id
::type = Subscription
::prefix = JoomprosubsTable

The <code>type_alias</code> column is used by the com_contenthistory component to find the row for each component in the #__content_types table. The <code>table</code> column gives the com_contenthistory component the information it needs to work with the JTable class for each component. The None of the other columns need to be set for now. Note that we will come back to the <code>content_history_options</code> column later in the tutorial to improve the appearance of the pop-up window.

The SQL for adding this second row to the #__content_types table is as follows:

<code>INSERT INTO `#__content_types` (`type_id`, `type_title`, `type_alias`, `table`, `rules`, `field_mappings`, `router`, `content_history_options`)
VALUES
(null,
'Subscriptions',
'com_joomprosubs.subscription',
'{"special":{"dbtable":"#__joompro_subscriptions","key":"id","type":"Subscription","prefix":"JoomprosubsTable"}}',
'', '', '', '');
</code>

These lines should be added to the file <code>administrator/components/com_joomprosubs/sql/install.mysql.utf8.sql</code> so that these rows will be created when the component is installed. You should also run these commands on your database to add the two rows to your #__content_types table before going to the next section. Remember to change the placeholder prefix "#__" to the actual prefix for your database before running the SQL commands on your local database.

'''Tip:''' When creating the values for the JSON strings, one trick is to copy from an existing row and edit the strings.

=Add Component Level Options=
The content history component uses two options as follows.
*'''save_history:''' If Yes, history is saved. Otherwise, no history is saved.
*'''history_limit:''' If > 0, limits the number of different history versions saved in the database. For example, if this is set to 10, then when the 11th history version is saved, the oldest is deleted automatically.

If our example component, we will add the following lines to the file <code>administrator/components/com_joomprosubs/config.xml</code>.

<source lang="xml">

<fieldset name="component">
<field
name="save_history"
type="radio"
class="btn-group btn-group-yesno"
default="1"
label="JGLOBAL_SAVE_HISTORY_OPTIONS_LABEL"
description="JGLOBAL_SAVE_HISTORY_OPTIONS_DESC"
>
<option
value="0">JNO</option>
<option
value="1">JYES</option>
</field>

<field
name="history_limit"
type="text"
filter="integer"
label="JGLOBAL_HISTORY_LIMIT_OPTIONS_LABEL"
description="JGLOBAL_HISTORY_LIMIT_OPTIONS_DESC"
default="5"
/>
</fieldset>
</source>
With this code, we will now be able to add and save these options. Go into the Options for the component and set save_history to Yes and history_limit to 10.

=Update Content History During Table Save and Delete=
Next we need to tell our component to call the content history methods during the save and delete operations. We can do this by adding this line of code to the <code>__construct()</code> method of the <code>JoomprosubsTableSubscription</code> class.

<source lang="php">
JObserverMapper::addObserverClassToClass('JTableObserverContenthistory', 'JoomprosubsTableSubscription', array('typeAlias' => 'com_joomprosubs.subscription'));
</source>

This code registers the content history table as an observer class for our component table. When a row is saved or deleted from our table, the appropriate methods are called automatically for the content history table.

At this point, we should be able to see content history working for the Joomprosubs categories. Test this by adding a new category for the component and then clicking on the Versions button in the toolbar. It should work exactly the same as categories for the core Joomla components.

=Add Versions Button to Tool Bar=
At this point, categories are working completely and we are saving history versions in the #__ucm_history table for our component. However, we need to be able to access these changes on our edit screen. To do this, we need to add the Versions button to the edit screen's toolbar. We do this by adding this code to the file <code>administrator/components/com_joomprosubs/views/subscription/view.html.php</code>, just before the code that adds the "cancel" button, as shown here.

<source lang="php">
else {
if ($this->state->params->get('save_history', 1) && $user->authorise('core.edit')) {
JToolbarHelper::versions('com_joomprosubs.subscription', $this->item->id);
}
JToolBarHelper::cancel('subscription.cancel', 'JTOOLBAR_CLOSE');
}
</source>

This code checks that we have the save_history option set and that we have edit permission for this component. If so, we show the Versions button using the <code>JToolbarHelper::versions()</code> method. This method has two arguments: the type_alias and the primary key of the component item row in the database.

With this code added, we can now go into the Joomprosubs component, add and save a new subscription, and now see the Versions button. If we click on it, we will see the Item Version History modal window open with our saved version.

There are still two things missing, however. One is that we don't have a way to add the Version Note to each version. The second is that we don't currently have meaningful labels for the versions when we use the Preview or Compare features. We will address these in the next two sections of this tutorial.

=Add Version Note Field to Form=
The content history feature adds a new field called "version_note" to the component edit form. This optional field is not saved in the component table. Instead, it is used to label the version in the content history table.

To add this field to our component edit screen, we do changes to two files. First, we add the field to the XML form file <code>administrator/components/com_joomprosubs/models/forms/subscription.xml</code> as follows:

<source lang="xml">
<field name="version_note"
type="text"
label="JGLOBAL_FIELD_VERSION_NOTE_LABEL"
description="JGLOBAL_FIELD_VERSION_NOTE_DESC"
class="inputbox" size="45"
labelclass="control-label"
/>
</source>

We can add it anywhere inside the fieldset element. Because we will place the field "created_by_alias" on the screen, we add it in the XML file after this element.

Second, we add this code to the file <code>administrator/components/com_joomprosubs/views/subscription/tmpl/edit.php</code>, just after the control group for "created_by_alias", as follows:

<source lang="php">
<div class="control-group">
<div class="control-label"><?php echo $this->form->getLabel('version_note'); ?></div>
<div class="controls"><?php echo $this->form->getInput('version_note'); ?></div>
</div>
</source>

Now we can add in a version note and see this in the Item Version History modal window.

=Add Labels to Pop-Up Windows=
At this point, everything works. However, when we use the pop-up Preview or Compare windows in the Item Version History modal, we see the database column names instead of the translated label from the form. Also, we see the category and user id numbers instead of the category name and user name.

We can improve the readability of windows by entering in some additional about our component's table. This information is entered as a JSON-formatted string in the content_history_options column of the #__content_types table. The following information can be entered in this column.
*'''formfile:''' This is the path to the XML JForm file for this form. If you add this, the Preview and Compare views will look up the labels from this XML file. This way the user will see translated labels instead of the database column name.
*'''hideFields:''' Some database columns are not meaningful for the user when viewing the item. For example, asset_id or check_out_time are not things that appear in the form and are not helpful to the user when figuring out the contents of an item. This is entered as an array of column names.
*'''ignoreChanges:''' The content history component uses a "hash" calculation (Sha1) to determine whether an item has changed. This allows you to see which version in history matches the current version. It also prevents duplicate versions from being saved in the content history table (for example, if you press the "save" button without making any changes). For this to work properly, we need to exclude some columns from the hash calculate. The "ignoreChanges" lets you exclude some database columns from the hash so that changes to these columns will not be considered real changes to the item. For example, columns such as "hits" or "modified_time" will change with each save, even if no meaningful data was changed in the item. This is an array of database column names.
*'''convertToInt:''' When the hash value is created, it uses a JSON array of the database column values. In some cases, such as start and stop publishing dates, the value might be blank when a row is first created and then a different value after the item is saved. To get a consistent hash value for the first and subsequent saves, these values can be converted to integers before the hash is created. That way, we don't think a value has changed when it really hasn't. This is an array of database column names.
*'''displayLookup:''' Here we can define how to display more meaningful data, for example, displaying a category title or user name instead of the ID. This is stored as an array of PHP standard class objects. Each object has the following fields.
:*''sourceColumn:'' The column in the form to replace. For example, the "created_user_id" or "catid".
:*''targetTable:'' The database table to get the title or name. For example, "#__users" or "#__categories".
:*''targetColumn:'' The column in the target table to use in the SQL query JOIN statement. For example, "id".
:*''displayColumn:'' The column in the target table to display in the Preview or Compare pop-up window. For example, "name" or "title".

=Update Extension SQL Files=

[[Category:Development]][[Category:Content History]]
[[Category:Tutorials]]

Using Content History in your Component

2013-11-03T19:38:01Z

Dextercowley: /* Add Version Note Field to Form */

Using Content History in your Component

2013-11-03T19:22:49Z

Dextercowley: /* Add Versions Button to Tool Bar */

Using Content History in your Component

2013-11-03T18:48:24Z

Dextercowley: /* Update Content History During Table Save and Delete */

Using Content History in your Component

2013-11-03T18:37:05Z

Dextercowley: /* Add Component Level Options */

Using Content History in your Component

2013-11-03T18:12:33Z

Dextercowley: tweak

Using Content History in your Component

2013-11-03T18:11:24Z

Dextercowley: minor fix

Using Content History in your Component

2013-11-02T23:22:27Z

Dextercowley: Finish the Add Rows section.

Using Content History in your Component

2013-11-02T23:18:44Z

Dextercowley: /* Add Rows to Content Types Table */

Using Content History in your Component

2013-11-02T22:24:14Z

Dextercowley: /* Set up Working Environment */

Using Content History in your Component

2013-11-02T17:49:26Z

Dextercowley: Start work on content history tutorial

Help310:Components Weblinks Links Edit

2013-10-14T00:41:27Z

Dextercowley: adjust image sizes

<noinclude>{{Help screen navbox|3.0|Components Help Screens}}</noinclude>==Overview==
This screen lets you create new Web Links and edit existing ones.

==How to Access==

Navigate to the [[Help30:Components_Weblinks_Links|Web Links Manager]]. To add a new Web Link, click the "New" icon in the toolbar. To edit an existing Web Link, click the Web Link's Title, or check the Web Link's checkbox and press the "Edit" icon in the toolbar.

==Description==

This is where you add a new Web Link or edit an existing one. Note that you need to create at least one [[Help30:Components_Weblinks_Categories_Edit|Web Links Category]] before you can create your first Web Link.

==Screenshot==

[[Image:Help30-Components-Weblinks-Links-Edit-screen.png|670px]]

===Edit Web Link===

This is where you enter or edit basic link information.

*'''Title'''. The Title of the Web Link. This field is required.
{{Chunk30:colheader|Alias}}
*'''URL'''. The URL of the Web Link.
{{Chunk30:colheader|Description}}
{{Chunk30:Add Category Quick Edit Buttons}}
{{Chunk30:colheader|Category}}
{{Chunk30:colheader|Tags}}
{{Chunk30:colheader|Status}}
{{Chunk30:colheader|Access}}
{{Chunk30:colheader|Language}}
{{Chunk30:colheader|Version Note}}

===Publishing===
[[Image:Help30-Components-Weblinks-Links-Edit-publishing-options-tab.png|670px]]

{{Chunk30:colheader|Start Publishing}}
{{Chunk30:colheader|Finish Publishing}}
{{Chunk30:colheader|Enter Created Date}}
{{Chunk30:colheader|Enter Created By}}
{{Chunk30:colheader|Enter Created By Alias}}
{{Chunk30:colheader|Modified Date}}
{{Chunk30:colheader|Modified By}}
{{Chunk30:colheader|Revisions}}
{{Chunk30:colheader|Hits}}
{{Chunk30:colheader|Id}}
{{Chunk30:colheader|Metadata Description}}
{{Chunk30:colheader|Metadata Keywords}}
{{Chunk30:colheader|External Reference}}
{{Chunk30:colheader|Metadata Robots}}
{{Chunk30:colheader|Content Help Screens Rights}}

===Options===
[[Image:Help30-Components-Weblinks-Links-Edit-basic-options-tab.png]]

{{Chunk30:colheader|Target}}
{{Chunk30:colheader|Width}}
{{Chunk30:colheader|Height}}
*'''Count Clicks.''' Whether or not to keep track of how many times this web link has been opened.

===Images===
[[File:Help30-Components-Weblinks-Links-Edit-Image-Options-Tab.png]]

{{Chunk30:Image|First Image}}
{{Chunk30:colheader|Image Float}}
{{Chunk30:colheader|Alt text}}
{{Chunk30:colheader|Caption}}
{{Chunk30:Image|Second Image}}
{{Chunk30:colheader|Image Float}}
{{Chunk30:colheader|Alt text}}
{{Chunk30:colheader|Caption}}

==Toolbar==
{{Chunk30:EditAndNewToolbars|Web Links Manager: Web Link|Web Links Manager: Web Link}}

==Quick Tips==
* At least one Web Link Category must be added ''before'' any Web Links can be created.

==Related Information==
*To add or edit Web Link Categories: [[Help30:Components_Weblinks_Categories|Web Link Category Manager]]
*To find and edit existing Web Links: [[Help30:Components_Weblinks_Links|Web Link Manager]]
*To create a page layout for Web Links: [[Help30:Menus_Menu_Item_Manager_Edit#Internal_Link_-_Web_Links|Menu Item Manager - New/Edit - Internal Link - Web Links]]

<noinclude>{{cathelp|3.0,3.1|Web Link Manager Help Screens|Components Help Screens}}</noinclude>

User:Dextercowley/gallery

2013-10-14T00:40:08Z

Dextercowley: commonist 0.4.28

== Sun Oct 13 17:39:49 PDT 2013 ==
<gallery>
File:Help30-Components-Weblinks-Links-Edit-Image-Options-Tab.png|
File:Help30-Components-Weblinks-Links-Edit-basic-options-tab.png|
File:Help30-Components-Weblinks-Links-Edit-publishing-options-tab.png|
</gallery>

== Sun Oct 13 16:43:56 PDT 2013 ==
<gallery>
File:Help30-Components-Newsfeeds-Feed-Edit-Display-Options-Tab.png|
File:Help30-Components-Newsfeeds-Feed-Edit-Image-Options-Tab.png|
</gallery>

== Sun Oct 14 07:12:09 PDT 2012 ==
<gallery>
File:Easygithub1.png|
File:Easygithub2.png|
File:Easygithub4.png|
File:Easygithub5.png|
File:Easygithub6.png|
File:Easygithub7.png|
File:Easygithub8.png|
File:Easygithub9.png|
</gallery>

== Wed Oct 10 17:34:50 PDT 2012 ==
<gallery>
File:Git-coders-tutorial-20121009-23.png|
</gallery>

== Wed Oct 10 17:29:26 PDT 2012 ==
<gallery>
File:Git-coders-tutorial-20121009-22.png|
</gallery>

== Wed Oct 10 17:18:47 PDT 2012 ==
<gallery>
File:Git-coders-tutorial-20121009-18.png|
File:Git-coders-tutorial-20121009-19.png|
File:Git-coders-tutorial-20121009-20.png|
File:Git-coders-tutorial-20121009-21.png|
</gallery>

== Wed Oct 10 16:54:09 PDT 2012 ==
<gallery>
File:Git-coders-tutorial-20121009-17.png|
</gallery>

== Wed Oct 10 16:02:02 PDT 2012 ==
<gallery>
File:Git-coders-tutorial-20121009-16.png|
</gallery>

== Wed Oct 10 15:20:50 PDT 2012 ==
<gallery>
File:Git-coders-tutorial-20121009-11.png|
File:Git-coders-tutorial-20121009-12.png|
File:Git-coders-tutorial-20121009-13.png|
File:Git-coders-tutorial-20121009-14.png|
File:Git-coders-tutorial-20121009-15.png|
</gallery>

== Wed Oct 10 11:40:41 PDT 2012 ==
<gallery>
File:Git-coders-tutorial-20121009-10.png|
</gallery>

== Wed Oct 10 11:37:54 PDT 2012 ==
<gallery>
File:Git-coders-tutorial-20121009-09.png|
</gallery>

== Wed Oct 10 11:32:55 PDT 2012 ==
<gallery>
File:Git-coders-tutorial-20121009-09.png|
</gallery>

== Wed Oct 10 11:05:13 PDT 2012 ==
<gallery>
File:Git-coders-tutorial-20121009-07.png|
File:Git-coders-tutorial-20121009-08.png|
</gallery>

== Tue Oct 09 17:56:50 PDT 2012 ==
<gallery>
File:Git-coders-tutorial-20121009-06.png|
</gallery>

== Tue Oct 09 17:39:00 PDT 2012 ==
<gallery>
File:Git-coders-tutorial-20121009-01.png|
File:Git-coders-tutorial-20121009-02.png|
File:Git-coders-tutorial-20121009-03.png|
File:Git-coders-tutorial-20121009-04.png|
File:Git-coders-tutorial-20121009-05.png|
</gallery>

== Mon Oct 08 21:26:49 PDT 2012 ==
<gallery>
File:Media_1349743656750.png|
File:Media_1349745128572.png|
File:Media_1349749085366.png|
File:Media_1349749557492.png|
</gallery>

== Mon Jun 25 13:04:30 PDT 2012 ==
<gallery>
File:Help25-screenshot-article-manager-options-toolbar.png|
</gallery>

== Sun Jun 24 20:24:55 PDT 2012 ==
<gallery>
File:Help25-screenshot-article-manager-options-articles.png|
File:Help25-screenshot-article-manager-options-blog-featured-layouts.png|
File:Help25-screenshot-article-manager-options-categories.png|
File:Help25-screenshot-article-manager-options-category.png|
File:Help25-screenshot-article-manager-options-editing-layout.png|
File:Help25-screenshot-article-manager-options-integration.png|
File:Help25-screenshot-article-manager-options-list-layouts.png|
File:Help25-screenshot-article-manager-options-permissions.png|
File:Help25-screenshot-article-manager-options-shared-options.png|
File:Help25-screenshot-article-manager-options.png|
</gallery>

== Sun Jun 24 19:52:18 PDT 2012 ==
<gallery>
File:Help25-screenshot-article-edit-toolbar.png|
</gallery>

== Sun Jun 24 19:38:37 PDT 2012 ==
=== errors ===
*[[:File:Help25-screenshot-article-edit-permissions.png]] missingparam

<gallery>
File:Help25-screenshot-article-edit-permissions.png|
</gallery>

== Sun Jun 24 17:33:18 PDT 2012 ==
<gallery>
File:Help25-screenshot-article-edit-permissions.png|
</gallery>

== Sun Jun 24 07:46:27 PDT 2012 ==
<gallery>
File:Help25-screenshot-article-edit-article-options.png|
File:Help25-screenshot-article-edit-configure-edit-screen.png|
File:Help25-screenshot-article-edit-images-links.png|
File:Help25-screenshot-article-edit-metadata-options.png|
File:Help25-screenshot-article-edit-publishing-options.png|
</gallery>

== Sat Jun 23 19:59:15 PDT 2012 ==
<gallery>
File:Help25-screenshot-editor-pagebreak-button.png|
</gallery>

== Sat Jun 23 19:49:11 PDT 2012 ==
<gallery>
File:Help25-screenshot-editor-image-button.png|
</gallery>

== Sat Jun 23 19:38:25 PDT 2012 ==
<gallery>
File:Help25-screenshot-editor-codemirror-example.png|
</gallery>

== Sat Jun 23 16:16:42 PDT 2012 ==
=== errors ===
*[[:File:Help25-screenshot-editor-tinymce-advanced.png]] missingparam

<gallery>
File:Help25-screenshot-editor-tinymce-advanced.png|
</gallery>

== Sat Jun 23 16:12:23 PDT 2012 ==
<gallery>
File:Help25-screenshot-editor-tinymce-advanced.png|
File:Help25-screenshot-editor-tinymce-extended.png|
File:Help25-screenshot-editor-tinymce-simple.png|
</gallery>

== Sat Jun 23 16:04:16 PDT 2012 ==
=== errors ===
*[[:File:Help25-screenshot-editor-buttons.png]] missingparam

<gallery>
File:Help25-screenshot-editor-buttons.png|
</gallery>

== Sat Jun 23 16:02:36 PDT 2012 ==
<gallery>
File:Help25-screenshot-editor-buttons.png|
</gallery>

== Tue Jun 12 18:29:34 PDT 2012 ==
<gallery>
File:Tortoisegit-tutorial-screenshot-20120612-21.png|
File:Tortoisegit-tutorial-screenshot-20120612-22.png|
File:Tortoisegit-tutorial-screenshot-20120612-22a.png|
File:Tortoisegit-tutorial-screenshot-20120612-23.png|
File:Tortoisegit-tutorial-screenshot-20120612-24.png|
</gallery>

== Tue Jun 12 17:57:24 PDT 2012 ==
<gallery>
File:Tortoisegit-tutorial-screenshot-20120612-01.png|
File:Tortoisegit-tutorial-screenshot-20120612-02.png|
File:Tortoisegit-tutorial-screenshot-20120612-03.png|
File:Tortoisegit-tutorial-screenshot-20120612-04.png|
File:Tortoisegit-tutorial-screenshot-20120612-05.png|
File:Tortoisegit-tutorial-screenshot-20120612-06.png|
File:Tortoisegit-tutorial-screenshot-20120612-07.png|
File:Tortoisegit-tutorial-screenshot-20120612-08.png|
File:Tortoisegit-tutorial-screenshot-20120612-09.png|
File:Tortoisegit-tutorial-screenshot-20120612-10.png|
File:Tortoisegit-tutorial-screenshot-20120612-11.png|
File:Tortoisegit-tutorial-screenshot-20120612-12.png|
File:Tortoisegit-tutorial-screenshot-20120612-13.png|
File:Tortoisegit-tutorial-screenshot-20120612-14.png|
File:Tortoisegit-tutorial-screenshot-20120612-15.png|
File:Tortoisegit-tutorial-screenshot-20120612-16.png|
File:Tortoisegit-tutorial-screenshot-20120612-17.png|
File:Tortoisegit-tutorial-screenshot-20120612-18.png|
File:Tortoisegit-tutorial-screenshot-20120612-19.png|
File:Tortoisegit-tutorial-screenshot-20120612-20.png|
</gallery>

== Fri Jun 01 16:20:16 PDT 2012 ==
<gallery>
File:Git-document-screenshot-20120530-01.png|
File:Git-document-screenshot-20120530-02.png|
File:Git-document-screenshot-20120530-03.png|
File:Git-document-screenshot-20120530-04.png|
</gallery>

== Fri Jun 01 16:14:48 PDT 2012 ==
=== errors ===
*[[:File:Git-document-screenshot-20120529-01.png]] aborted: exists: [[:File:Git-document-screenshot-20120529-01.png]]
*[[:File:Git-document-screenshot-20120529-02.png]] aborted: exists: [[:File:Git-document-screenshot-20120529-02.png]]
*[[:File:Git-document-screenshot-20120529-03.png]] aborted: exists: [[:File:Git-document-screenshot-20120529-03.png]]
*[[:File:Git-document-screenshot-20120529-04.png]] aborted: exists: [[:File:Git-document-screenshot-20120529-04.png]]

<gallery>
File:Git-document-screenshot-20120529-01.png|
File:Git-document-screenshot-20120529-02.png|
File:Git-document-screenshot-20120529-03.png|
File:Git-document-screenshot-20120529-04.png|
</gallery>

== Wed May 09 11:44:58 PDT 2012 ==
<gallery>
File:Eclipse-install-372-screenshot-01.png|
File:Eclipse-install-372-screenshot-02.png|
File:Eclipse-install-372-screenshot-03.png|
File:Eclipse-install-372-screenshot-04.png|
</gallery>

== Wed May 09 11:24:44 PDT 2012 ==
<gallery>
File:Git-eclipse-screenshot-01.png|
File:Git-eclipse-screenshot-02.png|
File:Git-eclipse-screenshot-03.png|
File:Git-eclipse-screenshot-03a.png|
File:Git-eclipse-screenshot-04.png|
File:Git-eclipse-screenshot-04a.png|
File:Git-eclipse-screenshot-05.png|
File:Git-eclipse-screenshot-06.png|
File:Git-eclipse-screenshot-07.png|
File:Git-eclipse-screenshot-07a.png|
File:Git-eclipse-screenshot-08.png|
File:Git-eclipse-screenshot-09.png|
File:Git-eclipse-screenshot-10.png|
File:Git-eclipse-screenshot-11.png|
File:Git-eclipse-screenshot-12.png|
File:Git-eclipse-screenshot-13.png|
File:Git-eclipse-screenshot-14.png|
File:Git-eclipse-screenshot-15.png|
</gallery>

== Wed Apr 18 17:05:54 PDT 2012 ==
<gallery>
File:Help25-chunk-colheader-batch-process.png|
File:Help25-chunk-colheader-pagination.png|
</gallery>

== Wed Apr 18 15:32:45 PDT 2012 ==
<gallery>
File:Help25-chunk-colheader-select-access.png|
File:Help25-chunk-colheader-select-author.png|
File:Help25-chunk-colheader-select-category.png|
File:Help25-chunk-colheader-select-language.png|
File:Help25-chunk-colheader-select-max-levels.png|
File:Help25-chunk-colheader-select-status.png|
</gallery>

== Wed Apr 18 15:04:00 PDT 2012 ==
<gallery>
File:Help25-chunk-colheader-filter-field.png|
</gallery>

== Wed Apr 18 10:23:23 PDT 2012 ==
<gallery>
File:Help25-chunk-colheader-order-ascending.png|
File:Help25-chunk-colheader-order-descending.png|
</gallery>

== Wed Apr 18 10:06:58 PDT 2012 ==
<gallery>
File:Help25-chunk-colheader-order-icons.png|
</gallery>

== Tue Apr 17 20:44:13 PDT 2012 ==
<gallery>
File:Help25-chunk-state-icons.png|
</gallery>

== Mon Apr 16 20:55:35 PDT 2012 ==
<gallery>
File:Help25-chunk-article-create-article-basic-options.png|
</gallery>

== Mon Apr 16 19:21:35 PDT 2012 ==
<gallery>
File:Help25-article-create-article-front-end-editor.png|
File:Help25-article-create-article-front-end-language-metadata.png|
File:Help25-article-create-article-front-end-publishing.png|
File:Help25-article-create-article-screenshot.png|
</gallery>

== Mon Apr 16 17:59:08 PDT 2012 ==
<gallery>
File:Help25-chunk-article-category-list-layout-options.png|
</gallery>

== Mon Apr 16 17:58:13 PDT 2012 ==
=== errors ===
*[[:File:Help25-chunk-article-category-blog-layout-options.png]] aborted: exists: [[:File:Help25-chunk-article-category-blog-layout-options.png]]

<gallery>
File:Help25-chunk-article-category-blog-layout-options.png|
</gallery>

== Mon Apr 16 17:50:26 PDT 2012 ==
<gallery>
File:Help25-article-category-list-screenshot.png|
</gallery>

== Mon Apr 16 16:53:06 PDT 2012 ==
<gallery>
File:Help25-chunk-article-category-blog-layout-options.png|
</gallery>

== Mon Apr 16 16:23:22 PDT 2012 ==
<gallery>
File:Help25-chunk-article-category-category-options.png|
</gallery>

== Mon Apr 16 16:20:43 PDT 2012 ==
<gallery>
File:Help25-chunk-article-category-select-category.png|
</gallery>

== Mon Apr 16 14:14:10 PDT 2012 ==
<gallery>
File:Help25-article-category-blog-screenshot.png|
</gallery>

== Mon Apr 16 10:48:33 PDT 2012 ==
=== errors ===
*[[:File:Help25-chunk-article-category-list-table-headings.png]] missingparam

<gallery>
File:Help25-chunk-article-category-list-table-headings.png|
</gallery>

== Mon Apr 16 10:46:12 PDT 2012 ==
=== errors ===
*[[:File:Help25-chunk-article-category-list-table-headings.png]] missingparam

<gallery>
File:Help25-chunk-article-category-list-table-headings.png|
</gallery>

== Mon Apr 16 10:36:50 PDT 2012 ==
=== errors ===
*[[:File:Help25-chunk-article-category-list-table-headings.png]] missingparam

<gallery>
File:Help25-chunk-article-category-list-table-headings.png|
</gallery>

== Mon Apr 16 10:07:56 PDT 2012 ==
=== errors ===
*[[:File:Help25-chunk-article-category-list-show-date.png]] missingparam

<gallery>
File:Help25-chunk-article-category-list-show-date.png|
</gallery>

== Mon Apr 16 09:59:59 PDT 2012 ==
<gallery>
File:Help25-chunk-article-category-list-show-date.png|
</gallery>

== Mon Apr 16 09:38:22 PDT 2012 ==
<gallery>
File:Help25-chunk-article-category-list-table-headings.png|
</gallery>

== Mon Apr 16 09:03:31 PDT 2012 ==
<gallery>
File:Help25-article-category-list-filter-field-options.png|
</gallery>

== Mon Apr 16 08:27:55 PDT 2012 ==
<gallery>
File:Help25-article-category-list-filter-field.png|
</gallery>

== Mon Apr 16 08:23:52 PDT 2012 ==
<gallery>
File:Help25-article-category-list-display-select.png|
</gallery>

== Sun Apr 15 14:15:38 PDT 2012 ==
<gallery>
File:Help25-chunk-menu-item-categories.png|
</gallery>

== Sun Apr 15 14:06:01 PDT 2012 ==
<gallery>
File:Image_20.png|
</gallery>

== Sun Apr 15 14:04:39 PDT 2012 ==
<gallery>
File:Help25-article-categories-categories-options.png|
File:Help25-article-categories-category-options.png|
File:Help25-article-categories-front-end.png|
File:Help25-article-categories-list-layout-options.png|
File:Help25-article-categories-required-settings.png|
</gallery>

== Sun Apr 15 14:04:10 PDT 2012 ==
<gallery>
File:Help25-article-categories-article-options.png|
File:Help25-article-categories-blog-layout-options.png|
</gallery>

== Tue Jan 18 17:25:47 PST 2011 ==
=== errors ===
*[[:File:Help16-Content_Article_Manager-Options-screen7.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK

<gallery>
Image:Help16-Content_Article_Manager-Conguration-screen1.png|
File:Help16-Content_Article_Manager-Options-screen7.png|
</gallery>

== Tue Jan 18 17:07:17 PST 2011 ==
<gallery>
Image:Help16-Content_Article_Manager-Options-screen1.png|
Image:Help16-Content_Article_Manager-Options-screen2.png|
Image:Help16-Content_Article_Manager-Options-screen3.png|
Image:Help16-Content_Article_Manager-Options-screen4.png|
Image:Help16-Content_Article_Manager-Options-screen5.png|
Image:Help16-Content_Article_Manager-Options-screen6.png|
Image:Help16-Content_Article_Manager-Options-screen7.png|
Image:Help16-Content_Article_Manager-Options-screen8.png|
</gallery>

== Sun Jan 16 16:07:40 PST 2011 ==
<gallery>
Image:Help16-Users_User_Manager-Other-Filter-screen.png|
Image:Help16-Users_User_Manager-Search-Filter-screen.png|
</gallery>

== Wed Jan 12 17:14:16 PST 2011 ==
<gallery>
Image:Screenshot_acl_tutorial_20110112-15.png|
</gallery>

== Wed Jan 12 17:02:08 PST 2011 ==
<gallery>
Image:Screenshot_acl_tutorial_20110112-10.png|
Image:Screenshot_acl_tutorial_20110112-11.png|
Image:Screenshot_acl_tutorial_20110112-12.png|
Image:Screenshot_acl_tutorial_20110112-13.png|
Image:Screenshot_acl_tutorial_20110112-14.png|
</gallery>

== Wed Jan 12 15:52:26 PST 2011 ==
<gallery>
Image:Screenshot_acl_tutorial_20110111-11a.png|
Image:Screenshot_acl_tutorial_20110111-12a.png|
</gallery>

== Wed Jan 12 15:51:20 PST 2011 ==
=== errors ===
*[[:File:Screenshot_acl_tutorial_20110111-11.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK
*[[:File:Screenshot_acl_tutorial_20110111-12.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK

<gallery>
File:Screenshot_acl_tutorial_20110111-11.png|
File:Screenshot_acl_tutorial_20110111-12.png|
</gallery>

== Wed Jan 12 15:42:54 PST 2011 ==
<gallery>
Image:Screenshot_acl_tutorial_20110112-07.png|
Image:Screenshot_acl_tutorial_20110112-08.png|
Image:Screenshot_acl_tutorial_20110112-09.png|
</gallery>

== Wed Jan 12 10:11:47 PST 2011 ==
<gallery>
Image:Screenshot_acl_tutorial_20110112-01.png|
Image:Screenshot_acl_tutorial_20110112-02.png|
Image:Screenshot_acl_tutorial_20110112-03.png|
Image:Screenshot_acl_tutorial_20110112-04.png|
Image:Screenshot_acl_tutorial_20110112-05.png|
Image:Screenshot_acl_tutorial_20110112-06.png|
</gallery>

== Wed Jan 12 08:27:33 PST 2011 ==
<gallery>
Image:Screenshot_acl_tutorial_20110111-01.png|
Image:Screenshot_acl_tutorial_20110111-02.png|
Image:Screenshot_acl_tutorial_20110111-03.png|
Image:Screenshot_acl_tutorial_20110111-04.png|
Image:Screenshot_acl_tutorial_20110111-05.png|
Image:Screenshot_acl_tutorial_20110111-06.png|
Image:Screenshot_acl_tutorial_20110111-07.png|
Image:Screenshot_acl_tutorial_20110111-08.png|
Image:Screenshot_acl_tutorial_20110111-09.png|
Image:Screenshot_acl_tutorial_20110111-10.png|
Image:Screenshot_acl_tutorial_20110111-11.png|
Image:Screenshot_acl_tutorial_20110111-12.png|
Image:Screenshot_acl_tutorial_20110111-13.png|
Image:Screenshot_acl_tutorial_20110111-14.png|
Image:Screenshot_acl_tutorial_20110111-15.png|
Image:Screenshot_acl_tutorial_20110111-16.png|
Image:Screenshot_acl_tutorial_20110111-17.png|
Image:Screenshot_acl_tutorial_20110111-18.png|
Image:Screenshot_acl_tutorial_20110111-19.png|
Image:Screenshot_acl_tutorial_20110111-20.png|
Image:Screenshot_acl_tutorial_20110111-21.png|
</gallery>

== Fri Jan 07 15:49:21 PST 2011 ==
<gallery>
Image:Screenshot_override_tutorial_20110107-01.png|
Image:Screenshot_override_tutorial_20110107-02.png|
Image:Screenshot_override_tutorial_20110107-03.png|
Image:Screenshot_override_tutorial_20110107-04.png|
Image:Screenshot_override_tutorial_20110107-05.png|
Image:Screenshot_override_tutorial_20110107-06.png|
Image:Screenshot_override_tutorial_20110107-07.png|
</gallery>

== Wed Apr 07 14:07:54 PDT 2010 ==
<gallery>
Image:Unit_test_tutorial_screenshot_20100406-16.png|
</gallery>

== Wed Apr 07 13:48:49 PDT 2010 ==
<gallery>
Image:Unit_test_tutorial_screenshot_20100406-14.png|
Image:Unit_test_tutorial_screenshot_20100406-15.png|
</gallery>

== Wed Apr 07 10:23:57 PDT 2010 ==
=== errors ===
*[[:File:Unit_test_tutorial_screenshot_20100406-02.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK

<gallery>
File:Unit_test_tutorial_screenshot_20100406-02.png|
Image:Unit_test_tutorial_screenshot_20100406-10.png|
Image:Unit_test_tutorial_screenshot_20100406-11.png|
Image:Unit_test_tutorial_screenshot_20100406-12.png|
Image:Unit_test_tutorial_screenshot_20100406-13.png|
</gallery>

== Tue Apr 06 19:40:09 PDT 2010 ==
=== errors ===
*[[:File:Unit_test_tutorial_screenshot_20100405-01.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK
*[[:File:Unit_test_tutorial_screenshot_20100406-01.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK

<gallery>
File:Unit_test_tutorial_screenshot_20100405-01.png|
File:Unit_test_tutorial_screenshot_20100406-01.png|
Image:Unit_test_tutorial_screenshot_20100406-01a.png|
Image:Unit_test_tutorial_screenshot_20100406-01b.png|
Image:Unit_test_tutorial_screenshot_20100406-01c.png|
Image:Unit_test_tutorial_screenshot_20100406-02.png|
Image:Unit_test_tutorial_screenshot_20100406-03.png|
Image:Unit_test_tutorial_screenshot_20100406-04.png|
Image:Unit_test_tutorial_screenshot_20100406-05.png|
Image:Unit_test_tutorial_screenshot_20100406-06.png|
Image:Unit_test_tutorial_screenshot_20100406-07.png|
Image:Unit_test_tutorial_screenshot_20100406-08.png|
Image:Unit_test_tutorial_screenshot_20100406-09.png|
Image:Unit_test_tutorial_screenshot_20100406-09a.png|
</gallery>

== Mon Jan 04 19:46:24 PST 2010 ==
<gallery>
Image:Svn_merge_20100104_01.png|
Image:Svn_merge_20100104_02.png|
Image:Svn_merge_20100104_03.png|
</gallery>

== Tue Oct 20 15:58:01 PDT 2009 ==
<gallery>
Image:Screen_user_new_group_20091019.png|
</gallery>

== Tue Oct 20 15:54:35 PDT 2009 ==
<gallery>
Image:Screen_user_access_level_20091019.png|
</gallery>

== Tue Oct 20 15:41:06 PDT 2009 ==
=== errors ===
*[[:File:Screen_article_mgr_permissions1_20091019.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK

<gallery>
File:Screen_article_mgr_permissions1_20091019.png|
</gallery>

== Tue Oct 20 15:33:12 PDT 2009 ==
<gallery>
Image:Screen_article_mgr_permissions1_20091019.png|
</gallery>

== Sun Oct 18 17:34:00 PDT 2009 ==
<gallery>
Image:Screen_menu_permissions_20091018.png|
</gallery>

== Sun Oct 18 17:27:55 PDT 2009 ==
<gallery>
Image:Screen_global_config_permissions_20091018.png|
</gallery>

== Sun Oct 18 17:25:16 PDT 2009 ==
<gallery>
Image:Screen_global_config_permissions_20091018.png|
</gallery>

== Sun Oct 18 16:52:03 PDT 2009 ==
<gallery>
Image:Screen_article_permissions1_20091018.png|
Image:Screen_article_permissions2_20091018.png|
Image:Screen_category_permissions1_20091018.png|
Image:Screen_category_permissions2_20091018.png|
</gallery>

== Sun Oct 18 08:28:37 PDT 2009 ==
<gallery>
Image:Acl_example_diagram1_20091018.png|
Image:Acl_example_diagram2_20091018.png|
</gallery>

== Sat Oct 17 16:29:17 PDT 2009 ==
=== errors ===
*[[:File:Acl_example_diagram3a_20091017.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK

<gallery>
File:Acl_example_diagram3a_20091017.png|
</gallery>

== Sat Oct 17 16:28:37 PDT 2009 ==
=== errors ===
*[[:File:Acl_example_diagram3a_20091017.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK

<gallery>
File:Acl_example_diagram3a_20091017.png|
</gallery>

== Sat Oct 17 16:26:05 PDT 2009 ==
=== errors ===
*[[:File:Acl_example_diagram3a_20091017.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK

<gallery>
File:Acl_example_diagram3a_20091017.png|
</gallery>

== Sat Oct 17 15:53:47 PDT 2009 ==
<gallery>
Image:Acl_example_diagram2_20091017.png|
Image:Acl_example_diagram3_20091017.png|
</gallery>

== Sat Oct 17 01:02:35 PDT 2009 ==
<gallery>
Image:Screen_menu_access_level_20091016.png|
Image:Screen_user_access_level_20091016.png|
</gallery>

== Fri Oct 16 16:17:18 PDT 2009 ==
<gallery>
Image:Screen_user_groups_20091016.png|
</gallery>

== Thu Oct 15 14:45:55 PDT 2009 ==
=== errors ===
*[[:File:Screen_user_config_20091015.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK

<gallery>
File:Screen_user_config_20091015.png|
</gallery>

== Thu Oct 15 11:22:29 PDT 2009 ==
<gallery>
Image:Screen_user_config_20091015.png|
</gallery>

== Thu Oct 15 11:19:13 PDT 2009 ==
=== errors ===
*[[:File:Screen_user_config_20091015.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK

<gallery>
File:Screen_user_config_20091015.png|
</gallery>

== Thu Oct 15 11:17:45 PDT 2009 ==
=== errors ===
*[[:File:Screen_user_config_permissions_20091015.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK

<gallery>
File:Screen_user_config_permissions_20091015.png|
</gallery>

== Thu Oct 15 11:13:50 PDT 2009 ==
=== errors ===
*[[:File:Screen_user_config_permissions_20091015.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK

<gallery>
File:Screen_user_config_permissions_20091015.png|
</gallery>

== Thu Oct 15 11:10:38 PDT 2009 ==
=== errors ===
*[[:File:Screen_user_config_permissions_20091015.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK

<gallery>
Image:Screen_content_options_permissions_20091015.png|
File:Screen_user_config_permissions_20091015.png|
</gallery>

== Wed Oct 14 20:01:15 PDT 2009 ==
<gallery>
Image:Screen_content_global_config_20091014.png|
Image:Screen_content_options_permissions_20091014.png|
Image:Tutorial_acl_diagram_20091014.png|
</gallery>

== Tue Aug 25 18:01:44 PDT 2009 ==
<gallery>
Image:Selenium_ide_screenshot1_20090821.png|
Image:Selenium_ide_screenshot2_20090821.png|
</gallery>

== Mon Aug 24 16:03:20 PDT 2009 ==
<gallery>
Image:Commonist-128.png|
</gallery>

File:Help30-Components-Weblinks-Links-Edit-publishing-options-tab-en.png

2013-10-14T00:40:06Z

Dextercowley:

[[:File:Help30-Components-Weblinks-Links-Edit-basic-options-tab.png|<<<]]
>>>

== batch ==
help screenshots for version 3.2

== description ==

== source ==
screenshot

== date ==
10/13/2012

== author ==
Mark Dexter

== permission ==

== license ==

{{self2|GFDL|cc-by-sa-2.5,2.0,1.0}}

File:Help30-Components-Weblinks-Links-Edit-basic-options-tab-en.png

2013-10-14T00:40:05Z

Dextercowley:

[[:File:Help30-Components-Weblinks-Links-Edit-Image-Options-Tab.png|<<<]]
[[:File:Help30-Components-Weblinks-Links-Edit-publishing-options-tab.png|>>>]]

== batch ==
help screenshots for version 3.2

== description ==

== source ==
screenshot

== date ==
10/13/2012

== author ==
Mark Dexter

== permission ==

== license ==

{{self2|GFDL|cc-by-sa-2.5,2.0,1.0}}

File:Help30-Components-Weblinks-Links-Edit-Image-Options-Tab-en.png

2013-10-14T00:40:04Z

Dextercowley:

<<<
[[:File:Help30-Components-Weblinks-Links-Edit-basic-options-tab.png|>>>]]

== batch ==
help screenshots for version 3.2

== description ==

== source ==
screenshot

== date ==
10/13/2012

== author ==
Mark Dexter

== permission ==

== license ==

{{self2|GFDL|cc-by-sa-2.5,2.0,1.0}}

Help310:Components Weblinks Links Edit

2013-10-14T00:34:38Z

Dextercowley: add images tab

<noinclude>{{Help screen navbox|3.0|Components Help Screens}}</noinclude>==Overview==
This screen lets you create new Web Links and edit existing ones.

==How to Access==

Navigate to the [[Help30:Components_Weblinks_Links|Web Links Manager]]. To add a new Web Link, click the "New" icon in the toolbar. To edit an existing Web Link, click the Web Link's Title, or check the Web Link's checkbox and press the "Edit" icon in the toolbar.

==Description==

This is where you add a new Web Link or edit an existing one. Note that you need to create at least one [[Help30:Components_Weblinks_Categories_Edit|Web Links Category]] before you can create your first Web Link.

==Screenshot==

[[Image:Help30-Components-Weblinks-Links-Edit-screen.png|670px]]

===Edit Web Link===

This is where you enter or edit basic link information.

*'''Title'''. The Title of the Web Link. This field is required.
{{Chunk30:colheader|Alias}}
*'''URL'''. The URL of the Web Link.
{{Chunk30:colheader|Description}}
{{Chunk30:Add Category Quick Edit Buttons}}
{{Chunk30:colheader|Category}}
{{Chunk30:colheader|Tags}}
{{Chunk30:colheader|Status}}
{{Chunk30:colheader|Access}}
{{Chunk30:colheader|Language}}
{{Chunk30:colheader|Version Note}}

===Publishing===
[[Image:Help30-Components-Weblinks-Links-Edit-publishing-options-tab.png]]

{{Chunk30:colheader|Start Publishing}}
{{Chunk30:colheader|Finish Publishing}}
{{Chunk30:colheader|Enter Created Date}}
{{Chunk30:colheader|Enter Created By}}
{{Chunk30:colheader|Enter Created By Alias}}
{{Chunk30:colheader|Modified Date}}
{{Chunk30:colheader|Modified By}}
{{Chunk30:colheader|Revisions}}
{{Chunk30:colheader|Hits}}
{{Chunk30:colheader|Id}}
{{Chunk30:colheader|Metadata Description}}
{{Chunk30:colheader|Metadata Keywords}}
{{Chunk30:colheader|External Reference}}
{{Chunk30:colheader|Metadata Robots}}
{{Chunk30:colheader|Content Help Screens Rights}}

===Options===
[[Image:Help30-Components-Weblinks-Links-Edit-basic-options-tab.png]]

{{Chunk30:colheader|Target}}
{{Chunk30:colheader|Width}}
{{Chunk30:colheader|Height}}
*'''Count Clicks.''' Whether or not to keep track of how many times this web link has been opened.

===Images===
[[File:Help30-Components-Weblinks-Links-Edit-Image-Options-Tab.png]]

{{Chunk30:Image|First Image}}
{{Chunk30:colheader|Image Float}}
{{Chunk30:colheader|Alt text}}
{{Chunk30:colheader|Caption}}
{{Chunk30:Image|Second Image}}
{{Chunk30:colheader|Image Float}}
{{Chunk30:colheader|Alt text}}
{{Chunk30:colheader|Caption}}

==Toolbar==
{{Chunk30:EditAndNewToolbars|Web Links Manager: Web Link|Web Links Manager: Web Link}}

==Quick Tips==
* At least one Web Link Category must be added ''before'' any Web Links can be created.

==Related Information==
*To add or edit Web Link Categories: [[Help30:Components_Weblinks_Categories|Web Link Category Manager]]
*To find and edit existing Web Links: [[Help30:Components_Weblinks_Links|Web Link Manager]]
*To create a page layout for Web Links: [[Help30:Menus_Menu_Item_Manager_Edit#Internal_Link_-_Web_Links|Menu Item Manager - New/Edit - Internal Link - Web Links]]

<noinclude>{{cathelp|3.0,3.1|Web Link Manager Help Screens|Components Help Screens}}</noinclude>

Help310:Components Weblinks Links Edit

2013-10-14T00:32:41Z

Dextercowley: /* Publishing */

<noinclude>{{Help screen navbox|3.0|Components Help Screens}}</noinclude>==Overview==
This screen lets you create new Web Links and edit existing ones.

==How to Access==

Navigate to the [[Help30:Components_Weblinks_Links|Web Links Manager]]. To add a new Web Link, click the "New" icon in the toolbar. To edit an existing Web Link, click the Web Link's Title, or check the Web Link's checkbox and press the "Edit" icon in the toolbar.

==Description==

This is where you add a new Web Link or edit an existing one. Note that you need to create at least one [[Help30:Components_Weblinks_Categories_Edit|Web Links Category]] before you can create your first Web Link.

==Screenshot==

[[Image:Help30-Components-Weblinks-Links-Edit-screen.png|670px]]

===Edit Web Link===

This is where you enter or edit basic link information.

*'''Title'''. The Title of the Web Link. This field is required.
{{Chunk30:colheader|Alias}}
*'''URL'''. The URL of the Web Link.
{{Chunk30:colheader|Description}}
{{Chunk30:Add Category Quick Edit Buttons}}
{{Chunk30:colheader|Category}}
{{Chunk30:colheader|Tags}}
{{Chunk30:colheader|Status}}
{{Chunk30:colheader|Access}}
{{Chunk30:colheader|Language}}
{{Chunk30:colheader|Version Note}}

===Publishing===
[[Image:Help30-Components-Weblinks-Links-Edit-publishing-options-tag.png]]

{{Chunk30:colheader|Start Publishing}}
{{Chunk30:colheader|Finish Publishing}}
{{Chunk30:colheader|Enter Created Date}}
{{Chunk30:colheader|Enter Created By}}
{{Chunk30:colheader|Enter Created By Alias}}
{{Chunk30:colheader|Modified Date}}
{{Chunk30:colheader|Modified By}}
{{Chunk30:colheader|Revisions}}
{{Chunk30:colheader|Hits}}
{{Chunk30:colheader|Id}}
{{Chunk30:colheader|Metadata Description}}
{{Chunk30:colheader|Metadata Keywords}}
{{Chunk30:colheader|External Reference}}
{{Chunk30:colheader|Metadata Robots}}
{{Chunk30:colheader|Content Help Screens Rights}}

===Options===
[[Image:Help30-Components-Weblinks-Links-Edit-basic-options-parmeters.png]]

{{Chunk30:colheader|Target}}
{{Chunk30:colheader|Width}}
{{Chunk30:colheader|Height}}
*'''Count Clicks.''' Whether or not to keep track of how many times this web link has been opened.

==Toolbar==
{{Chunk30:EditAndNewToolbars|Web Links Manager: Web Link|Web Links Manager: Web Link}}

==Quick Tips==
* At least one Web Link Category must be added ''before'' any Web Links can be created.

==Related Information==
*To add or edit Web Link Categories: [[Help30:Components_Weblinks_Categories|Web Link Category Manager]]
*To find and edit existing Web Links: [[Help30:Components_Weblinks_Links|Web Link Manager]]
*To create a page layout for Web Links: [[Help30:Menus_Menu_Item_Manager_Edit#Internal_Link_-_Web_Links|Menu Item Manager - New/Edit - Internal Link - Web Links]]

<noinclude>{{cathelp|3.0,3.1|Web Link Manager Help Screens|Components Help Screens}}</noinclude>

Help310:Components Weblinks Links Edit

2013-10-14T00:31:35Z

Dextercowley: update for 3.2

<noinclude>{{Help screen navbox|3.0|Components Help Screens}}</noinclude>==Overview==
This screen lets you create new Web Links and edit existing ones.

==How to Access==

Navigate to the [[Help30:Components_Weblinks_Links|Web Links Manager]]. To add a new Web Link, click the "New" icon in the toolbar. To edit an existing Web Link, click the Web Link's Title, or check the Web Link's checkbox and press the "Edit" icon in the toolbar.

==Description==

This is where you add a new Web Link or edit an existing one. Note that you need to create at least one [[Help30:Components_Weblinks_Categories_Edit|Web Links Category]] before you can create your first Web Link.

==Screenshot==

[[Image:Help30-Components-Weblinks-Links-Edit-screen.png|670px]]

===Edit Web Link===

This is where you enter or edit basic link information.

*'''Title'''. The Title of the Web Link. This field is required.
{{Chunk30:colheader|Alias}}
*'''URL'''. The URL of the Web Link.
{{Chunk30:colheader|Description}}
{{Chunk30:Add Category Quick Edit Buttons}}
{{Chunk30:colheader|Category}}
{{Chunk30:colheader|Tags}}
{{Chunk30:colheader|Status}}
{{Chunk30:colheader|Access}}
{{Chunk30:colheader|Language}}
{{Chunk30:colheader|Version Note}}

===Publishing===
[[Image:Help30-Components-Weblinks-Links-Edit-publishing-options-parmeters.png]]

{{Chunk30:colheader|Start Publishing}}
{{Chunk30:colheader|Finish Publishing}}
{{Chunk30:colheader|Enter Created Date}}
{{Chunk30:colheader|Enter Created By}}
{{Chunk30:colheader|Enter Created By Alias}}
{{Chunk30:colheader|Modified Date}}
{{Chunk30:colheader|Modified By}}
{{Chunk30:colheader|Revisions}}
{{Chunk30:colheader|Hits}}
{{Chunk30:colheader|Id}}
{{Chunk30:colheader|Metadata Description}}
{{Chunk30:colheader|Metadata Keywords}}
{{Chunk30:colheader|External Reference}}
{{Chunk30:colheader|Metadata Robots}}
{{Chunk30:colheader|Content Help Screens Rights}}

===Options===
[[Image:Help30-Components-Weblinks-Links-Edit-basic-options-parmeters.png]]

{{Chunk30:colheader|Target}}
{{Chunk30:colheader|Width}}
{{Chunk30:colheader|Height}}
*'''Count Clicks.''' Whether or not to keep track of how many times this web link has been opened.

==Toolbar==
{{Chunk30:EditAndNewToolbars|Web Links Manager: Web Link|Web Links Manager: Web Link}}

==Quick Tips==
* At least one Web Link Category must be added ''before'' any Web Links can be created.

==Related Information==
*To add or edit Web Link Categories: [[Help30:Components_Weblinks_Categories|Web Link Category Manager]]
*To find and edit existing Web Links: [[Help30:Components_Weblinks_Links|Web Link Manager]]
*To create a page layout for Web Links: [[Help30:Menus_Menu_Item_Manager_Edit#Internal_Link_-_Web_Links|Menu Item Manager - New/Edit - Internal Link - Web Links]]

<noinclude>{{cathelp|3.0,3.1|Web Link Manager Help Screens|Components Help Screens}}</noinclude>

File:Help30-Components-Weblinks-Links-Edit-screen-en.png

2013-10-14T00:20:08Z

Dextercowley: Dextercowley uploaded a new version of "File:Help30-Components-Weblinks-Links-Edit-screen.png": Updated for 3.2

== Summary ==
Screenshot
== Licensing ==
{{JEDL}}

Help310:Components Newsfeeds Feeds Edit

2013-10-14T00:17:55Z

Dextercowley:

<noinclude>{{Help screen navbox|3.0|Components Help Screens}}</noinclude>==How to Access==
Navigate to the the [[Help30:Components_Newsfeeds_Feeds|News Feed Manager]]. To add a new News Feed, click the "New" icon in the toolbar. To edit an existing News Feed, click the News Feed's name, or check the news Feed's checkbox and press the "Edit" icon in the toolbar.

==Description==
This is where you add a new News Feed or edit an existing one. Note that you need to create at least one [[Help30:Components_Newsfeeds_Categories|News Feed Category]] before you can create your first News Feed.

==Screenshot==
[[Image:Help30-Components-Newsfeeds-Feeds-Edit-screen.png|670px]]

==Details and Options==
===Edit News Feed===
*'''Title.''' The Name of the News Feed. This field is required.
{{Chunk30:colheader|Alias}}
*'''Link.''' The link of this News Feed. This should normally begin with <nowiki>"http://"</nowiki>.
{{Chunk30:colheader|Description}}
{{Chunk30:Add Category Quick Edit Buttons}}
{{Chunk30:colheader|Category}}
{{Chunk30:colheader|Tags}}
{{Chunk30:colheader|State}}
{{Chunk30:colheader|Access}}
{{Chunk30:colheader|Language}}
{{Chunk30:colheader|Version Note}}

===Publishing===
[[File:Help30-Components-Newsfeeds-Feed-Edit-Publishing-Options-Tab.png|670px]]

{{Chunk30:colheader|Start Publishing}}
{{Chunk30:colheader|Finish Publishing}}
{{Chunk30:colheader|Enter Created Date}}
{{Chunk30:colheader|Enter Created By}}
{{Chunk30:colheader|Enter Created By Alias}}
{{Chunk30:colheader|Modified Date}}
{{Chunk30:colheader|Modified By}}
{{Chunk30:colheader|Revisions}}
{{Chunk30:colheader|Id}}
{{Chunk30:colheader|Metadata Description}}
{{Chunk30:colheader|Metadata Keywords}}
{{Chunk30:colheader|External Reference}}
{{Chunk30:colheader|Metadata Robots}}
{{Chunk30:colheader|Content Help Screens Rights}}

===Display===
[[File:Help30-Components-Newsfeeds-Feed-Edit-Display-Options-Tab.png]]

*'''Number of Articles.''' The number of articles from the news feed to display on the page.
*'''Cache Time.''' The number of minutes before the system checks for new content from the news feed source.
*'''Language Direction.''' Whether the language for this feed reads from left to right or right to left.

===Images===
[[File:Help30-Components-Newsfeeds-Feed-Edit-Image-Options-Tab.png]]

{{Chunk30:Image|First Image}}
{{Chunk30:colheader|Image Float}}
{{Chunk30:colheader|Alt text}}
{{Chunk30:colheader|Caption}}
{{Chunk30:Image|Second Image}}
{{Chunk30:colheader|Image Float}}
{{Chunk30:colheader|Alt text}}
{{Chunk30:colheader|Caption}}

==Toolbar==
{{Chunk30:EditAndNewToolbars|News Feed Manager: News Feed|News Feed Manager: News Feed}}

==Quick Tips==
*A News Feed category must be added ''before'' any News Feed can be created.

==Related Information==
*To add or edit News Feed Categories: [[Help30:Components_Newsfeeds_Categories|News Feed Category Manager]]

<noinclude>{{cathelp|3.0,3.1|News Feed Manager Helps Screens|Components Help Screens}}</noinclude>

Help310:Components Newsfeeds Feeds Edit

2013-10-14T00:17:24Z

Dextercowley: update for 3.2

Chunk30:Image

2013-10-14T00:16:24Z

Dextercowley:

*'''{{{1|Image}}}.''' Click on Select to select an image to display with this item in the front end.

Chunk30:Image

2013-10-14T00:16:01Z

Dextercowley: Image with variable caption.

'''{{{1|Image}}}.''' Click on Select to select an image to display with this item in the front end.

Chunk30:Help screen column header Image

2013-10-14T00:14:05Z

Dextercowley: back to original

*'''{{{Image}}}'''. Choose an image to be displayed with this item/category in the front-end.

Chunk30:Help screen column header Image

2013-10-14T00:12:23Z

Dextercowley: testing

*'''{{{1|Image}}}'''. Choose an image to be displayed with this item/category in the front-end.
*'''{{{2|Image}}}'''. Choose an image to be displayed with this item/category in the front-end.
*'''{{{3|Image}}}'''. Choose an image to be displayed with this item/category in the front-end.

Chunk30:Help screen column header Image

2013-10-14T00:08:55Z

Dextercowley:

*'''{{{2|Image}}}'''. Choose an image to be displayed with this item/category in the front-end.

Chunk30:Help screen column header Image

2013-10-14T00:07:03Z

Dextercowley: Make description a variable

*'''{{{1|Image}}}'''. Choose an image to be displayed with this item/category in the front-end.

Chunk30:Help screen column header Caption

2013-10-14T00:01:11Z

Dextercowley: caption

*'''Caption.''' The caption for the image.

Chunk30:Help screen column header Alt text

2013-10-14T00:00:35Z

Dextercowley: alt text

*'''Alt text.''' Alternative text to use for visitors who don't have access to images. This text is replaced with the caption text if caption text is available.

Chunk30:Help screen column header Image Float

2013-10-13T23:59:30Z

Dextercowley: Image float

*'''Image Float.''' (Use Global/Right/Left/None). Where to place the image relative to the text on the page.

Chunk30:Help screen column header Alt text

2013-10-13T23:58:26Z

Dextercowley: Image float chunk.

*'''Image Float.''' (Use Global/Right/Left/None). Where to place the image relative to the text on the page.

User:Dextercowley/gallery

2013-10-13T23:44:14Z

Dextercowley: commonist 0.4.28

== Sun Oct 13 16:43:56 PDT 2013 ==
<gallery>
File:Help30-Components-Newsfeeds-Feed-Edit-Display-Options-Tab.png|
File:Help30-Components-Newsfeeds-Feed-Edit-Image-Options-Tab.png|
</gallery>

== Sun Oct 14 07:12:09 PDT 2012 ==
<gallery>
File:Easygithub1.png|
File:Easygithub2.png|
File:Easygithub4.png|
File:Easygithub5.png|
File:Easygithub6.png|
File:Easygithub7.png|
File:Easygithub8.png|
File:Easygithub9.png|
</gallery>

== Wed Oct 10 17:34:50 PDT 2012 ==
<gallery>
File:Git-coders-tutorial-20121009-23.png|
</gallery>

== Wed Oct 10 17:29:26 PDT 2012 ==
<gallery>
File:Git-coders-tutorial-20121009-22.png|
</gallery>

== Wed Oct 10 17:18:47 PDT 2012 ==
<gallery>
File:Git-coders-tutorial-20121009-18.png|
File:Git-coders-tutorial-20121009-19.png|
File:Git-coders-tutorial-20121009-20.png|
File:Git-coders-tutorial-20121009-21.png|
</gallery>

== Wed Oct 10 16:54:09 PDT 2012 ==
<gallery>
File:Git-coders-tutorial-20121009-17.png|
</gallery>

== Wed Oct 10 16:02:02 PDT 2012 ==
<gallery>
File:Git-coders-tutorial-20121009-16.png|
</gallery>

== Wed Oct 10 15:20:50 PDT 2012 ==
<gallery>
File:Git-coders-tutorial-20121009-11.png|
File:Git-coders-tutorial-20121009-12.png|
File:Git-coders-tutorial-20121009-13.png|
File:Git-coders-tutorial-20121009-14.png|
File:Git-coders-tutorial-20121009-15.png|
</gallery>

== Wed Oct 10 11:40:41 PDT 2012 ==
<gallery>
File:Git-coders-tutorial-20121009-10.png|
</gallery>

== Wed Oct 10 11:37:54 PDT 2012 ==
<gallery>
File:Git-coders-tutorial-20121009-09.png|
</gallery>

== Wed Oct 10 11:32:55 PDT 2012 ==
<gallery>
File:Git-coders-tutorial-20121009-09.png|
</gallery>

== Wed Oct 10 11:05:13 PDT 2012 ==
<gallery>
File:Git-coders-tutorial-20121009-07.png|
File:Git-coders-tutorial-20121009-08.png|
</gallery>

== Tue Oct 09 17:56:50 PDT 2012 ==
<gallery>
File:Git-coders-tutorial-20121009-06.png|
</gallery>

== Tue Oct 09 17:39:00 PDT 2012 ==
<gallery>
File:Git-coders-tutorial-20121009-01.png|
File:Git-coders-tutorial-20121009-02.png|
File:Git-coders-tutorial-20121009-03.png|
File:Git-coders-tutorial-20121009-04.png|
File:Git-coders-tutorial-20121009-05.png|
</gallery>

== Mon Oct 08 21:26:49 PDT 2012 ==
<gallery>
File:Media_1349743656750.png|
File:Media_1349745128572.png|
File:Media_1349749085366.png|
File:Media_1349749557492.png|
</gallery>

== Mon Jun 25 13:04:30 PDT 2012 ==
<gallery>
File:Help25-screenshot-article-manager-options-toolbar.png|
</gallery>

== Sun Jun 24 20:24:55 PDT 2012 ==
<gallery>
File:Help25-screenshot-article-manager-options-articles.png|
File:Help25-screenshot-article-manager-options-blog-featured-layouts.png|
File:Help25-screenshot-article-manager-options-categories.png|
File:Help25-screenshot-article-manager-options-category.png|
File:Help25-screenshot-article-manager-options-editing-layout.png|
File:Help25-screenshot-article-manager-options-integration.png|
File:Help25-screenshot-article-manager-options-list-layouts.png|
File:Help25-screenshot-article-manager-options-permissions.png|
File:Help25-screenshot-article-manager-options-shared-options.png|
File:Help25-screenshot-article-manager-options.png|
</gallery>

== Sun Jun 24 19:52:18 PDT 2012 ==
<gallery>
File:Help25-screenshot-article-edit-toolbar.png|
</gallery>

== Sun Jun 24 19:38:37 PDT 2012 ==
=== errors ===
*[[:File:Help25-screenshot-article-edit-permissions.png]] missingparam

<gallery>
File:Help25-screenshot-article-edit-permissions.png|
</gallery>

== Sun Jun 24 17:33:18 PDT 2012 ==
<gallery>
File:Help25-screenshot-article-edit-permissions.png|
</gallery>

== Sun Jun 24 07:46:27 PDT 2012 ==
<gallery>
File:Help25-screenshot-article-edit-article-options.png|
File:Help25-screenshot-article-edit-configure-edit-screen.png|
File:Help25-screenshot-article-edit-images-links.png|
File:Help25-screenshot-article-edit-metadata-options.png|
File:Help25-screenshot-article-edit-publishing-options.png|
</gallery>

== Sat Jun 23 19:59:15 PDT 2012 ==
<gallery>
File:Help25-screenshot-editor-pagebreak-button.png|
</gallery>

== Sat Jun 23 19:49:11 PDT 2012 ==
<gallery>
File:Help25-screenshot-editor-image-button.png|
</gallery>

== Sat Jun 23 19:38:25 PDT 2012 ==
<gallery>
File:Help25-screenshot-editor-codemirror-example.png|
</gallery>

== Sat Jun 23 16:16:42 PDT 2012 ==
=== errors ===
*[[:File:Help25-screenshot-editor-tinymce-advanced.png]] missingparam

<gallery>
File:Help25-screenshot-editor-tinymce-advanced.png|
</gallery>

== Sat Jun 23 16:12:23 PDT 2012 ==
<gallery>
File:Help25-screenshot-editor-tinymce-advanced.png|
File:Help25-screenshot-editor-tinymce-extended.png|
File:Help25-screenshot-editor-tinymce-simple.png|
</gallery>

== Sat Jun 23 16:04:16 PDT 2012 ==
=== errors ===
*[[:File:Help25-screenshot-editor-buttons.png]] missingparam

<gallery>
File:Help25-screenshot-editor-buttons.png|
</gallery>

== Sat Jun 23 16:02:36 PDT 2012 ==
<gallery>
File:Help25-screenshot-editor-buttons.png|
</gallery>

== Tue Jun 12 18:29:34 PDT 2012 ==
<gallery>
File:Tortoisegit-tutorial-screenshot-20120612-21.png|
File:Tortoisegit-tutorial-screenshot-20120612-22.png|
File:Tortoisegit-tutorial-screenshot-20120612-22a.png|
File:Tortoisegit-tutorial-screenshot-20120612-23.png|
File:Tortoisegit-tutorial-screenshot-20120612-24.png|
</gallery>

== Tue Jun 12 17:57:24 PDT 2012 ==
<gallery>
File:Tortoisegit-tutorial-screenshot-20120612-01.png|
File:Tortoisegit-tutorial-screenshot-20120612-02.png|
File:Tortoisegit-tutorial-screenshot-20120612-03.png|
File:Tortoisegit-tutorial-screenshot-20120612-04.png|
File:Tortoisegit-tutorial-screenshot-20120612-05.png|
File:Tortoisegit-tutorial-screenshot-20120612-06.png|
File:Tortoisegit-tutorial-screenshot-20120612-07.png|
File:Tortoisegit-tutorial-screenshot-20120612-08.png|
File:Tortoisegit-tutorial-screenshot-20120612-09.png|
File:Tortoisegit-tutorial-screenshot-20120612-10.png|
File:Tortoisegit-tutorial-screenshot-20120612-11.png|
File:Tortoisegit-tutorial-screenshot-20120612-12.png|
File:Tortoisegit-tutorial-screenshot-20120612-13.png|
File:Tortoisegit-tutorial-screenshot-20120612-14.png|
File:Tortoisegit-tutorial-screenshot-20120612-15.png|
File:Tortoisegit-tutorial-screenshot-20120612-16.png|
File:Tortoisegit-tutorial-screenshot-20120612-17.png|
File:Tortoisegit-tutorial-screenshot-20120612-18.png|
File:Tortoisegit-tutorial-screenshot-20120612-19.png|
File:Tortoisegit-tutorial-screenshot-20120612-20.png|
</gallery>

== Fri Jun 01 16:20:16 PDT 2012 ==
<gallery>
File:Git-document-screenshot-20120530-01.png|
File:Git-document-screenshot-20120530-02.png|
File:Git-document-screenshot-20120530-03.png|
File:Git-document-screenshot-20120530-04.png|
</gallery>

== Fri Jun 01 16:14:48 PDT 2012 ==
=== errors ===
*[[:File:Git-document-screenshot-20120529-01.png]] aborted: exists: [[:File:Git-document-screenshot-20120529-01.png]]
*[[:File:Git-document-screenshot-20120529-02.png]] aborted: exists: [[:File:Git-document-screenshot-20120529-02.png]]
*[[:File:Git-document-screenshot-20120529-03.png]] aborted: exists: [[:File:Git-document-screenshot-20120529-03.png]]
*[[:File:Git-document-screenshot-20120529-04.png]] aborted: exists: [[:File:Git-document-screenshot-20120529-04.png]]

<gallery>
File:Git-document-screenshot-20120529-01.png|
File:Git-document-screenshot-20120529-02.png|
File:Git-document-screenshot-20120529-03.png|
File:Git-document-screenshot-20120529-04.png|
</gallery>

== Wed May 09 11:44:58 PDT 2012 ==
<gallery>
File:Eclipse-install-372-screenshot-01.png|
File:Eclipse-install-372-screenshot-02.png|
File:Eclipse-install-372-screenshot-03.png|
File:Eclipse-install-372-screenshot-04.png|
</gallery>

== Wed May 09 11:24:44 PDT 2012 ==
<gallery>
File:Git-eclipse-screenshot-01.png|
File:Git-eclipse-screenshot-02.png|
File:Git-eclipse-screenshot-03.png|
File:Git-eclipse-screenshot-03a.png|
File:Git-eclipse-screenshot-04.png|
File:Git-eclipse-screenshot-04a.png|
File:Git-eclipse-screenshot-05.png|
File:Git-eclipse-screenshot-06.png|
File:Git-eclipse-screenshot-07.png|
File:Git-eclipse-screenshot-07a.png|
File:Git-eclipse-screenshot-08.png|
File:Git-eclipse-screenshot-09.png|
File:Git-eclipse-screenshot-10.png|
File:Git-eclipse-screenshot-11.png|
File:Git-eclipse-screenshot-12.png|
File:Git-eclipse-screenshot-13.png|
File:Git-eclipse-screenshot-14.png|
File:Git-eclipse-screenshot-15.png|
</gallery>

== Wed Apr 18 17:05:54 PDT 2012 ==
<gallery>
File:Help25-chunk-colheader-batch-process.png|
File:Help25-chunk-colheader-pagination.png|
</gallery>

== Wed Apr 18 15:32:45 PDT 2012 ==
<gallery>
File:Help25-chunk-colheader-select-access.png|
File:Help25-chunk-colheader-select-author.png|
File:Help25-chunk-colheader-select-category.png|
File:Help25-chunk-colheader-select-language.png|
File:Help25-chunk-colheader-select-max-levels.png|
File:Help25-chunk-colheader-select-status.png|
</gallery>

== Wed Apr 18 15:04:00 PDT 2012 ==
<gallery>
File:Help25-chunk-colheader-filter-field.png|
</gallery>

== Wed Apr 18 10:23:23 PDT 2012 ==
<gallery>
File:Help25-chunk-colheader-order-ascending.png|
File:Help25-chunk-colheader-order-descending.png|
</gallery>

== Wed Apr 18 10:06:58 PDT 2012 ==
<gallery>
File:Help25-chunk-colheader-order-icons.png|
</gallery>

== Tue Apr 17 20:44:13 PDT 2012 ==
<gallery>
File:Help25-chunk-state-icons.png|
</gallery>

== Mon Apr 16 20:55:35 PDT 2012 ==
<gallery>
File:Help25-chunk-article-create-article-basic-options.png|
</gallery>

== Mon Apr 16 19:21:35 PDT 2012 ==
<gallery>
File:Help25-article-create-article-front-end-editor.png|
File:Help25-article-create-article-front-end-language-metadata.png|
File:Help25-article-create-article-front-end-publishing.png|
File:Help25-article-create-article-screenshot.png|
</gallery>

== Mon Apr 16 17:59:08 PDT 2012 ==
<gallery>
File:Help25-chunk-article-category-list-layout-options.png|
</gallery>

== Mon Apr 16 17:58:13 PDT 2012 ==
=== errors ===
*[[:File:Help25-chunk-article-category-blog-layout-options.png]] aborted: exists: [[:File:Help25-chunk-article-category-blog-layout-options.png]]

<gallery>
File:Help25-chunk-article-category-blog-layout-options.png|
</gallery>

== Mon Apr 16 17:50:26 PDT 2012 ==
<gallery>
File:Help25-article-category-list-screenshot.png|
</gallery>

== Mon Apr 16 16:53:06 PDT 2012 ==
<gallery>
File:Help25-chunk-article-category-blog-layout-options.png|
</gallery>

== Mon Apr 16 16:23:22 PDT 2012 ==
<gallery>
File:Help25-chunk-article-category-category-options.png|
</gallery>

== Mon Apr 16 16:20:43 PDT 2012 ==
<gallery>
File:Help25-chunk-article-category-select-category.png|
</gallery>

== Mon Apr 16 14:14:10 PDT 2012 ==
<gallery>
File:Help25-article-category-blog-screenshot.png|
</gallery>

== Mon Apr 16 10:48:33 PDT 2012 ==
=== errors ===
*[[:File:Help25-chunk-article-category-list-table-headings.png]] missingparam

<gallery>
File:Help25-chunk-article-category-list-table-headings.png|
</gallery>

== Mon Apr 16 10:46:12 PDT 2012 ==
=== errors ===
*[[:File:Help25-chunk-article-category-list-table-headings.png]] missingparam

<gallery>
File:Help25-chunk-article-category-list-table-headings.png|
</gallery>

== Mon Apr 16 10:36:50 PDT 2012 ==
=== errors ===
*[[:File:Help25-chunk-article-category-list-table-headings.png]] missingparam

<gallery>
File:Help25-chunk-article-category-list-table-headings.png|
</gallery>

== Mon Apr 16 10:07:56 PDT 2012 ==
=== errors ===
*[[:File:Help25-chunk-article-category-list-show-date.png]] missingparam

<gallery>
File:Help25-chunk-article-category-list-show-date.png|
</gallery>

== Mon Apr 16 09:59:59 PDT 2012 ==
<gallery>
File:Help25-chunk-article-category-list-show-date.png|
</gallery>

== Mon Apr 16 09:38:22 PDT 2012 ==
<gallery>
File:Help25-chunk-article-category-list-table-headings.png|
</gallery>

== Mon Apr 16 09:03:31 PDT 2012 ==
<gallery>
File:Help25-article-category-list-filter-field-options.png|
</gallery>

== Mon Apr 16 08:27:55 PDT 2012 ==
<gallery>
File:Help25-article-category-list-filter-field.png|
</gallery>

== Mon Apr 16 08:23:52 PDT 2012 ==
<gallery>
File:Help25-article-category-list-display-select.png|
</gallery>

== Sun Apr 15 14:15:38 PDT 2012 ==
<gallery>
File:Help25-chunk-menu-item-categories.png|
</gallery>

== Sun Apr 15 14:06:01 PDT 2012 ==
<gallery>
File:Image_20.png|
</gallery>

== Sun Apr 15 14:04:39 PDT 2012 ==
<gallery>
File:Help25-article-categories-categories-options.png|
File:Help25-article-categories-category-options.png|
File:Help25-article-categories-front-end.png|
File:Help25-article-categories-list-layout-options.png|
File:Help25-article-categories-required-settings.png|
</gallery>

== Sun Apr 15 14:04:10 PDT 2012 ==
<gallery>
File:Help25-article-categories-article-options.png|
File:Help25-article-categories-blog-layout-options.png|
</gallery>

== Tue Jan 18 17:25:47 PST 2011 ==
=== errors ===
*[[:File:Help16-Content_Article_Manager-Options-screen7.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK

<gallery>
Image:Help16-Content_Article_Manager-Conguration-screen1.png|
File:Help16-Content_Article_Manager-Options-screen7.png|
</gallery>

== Tue Jan 18 17:07:17 PST 2011 ==
<gallery>
Image:Help16-Content_Article_Manager-Options-screen1.png|
Image:Help16-Content_Article_Manager-Options-screen2.png|
Image:Help16-Content_Article_Manager-Options-screen3.png|
Image:Help16-Content_Article_Manager-Options-screen4.png|
Image:Help16-Content_Article_Manager-Options-screen5.png|
Image:Help16-Content_Article_Manager-Options-screen6.png|
Image:Help16-Content_Article_Manager-Options-screen7.png|
Image:Help16-Content_Article_Manager-Options-screen8.png|
</gallery>

== Sun Jan 16 16:07:40 PST 2011 ==
<gallery>
Image:Help16-Users_User_Manager-Other-Filter-screen.png|
Image:Help16-Users_User_Manager-Search-Filter-screen.png|
</gallery>

== Wed Jan 12 17:14:16 PST 2011 ==
<gallery>
Image:Screenshot_acl_tutorial_20110112-15.png|
</gallery>

== Wed Jan 12 17:02:08 PST 2011 ==
<gallery>
Image:Screenshot_acl_tutorial_20110112-10.png|
Image:Screenshot_acl_tutorial_20110112-11.png|
Image:Screenshot_acl_tutorial_20110112-12.png|
Image:Screenshot_acl_tutorial_20110112-13.png|
Image:Screenshot_acl_tutorial_20110112-14.png|
</gallery>

== Wed Jan 12 15:52:26 PST 2011 ==
<gallery>
Image:Screenshot_acl_tutorial_20110111-11a.png|
Image:Screenshot_acl_tutorial_20110111-12a.png|
</gallery>

== Wed Jan 12 15:51:20 PST 2011 ==
=== errors ===
*[[:File:Screenshot_acl_tutorial_20110111-11.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK
*[[:File:Screenshot_acl_tutorial_20110111-12.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK

<gallery>
File:Screenshot_acl_tutorial_20110111-11.png|
File:Screenshot_acl_tutorial_20110111-12.png|
</gallery>

== Wed Jan 12 15:42:54 PST 2011 ==
<gallery>
Image:Screenshot_acl_tutorial_20110112-07.png|
Image:Screenshot_acl_tutorial_20110112-08.png|
Image:Screenshot_acl_tutorial_20110112-09.png|
</gallery>

== Wed Jan 12 10:11:47 PST 2011 ==
<gallery>
Image:Screenshot_acl_tutorial_20110112-01.png|
Image:Screenshot_acl_tutorial_20110112-02.png|
Image:Screenshot_acl_tutorial_20110112-03.png|
Image:Screenshot_acl_tutorial_20110112-04.png|
Image:Screenshot_acl_tutorial_20110112-05.png|
Image:Screenshot_acl_tutorial_20110112-06.png|
</gallery>

== Wed Jan 12 08:27:33 PST 2011 ==
<gallery>
Image:Screenshot_acl_tutorial_20110111-01.png|
Image:Screenshot_acl_tutorial_20110111-02.png|
Image:Screenshot_acl_tutorial_20110111-03.png|
Image:Screenshot_acl_tutorial_20110111-04.png|
Image:Screenshot_acl_tutorial_20110111-05.png|
Image:Screenshot_acl_tutorial_20110111-06.png|
Image:Screenshot_acl_tutorial_20110111-07.png|
Image:Screenshot_acl_tutorial_20110111-08.png|
Image:Screenshot_acl_tutorial_20110111-09.png|
Image:Screenshot_acl_tutorial_20110111-10.png|
Image:Screenshot_acl_tutorial_20110111-11.png|
Image:Screenshot_acl_tutorial_20110111-12.png|
Image:Screenshot_acl_tutorial_20110111-13.png|
Image:Screenshot_acl_tutorial_20110111-14.png|
Image:Screenshot_acl_tutorial_20110111-15.png|
Image:Screenshot_acl_tutorial_20110111-16.png|
Image:Screenshot_acl_tutorial_20110111-17.png|
Image:Screenshot_acl_tutorial_20110111-18.png|
Image:Screenshot_acl_tutorial_20110111-19.png|
Image:Screenshot_acl_tutorial_20110111-20.png|
Image:Screenshot_acl_tutorial_20110111-21.png|
</gallery>

== Fri Jan 07 15:49:21 PST 2011 ==
<gallery>
Image:Screenshot_override_tutorial_20110107-01.png|
Image:Screenshot_override_tutorial_20110107-02.png|
Image:Screenshot_override_tutorial_20110107-03.png|
Image:Screenshot_override_tutorial_20110107-04.png|
Image:Screenshot_override_tutorial_20110107-05.png|
Image:Screenshot_override_tutorial_20110107-06.png|
Image:Screenshot_override_tutorial_20110107-07.png|
</gallery>

== Wed Apr 07 14:07:54 PDT 2010 ==
<gallery>
Image:Unit_test_tutorial_screenshot_20100406-16.png|
</gallery>

== Wed Apr 07 13:48:49 PDT 2010 ==
<gallery>
Image:Unit_test_tutorial_screenshot_20100406-14.png|
Image:Unit_test_tutorial_screenshot_20100406-15.png|
</gallery>

== Wed Apr 07 10:23:57 PDT 2010 ==
=== errors ===
*[[:File:Unit_test_tutorial_screenshot_20100406-02.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK

<gallery>
File:Unit_test_tutorial_screenshot_20100406-02.png|
Image:Unit_test_tutorial_screenshot_20100406-10.png|
Image:Unit_test_tutorial_screenshot_20100406-11.png|
Image:Unit_test_tutorial_screenshot_20100406-12.png|
Image:Unit_test_tutorial_screenshot_20100406-13.png|
</gallery>

== Tue Apr 06 19:40:09 PDT 2010 ==
=== errors ===
*[[:File:Unit_test_tutorial_screenshot_20100405-01.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK
*[[:File:Unit_test_tutorial_screenshot_20100406-01.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK

<gallery>
File:Unit_test_tutorial_screenshot_20100405-01.png|
File:Unit_test_tutorial_screenshot_20100406-01.png|
Image:Unit_test_tutorial_screenshot_20100406-01a.png|
Image:Unit_test_tutorial_screenshot_20100406-01b.png|
Image:Unit_test_tutorial_screenshot_20100406-01c.png|
Image:Unit_test_tutorial_screenshot_20100406-02.png|
Image:Unit_test_tutorial_screenshot_20100406-03.png|
Image:Unit_test_tutorial_screenshot_20100406-04.png|
Image:Unit_test_tutorial_screenshot_20100406-05.png|
Image:Unit_test_tutorial_screenshot_20100406-06.png|
Image:Unit_test_tutorial_screenshot_20100406-07.png|
Image:Unit_test_tutorial_screenshot_20100406-08.png|
Image:Unit_test_tutorial_screenshot_20100406-09.png|
Image:Unit_test_tutorial_screenshot_20100406-09a.png|
</gallery>

== Mon Jan 04 19:46:24 PST 2010 ==
<gallery>
Image:Svn_merge_20100104_01.png|
Image:Svn_merge_20100104_02.png|
Image:Svn_merge_20100104_03.png|
</gallery>

== Tue Oct 20 15:58:01 PDT 2009 ==
<gallery>
Image:Screen_user_new_group_20091019.png|
</gallery>

== Tue Oct 20 15:54:35 PDT 2009 ==
<gallery>
Image:Screen_user_access_level_20091019.png|
</gallery>

== Tue Oct 20 15:41:06 PDT 2009 ==
=== errors ===
*[[:File:Screen_article_mgr_permissions1_20091019.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK

<gallery>
File:Screen_article_mgr_permissions1_20091019.png|
</gallery>

== Tue Oct 20 15:33:12 PDT 2009 ==
<gallery>
Image:Screen_article_mgr_permissions1_20091019.png|
</gallery>

== Sun Oct 18 17:34:00 PDT 2009 ==
<gallery>
Image:Screen_menu_permissions_20091018.png|
</gallery>

== Sun Oct 18 17:27:55 PDT 2009 ==
<gallery>
Image:Screen_global_config_permissions_20091018.png|
</gallery>

== Sun Oct 18 17:25:16 PDT 2009 ==
<gallery>
Image:Screen_global_config_permissions_20091018.png|
</gallery>

== Sun Oct 18 16:52:03 PDT 2009 ==
<gallery>
Image:Screen_article_permissions1_20091018.png|
Image:Screen_article_permissions2_20091018.png|
Image:Screen_category_permissions1_20091018.png|
Image:Screen_category_permissions2_20091018.png|
</gallery>

== Sun Oct 18 08:28:37 PDT 2009 ==
<gallery>
Image:Acl_example_diagram1_20091018.png|
Image:Acl_example_diagram2_20091018.png|
</gallery>

== Sat Oct 17 16:29:17 PDT 2009 ==
=== errors ===
*[[:File:Acl_example_diagram3a_20091017.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK

<gallery>
File:Acl_example_diagram3a_20091017.png|
</gallery>

== Sat Oct 17 16:28:37 PDT 2009 ==
=== errors ===
*[[:File:Acl_example_diagram3a_20091017.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK

<gallery>
File:Acl_example_diagram3a_20091017.png|
</gallery>

== Sat Oct 17 16:26:05 PDT 2009 ==
=== errors ===
*[[:File:Acl_example_diagram3a_20091017.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK

<gallery>
File:Acl_example_diagram3a_20091017.png|
</gallery>

== Sat Oct 17 15:53:47 PDT 2009 ==
<gallery>
Image:Acl_example_diagram2_20091017.png|
Image:Acl_example_diagram3_20091017.png|
</gallery>

== Sat Oct 17 01:02:35 PDT 2009 ==
<gallery>
Image:Screen_menu_access_level_20091016.png|
Image:Screen_user_access_level_20091016.png|
</gallery>

== Fri Oct 16 16:17:18 PDT 2009 ==
<gallery>
Image:Screen_user_groups_20091016.png|
</gallery>

== Thu Oct 15 14:45:55 PDT 2009 ==
=== errors ===
*[[:File:Screen_user_config_20091015.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK

<gallery>
File:Screen_user_config_20091015.png|
</gallery>

== Thu Oct 15 11:22:29 PDT 2009 ==
<gallery>
Image:Screen_user_config_20091015.png|
</gallery>

== Thu Oct 15 11:19:13 PDT 2009 ==
=== errors ===
*[[:File:Screen_user_config_20091015.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK

<gallery>
File:Screen_user_config_20091015.png|
</gallery>

== Thu Oct 15 11:17:45 PDT 2009 ==
=== errors ===
*[[:File:Screen_user_config_permissions_20091015.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK

<gallery>
File:Screen_user_config_permissions_20091015.png|
</gallery>

== Thu Oct 15 11:13:50 PDT 2009 ==
=== errors ===
*[[:File:Screen_user_config_permissions_20091015.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK

<gallery>
File:Screen_user_config_permissions_20091015.png|
</gallery>

== Thu Oct 15 11:10:38 PDT 2009 ==
=== errors ===
*[[:File:Screen_user_config_permissions_20091015.png]] UnexpectedAnswerException unexpected response data (UiSimpleActionBase) status HTTP/1.1 200 OK

<gallery>
Image:Screen_content_options_permissions_20091015.png|
File:Screen_user_config_permissions_20091015.png|
</gallery>

== Wed Oct 14 20:01:15 PDT 2009 ==
<gallery>
Image:Screen_content_global_config_20091014.png|
Image:Screen_content_options_permissions_20091014.png|
Image:Tutorial_acl_diagram_20091014.png|
</gallery>

== Tue Aug 25 18:01:44 PDT 2009 ==
<gallery>
Image:Selenium_ide_screenshot1_20090821.png|
Image:Selenium_ide_screenshot2_20090821.png|
</gallery>

== Mon Aug 24 16:03:20 PDT 2009 ==
<gallery>
Image:Commonist-128.png|
</gallery>

File:Help30-Components-Newsfeeds-Feed-Edit-Image-Options-Tab-en.png

2013-10-13T23:44:12Z

Dextercowley:

[[:File:Help30-Components-Newsfeeds-Feed-Edit-Display-Options-Tab.png|<<<]]
>>>

== batch ==
screenshots for git tutorial

== description ==

== source ==
screenshot

== date ==
4/14/2012

== author ==
Mark Dexter

== permission ==

== license ==

{{self2|GFDL|cc-by-sa-2.5,2.0,1.0}}

File:Help30-Components-Newsfeeds-Feed-Edit-Display-Options-Tab-en.png

2013-10-13T23:44:11Z

Dextercowley:

<<<
[[:File:Help30-Components-Newsfeeds-Feed-Edit-Image-Options-Tab.png|>>>]]

== batch ==
screenshots for git tutorial

== description ==

== source ==
screenshot

== date ==
4/14/2012

== author ==
Mark Dexter

== permission ==

== license ==

{{self2|GFDL|cc-by-sa-2.5,2.0,1.0}}

Chunk30:Help screen column header State

2013-10-13T23:34:45Z

Dextercowley: change from State to Status to conform with edit screens

*'''Status''': Published status of the item. Possible values are:
**''Published'': The item is published. This is the only state that will allow regular website users to view this item.
**''Unpublished'': The item is unpublished.
**''Archived'': The item has been archived. {{#ifeq: {{{IncludeReported}}} | yes | **''Reported'': The item has been reported as invalid by a visitor. }}
**''Trashed'': The item has been sent to the Trash.

Help310:Components Newsfeeds Feeds Edit

2013-10-13T22:52:31Z

Dextercowley: details section

Chunk30:Add Category Quick Edit Buttons

2013-10-13T22:47:37Z

Dextercowley: indent

:[[File:Help30-Add-Category-Article-Image-ToggleEditor-buttons.png]]
{{Chunk30:colheader|Article Button}}
{{Chunk30:colheader|Image Button}}
{{Chunk30:colheader|ToggleEditor Button}}

Chunk30:Help screen column header ToggleEditor Button

2013-10-13T22:47:22Z

Dextercowley: indent

:* '''Toggle Editor'''. Turns on or off the the editor's description box '''WYSIWYG''' features to show HTML markup.

Chunk4x:Help screen column header Image Button

2013-10-13T22:47:09Z

Dextercowley: indent

:* '''Image'''. Click to quickly add an 'Image' to the description with a popup window.

Chunk30:Help screen column header Image Button

2013-10-13T22:47:09Z

Dextercowley: indent

:* '''Image'''. Click to quickly add an 'Image' to the description with a popup window.

Chunk4x:Help screen column header Article Button

2013-10-13T22:46:43Z

Dextercowley: indent

:* '''Article'''. Click to quickly add an 'Article' link to the description with a popup window.