Шаблон:ApiDocStart: различия между версиями

Текущая версия от 19:25, 3 сентября 2024

Message_documentation_title[view] [edit] [history] [purge]

message_transclude_desc

{{#seo:

| type = website | description = Шаблон:ApiDocStart is a template page used on the iCCup Wiki. Templates are pages that are embedded (transcluded) into other pages to allow for the repetition of information. | site_name = iCCup Wiki | locale = ru }}

@@ Строка 1: / Строка 1: @@
 <includeonly>
-<!-- Displaying the function name with a link, based on the availability of the `api_module_name` variable -->
+<dl>
-<dt>
+  <!-- Отображение программного имени с ссылкой, если оно предоставлено -->
-   {{#if:{{#var:api_module_name|}}|[[{{#var:api_module_name}}/doc/{{{1|}}}|{{{1|}}}]]|[[/{{{1|}}}|{{{1|}}}]]}}
+   {{#if:{{{1|}}}|Программное имя: '''{{#if:{{{link|}}}|[[{{{link|}}}|{{{1|}}}]]|[[{{{1|}}}]]}}'''<br/><br/>}}
-  <!-- Displaying parameters if provided -->
-  {{#if:{{{params|}}}|<span style="font-weight:400;">({{{params|}}})</span>}}
-  <!-- Displaying return type if provided -->
-  {{#if:{{{returns|}}}|<span style="font-weight:400;"> → {{{returns|}}}</span>}}
-</dt>
-<!-- Displaying the description of the API function -->
+  <!-- Определение имени модуля для использования в API и других местах -->
-<dd style="margin-left: 0;">
+   {{#vardefine:api_module_name|{{{link|{{{1|}}}}}}}}
-   <p style="max-width: 990px;">{{{description|}}}</p>
-</dd>
-<br/>
-<!-- Conditional block for storing the data point in iccupdb, only if `api_store` and `isDocPage` conditions are true -->
+  <!-- Условное определение хранения данных в базе данных iccupdb, если не указано иное -->
-{{#if:{{#var:api_store}}|
+   {{#ifeq:{{{store|}}}|false||{{#vardefine:api_store|true}}}}
-   {{#if:{{#invoke:ApiDoc|isDocPage}}|
+</dl>
-    {{#iccupdb_datapoint:API_{{PAGENAME}}_{{{1|}}}
-      |type=api
-      |name={{{1|}}}
-      |information=
-      |image=
-      |date=
-      |extradata={{#iccupdb_create_json:
-        |description={{{description|}}}
-        |params={{{params|}}}
-        |returns={{{returns|}}}
-        |module={{#var:api_module_name}}
-      }}<!-- end of extradata -->
-    }}<!-- End of iccupdb -->
-  }}<!-- End of isDocPage conditional -->
-}}
 </includeonly>
 <noinclude>{{Documentation}}</noinclude>