data_crow_howto_create_modules.pdf

(640 KB) Pobierz
Designing Modules
How to create your own module
Written by Robert Jan van der Waals | July 18, 2014 |
Version 1.1 | Based on Data Crow 4.0
I
NTRODUCTION
Since Data Crow 3 it is possible to create your own modules. I have had many
requests to add additional modules like a coin and a wine module. Using the
module creation wizard you can now easily create the modules you are missing
from the standard Data Crow installation. Additionally you can change existing
modules by adding new fields for example.
Using the module creation wizard you can quickly create a new module. This
manual has been created to ensure you can create the module you need.
2
G
ENERAL TIPS
1.
Always create a module in a clean installation of Data Crow. Just install
a version of Data Crow to a different location then your production
version. In this new and empty version you can experiment without
having to worry about messing up your current installation. How to do
this? Navigate to [Settings > Change Folder] and select a new user
folder for testing purposes.
You can share a module with someone else or copy a module you have
created in your test installation to the production version. Use the
[Modules > Module Export Wizard] to export your module. Import the
module by at any other Data Crow installation by using the [Modules >
Module Import Wizard]
Describe on a piece of paper the fields you will need. Also define if you
need lists of options a user can select from. You can create managed
lists within your module. Meaning you can define a field called
“genres” and make the content (the genres) manageable from within
Data Crow.
If you want to use lists as described in point 3, create the modules
which will hold the items first. Most common these will be simple
property modules for items like categories, genres, etc. Items of these
modules have a name and an icon, nothing else. This will be explained
further on in this document. Just remember that the fastest way to
create your module is from the bottom to the top.
Make sure to visit the field settings for your newly created modules.
For example; the “is descriptive” setting determines the label of your
items. This label will be used to display your items in the views, the
grouping pane and in the reference fields.
2.
3.
4.
5.
3
M
ODULE
T
YPES
One of the first things you need to know is what every module type is and what
it can be used for. There are three types of modules; property modules, media
module and ‘other’ modules.
The type of module determines how the module can be accessed and which
predefined fields a module has. Predefined fields (such as the ID) cannot be
removed from the module (though they can be hidden using the normal field
settings editor).
P
ROPERTY
MODULE TYPE
A property module is the simplest module type. Examples of property modules
are the movie and music genres, the software category, the storage media and
the platforms. Important to note is that a property module can’t have any
reference fields and can’t have a picture field either.
A property module will never show up in the module bar. In fact it will not
show up anywhere until used within another module. Its existence depends on
other modules. This will be discussed later on in this document when we get to
the field creation.
When a property module has been used within another module you can
manage its items via the [Administration] menu. Note that this is the
[Administration] menu of the module using this property module.
Managing referenced property module items
P
R ED E FI N E D
FI E L DS
Among other, system related fields, the following fields will always be present
for property modules:
Alternative Names (for synonyms of the same items)
Name (name of the item)
Icon (icon to represent the item)
4
M
EDIA
MODULE TYPE
This type of module is a fully functioning module. After its creation it will show
up in the module bar from where it can be opened and used.
Module List
Items created within this module can also be managed by using the media
module. The media module allows all items from modules of type “Media
Module” to be shown in one overview.
Media module
P
R ED E FI N E D
FI E L DS
Among other, system related fields, the following fields will always be present
for media modules:
Countries (Countries where the item was released)
Languages
Description (item description, long text)
Location (free form location description of the item)
Rating (10 star based rating)
Title (title of the item)
Year (year of release of the item)
5

Plik z chomika:

Inne pliki z tego folderu:

Inne foldery tego chomika:

Zgłoś jeśli naruszono regulamin