Ferreteria/v0.5/@cls: Difference between revisions

Latest revision as of 21:49, 17 July 2022

Ferreteria v0.5 classes

ferret\layout namespace

This is the class documentation paradigm I'm currently trying.

Titles for pages about classlike types (classes, traits, interfaces) should use the minimum unambiguous name. i.e. only include namespace if there's another classlike with the same name in another namespace, and include only as much of the namespace as needed to disambiguate.
The {{l/ver/class|<class name>}} template can be used to point to the documentation page for a classlike type.
If a classlike page title could refer to more than one class, there will be a disambiguation page.

@@ Line 1: / Line 1: @@
-* [[/users/csLogin]]
+{{fmt/title|Ferreteria v0.5 classes|
+<code>[[../|ferret]]\layout</code> namespace}}
+{| style="border: solid 1px grey; background: #eef;"
+|-
+| {{l/ver/class|csArray}}
+|-
+| {{l/ver/class|caApp}}
+|-
+|
+{|
+|-
+|
+{{l/ver/class|caDynamicLink}} &rarr;<br>
+{{l/ver/class|tRequiresPermit}} &rarr;
+|
+{{l/ver/class|cDropinLink}}
+|
+&rarr; {{l/ver/class|cDropinAction}}
+|}
+|}
+==Sub-Namespaces==
+* [[/arr]]: array classes
+* [[/data]]: database classes
+* [[/layout]]: graphic/visual/document layout
+* [[/login]]: login management classes
+* [[/menu]]
+==Meta: Paradigm==
+This is the class documentation paradigm I'm currently trying.
+* Titles for pages about classlike types (classes, traits, interfaces) should use the minimum unambiguous name. i.e. only include namespace if there's another classlike with the same name in another namespace, and include only as much of the namespace as needed to disambiguate.
+* The <nowiki>{{</nowiki>{{lt|l/ver/class}}|{{arg|class name}}}} template can be used to point to the documentation page for a classlike type.
+* If a classlike page title could refer to more than one class, there will be a disambiguation page.