-
Notifications
You must be signed in to change notification settings - Fork 24
Anatomy of info.yaml Files
vito edited this page Sep 12, 2010
·
4 revisions
For a general overview of YAML syntax, head over to YAML.org or the Wikipedia page. It should be fairly intuitive, however.
name: My Module url: http://example.com/ version: 2.0.1 description: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. author: name: Testy McTesticles url: http://mysite.com/ conflicts: - his_module notifications: - This is shown when they enable my module. - So is this. confirm: Do you want to delete all the whatnot that My Module created?
notifications
, conflicts
, and confirm
are all optional. conflicts
is a list of modules (based on their folder name) that this module conflicts with. A red line will be drawn between them at the Extend > Modules page to indicate that they conflict.
name: Snufflupugus url: http://thismustbeanimportantfeathertohaveitsownwebsite.com/ version: 2.0.1 description: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. author: name: Testy McTesticles url: http://mysite.com/ notifications: - This is shown when they enable my module. - So is this. confirm: Do you want to delete all the whatnot that My Module created? plural: snufflupugii
notifications
, confirm
, and plural
are all optional. plural
is the plural form of the name of the feather, if the pluralize()
function gets it wrong. For example, the plural of a feather named “audio” is still “audio”.
name: Chyrp Theme url: http://foobar.com/ version: 1.0 author: name: Testy McTesticles url: http://mysite.com/