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 4: XML Installation Manifest File

The mainfest file we will be creating will basically be the same as a standard one for installing files i.e. the extension type will be ‘file’.  But in our case we have modified the template by adding an arkeditor section so the installing knows it is installing an inline editing app.

So, the arkeditor section for our MyCCK inline editing app so far looks like this:

<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>
</arkeditor> 

The whole file will be as follows:

<?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>
	
</extension>

So here you can see we have added two sections for installing our files: One for installing the mycck.php file that handles creating our editable regions for our inline editable types and the other for installing our files for our types of our components, that handle the read/save functionality for inline editing these types.

So looking at another example, if we were to create an inline app for Joomla’s stock Article Manager, the XML file would probably look like this:

<?xml version="1.0" encoding="utf-8"?>
<extension version="3.2" type="file" method="upgrade">
	<name>files_content</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 Joomla’s Article Manager</description>
	
	
	<!-- set up data for  inline lookup table     //-->

	<arkeditor>	
		<extensionName>com_content</extensionName>
		<!-- allowable views for inline editing //-->
		<views>
			<view>item</view>
			<view>category</view>
			<view>featured</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> article </type>
			<type>blog</type>
			<type>featured</type>
		</types>
		
		<!-- details for Joomla versioning system //-->
	
	</arkeditor>
	
	<fileset>
		
		<!-- location for Article Manager main inline editing extension type file //--> 
	
		<files folder="extensions" target="plugins/content/arkcontent/extensions">
			<file>content.php</file>
		</files>
	
		<!-- location for context types for MyCCK  inline editing extension //-->
	
		<files folder="contexts/content" target="plugins/ajax/inlinecontent/contexts/content">
			<file>category.php</file>
			<file>article.php</file>
			<file>blog.php</file>
			<file>featured.php</file>
		</files>
		
	</fileset>
	
</extension>

 

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