-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathstyle-guide.html
More file actions
406 lines (362 loc) 路 14.5 KB
/
Copy pathstyle-guide.html
File metadata and controls
406 lines (362 loc) 路 14.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta
name="description"
content="The Style Guide for the Real&Mate documentation."
/>
<meta
name="keywords"
content="real&mate, web application, documentation, style, document, real estate, business, management, estate"
/>
</head>
<body style="display: none">
<div id="container">
<nav>
<nav-links-doc-main-page></nav-links-doc-main-page>
</nav>
<theme-button></theme-button>
<editor-button></editor-button>
<speak-button></speak-button>
<div id="header">
<h1>
<span class="title">Style Guide</span>
</h1>
<logo-img></logo-img>
</div>
</div>
<main>
<!-- prettier-ignore -->
<p class=" text-center speak">The Real&Mate formatting options are a mix of HTML and custom reusable web components. Below are listed all these content formatting options as well as guidelines and best practices to follow when writing for Real&Mate's Documentation.</p>
<details id="toc">
<summary>Table of Contents</summary>
<ul class="ul-left">
<li>
<a href="#content-formatting"> Content Formatting </a>
<ul>
<li><a href="#titles">Titles</a></li>
<li><a href="#text-highlights">Text Highlights</a></li>
<li><a href="#notes">Notes</a></li>
<li><a href="#links">Links</a></li>
<li><a href="#lists">Lists</a></li>
<li><a href="#code-examples">Code Examples</a></li>
<li><a href="#details">Details</a></li>
<li><a href="#tables">Tables</a></li>
<!--
<li><a href="#requests-&-responses">
Requests & Responses
</a></li>-->
</ul>
</li>
<li>
<a href="#illustrations">Illustrations</a>
<ul>
<li><a href="#screenshots">Screenshots</a></li>
<li><a href="#buttons">Buttons</a></li>
</ul>
</li>
</ul>
</details>
<section id="content-formatting">
<h2 class="speak">Content Formatting</h2>
<section id="titles">
<h3 class="speak">Titles</h3>
<!-- prettier-ignore -->
<p>Titles are the base of a documentation structure, as they shape the content by separating it into coherent sections.</p>
<!-- prettier-ignore -->
<p>There is only one H1 title, at the beginning of the documentation file. Other titles can be used several times throughout the file and must keep a logical order.</p>
<best-practices>
<ul>
<!-- prettier-ignore -->
<li>Titles must be short, and at the same time give a clear idea of what topic will be tackled in the related documentation section.
</li>
<!-- prettier-ignore -->
<li>Titles shouldn't be a question.
</li>
<!-- prettier-ignore -->
<li>Titles should all have a similar format, especially titles of the same level.
</li>
<!-- prettier-ignore -->
<li>Titles can emphasise the action that is tackled in the following documentation by starting with an action verb (e.g. "Writing content", "Creating content-types").
</li>
</ul>
</best-practices>
<!-- prettier-ignore -->
<codeblock>
<h1>H1 title</h1>
<h2>H2 title</h2>
<h3>H3 title</h3>
<h4>H4 title</h4>
<h5>H5 title</h5>
</codeblock>
</section>
<section id="text-highlights">
<h3 class="speak">Text Highlights</h3>
<!-- prettier-ignore -->
<p>Text highlights are basic formatting that represent and/or highlight items from user interfaces:</p>
<ul>
<li><i>italics</i>: for GUI section, window and field names.</li>
<li><b>bold</b>: for button names.</li>
<li>
<code>code</code>: for small code excerpts, file names and paths.
</li>
</ul>
<!-- prettier-ignore -->
<codeblock>
<i>italics</i>
<b>bold</b>
<code>code</code>
</codeblock>
</section>
<section id="notes">
<h3 class="speak">Notes</h3>
<!-- prettier-ignore -->
<p>Notes highlight information by separating it from the regular, main content.</p>
<note>
<p>
<!-- prettier-ignore -->
New entries are only considered created once some of their content has been written and saved. Only then will the new entry be listed in the list view.
</p>
</note>
<!-- prettier-ignore -->
<codeblock>
<note><p>
New entries are only considered created once some of their content has been written and saved. Only then will the new entry be listed in the list view.
</p></note>
</codeblock>
</section>
<section id="links">
<h3 class="speak">Links</h3>
<!-- prettier-ignore -->
<p>Links can redirect users to other parts/sections of the Real&Mate Documentation (internal links) and to any other resource outside the Real&Mate Documentation (external links).</p>
<best-practices>
<ul>
<!-- prettier-ignore -->
<li>If the name of the doc/section to link is already in the sentence, directly put the link on that doc/section name. Otherwise, add the name of the related doc and the link in the following format: <code>(see <a href="link">document
name</a>)</code>.</li>
<li>
External links should contain the
<code>target="_blank"</code> attribute value.
</li>
</ul>
<!-- prettier-ignore -->
</best-practices>
<h4>Internal Link</h4>
<!-- prettier-ignore -->
<codeblock>
<a href="style-guide.html">Style Guide</a>
</codeblock>
<h4>External Link</h4>
<!-- prettier-ignore -->
<codeblock>
<a href="https://restfulapi.net/" target="_blank">Representational State Transfer</a>
</codeblock>
</section>
<section id="lists">
<h3 class="speak">Lists</h3>
<!-- prettier-ignore -->
<p>Lists allow to group sets of related items:</p>
<ul>
<!-- prettier-ignore -->
<li>Bullet lists are for same-level items. They are used where enumeration isn't necessary.</li>
<!-- prettier-ignore -->
<li>Numbered lists are for procedures. Each number describes an action that will lead a user to complete a goal.</li>
</ul>
<best-practices>
<p>Always start with a capital letter and finish with a period.</p>
</best-practices>
<h4>Bullet List</h4>
<!-- prettier-ignore -->
<codeblock>
The name of the subscription plan:<ul>
<li><code>Starter</code>.</li>
<li><code>Standard</code>.</li>
<li><code>Premium</code>.</li>
<li><code>Enterprise</code>.</li>
</ul>
</codeblock>
<h4>Numbered List (Procedure)</h4>
<!-- prettier-ignore -->
<codeblock>
To start receiving webhook events in your app, create and register a webhook endpoint:<ol>
<li>Create a webhook endpoint handler to receive event data POST requests.</li>
<li>Test your webhook endpoint handler.</li>
<li>Register your endpoint within Real&Mate.</li>
<li>Secure your webhook endpoint.</li>
</ol>
</codeblock>
</section>
<section id="code-examples">
<h3 class="speak">Code Examples</h3>
<!-- prettier-ignore -->
<p>Code examples are displayed in a console-like style, that also contains a "Copy" button for easier use.</p>
<!-- prettier-ignore -->
<codeblock>
<codeblock>Necessary code goes here.</codeblock>
</codeblock>
</section>
<section id="details">
<h3 class="speak">Details</h3>
<!-- prettier-ignore -->
<p>Details are components that by default only display a title, as the rest of the content is collapsed. It's used for content that can be hidden by default to make documentation shorter and cleaner.</p>
<details>
<summary>Title of the Details</summary>
Necessary content goes here.
</details>
<!-- prettier-ignore -->
<codeblock>
<details>
<summary>
Title of the Details
</summary>
Necessary content goes here.
</details>
</codeblock>
</section>
<section id="tables">
<h3 class="speak">Tables</h3>
<!-- prettier-ignore -->
<p>Tables display more clearly complex groups of items related to the same kind of information.</p>
<table-container>
<table>
<thead>
<tr>
<th>Title 1</th>
<th>Title 2</th>
<th>Title 3</th>
<th>Title 4</th>
<th>Title 5</th>
<th>Title 6</th>
<th>Title 7</th>
</tr>
</thead>
<tbody>
<tr>
<td>Key Item</td>
<td>Item</td>
<td>Item</td>
<td>Item</td>
<td>Item</td>
<td>Item</td>
<td>Item</td>
</tr>
<tr>
<td>Key Item</td>
<td>Item</td>
<td>Item</td>
<td>Item</td>
<td>Item</td>
<td>Item</td>
<td>Item</td>
</tr>
</tbody>
</table>
</table-container>
<!-- prettier-ignore -->
<codeblock>
<table>
<thead>
<tr>
<th>Title 1</th>
<th>Title 2</th>
<th>Title 3</th>
<th>Title 4</th>
<th>Title 5</th>
<th>Title 6</th>
<th>Title 7</th>
</tr>
</thead>
<tbody>
<tr>
<td>Key Item</td>
<td>Item</td>
<td>Item</td>
<td>Item</td>
<td>Item</td>
<td>Item</td>
<td>Item</td>
</tr>
<tr>
<td>Key Item</td>
<td>Item</td>
<td>Item</td>
<td>Item</td>
<td>Item</td>
<td>Item</td>
<td>Item</td>
</tr>
</tbody>
</table>
</codeblock>
</section>
<!--<a name="requests-&-responses"></a>
<h3 class="speak">Requests & Responses</h3>-->
</section>
<section id="illustrations">
<h2 class="speak">Illustrations</h2>
<section id="screenshots">
<h3 class="speak">Screenshots</h3>
<!-- prettier-ignore -->
<p>Screenshots show contents of a device display.</p>
<best-practices>
<ul>
<!-- prettier-ignore -->
<li>Prefer screenshots of the whole interface instead of cutting only part of it. It's easier for a user to locate where something is on the interface using a context.</li>
<!-- prettier-ignore -->
<li>To indicate a specific area of the screenshot that's mentioned in the documentation, edit the screenshot to add a rectangular shape around the area. The shape should blue (#37aef7), and its lines should be 3px wide.</li>
</ul>
</best-practices>
<img
alt="Style Guide"
title="Style Guide"
src="assets/screenshots/style-guide.jpg"
class="screenshot"
/>
<!-- prettier-ignore -->
<codeblock>
<img alt="Style Guide" title="Style Guide" src="assets/screenshots/style-guide.jpg" class="screenshot" />
</codeblock>
</section>
<section id="buttons">
<h3 class="speak">Buttons</h3>
<!-- prettier-ignore -->
<p>Buttons are used to replicate those used on Real&Mate user interfaces (for example, the admin panel), to help users locate them on the interface. Buttons are available in the <code>assets/buttons</code> folder, in the SVG format, and should be integrated in the documentation files as images.</p>
<!-- prettier-ignore -->
<p>Click <img alt="Arrow counterclockwise" src="assets/buttons/arrow-counterclockwise.svg" /> to refresh the window.</p>
<!-- prettier-ignore -->
<codeblock>
Click <img alt="Arrow counterclockwise" src="assets/buttons/arrow-counterclockwise.svg" /> to refresh the window.
</codeblock>
</section>
<div id="w3c">
<a
href="https://jigsaw.w3.org/css-validator/validator?uri=https%3A%2F%2Fprimesolar.github.io%2Fdocs%2Fglossary.html&profile=css3svg&usermedium=all&warning=no&vextwarning=&lang=en"
target="_blank"
rel="noopener"
id="w3c-text"
>
Verified by World Wide Web Consortium:
</a>
<a
href="https://jigsaw.w3.org/css-validator/validator?uri=https%3A%2F%2Fprimesolar.github.io%2Fdocs%2Fglossary.html&profile=css3svg&usermedium=all&warning=no&vextwarning=&lang=en"
target="_blank"
rel="noopener"
id="w3c-img"
>
<img id="w3c-img" />
</a>
</div>
</section>
</main>
<div id="footerContainer"></div>
<script src="scripts/components-title-min.js"></script>
<script src="scripts/dark-theme-min.js"></script>
<script src="scripts/editor-mode-min.js"></script>
<script src="scripts/p-1-line-indent-min.js"></script>
<script src="scripts/speak-min.js"></script>
<script src="scripts/copy-min.js"></script>
<script src="scripts/components-min.js"></script>
<script src="scripts/meta-tags-min.js"></script>
</body>
</html>