Difference between revisions of "Developer Area/Import//Export/LEAP Export/File Artefact Plugin"

From Mahara Wiki
Jump to navigation Jump to search
(Created page with "The file artefact plugin hooks into the LEAP export system to export files, folders, images and profile icons (which are technically…")
 
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
The file artefact plugin hooks into the [[Developer Area/Import//Export/LEAP Export|LEAP export system]] to export files, folders, images and profile icons (which are technically treated differently to images in Mahara). This plugin just overrides LeapExportElement for the file, folder, image and profileicon artefact types.
+
The file artefact plugin hooks into the [[Developer Area/Import%2f%2fExport/LEAP Export|LEAP export system]] to export files, folders, images and profile icons (which are technically treated differently to images in Mahara). This plugin just overrides LeapExportElement for the file, folder, image and profileicon artefact types.
  
 
<div id="section_1">
 
<div id="section_1">
  
== Files &amp; Images ==
+
==Files &amp; Images==
  
 
These are exported as [http://wiki.cetis.ac.uk/2009-03/LEAP2A_types#resource LEAP2A resources] of [http://wiki.cetis.ac.uk/2009-03/LEAP2A_categories/resource_type#Offline resource_type:Offline], with the following customisations:
 
These are exported as [http://wiki.cetis.ac.uk/2009-03/LEAP2A_types#resource LEAP2A resources] of [http://wiki.cetis.ac.uk/2009-03/LEAP2A_categories/resource_type#Offline resource_type:Offline], with the following customisations:
Line 12: Line 12:
 
</div><div id="section_2">
 
</div><div id="section_2">
  
== Profile Icons ==
+
==Profile Icons==
  
 
These are exported exactly how Files &amp; Images are exported, with the addition of one link of type [http://wiki.cetis.ac.uk/2009-03/LEAP2A_relationships#relation related] to the persondata element for the export, to signify that it is a profile icon. This convention was agreed on by the mailing list, but isn't part of the standard. It's likely a future version of the LEAP2A standard will add a 'depicts'/'is_depiction_of' relationship to assist with this.
 
These are exported exactly how Files &amp; Images are exported, with the addition of one link of type [http://wiki.cetis.ac.uk/2009-03/LEAP2A_relationships#relation related] to the persondata element for the export, to signify that it is a profile icon. This convention was agreed on by the mailing list, but isn't part of the standard. It's likely a future version of the LEAP2A standard will add a 'depicts'/'is_depiction_of' relationship to assist with this.
Line 18: Line 18:
 
</div><div id="section_3">
 
</div><div id="section_3">
  
== Folders ==
+
==Folders==
  
 
These are exported as [http://wiki.cetis.ac.uk/2009-03/LEAP2A_types#selection LEAP2A selections] of [http://wiki.cetis.ac.uk/2009-03/LEAP2A_categories/selection_type#Folder selection_type:Folder].
 
These are exported as [http://wiki.cetis.ac.uk/2009-03/LEAP2A_types#selection LEAP2A selections] of [http://wiki.cetis.ac.uk/2009-03/LEAP2A_categories/selection_type#Folder selection_type:Folder].
Line 24: Line 24:
 
</div><div id="section_4">
 
</div><div id="section_4">
  
== Further Information ==
+
==Further Information==
  
 
* [http://git.mahara.org/?p=mahara.git;a=blob;f=htdocs/artefact/file/export/leap/lib.php;hb=HEAD artefact/file/export/leap/lib.php in source control] 
 
* [http://git.mahara.org/?p=mahara.git;a=blob;f=htdocs/artefact/file/export/leap/lib.php;hb=HEAD artefact/file/export/leap/lib.php in source control] 
* [[Developer Area/Import//Export/LEAP Import/File Artefact Plugin|LEAP File Import]] 
+
* [[Developer Area/Import%2f%2fExport/LEAP Import/File Artefact Plugin|LEAP File Import]] 
  
 
</div>
 
</div>
 +
[[Category:Developer Area]][[Category:Plugins]]

Latest revision as of 15:37, 16 May 2011

The file artefact plugin hooks into the LEAP export system to export files, folders, images and profile icons (which are technically treated differently to images in Mahara). This plugin just overrides LeapExportElement for the file, folder, image and profileicon artefact types.

Files & Images

These are exported as LEAP2A resources of resource_type:Offline, with the following customisations:

  • Anything the file is attached to is added as a link of type is_attachment_of (this is subject to change - is_attachment_of is not a valid LEAP2A relationship)
  • The file is always exported out of line, even if it has an html or xhtml content type

Profile Icons

These are exported exactly how Files & Images are exported, with the addition of one link of type related to the persondata element for the export, to signify that it is a profile icon. This convention was agreed on by the mailing list, but isn't part of the standard. It's likely a future version of the LEAP2A standard will add a 'depicts'/'is_depiction_of' relationship to assist with this.

Folders

These are exported as LEAP2A selections of selection_type:Folder.