Documentation

Below you will find documentation on how to use our software. This contains easy-to-use steps by step guides with helpful screenshots on how to configure and get the best results.
 

Categories

Chapter 6: Creating the Package

Okay, if you have been following this tutorial, you should have created similar files as follows:

+files_inlinemycck   [FILES_INLINE + COMPONENT NAME]
|
------+extensions
 	|
---mycck.php   [COMPONENT NAME]
|
------+contexts
	|
	---+mycck	[COMPONENT NAME]
         |
	    --------category.php   	[TYPE NAME as explained in XML]
	   |
	    ----------item.php        [TYPE NAME as explained in XML]
	   |
	    -----------blog.php       [TYPE NAME as explained in XML]
|
index.html
|
inlinemyck.xml  [INLINE +  COMPONENT NAME].xml


This will differ according to your component, but, in general, it should be similar as in our component.

Note: You may or may not have the extensions folder in your package. It all depends if you went with the plugin override or the component/template override method as discussed in Chapter 2: Approach 1 [Plugin override] , Approach 2 [Component override] and Approach 3 [Template override].

 

Your full XML for the inline editing app extension should look like this:

<?xml version="1.0" encoding="utf-8"?>
<extension version="3.2" type="file" method="upgrade">
	<name>files_mycck</name>
	<author>WebxSolution Ltd</author>
	<creationDate>March 2015</creationDate>
	<copyright>>Copyright (C) 2015 All rights reserved</copyright>
	<license>GNU General Public License version 2</license>
	<authorEmail>This email address is being protected from spambots. You need JavaScript enabled to view it.</authorEmail>
	<authorUrl>http://www.arkextensions.com</authorUrl>
	<version>1.0</version>
	<description>This plugin provides an extension for ARK inline editing to add support for MyCCK</description>
	
	
	<!-- set up data for  inline lookup table     //-->

	<arkeditor>	
		<extensionName>com_mycck</extensionName>
		<!-- allowable views for inline editing //-->
		<views>
			<view>item</view>
			<view>category</view>
		</views>
		
		<!-- add context element if context is different to extension Name //-->
	
		<!-- extension types to be used for inline editing //-->
		<types>
			<type>category</type>
			<type>item</type>
			<type>blog</type>
		</types>
		
		<!-- details for Joomla versioning system //-->
	
	</arkeditor>
	
	<fileset>
		
		<!-- location for MyCCK main inline editing extension type file //--> 
	
		<files folder="extensions" target="plugins/content/arkcontent/extensions">
			<file>mycck.php</file>
		</files>
	
		<!-- location for context types for MyCCK  inline editing extension //-->
	
		<files folder="contexts/mycck" target="plugins/ajax/inlinecontent/contexts/mycck">
			<file>category.php</file>
			<file>item.php</file>
			<file>blog.php</file>
		</files>
		
	</fileset>	
	
	<!-- details for Joomla versioning system //-->
		
	<versioning>
		<versions>
			<version>
				<dbtable>#__items</dbtable>
				<type>item</type>
				<prefix>MyCCKTable</prefix>	
				<formFile>administrator/components/com_flexicontent/models/forms/item.xml</formFile>
				<fields>
					<field>id</field>
					<field>title</field>
					<field>introtext</field>
					<field>fulltext</field>
				</fields>
			</version>
		</versions>
		<catdbtable>#__categories</catdbtable>
		<cattype>category</cattype>
		<catprefix>MyCKKTable</catprefix>	
		<catformFile>administrator/components/com_flexicontent/models/forms/category.xml</catformFile>
		<catfields>
			<field>id</field>
			<field>title</field>
			<field>description</field>
		</catfields>
	</versioning>
	
</extension>

Now, zip all your files, basically, zip up the root folder that contains your files and folders you created. So, you will create a zip file like [FILES_INLINE + COMPONENT NAME].zip such as files_inlinemyck.zip in our case.

Okay, now, we will create a Joomla package file, so that we can easily install and manage our inline editing app using Joomla’s Extension Manager.

Joomla package zipped file should contain the following:

+pkg_inlinemycck	[PKG + COMPONENT NAME]
|
--------+packages
	|
	---------files_inlinemycck.php(Zip file you created above.)
|
index.html
|
pkg_inlinemycck.xml		[PKG_INLINE + COMPONENT NAME].xml

The [PKG_INLINE_ + COMPONENT Name].xml should have similar content to our

Pkg_inlinemycck.xml file:

<?xml version="1.0" encoding="utf-8"?>
<extension version="3.2" type="package" method="upgrade">
	<name>Package - Inline MyCCK Editing for Ark Editor</name>
	<author>WebxSolution Ltd</author>
	<creationDate>July 2015</creationDate>
	<packagename>inlinemycck</packagename>
	<version>1.0</version>
	<url>http://www.arkextensions.com</url>
	<packager>Webxsolution</packager>
	<packagerurl>http://www.arkextensions.com</packagerurl>
	<description>This package provides an extension for ArK inline editing, adding support for MyCCK</description>
	<license>GNU/GPLv2</license>

	<files folder="packages">
		<file type="file" id="inlinemycck">files_inlinemycck.zip</file>
	</files>
</extension>

So, zip up those files to create the inline editing package, when you are ready to install your inline editing app.

Okay, that is it, you should be good to go!

 

WebxSolution Ltd is not affiliated with or endorsed by the Joomla! Project or Open Source Matters. The Joomla! name and logo is used under a limited license granted by Open Source Matters the trademark holder in the United States and other countries.

Copyright © 2009 - 2016 WebxSolution Ltd
Powered by JoomlaWired

 

Cron Job Starts