-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
1095 lines (1093 loc) · 56 KB
/
index.html
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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Coding standard | viharm</title>
<meta name="description" content="A library of coding standards" />
<meta name="keywords" content="code clean standard" />
<meta name="author" content="viharm" />
<link rel='stylesheet' type='text/css' href='https://bootswatch.com/3/flatly/bootstrap.min.css' />
<link rel='stylesheet' type='text/css' href="Lib/Ui/Style.inc.css" />
<link rel='stylesheet' type='text/css' href='https://fonts.googleapis.com/css?family=Pompiere' />
<link rel="icon" type="image/x-icon" href="https://www.gravatar.com/avatar/ad7949dd6f25efe46f3dd10cba9b91fa?s=16" />
<script src="https://use.fontawesome.com/ff2ad066ff.js"></script>
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div id="dv_DocBody" class="container-fluid">
<div id="dv_PageHeader">
<div class="panel panel-default cl_ViharmBg">
<div class="panel-body">
<a href="/"><img class="cl_Banner img-responsive center-block" src="https://www.gravatar.com/avatar/ad7949dd6f25efe46f3dd10cba9b91fa" alt="viharm" title="viharm" /></a>
</div>
</div>
</div>
<div id="dv_PageNav">
<nav class="navbar navbar-default">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#nv_Page">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">
Coding standard
</a>
</div>
<div class="collapse navbar-collapse" id="nv_Page">
<ul class="nav navbar-nav navbar-right">
<li>
<a href="#id_Concepts">
<span class="glyphicon glyphicon-tower"></span>
Concepts
</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false"><span class="glyphicon glyphicon-bookmark"></span> Organisation <span class="caret"></span></a>
<ul class="dropdown-menu">
<li>
<a href="#id_Files">
<span class="glyphicon glyphicon-duplicate"></span>
Files
</a>
</li>
<li>
<a href="#id_Layout">
<span class="glyphicon glyphicon-th-large"></span>
Layout
</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false"><span class="glyphicon glyphicon-cog"></span> Architecture <span class="caret"></span></a>
<ul class="dropdown-menu">
<li>
<a href="#id_Formatting">
<span class="glyphicon glyphicon-indent-left"></span>
Formatting
</a>
</li>
<li>
<a href="#id_Semantics">
<span class="glyphicon glyphicon-barcode"></span>
Semantics
</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false"><span class="glyphicon glyphicon-gift"></span> Delivery <span class="caret"></span></a>
<ul class="dropdown-menu">
<li>
<a href="#id_Testing">
<span class="glyphicon glyphicon-check"></span>
Testing
</a>
</li>
<li>
<a href="#id_Documenting">
<span class="glyphicon glyphicon-book"></span>
Documenting
</a>
</li>
<li>
<a href="#id_Packaging">
<span class="glyphicon glyphicon-compressed"></span>
Packaging
</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
</div>
<div id="dv_PageBody">
<div id="id_Intro">
<p>This document describes best practices for creating software.</p>
<p>It is well known that some programming languages have specific requirements both presentational and functional; while others have a relaxed approach toward presentation.</p>
<p>The recommendations made here endeavour to create a set of best practices to suit as many languages as possible to maintain consistency in structure, semantics and layout.</p>
<div class="alert alert-info" role="alert">
<span class="glyphicon glyphicon-info-sign"></span>
This document is currently under development and various sections are incomplete.
</div>
<div class="alert alert-info" role="alert">
<span class="glyphicon glyphicon-bullhorn"></span>
Suggestions are welcome. Simply create a new <a class="alert-link" href="https://github.com/viharm/viharm.github.io/issues" target="_blank">issue</a> at GitHub
</div>
</div>
<section id="id_Concepts">
<a href="#dv_PageNav" title="Top of page">
<span class="glyphicon glyphicon-triangle-top pull-right btn btn-default btn-xs"></span>
</a>
<h3>Concepts <span class="label label-default">to do</span></h3>
<p>
Fundamental concepts
</p>
<h4>Library <span class="label label-default">to do</span></h4>
<p>
Library of assets, further categorised into types.
</p>
<h5>UI elements</h5>
<h5>Operational elements</h5>
<p>
Reusable code
</p>
<h4>Discretisation <span class="label label-default">to do</span></h4>
<p>
Design of various applications vastly differs from each other in the way they are developed, and there can be no common standard to control the architecture of applications.
</p>
<p>
The general guideline is towards discretisation of an applicaiton into smaller logical units of code which work together to provide a base functionality. This base functionality can be further enhanced by incremental units.
</p>
<p>
Such discretisation results in the definition of various types of logical units of applications/packages.
</p>
<div class="panel panel-warning">
<div class="panel-body">
<span class="label label-default pull-right">to do</span>
<p><span class="lead glyphicon glyphicon-edit"></span> Include graphical illustration of core, modules, extensions, add-on, plugin along with base functionality, extended functionality and features</p>
</div>
</div>
</section>
<section id="id_Files">
<a href="#dv_PageNav" title="Top of page">
<span class="glyphicon glyphicon-triangle-top pull-right btn btn-default btn-xs"></span>
</a>
<h3>Files <span class="label label-warning">draft</span></h3>
<p>
Description of files here
</p>
<dl class="dl-horizontal">
<dt>LICENSE</dt>
<dd>A plain text file containing the licence with the name of the copyright holder</dd>
</dl>
<dl class="dl-horizontal">
<dt>VERSION</dt>
<dd>
<p>A plain text file containing the version number of the package.</p>
<div class="alert alert-info" role="alert">
Use of <a class="alert-link" href="http://semver.org/" target ="_blank">semantic versioning</a> is highly encouraged.
</div>
</dd>
</dl>
<dl class="dl-horizontal">
<dt>Quickstart</dt>
<dd>
<p>A plain text file containing a brief guide to get started.</p>
<p>This is typically the <code>README.md</code> file in most packages. If the application is small then this may contain the complete documentation.</p>
</dd>
</dl>
<dl class="dl-horizontal">
<dt>Code</dt>
<dd>
<p>Files and folders as per the structure of the software/library</p>
<p>Use of the directory structure described later is highly encouraged.</p>
</dd>
</dl>
<p>
Directory layout of different applications and packages vary however the approach used is very similar.
</p>
<div class="panel panel-default">
<div class="panel-heading">Example directory structure</div>
<div class="panel-body">
<p class="cl_TreeRoot">Project directory</p>
<!--
<p>
<span class="label label-warning">Project directory</span>
</p>
-->
<ul class="cl_TreeList">
<li>LICENSE</li>
<li>VERSION</li>
<li>CHANGELOG</li>
<li>
Config
<ul>
<li>fl_App.config.inc.ext</li>
<li>fl_Plugin.config.inc.ext</li>
<li>...</li>
</ul>
</li>
<li>
Lib
<ul>
<li>fl_Common.function.inc.php</li>
<li>fl_Specific.class.inc.php</li>
<li>...</li>
</ul>
</li>
<li>
Module
<ul>
<li>
Render_Template
<ul>
<li>fl_Render_Smarty.module.inc.php</li>
<li>...</li>
</ul>
</li>
<li>
Scraper_Tvdb
<ul>
<li>fl_Scraper_Tvdb.module.inc.php</li>
<li>...</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</section>
<section id="id_Layout">
<a href="#dv_PageNav" title="Top of page">
<span class="glyphicon glyphicon-triangle-top pull-right btn btn-default btn-xs"></span>
</a>
<h3>Layout <span class="label label-default">to do</span></h3>
<p>
Typical structure of a file. Variable declarations, function definitions, etc.
</p>
</section>
<section id="id_VarOrg">
<a href="#dv_PageNav" title="Top of page">
<span class="glyphicon glyphicon-triangle-top pull-right btn btn-default btn-xs"></span>
</a>
<h3>Variable organisation <span class="label label-danger">wip</span></h3>
<p>
As the development of a project progresses, the various mathematical steps, logical routines and control structures will inevitable leave behind a significant number of variables. This can result in considerable disorganisation of used and unused variables in memory. Unfortunately this variable "spread" cannot be predicted or planned before project kick-off, as most of the variables are a result of evolved development.
</p>
<p>
It is therefore essential to re-evaluate the organisation of variables to ensure they are controlled and organised, to ensure a tidy code structure.
</p>
<p>
Variables can be broadly organised into the following categories. Each of the categories may leverage the variable structure formulation of coding language used. The most typical of this is the array construct.
</p>
<dl>
<dt>Configuration</dt>
<dd>A collection of variables representing the configuration of the project/programme/code base.</dd>
<dt>State</dt>
<dd>A collection of variables representing the state of various aspects of the code base.</dd>
<dt>Exchange</dt>
<dd>Collections of variables for data exchange between modules</dd>
</dl>
<h4>Configuration variables</h4>
<p>Configuration variables represent the configuration of the application and can be organised either by the "changeability" of the configuration or by application architecture (modules, etc.).</p>
<div class="container-fluid">
<div class="row">
<div class="col-xs-12">
<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title">Constant configuration</h5>
</div>
<div class="panel-body">
Per instance. Install-time.
</div>
</div>
</div>
</div>
<div class="row">
<div class="col-xs-12">
<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title">Static configuration</h5>
</div>
<div class="panel-body">
Per session. pre-run
</div>
</div>
</div>
</div>
<div class="row">
<div class="col-xs-12">
<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title">Dynamic configuration</h5>
</div>
<div class="panel-body">
Run time configuration. Per page or per view
</div>
</div>
</div>
</div>
<div class="row">
<div class="col-xs-12">
<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title">Active configuration</h5>
</div>
<div class="panel-body">
Run time configuration, actively changeable.
</div>
</div>
</div>
</div>
</div>
<h4>State variables</h4>
<p>This collection of variables can be utilised various aspects of the core code or modules to check the status or state of either configuration flags or any specific requirements</p>
<h4>Exchange variables</h4>
<p>Exchange variables are used to specifically exchange data, either take input, provide output or pass data between modules or other language constructs.</p>
<p>This is particularly useful when randomly picking existing variables for exchange may introduce confusion and potential security threats.</p>
<div class="container-fluid">
<div class="row">
<div class="col-xs-12">
<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title">Input variables</h5>
</div>
<div class="panel-body">
<p>A collection of variables representing input data for processing (sanitised, if necessary).</p>
</div>
</div>
</div>
</div>
<div class="row">
<div class="col-xs-12">
<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title">Response variables</h5>
</div>
<div class="panel-body">
<p>A collection of variables representing response to an action so this may be handed off (redacted, if necessary).</p>
<p>This collection of variables can be utilised to store response or responses from functions, classes or other logic structures, so that the outcome of processing can be carried out in isolation.</p>
</div>
</div>
</div>
</div>
</div>
<h4>Other</h4>
There some additional variable collection which may be added by contexts
<div class="container-fluid">
<div class="row">
<div class="col-xs-12">
<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title">UI</h5>
</div>
<div class="panel-body">
A collection to hand-off to UI, especially in MVC-modelled codebases.
</div>
</div>
</div>
</div>
</div>
</section>
<section id="id_Formatting">
<a href="#dv_PageNav" title="Top of page">
<span class="glyphicon glyphicon-triangle-top pull-right btn btn-default btn-xs"></span>
</a>
<h3>Formatting <span class="label label-danger">wip</span></h3>
<p>
Description of formatting here
</p>
<ul>
<li>80 columns wide lines is a generic viewport</li>
</ul>
<h4>Whitespace <span class="label label-danger">wip</span></h4>
<p>
Liberal but optimal use of whitespace, both horizontal and vertical.
</p>
<h5>Horizontal <span class="label label-danger">wip</span></h5>
<h6>Indent <span class="label label-warning">draft</span></h6>
<p>
Indenting code is essential to cleanly convey the logic and approach used in developing the application. The exception to this is the formatting restrictions imposed by the language used to write the code.
</p>
<div class="panel-group" id="accordion_Indent" role="tablist" aria-multiselectable="true">
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_LogicalIndent">
<h4 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Indent" href="#id_Cp_LogicalIndent" aria-controls="id_Cp_LogicalIndent">
Logical indentation : 2-character soft tabs
</a>
</h4>
</div>
<div id="id_Cp_LogicalIndent" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_LogicalIndent">
<div class="panel-body">
<p>Logical indentation refers to the indentation used in the code to depict logical hierarchy; e.g., nested loops, functions, classes and methods.</p>
<p>This is unambiguous and provides a clear view of the hierarchy. There are however certain descretions that can be taken to ensure clean code. These descretions are in cases were hierarchical child objects are small enough to need a line for themselves, hence included in the same line as their heirarchical parent, as shown in the following example of a single line of repeating code in <i>PHP</i> which also contributes to the modular approach.</p>
<pre>fn_Debug($sr_Check){echo('<pre>'.$sr_Check.'</pre>');}</pre>
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_OverflowIndent">
<h4 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Indent" href="#id_Cp_OverflowIndent" aria-controls="id_Cp_OverflowIndent">
Overflow indentation : Hanging indent using contextual width or 2-character soft tabs
</a>
</h4>
</div>
<div id="id_Cp_OverflowIndent" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_OverflowIndent">
<div class="panel-body">
<p>Overflow indentation refers to the hanging indentation used in the code to depict continuation of a statement from the preceding line. This is primarily done to ensure that the overall width of lines does not exceed the conservative 80-character width of the generic view port</p>
<p>There are two alternatives to clean represent such continuation.</p>
<div class="list-group">
<div class="list-group-item">
<h4 class="list-group-item-heading">Contextual hanging indent</h4>
<p class="list-group-item-text">Width of indentation in this case is decided by the point at which the item continued on the new line is started; shown by the following example</p>
<pre><code>if ( !array_key_exists ( 'ky_LdapVer' , $this->ar_Dir['ky_Conf'] ) |<br /> $this->ar_Dir['ky_Conf']['ky_LdapVer'] == ''<br /> ) {<br /> $this->ar_Dir['ky_Conf']['ky_LdapVer'] = 3 ;<br />}</code></pre>
</div>
<div class="list-group-item">
<h4 class="list-group-item-heading">Fixed hanging indent</h4>
<p class="list-group-item-text">Width of indentation in this case is decided by the chosen width used for global logical indentation; shown by the following example. In this case the continued code on the overflow line is treated as a heirarchical child of the line on which the overflowing statement started.</p>
<pre><code>if ( !array_key_exists ( 'ky_LdapVer' , $this->ar_Dir['ky_Conf'] ) |<br /> $this->ar_Dir['ky_Conf']['ky_LdapVer'] == ''<br /> ) {<br /> $this->ar_Dir['ky_Conf']['ky_LdapVer'] = 3 ;<br />}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
<h6>Intra-line space <span class="label label-default">to do</span></h6>
<h5>Vertical <span class="label label-default">to do</span></h5>
</section>
<section id="id_Semantics">
<a href="#dv_PageNav" title="Top of page">
<span class="glyphicon glyphicon-triangle-top pull-right btn btn-default btn-xs"></span>
</a>
<h3>Semantics <span class="label label-warning">draft</span></h3>
<p>
Coding semantics play an important role in making the entire code consistent. If this practice is applied across teams and languages, Large pieces of code can be easily understood. Various aspects of coding fall under semantics; these can be logical variables, values, database tables, fields or even filesystem objects like files and directories. For the purpose of this document, each of these aspect will be referred to as an <i>item</i>.
</p>
<h4>Formulation</h4>
<p>
The semantic formulation of an item name involves splitting it into two distinct parts.
</p>
<dl class="dl-horizontal">
<dt>Type prefix</dt>
<dd>A two character prefix indicating the type of item </dd>
<dt>Item name</dt>
<dd>Rational name of the item</dd>
</dl>
<div class="container-fluid">
<div class="row">
<div class="col-xs-12 col-sm-6">
<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title">Type prefix</h5>
</div>
<div class="panel-body">
Two characters, both lower case, describing the type of item, variable or object. Two characters provide 676 unique combinations, so should be plenty. Selection of these two characters is made by using the first two consonants in the type name. If already used, then the first and the third, and so on.
</div>
</div>
</div>
<div class="col-xs-12 col-sm-6">
<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title">Item name</h5>
</div>
<div class="panel-body">
A short but descriptive name of the item, variable or object. Avoid abbreviations and standard names from language documentation. Use CamelCase for multi-word names. Use shorter forms of common words.
</div>
</div>
</div>
</div>
</div>
<h4>Examples</h4>
<p>
The following examples illustrate the formulation of an item name/reference in various contexts.
</p>
<h5>Logic</h5>
<p>
Logic items include variables, objects and logic routines like classes, functions, methods and objects.
</p>
<div class="panel-group" id="accordion_Semantic_Logic" role="tablist" aria-multiselectable="true">
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Nm">
<h6 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Logic" href="#id_Cp_Nm" aria-controls="id_Cp_Nm">
<code>nm_</code>... : Number
</a>
</h6>
</div>
<div id="id_Cp_Nm" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Nm">
<div class="panel-body">
Numerical variable (integer, float, etc.)
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Bl">
<h4 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Logic" href="#id_Cp_Bl" aria-controls="id_Cp_Bl">
<code>bl_</code>... : Boolean
</a>
</h4>
</div>
<div id="id_Cp_Bl" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Bl">
<div class="panel-body">
Boolean variable (true/false, yes/no, 1/0, etc. )
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Sr">
<h4 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Logic" href="#id_Cp_Sr" aria-controls="id_Cp_Sr">
<code>sr_</code>... : String
</a>
</h4>
</div>
<div id="id_Cp_Sr" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Sr">
<div class="panel-body">
String variable (including numeric characters)
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Ag">
<h4 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Logic" href="#id_Cp_Ag" aria-controls="id_Cp_Ag">
<code>ag_</code>... : Argument
</a>
</h4>
</div>
<div id="id_Cp_Ag" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Ag">
<div class="panel-body">
Argument supplied to a function/method
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Rt">
<h4 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Logic" href="#id_Cp_Rt" aria-controls="id_Cp_Rt">
<code>rt_</code>... : Return
</a>
</h4>
</div>
<div id="id_Cp_Rt" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Rt">
<div class="panel-body">
Return variable (all types including arrays, integer, float, etc.)
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Ar">
<h4 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Logic" href="#id_Cp_Ar" aria-controls="id_Cp_Ar">
<code>ar_</code>... : Array
</a>
</h4>
</div>
<div id="id_Cp_Ar" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Ar">
<div class="panel-body">
Array variable (both associative and non-associative)
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Ky">
<h4 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Logic" href="#id_Cp_Ky" aria-controls="id_Cp_Ky">
<code>ky_</code>... : Array key
</a>
</h4>
</div>
<div id="id_Cp_Ky" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Ky">
<div class="panel-body">
Key for arrays (specifically for associative types).
<br />
There is still a question whether all arrays should be prefixed with <code>ky_</code> or with the type of variable they are. This is open for discussion.
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Fn">
<h4 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Logic" href="#id_Cp_Fn" aria-controls="id_Cp_Fn">
<code>fn_</code>... : Function
</a>
</h4>
</div>
<div id="id_Cp_Fn" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Fn">
<div class="panel-body">
Function or method
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Cl">
<h4 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Logic" href="#id_Cp_Cl" aria-controls="id_Cp_Cl">
<code>cl_</code>... : Class
</a>
</h4>
</div>
<div id="id_Cp_Cl" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Cl">
<div class="panel-body">
Class definitions
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Ob">
<h4 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Logic" href="#id_Cp_Ob" aria-controls="id_Cp_Ob">
<code>ob_</code>... : Object
</a>
</h4>
</div>
<div id="id_Cp_Ob" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Ob">
<div class="panel-body">
Object instance of class
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Vr">
<h4 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Logic" href="#id_Cp_Vr" aria-controls="id_Cp_Vr">
<code>vr_</code>... : Unspecified
</a>
</h4>
</div>
<div id="id_Cp_Vr" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Vr">
<div class="panel-body">
Unspecified variable type or category.
</div>
</div>
</div>
</div>
<h5>User interface</h5>
<p>
User interface items include UI elements, frames, buttons and other hidden elements like <code>div</code> elements.
</p>
<div class="panel-group" id="accordion_Semantic_Interface" role="tablist" aria-multiselectable="true">
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Bt">
<h6 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Interface" href="#id_Cp_Bt" aria-controls="id_Cp_Bt">
<code>bt_</code>... : Button
</a>
</h6>
</div>
<div id="id_Cp_Bt" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Bt">
<div class="panel-body">
Button, either aesthetic or for forms.
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Tx">
<h6 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Interface" href="#id_Cp_Tx" aria-controls="id_Cp_Tx">
<code>tx_</code>... : Text box/field
</a>
</h6>
</div>
<div id="id_Cp_Tx" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Tx">
<div class="panel-body">
Text box or field for forms.
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Lb">
<h6 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Interface" href="#id_Cp_Lb" aria-controls="id_Cp_Lb">
<code>lb_</code>... : Label
</a>
</h6>
</div>
<div id="id_Cp_Lb" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Lb">
<div class="panel-body">
Label elements.
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Ck">
<h6 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Interface" href="#id_Cp_Ck" aria-controls="id_Cp_Ck">
<code>ck_</code>... : Checkbox
</a>
</h6>
</div>
<div id="id_Cp_Ck" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Ck">
<div class="panel-body">
Check box element.
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Rd">
<h6 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Interface" href="#id_Cp_Rd" aria-controls="id_Cp_Rd">
<code>rd_</code>... : Radio button
</a>
</h6>
</div>
<div id="id_Cp_Rd" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Rd">
<div class="panel-body">
Radio button element.
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Tb">
<h6 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Interface" href="#id_Cp_Tb" aria-controls="id_Cp_Tb">
<code>tb_</code>... : Tabbed section container
</a>
</h6>
</div>
<div id="id_Cp_Tb" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Tb">
<div class="panel-body">
Tabbed section container.
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Tp">
<h6 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Interface" href="#id_Cp_Tp" aria-controls="id_Cp_Tp">
<code>tp_</code>... : Tab page
</a>
</h6>
</div>
<div id="id_Cp_Tp" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Tp">
<div class="panel-body">
Tab page (usually inside a tabbed section container).
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Dv">
<h6 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Interface" href="#id_Cp_Dv" aria-controls="id_Cp_Dv">
<code>dv_</code>... : Division (div)
</a>
</h6>
</div>
<div id="id_Cp_Dv" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Dv">
<div class="panel-body">
Division (div) element, usually found in HTML.
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Mg">
<h6 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Interface" href="#id_Cp_Mg" aria-controls="id_Cp_Mg">
<code>mg_</code>... : Image
</a>
</h6>
</div>
<div id="id_Cp_Mg" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Mg">
<div class="panel-body">
Image element.
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Ln">
<h6 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Interface" href="#id_Cp_Ln" aria-controls="id_Cp_Ln">
<code>ln_</code>... : Link
</a>
</h6>
</div>
<div id="id_Cp_Ln" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Ln">
<div class="panel-body">
Link element. This could be reference to a symbolic link, its container or a URL.
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Cb">
<h6 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Interface" href="#id_Cp_Cb" aria-controls="id_Cp_Cb">
<code>cb_</code>... : Combo box
</a>
</h6>
</div>
<div id="id_Cp_Cb" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Cb">
<div class="panel-body">
Combo box, usually rendered as an on-demand drop-down list.
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Rp">
<h6 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Interface" href="#id_Cp_Rp" aria-controls="id_Cp_Rp">
<code>rp_</code>... : Report
</a>
</h6>
</div>
<div id="id_Cp_Rp" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Rp">
<div class="panel-body">
Depending on the application environment and the coding language used, this could be reference to a file, sub-routine or a sub-system relating to reporting.
<br />
In database programming, this could be a saved report template.
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Fr">
<h6 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Interface" href="#id_Cp_Fr" aria-controls="id_Cp_Fr">
<code>fr_</code>... : Frame
</a>
</h6>
</div>
<div id="id_Cp_Fr" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Fr">
<div class="panel-body">
Frame could refer either a container for other UI elements or a sectioned division of the rendered viewport.
</div>
</div>
</div>
</div>
<h5>Databases</h5>
<p>
Database include databases, users, tables, fields, etc.
</p>
<div class="panel-group" id="accordion_Semantic_Database" role="tablist" aria-multiselectable="true">
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Db">
<h6 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Database" href="#id_Cp_Db" aria-controls="id_Cp_Db">
<code>db_</code>... : Database
</a>
</h6>
</div>
<div id="id_Cp_Db" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Db">
<div class="panel-body">
Database reference.
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Us">
<h6 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Database" href="#id_Cp_Us" aria-controls="id_Cp_Us">
<code>us_</code>... : User
</a>
</h6>
</div>
<div id="id_Cp_Us" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Us">
<div class="panel-body">
User, also usable in non-database context.
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Pw">
<h6 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Database" href="#id_Cp_Pw" aria-controls="id_Cp_Pw">
<code>pw_</code>... : Password
</a>
</h6>
</div>
<div id="id_Cp_Pw" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Pw">
<div class="panel-body">
Database password, also can be utilised elsewhere.
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Tl">
<h6 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Database" href="#id_Cp_Tl" aria-controls="id_Cp_Tl">
<code>tl_</code>... : Table
</a>
</h6>
</div>
<div id="id_Cp_Tl" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Tl">
<div class="panel-body">
Table, also can be used for interface elements rendered as tables.
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Fd">
<h6 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Database" href="#id_Cp_Fd" aria-controls="id_Cp_Fd">
<code>fd_</code>... : Field
</a>
</h6>
</div>
<div id="id_Cp_Fd" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Fd">
<div class="panel-body">
Database fields.
<div class="alert alert-success media" role="alert">
<div class="media-left">
<span class="glyphicon glyphicon-info-sign"></span>
</div>
<div class="media-body">
Since database fields are mostly predefined, it may be most efficient to define these field names based on the type of variable. For example,
<ul>
<li><code>sr_Fieldname</code> for fields containing string variable types</li>
<li><code>nm_Fieldname</code> for fields containing numeric variable types</li>
<li><code>bl_Fieldname</code> for fields containing boolean variable types</li>
</ul>
<p>For mixed or undefined field types <code>fd_FieldName</code> can be used as a fall-back.</p>
</div>
</div>
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Jc">
<h6 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Database" href="#id_Cp_Jc" aria-controls="id_Cp_Jc">
<code>jc_</code>... : Junction
</a>
</h6>
</div>
<div id="id_Cp_Jc" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Jc">
<div class="panel-body">
Junction or map tables (commonly used for many-to-many relationships in RDBMS).
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Lk">
<h6 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Database" href="#id_Cp_Lk" aria-controls="id_Cp_Lk">
<code>lk_</code>... : Lookups
</a>
</h6>
</div>
<div id="id_Cp_Lk" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Lk">
<div class="panel-body">
Lookups (usually tables).
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Qy">
<h6 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Database" href="#id_Cp_Qy" aria-controls="id_Cp_Qy">
<code>qy_</code>... : Query
</a>
</h6>
</div>
<div id="id_Cp_Qy" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Qy">
<div class="panel-body">
Database queries.
</div>
</div>
</div>
</div>
<h5>File system</h5>
<p>
Filesystem items include objects like files, directories, sockets, PID files, etc.
</p>
<div class="panel-group" id="accordion_Semantic_Filesystem" role="tablist" aria-multiselectable="true">
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="id_Hd_Fl">
<h6 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion_Semantic_Filesystem" href="#id_Cp_Fl" aria-controls="id_Cp_Fl">
<code>fl_</code>... : File
</a>
</h6>
</div>
<div id="id_Cp_Fl" class="panel-collapse collapse" role="tabpanel" aria-labelledby="id_Hd_Fl">
<div class="panel-body">
File object, used to reference or to store paths to file objects.
</div>