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

From Woozle Writes Code
Jump to navigation Jump to search
No edit summary
No edit summary
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{fmt/title|Ferreteria v0.5 classes|{{fmt/code|ferret}} namespace}}
{{fmt/title|Ferreteria v0.5 classes|
==Classes==
<code>[[../|ferret]]\layout</code> namespace}}
* [[/app]] classes
{| 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==
==Sub-Namespaces==
* [[/login]]
* [[/arr]]: array classes
* [[/data]]: database classes
* [[/layout]]: graphic/visual/document layout
* [[/login]]: login management classes
* [[/menu]]
* [[/menu]]
* [[/page]]
==Meta: Paradigm==
==Meta: Paradigm==
This is the class documentation paradigm I'm currently trying.
This is the class documentation paradigm I'm currently trying.
* Titles for class pages (which includes traits) should not include the [[Conventions/coding#Type Prefixes|prefix]] (c, ca, cs, t, ta, ts).
* 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 a class name -- either with prefix and no namespace, or with a namespace and no prefix.
* 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 not namespaced, the target page should redirect to the correct namespace. If there are multiple classes by that name (in different namespaces), it should list them with links. Ideally, the editor using the template would then correct it to point to the right one.
* If a classlike page title could refer to more than one class, there will be a disambiguation page.

Latest revision as of 21:49, 17 July 2022

Ferreteria v0.5 classes

ferret\layout namespace

csArray
caApp

caDynamicLink →
tRequiresPermit →

cDropinLink

→ cDropinAction

Sub-Namespaces

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 {{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.
Retrieved from "https://wooz.dev/mw/index.php?title=Ferreteria/v0.5/@cls&oldid=3358"