Extension:Cargo/Hızlı başlangıç kılavuzu

Diyelim ki evinizdeki tüm kitapları gösteren bir viki oluşturmak istiyorsunuz. Vikinizde iki tür sayfa istiyorsunuz: biri kitaplar için, diğeri yazarlar için. Her kitap sayfasında bir başlık, bir yazar adı (veya adları), bir tür (veya türler), bir yayın yılı ve birkaç sayfa bulunmalıdır. Her yazar sayfasında yazar adı, menşe ülkesi ve sahip olduğunuz tüm kitapların bir listesi yer almalıdır.

Şablonların oluşturulması

Yapmanız gereken en önemli şey, biri kitaplar, diğeri yazarlar için olmak üzere iki şablon oluşturmaktır. Yüklü Sayfa Formları uzantınız varsa, bu şablonları oluşturmak için yardımcı sayfalarından biri olan Special:CreateTemplate veya Special:CreateClass kullanabilirsiniz. Ayrıca, Page Schemas uzantısı yüklediyseniz, Cargo tabanlı şablonlar oluşturmak ve yeniden oluşturmak için standart "şema oluştur/düzenle" seçeneğini kullanabilirsiniz.

Ancak bu şablonları manüel olarak da oluşturabilirsiniz. İki şablon şöyle görünebilir:

Template:Book

<noinclude>
Bu "Kitap" şablondur.

{{#cargo_declare:_table=Books
|Authors=List (,) of Page
|Genres=List (,) of String
|YearOfPublication=Date
|NumberOfPages=Integer}}
</noinclude>
<includeonly>
{{#cargo_store:_table=Books}}
{|
! Yazar(lar)
| {{#arraymap:{{{Authors|}}}|,|x|{{#formredlink:form=Author|target=x}} }}
|-
! Tür(ler)
| {{{Genres|}}}
|-
! Yayın yılı
| {{{YearOfPublication|}}}
|-
! Sayfa sayısı
| {{{NumberOfPages|}}}
|}
</includeonly>

Template:Author

<noinclude>
This is the "Author" template.

{{#cargo_declare:_table=Authors
|Country=String}}
</noinclude>
<includeonly>
{{#cargo_store:_table=Authors}}
{|
! Country of origin
| {{{Country|}}}
|-
! Books
| {{#cargo_query:tables=Books|where=Authors HOLDS '{{PAGENAME}}'}}
|}
</includeonly>

That is all you need to do to have infobox-style templates that both define a data structure and store their data in an easily-queried way.

You can see in this template examples of calls to the three main parser functions of Cargo: #cargo_declare, #cargo_store, #cargo_query; and hopefully how the three interact together. Note especially the placement of #cargo_declare, #cargo_store: the former in the ‎<noinclude> tag, the latter in the ‎<includeonly> tag.

A few other notes on these templates:

• For both templates, the name of the entity, i.e the name of the book or author, is not stored in the template. That is because the name of the page itself will hold the name of that book or author -- and will also be stored in those two tables, in a field named "_pageName".
• The "Author" template contains, at the end, what is known as an aggregating query, which queries the "Books" table (defined by the other template) and gets the names of all the pages that have the current page among its values for the "Authors" field. (It will then, by default, display that information in a comma-separated list.) This is a very common type of query; it means that you don't need to store the same data in two different pages, because one page can simply query the data.
• There is one line of this sample code that requires another extension to work: the line in Template:Book which includes calls to both #arraymap and #formredlink, both of which are defined by the Page Forms extension. This line does a rather complex operation: it separates the value of "{{{Authors|}}}" into one or more sub-values (splitting by comma), then, for each value, either links directly to that page, if a page with that name already exists; or links to the form for creating that page, using the form definition at "Form:Author". Thus, this template presupposes not only that the Page Forms extension is installed, but that an "Author" form has been created. If you don't have Page Forms installed, you could replace that line with something a lot simpler, like:

| {{{Authors|}}}

However, Page Forms is strongly recommended for any wiki that uses Cargo.

Cargo tablolarının oluşturulması

Once the templates are created, there's only one more simple step, which is to create the Cargo database tables for each template. This is not done automatically when the template is saved. Instead, there are two options:

• For each template, go that template's page, select the "Create data table" tab option (or append ?action=recreatedata to the URL), then click the "OK" button.
• From the command line, go to Cargo's /maintenance directory and run "php cargoRecreateData.php".

After doing either of these, a table will be created holding the data for each relevant template; and you will be able to see that table's contents at any time by clicking the "View table" link on the template's page.