Lesson 02: Meta data and how it's used

From VZ Developer Wiki
Jump to: navigation, search

General Guidelines | XML Specification | Features | Views | JavaScript API | REST API | Tutorials | OAuth


Lesson 01: A simple HelloWorld Back to overview Lesson 03: Views and Navigation

We use the information of several meta data fields, that are mandatory for all gadgets that are going live.

Metadata can be defined as attributes in the ModulePrefs tag of your gadget XML.

 <?xml version="1.0" encoding="UTF-8" ?>
 <Module>
   <ModulePrefs 
	title="HelloWorld Gadget"
	author="Max Mustermann" 
	author_email="mustermann@domain.net"
	description="This is the first example Gadget"
	preview="This text will be shown in the gallery"
        required_data="Vorname, Nachname, Geschlecht, Geburtstag, Profilbild, Profil-URL,  
        Buschfunk, E-Mail, Handy-Nummer, Telefon, Telefon geschäftlich, Straße Nr, PLZ, Ort, 
        Land, Webseite, Hochschule, Was bin ich, Berufsstatus, Beziehung"
	thumbnail="vzall_150x100.jpg"
	icon="vzall_85x85.jpg"
	platform="studivz+meinvz,schuelervz"
	age_restriction="false"
	private="false"
        host_location="Germany"
   >
     <Require feature="opensocial-0.8" />
   </ModulePrefs>
   <Content type="html">
     <![CDATA[
       Hello, world!
     ]]>
   </Content>
 </Module>

This data is used e.g in the gallery, vcard administration, gadget install flow, gadget settings, invitation flow and every time a gadget is rendered.

For a complete list of possible meta data see Gadgets_XML#ModulePrefs.


  • Lesson 02: Meta data and how it's used