Browse code

Re-rewrite the quickstart-guide according to the new folder-structure

Manuel Thalmann authored on 30/04/2018 13:19:52
Showing 1 changed files
... ...
@@ -100,7 +100,7 @@ For example:
100 100
 > The `Package.ts`-file contains meta-data of your package.
101 101
 ### Interface
102 102
 ```ts
103
-<%- include("./lib/IPackage.ts") %>
103
+<%- include("./lib/PackageSystem/IPackage.ts") %>
104 104
 ```
105 105
 
106 106
 ### Example
... ...
@@ -416,7 +416,7 @@ Using the `OptionsInstruction` you can provide options and their translations fo
416 416
 
417 417
 ### Interface
418 418
 ```ts
419
-<%- include("./lib/ControlPanel/IOptionsInstruction.ts") %>
419
+<%- include("./lib/Options/ControlPanel/IOptionsInstruction.ts") %>
420 420
 ```
421 421
 
422 422
 ### Example
... ...
@@ -528,7 +528,7 @@ A category may contain sub-categories or options.
528 528
 
529 529
 ### Interface
530 530
 ```ts
531
-<%- include("./lib/ControlPanel/ISettingsNode.ts") %>
531
+<%- include("./lib/Options/ControlPanel/ISettingsNode.ts") %>
532 532
 ```
533 533
 
534 534
 ### Example
... ...
@@ -644,7 +644,7 @@ Options are displayed in the Admin Control-Panel inside the category you've chos
644 644
 
645 645
 ### Interface
646 646
 ```ts
647
-<%- include("./lib/ControlPanel/IOption.ts") %>
647
+<%- include("./lib/Options/ControlPanel/IOption.ts") %>
648 648
 ```
649 649
 
650 650
 ### Properties
... ...
@@ -715,7 +715,7 @@ The type of the option.
715 715
 Following types are allowed:
716 716
 
717 717
 ```ts
718
-<%- include("./lib/Controlpanel/OptionType.ts") %>
718
+<%- include("./lib/Options/Controlpanel/OptionType.ts") %>
719 719
 ```
720 720
 
721 721
 **Examlpe:**
... ...
@@ -750,7 +750,7 @@ An option-item represents an item of an option with a `ComboBox`, `MultiSelect`
750 750
 
751 751
 ### Interface
752 752
 ```ts
753
-<%- include("./lib/ControlPanel/IOptionItem.ts") %>
753
+<%- include("./lib/Options/ControlPanel/IOptionItem.ts") %>
754 754
 ```
755 755
 
756 756
 ### Properties
... ...
@@ -785,7 +785,7 @@ The `EventListenerInstruction` allows you to make WoltLab executing custom code
785 785
 
786 786
 ### Interface
787 787
 ```ts
788
-<%- include("./lib/EventListener.ts") %>
788
+<%- include("./lib/Events/EventListener.ts") %>
789 789
 ```
790 790
 
791 791
 ### Examlpe
... ...
@@ -891,7 +891,7 @@ But there is one major difference: You can declare an ID to access the error-mes
891 891
 
892 892
 ### Interface
893 893
 ```ts
894
-<%- include("./lib/Globalization/IErrorMessagesInstruction.ts") %>
894
+<%- include("./lib/Globalization/Errors/IErrorMessagesInstruction.ts") %>
895 895
 ```
896 896
 
897 897
 ### Example
... ...
@@ -935,7 +935,7 @@ You can provide them using `TemlpateListenersInstruction`s.
935 935
 
936 936
 ### Interface
937 937
 ```ts
938
-<%- include("./lib/Customization/ITemplateListenersInstruction.ts") %>
938
+<%- include("./lib/Customization/Presentation/ITemplateListenersInstruction.ts") %>
939 939
 ```
940 940
 
941 941
 ### Examlpe
... ...
@@ -969,7 +969,7 @@ A set of temlpate-listeners.
969 969
 ## `TemlpateListener`
970 970
 ### Interface
971 971
 ```ts
972
-<%- include("./lib/Customization/ITemplateListener.ts") %>
972
+<%- include("./lib/Customization/Presentation/ITemplateListener.ts") %>
973 973
 ```
974 974
 
975 975
 ### Properties
... ...
@@ -993,7 +993,7 @@ You can provide your own emojis by using an `EmojisInstruction`.
993 993
 
994 994
 ### Interface
995 995
 ```ts
996
-<% include("./lib/Customization/IEmojisInstruction.ts") %>
996
+<% include("./lib/Customization/Emojis/IEmojisInstruction.ts") %>
997 997
 ```
998 998
 
999 999
 ### Examlpe
... ...
@@ -1031,7 +1031,7 @@ This class represents an emoji.
1031 1031
 
1032 1032
 ### Interface
1033 1033
 ```ts
1034
-<%- include("./lib/Customization/IEmoji.ts") %>
1034
+<%- include("./lib/Customization/Emojis/IEmoji.ts") %>
1035 1035
 ```
1036 1036
 
1037 1037
 ### Properties
... ...
@@ -1056,7 +1056,7 @@ You can provide new bb-codes using a `BBCodesInstruction`.
1056 1056
 
1057 1057
 ### Interface
1058 1058
 ```ts
1059
-<%- include("./lib/Customization/IBBCodesInstruction.ts") %>
1059
+<%- include("./lib/Customization/BBCodes/IBBCodesInstruction.ts") %>
1060 1060
 ```
1061 1061
 
1062 1062
 ### Example
... ...
@@ -1073,7 +1073,7 @@ A BB-Code is a tag you can use when editing or adding contents on/to WoltLab Sui
1073 1073
 
1074 1074
 ### Interface
1075 1075
 ```ts
1076
-<%- include("./lib/Customization/IBBCode.ts") %>
1076
+<%- include("./lib/Customization/BBCodes/IBBCode.ts") %>
1077 1077
 ```
1078 1078
 
1079 1079
 ### Properties
... ...
@@ -1136,7 +1136,7 @@ A BBCode-attribute allows users to provide further arguments to the bbcode in or
1136 1136
 
1137 1137
 ### Interface
1138 1138
 ```ts
1139
-<%- include("./lib/Customization/IBBCodeAttribute.ts") %>
1139
+<%- include("./lib/Customization/BBCodes/IBBCodeAttribute.ts") %>
1140 1140
 ```
1141 1141
 
1142 1142
 ### Properties