Jump to content

ICT:Automatic IDs: Difference between revisions

From Costa Sano MediaWiki
← Older edit
Mngr (talk | contribs)
Bots, Bureaucrats, club, ict, Interface administrators, research, Suppressors, Administrators
1,027 edits
VisualWikitext
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{#set:Description=Documentation for generating and querying automatic IDs using Page Forms and Cargo.}}
'''Description:''' Documentation for generating and querying automatic IDs using Page Forms and Cargo, including Protected Namespace management.


= Automatic ID Generation for Cargo Tables =
= Automatic ID Generation & Namespace Control =


This page documents the workflow for generating automatic, composite IDs using the [[Extension:Page Forms|Page Forms]] and [[Extension:Cargo|Cargo]] extensions.
This page documents the workflow for creating unique, automatic IDs and ensuring pages are saved within a specific Protected Namespace using [[Extension:Page Forms|Page Forms]] and [[Extension:Cargo|Cargo]].


== Overview ==
== 1. Template Logic (Automatic ID Generation) ==
While Page Forms does not have a "native" ID generator button, unique IDs can be constructed by:
The best practice is to construct your ID inside the storage template. This allows you to combine multiple attributes and system values (like timestamps) before storing them in Cargo.
# Combining user-input attributes in the storage template.
# Using the form's '''page name''' formula to ensure uniqueness.
# Enforcing uniqueness via form validation.
 
== 1. Template Logic (The "Store" Method) ==
To create an ID from a combination of attributes, logic is placed inside the <nowiki>{{#cargo_store}}</nowiki> function.
 
=== Example Cargo Declaration ===
Define your table in your Schema template:
<pre>
<nowiki>
{{#cargo_declare:
_table = Projects
|ProjectID = String
|Category = String
|Year = Integer
}}
</nowiki>
</pre>


=== Example Cargo Store ===
=== Example Cargo Store ===
In your data template, concatenate the fields to create the `ProjectID`:
In your data template's &lt;includeonly&gt; section:
<pre>
<pre>
<nowiki>
&#123;&#123;#cargo_store:
<includeonly>
{{#cargo_store:
_table = Projects
_table = Projects
|ProjectID = {{{Category|}}}-{{{Year|}}}-{{#time:U}}
&#124;ProjectID = &#123;&#123;&#123;Category&#124;&#125;&#125;&#125;-&#123;&#123;&#123;Year&#124;&#125;&#125;&#125;-&#123;&#123;#time:U&#125;&#125;
|Category = {{{Category|}}}
&#124;Category = &#123;&#123;&#123;Category&#124;&#125;&#125;&#125;
|Year = {{{Year|}}}
&#124;Year = &#123;&#123;&#123;Year&#124;&#125;&#125;&#125;
}}
&#125;&#125;
</includeonly>
</nowiki>
</pre>
</pre>


== 2. Form Definition ==
== 2. Form Definition (Namespace & Page Naming) ==
To ensure the user doesn't create a duplicate ID, use the `unique` and `page name` parameters in [[Extension:Page Forms|Page Forms]].
By defining the `page name` formula in the form, you can force all new pages into a specific namespace and ensure the URL itself acts as a unique identifier.


=== Page Name Formula ===
=== Forcing a Protected Namespace ===
In the <nowiki>{{{info}}}</nowiki> tag, define how the page is named automatically:
In the &lt;info&gt; tag, prefix your formula with the name of your protected namespace.
<pre>
<pre>
<nowiki>
&#123;&#123;&#123;info&#124;page name=Archive:&lt;Projects[Category]&gt;-&lt;Projects[Year]&gt;-&lt;unique number;start=001&gt;&#125;&#125;&#125;
{{{info|page name=<Projects[Category]>-<Projects[Year]>-<unique number;start=001>}}}
</nowiki>
</pre>
</pre>


=== Field Validation ===
=== Validation for Uniqueness ===
Force the form to check if an ID already exists:
To prevent manual ID collisions, use the `unique` parameter on a hidden field:
<pre>
<pre>
<nowiki>
&#123;&#123;&#123;field&#124;ProjectID&#124;unique&#124;input type=text&#124;hidden&#125;&#125;&#125;
{{{field|ProjectID|unique|input type=text|hidden}}}
</nowiki>
</pre>
</pre>


== 3. Querying Records ==
== 3. Querying Protected Data ==
To retrieve data using your custom ID, use the <nowiki>{{#cargo_query:...}}</nowiki> parser function.
When querying pages in a specific namespace, Cargo's `_pageName` will include the namespace prefix (e.g., `Archive:Project-101`).


=== Filter by Composite ID ===
=== Query Example ===
<pre>
<pre>
<nowiki>
&#123;&#123;#cargo_query:
{{#cargo_query:
&#124;tables = Projects
|tables = Projects
&#124;fields = _pageName=ID, Category
|fields = _pageName=Page, Category, Year
&#124;where = _pageNamespace = 102
|where = ProjectID = 'Hardware-2024-171523421'
&#124;format = table
|format = table
&#125;&#125;
}}
</nowiki>
</pre>
</pre>


== Extensions Used ==
== Comparison: Page Forms vs. Page Schemas ==
* [[Extension:Page Forms|Page Forms]]: Handles the user interface and page naming.
| Feature | Page Schemas | Manual Page Forms |
* [[Extension:Cargo|Cargo]]: Handles data storage and querying.
| :--- | :--- | :--- |
* [[Extension:ParserFunctions|ParserFunctions]]: Used for string manipulation and date formatting.
| **Namespace Control** | Limited / Hardcoded | Full (Dynamic via `page name`) |
| **Custom ID Logic** | Difficult to customize | Unlimited (via ParserFunctions) |


[[Category:Help]]
[[Category:Help]]
[[Category:Cargo]]
[[Category:Cargo]]

Latest revision as of 16:44, 29 January 2026

Description: Documentation for generating and querying automatic IDs using Page Forms and Cargo, including Protected Namespace management.

Automatic ID Generation & Namespace Control

This page documents the workflow for creating unique, automatic IDs and ensuring pages are saved within a specific Protected Namespace using Page Forms and Cargo.

1. Template Logic (Automatic ID Generation)

The best practice is to construct your ID inside the storage template. This allows you to combine multiple attributes and system values (like timestamps) before storing them in Cargo.

Example Cargo Store

In your data template's <includeonly> section: 

{{#cargo_store:
_table = Projects
|ProjectID = {{{Category|}}}-{{{Year|}}}-{{#time:U}}
|Category = {{{Category|}}}
|Year = {{{Year|}}}
}}

2. Form Definition (Namespace & Page Naming)

By defining the `page name` formula in the form, you can force all new pages into a specific namespace and ensure the URL itself acts as a unique identifier.

Forcing a Protected Namespace

In the <info> tag, prefix your formula with the name of your protected namespace. 

{{{info|page name=Archive:<Projects[Category]>-<Projects[Year]>-<unique number;start=001>}}}

Validation for Uniqueness

To prevent manual ID collisions, use the `unique` parameter on a hidden field: 

{{{field|ProjectID|unique|input type=text|hidden}}}

3. Querying Protected Data

When querying pages in a specific namespace, Cargo's `_pageName` will include the namespace prefix (e.g., `Archive:Project-101`).

Query Example

{{#cargo_query:
|tables = Projects
|fields = _pageName=ID, Category
|where = _pageNamespace = 102
|format = table
}}

Comparison: Page Forms vs. Page Schemas

| Feature | Page Schemas | Manual Page Forms | | :--- | :--- | :--- | | **Namespace Control** | Limited / Hardcoded | Full (Dynamic via `page name`) | | **Custom ID Logic** | Difficult to customize | Unlimited (via ParserFunctions) |

Retrieved from "https://mwiki.costasano.club/index.php?title=ICT:Automatic_IDs&oldid=243"