Anatomy of info.yaml Files

<p>For a general overview of <span class="caps">YAML</span> syntax, head over to <a href="http://www.yaml.org/"><span class="caps">YAML</span>.org</a> or the <a href="http://en.wikipedia.org/wiki/YAML">Wikipedia page</a>. It should be fairly intuitive, however.</p> <h1>Modules</h1> <pre>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? </pre> <p><code>notifications</code>, <code>conflicts</code>, and <code>confirm</code> are all optional. <code>conflicts</code> 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.</p> <h1>Feathers</h1> <pre>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 </pre> <p><code>notifications</code>, <code>confirm</code>, and <code>plural</code> are all optional. <code>plural</code> is the plural form of the name of the feather, if the <a href="http://chyrp.net/docs/helpers-php.html#pluralize"><code>pluralize()</code></a> function gets it wrong. For example, the plural of a feather named “audio” is still “audio”.</p> <h1>Themes</h1> <pre>name: Chyrp Theme url: http://foobar.com/ version: 1.0 author: name: Testy McTesticles url: http://mysite.com/ </pre> 2008-06-27T19:54:03-07:00 31277 anatomy-of-info-yaml-files

7368

2008-07-03T17:45:46-07:00

1880