Skip to content

Commit ae91b38

Browse files
Fernando-A-RochaFernando-A-Rocha
committed
Tidy builder.py
1 parent 41c7298 commit ae91b38

File tree

7 files changed

+138
-186
lines changed

7 files changed

+138
-186
lines changed

‎functions/Cursor/getCursorAlpha.yaml‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ client:
1212
values:
1313
- type: 'int'
1414
name: 'alpha'
15-
version:
16-
added: '1.3.2'
1715
examples:
1816
- path: 'examples/getCursorAlpha.lua'
1917
description: |

‎functions/Cursor/setCursorAlpha.yaml‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@ client:
1616
values:
1717
- type: 'bool'
1818
name: 'result'
19-
version:
20-
added: '1.3.2'
2119
examples:
2220
- path: 'examples/setCursorAlpha.lua'
2321
description: |

‎functions/Element/setElementPosition.yaml‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
shared: &shared
22
name: 'setElementPosition'
3-
meta:
4-
- needs_checking: 'This is just a placeholder message for this needs_checking meta-property.'
53
oop:
64
entity: element
75
method: setPosition

‎web/resources/function.html‎

Lines changed: 50 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -59,37 +59,27 @@ <h3>Pair: <a href="/{{ function[type_name].pair }}">{{ function[type_name].pair
5959
{% for type_name in ['shared', 'server', 'client'] %}
6060
{% if function[type_name] and function[type_name].meta %}
6161
{% if function[type_name].meta %}
62-
<div style="padding-left: 1em; margin-top: 1em; border: 1px solid #aaa; border-radius: 5px; background-color: rgba(255, 255, 255, 0.1);">
63-
<ul>
64-
{% for meta_item in function[type_name].meta %}
65-
{% if meta_item.needs_checking %}
66-
<li><p><strong>Needs checking:</strong> {{ meta_item.needs_checking }}</p></li>
62+
{% for meta_item in function[type_name].meta %}
63+
<div style="padding-left: 1em; margin-top: 1em; border: 1px solid #aaa; border-radius: 5px; background-color: rgba(255, 255, 255, 0.1);">
64+
{% if meta_item.needs_checking %}
65+
<p><strong>Needs checking:</strong> {{ meta_item.needs_checking }}</p>
6766
{% endif %}
68-
{% endfor %}
69-
</ul>
70-
</div>
67+
</div>
68+
{% endfor %}
7169
{% endif %}
7270
{% endif %}
7371
{% endfor %}
7472

7573
<!-- Issues -->
7674
{% for type_name in ['shared', 'client', 'server'] %}
7775
{% if function[type_name] %}
78-
7976
{% if function[type_name].issues %}
77+
{% for issue in function[type_name].issues %}
8078
<div style="padding-left: 1em; margin-top: 1em; border: 1px solid {{ info_color }}; border-radius: 5px; background-color: rgba(255, 255, 0, 0.1);">
81-
<ul>
82-
{% for issue in function[type_name].issues %}
83-
<li>
84-
<a target="_blank" href="https://github.com/multitheftauto/mtasa-blue/issues/{{ issue.id }}">
85-
Issue #{{ issue.id }} (mtasa-blue)
86-
</a>: {{ issue.description_html }}
87-
</li>
88-
{% endfor %}
89-
</ul>
79+
<p><a target="_blank" href="https://github.com/multitheftauto/mtasa-blue/issues/{{ issue.id }}">Issue #{{ issue.id }} (mtasa-blue):</a> {{ issue.description_html }}</p>
9080
</div>
81+
{% endfor %}
9182
{% endif %}
92-
9383
{% endif %}
9484
{% endfor %}
9585

@@ -98,20 +88,18 @@ <h3>Pair: <a href="/{{ function[type_name].pair }}">{{ function[type_name].pair
9888
{% if function[type_name] %}
9989

10090
{% if function[type_name].notes %}
101-
<div style="padding-left: 1em; margin-top: 1em; border: 1px solid {{ info_color }}; border-radius: 5px; background-color: rgba(0, 255, 0, 0.1);">
102-
<ul>
103-
{% for note in function[type_name].notes %}
104-
<li>{{ note }}</li>
105-
{% endfor %}
106-
</ul>
107-
</div>
91+
{% for note in function[type_name].notes %}
92+
<div style="padding-left: 1em; margin-top: 1em; border: 1px solid {{ info_color }}; border-radius: 5px; background-color: rgba(0, 255, 0, 0.1);">
93+
<p>{{ note }}</p>
94+
</div>
95+
{% endfor %}
10896
{% endif %}
109-
11097
{% endif %}
11198
{% endfor %}
11299

113100
<!-- Syntax -->
114101
<h2 id="syntax">Syntax <a href="#syntax"><i class="fa-solid fa-link"></i></a></h2>
102+
115103
{% if function.syntaxes.single %}
116104
{% set syntax = function.syntaxes.single %}
117105
<div style="padding-left: 1em; margin-top: 1em; border: 1px solid {{ info_color }}; border-radius: 5px;">
@@ -122,7 +110,7 @@ <h2 id="syntax">Syntax <a href="#syntax"><i class="fa-solid fa-link"></i></a></h
122110
<h3>Required arguments:</h3>
123111
<ul>
124112
{% for item in syntax.arguments.required %}
125-
<li>{{ item.type }} <strong>{{ item.name }}</strong> : {{ item.description_html }}</li>
113+
<li>{{ item.type }} <strong>{{ item.name }}</strong>: {{ item.description_html }}</li>
126114
{% endfor %}
127115
</ul>
128116
{% endif %}
@@ -131,7 +119,7 @@ <h3>Required arguments:</h3>
131119
<h3>Optional arguments:</h3>
132120
<ul>
133121
{% for item in syntax.arguments.optional %}
134-
<li>{{ item.type }} <strong>{{ item.name }}</strong> (default: <em>{{ item.default }}</em>) : {{ item.description_html }}</li>
122+
<li>{{ item.type }} <strong>{{ item.name }}</strong> (default: <em>{{ item.default }}</em>): {{ item.description_html }}</li>
135123
{% endfor %}
136124
</ul>
137125
{% endif %}
@@ -145,6 +133,8 @@ <h3>Returns:</h3>
145133
<li>{{ item.type }} {{ item.name }}</li>
146134
{% endfor %}
147135
</ul>
136+
137+
</div>
148138
{% else %}
149139
{% for type_name in ['server', 'client'] %}
150140
{% set syntax = function.syntaxes[type_name] %}
@@ -158,7 +148,7 @@ <h3 style="color: {{ type_colors[type_name] }};">{{ type_name|capitalize }}:</h3
158148
<h4>Required arguments:</h4>
159149
<ul>
160150
{% for item in syntax.arguments.required %}
161-
<li>{{ item.type }} <strong>{{ item.name }}</strong> : {{ item.description_html }}</li>
151+
<li>{{ item.type }} <strong>{{ item.name }}</strong>: {{ item.description_html }}</li>
162152
{% endfor %}
163153
</ul>
164154
{% endif %}
@@ -167,7 +157,7 @@ <h4>Required arguments:</h4>
167157
<h4>Optional arguments:</h4>
168158
<ul>
169159
{% for item in syntax.arguments.optional %}
170-
<li>{{ item.type }} <strong>{{ item.name }}</strong> (default: <em>{{ item.default }}</em>) : {{ item.description_html }}</li>
160+
<li>{{ item.type }} <strong>{{ item.name }}</strong> (default: <em>{{ item.default }}</em>): {{ item.description_html }}</li>
171161
{% endfor %}
172162
</ul>
173163
{% endif %}
@@ -185,35 +175,37 @@ <h4>Returns:</h4>
185175
{% endif %}
186176
{% endfor %}
187177
{% endif %}
188-
<!-- OOP Syntax -->
189-
{% for type_name in ['shared', 'client', 'server'] %}
190-
{% if function[type_name] %}
191-
{% if function[type_name].oop %}
192-
<h3>OOP syntax: <a href="/OOP_Introduction" ><i class="fa-regular fa-circle-question"></i></a></h3>
193-
{% if function[type_name].oop.note %}
194-
<p>{{ function[type_name].oop.note }}</p>
178+
179+
180+
181+
<!-- OOP Syntax -->
182+
{% for type_name in ['shared', 'client', 'server'] %}
183+
{% if function[type_name] %}
184+
{% if function[type_name].oop %}
185+
<h2>OOP syntax <a href="/OOP_Introduction" ><i class="fa-regular fa-circle-question"></i></a></h2>
186+
187+
<div style="padding-left: 1em; margin-top: 1em; border: 1px solid {{ info_color }}; border-radius: 5px;">
188+
189+
{% if function[type_name].oop.note %}
190+
<p>{{ function[type_name].oop.note }}</p>
191+
{% endif %}
192+
<!-- Method or constructor -->
193+
{% if function[type_name].oop.constructor %}
194+
<p><strong>Constructor:</strong> <a href="/{{ function[type_name].oop.constructor|lower }}">{{ function[type_name].oop.constructor|capitalize }}</a>(...)</p>
195+
{% else %}
196+
<p><strong>Method:</strong>
197+
{% if function[type_name].oop.static %}<a href="/{{ function[type_name].oop.entity|capitalize }}">{{ function[type_name].oop.entity|capitalize }}</a>.{{ function[type_name].oop.method }}(...)
198+
{% else %}<a href="/{{ function[type_name].oop.entity|lower }}">{{ function[type_name].oop.entity }}</a>:{{ function[type_name].oop.method }}(...)
199+
{% endif %}</p>
200+
{% if function[type_name].oop.variable %}
201+
<p><strong>Variable:</strong> <a href="/{{ function[type_name].oop.entity|lower }}">{{ function[type_name].oop.entity }}</a>.{{ function[type_name].oop.variable }}</p>
195202
{% endif %}
196-
<!-- Method or constructor -->
197-
<ul>
198-
{% if function[type_name].oop.constructor %}
199-
<li><strong>Constructor:</strong> <a href="/{{ function[type_name].oop.constructor|lower }}">{{ function[type_name].oop.constructor|capitalize }}</a>(...)</li>
200-
{% else %}
201-
{% if function[type_name].oop.static %}
202-
<li><strong>Method:</strong> <a href="/{{ function[type_name].oop.entity|capitalize }}">{{ function[type_name].oop.entity|capitalize }}</a>.{{ function[type_name].oop.method }}(...)</li>
203-
{% else %}
204-
<li><strong>Method:</strong> <a href="/{{ function[type_name].oop.entity|lower }}">{{ function[type_name].oop.entity }}</a>:{{ function[type_name].oop.method }}(...)</li>
205-
{% endif %}
206-
{% if function[type_name].oop.variable %}
207-
<li><strong>Variable:</strong> <a href="/{{ function[type_name].oop.entity|lower }}">{{ function[type_name].oop.entity }}</a>.{{ function[type_name].oop.variable }}</li>
208-
{% endif %}
209-
{% endif %}
210-
</ul>
211203
{% endif %}
212-
{% endif %}
213-
{% endfor %}
214-
{% if function.syntaxes.single %}
215-
</div>
216-
{% endif %}
204+
205+
</div>
206+
{% endif %}
207+
{% endif %}
208+
{% endfor %}
217209

218210
<!-- Preview Images -->
219211
{% for type_name in ['shared', 'client', 'server'] %}
@@ -227,7 +219,6 @@ <h3>OOP syntax: <a href="/OOP_Introduction" ><i class="fa-regular fa-circle-ques
227219
{% endif %}
228220
<img style="max-height: 150px;" src="{{ image.path_html }}">
229221
{% endfor %}
230-
</ul>
231222
</div>
232223
{% endif %}
233224
{% endif %}

‎web/resources/navigation.yaml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
- name: Introduction
2+
path_html: "/"
3+
article:
4+
name: introduction
5+
folder: ''
6+
- name: Articles
7+
subitems:
8+
- name: Official articles
9+
path_html: "/official"
10+
category:
11+
name: Official articles
12+
articles:
13+
path: official
14+
- name: Community articles
15+
path_html: "/community"
16+
category:
17+
name: Community articles
18+
articles:
19+
path: community
20+
- name: Functions
21+
subitems:
22+
- name: Client functions
23+
path_html: "/lua/functions/client"
24+
category:
25+
name: Client functions
26+
subcategories:
27+
- name: Client cursor functions
28+
functions:
29+
path: Cursor
30+
type: client
31+
- name: Shared functions
32+
path_html: "/lua/functions/shared"
33+
category:
34+
name: Shared functions
35+
subcategories:
36+
- name: Shared cursor functions
37+
functions:
38+
path: Cursor
39+
type: shared
40+
- name: Shared element functions
41+
functions:
42+
path: Element
43+
type: shared

0 commit comments

Comments
 (0)