Difference between revisions of "PackageSyntax"
AndreasLeue (talk | contribs) (New page: {{HelpPagesHeaderBar}} ==Metabox== First part of each package page is a socalled ''Metabox''. It provides meta data of the package and is automatically nicely rendered. The Metabox is a ...) |
AndreasLeue (talk | contribs) |
||
| Line 22: | Line 22: | ||
==Sub Packages== | ==Sub Packages== | ||
You should add a section called "Sub Packages" which contains a <nowiki><SubPages/></nowiki> tag. This tag automatically generates a list of all sub packages of your package. If you do so, users can browse into your | You should add a section called "Sub Packages" which contains a <nowiki><SubPages/></nowiki> tag. This tag automatically generates a list of all sub packages of your package. If you do so, users can browse into your packages, which is very desirable. | ||
==Ancestors== | ==Ancestors== | ||
'''Please make sure to add all ancestor package pages, too'''. Mediawiki does not automatically create such pages. If you want to make your package browsable, you have to add all ancestor pages manually. You might need to refresh the ancestor pages afterwards (clearing the cache, with help of the action ''purge''), to allow the ''SubPages'' tag to create updated content. | '''Please make sure to add all ancestor package pages, too'''. Mediawiki does not automatically create such pages. If you want to make your package browsable, you have to add all ancestor pages manually. You might need to refresh the ancestor pages afterwards (clearing the cache, with help of the action ''purge''), to allow the ''SubPages'' tag to create updated content. | ||
Latest revision as of 08:08, 23 July 2008
Editing Introduction·
Wiki Syntax·
Wiki Structure (Namespaces)·
Artefact Syntax·
Mediawiki Help Pages
OOModels Quickstart·
Glossary·
ArtefactSyntax·
TypeSyntax·
NamespaceSyntax·
PackageSyntax·
ConversionStepSyntax
HowToStartAProject·
HowToAddAModel·
HowToAddAFormat·
HowToAddAPackage·
HowToAddANamespace·
HowToAddAContact
Metabox[edit]
First part of each package page is a socalled Metabox. It provides meta data of the package and is automatically nicely rendered. The Metabox is a self-describing wiki template (read more about the Metabox template).
The Metabox entry on your page typically looks like this:
{{Metabox
| Meta_Category = Type:org/oomodels/wiki/Package
}}
Arbitrary Text[edit]
You can add arbitrary text describing your package.
Since different items (e.g. a Model and a Contact) existing in the same package may be in different wiki namespaces (e.g. Artefact:Model/your/package... and Contact:Person/your/package...) your package appears twice in the wiki. Now to avoid to have to write your package description twice (redundantly), you may prefer to describe the corresponding logical namespace instead. This description is automatically included on all respective package pages.
Sub Packages[edit]
You should add a section called "Sub Packages" which contains a <SubPages/> tag. This tag automatically generates a list of all sub packages of your package. If you do so, users can browse into your packages, which is very desirable.
Ancestors[edit]
Please make sure to add all ancestor package pages, too. Mediawiki does not automatically create such pages. If you want to make your package browsable, you have to add all ancestor pages manually. You might need to refresh the ancestor pages afterwards (clearing the cache, with help of the action purge), to allow the SubPages tag to create updated content.
