|
1 | | -# DelphiDabbler Code Library Documentation |
| 1 | +# DelphiDabbler Code Library Documentation [SUPERSEDED] |
2 | 2 |
|
3 | | -> ***THIS REPO IS MOVING*** |
4 | | -> |
5 | | -> A new *DelphiDabbler Code Library Documentation* website is being developed. It can be found at <https://lib-docs.delphidabbler.com>. |
6 | | -> |
7 | | -> The website's source code is available in the [`ddablib/ddablib.github.io`](https://github.com/ddablib/ddablib.github.io) GitHub repository. The website is being developed from a copy of this repository's code base. |
8 | | -> |
9 | | -> The code in the new repo is being restructured to better suit the website format *and* to enable documentation for different major versions of a library project to coexist. |
10 | | -> |
11 | | -> Restructuring is taking place one project at a time. As each project's documentation is completed that section of the website will replace the documentation here. Once the restructuring of the website code has been completed, this repository will be archived. |
| 3 | +***THIS REPOSITORY IS ARCHIVED*** |
12 | 4 |
|
13 | | -The DelphiDabbler Code Library contains various useful and re-usable Delphi components, units and IDE extensions, arranged in sub-projects. All were originally published on [DelphiDabbler.com](https://delphidabbler.com/). |
| 5 | +The documentation formerly provided by this repository has now moved to the following website: |
14 | 6 |
|
15 | | -Many of the components and classes are stable and have been in development for a number of years. For details of each sub-project see [this summary](Docs/Welcome.md). |
| 7 | +* **<https://lib-docs.delphidabbler.com/>** |
16 | 8 |
|
17 | | -The project contains these components, classes and IDE extensions: |
| 9 | +The site is developed at: |
18 | 10 |
|
19 | | -| Project | Source Code Repo | Documentation | Releases | More Info | Platforms | Framework | |
20 | | -| ------- | ---------------- | ------------- | -------- | --------- | --------- | --------- | |
21 | | -| About Box Component | [ddablib/aboutbox](https://github.com/ddablib/aboutbox) | [Website](https://lib-docs.delphidabbler.com/AboutBox/) | [SourceForge](https://sourceforge.net/projects/ddablib/files/aboutbox/)<br>[GitHub](https://github.com/ddablib/aboutbox/releases) | [Website](https://delphidabbler.com/software/aboutbox) | Win32<br>Win64 | VCL<br><strike>FMX</strike> | |
22 | | -| Clipboard Viewer Component | [ddablib/cbview](https://github.com/ddablib/cbview) | [Website](https://lib-docs.delphidabbler.com/CBView) | [SourceForge](https://sourceforge.net/projects/ddablib/files/cbview/)<br>[GitHub](https://github.com/ddablib/cbview/releases) | [Website](https://delphidabbler.com/software/cbview) | Win32<br>Win64 | VCL<br><strike>FMX</strike> | |
23 | | -| Console Application Runner Classes | [ddablib/consoleapp](https://github.com/ddablib/consoleapp) | [Website](https://lib-docs.delphidabbler.com/ConsoleApp/) | [SourceForge](https://sourceforge.net/projects/ddablib/files/consoleapp/)<br>[GitHub](https://github.com/ddablib/consoleapp/releases) | [Website](https://delphidabbler.com/software/consoleapp) | Win32<br>Win64 | RTL | |
24 | | -| Drop Files Components | [ddablib/dropfiles](https://github.com/ddablib/dropfiles) | [Website](https://lib-docs.delphidabbler.com/DropFiles/) | [SourceForge](https://sourceforge.net/projects/ddablib/files/dropfiles/)<br>[GitHub](https://github.com/ddablib/dropfiles/releases) | [Website](https://delphidabbler.com/software/dropfiles) | Win32<br>Win64 | VCL<br><strike>FMX</strike> | |
25 | | -| Environment Variables Unit | [ddablib/envvars](https://github.com/ddablib/envvars) | [Website](https://lib-docs.delphidabbler.com/EnvVars/) | [SourceForge](https://sourceforge.net/projects/ddablib/files/envvars/)<br>[GitHub](https://github.com/ddablib/envvars/releases) | [Website](https://delphidabbler.com/software/envvars) | Win32<br>Win64 | VCL<br>FMX | |
26 | | -| Extended String Property Editor | [ddablib/stringpe](https://github.com/ddablib/stringpe) | [Website](https://lib-docs.delphidabbler.com/StringPE/) | [SourceForge](https://sourceforge.net/projects/ddablib/files/stringpe/)<br>[GitHub](https://github.com/ddablib/stringpe/releases) | [Website](https://delphidabbler.com/software/stringpe) | Win32<br><strike>Win64</strike> | IDE | |
27 | | -| Fractions Unit *(beta)* | [ddablib/fractions](https://github.com/ddablib/fractions) | [WebSite](https://lib-docs.delphidabbler.com/Fractions/) | [SourceForge](https://sourceforge.net/projects/ddablib/files/fractions/)<br>[GitHub](https://github.com/ddablib/fractions/releases) | [Website](https://delphidabbler.com/software/fractions) | Win32<br>Win64 | RTL | |
28 | | -| Hot Label Component | [ddablib/hotlabel](https://github.com/ddablib/hotlabel) | [Website](https://lib-docs.delphidabbler.com/HotLabel/) | [SourceForge](https://sourceforge.net/projects/ddablib/files/hotlabel/)<br>[GitHub](https://github.com/ddablib/hotlabel/releases) | [Website](https://delphidabbler.com/software/hotlabel) | Win32<br>Win64 | VCL<br><strike>FMX</strike> | |
29 | | -| I/O Utility Classes | [ddablib/ioutils](https://github.com/ddablib/ioutils) | [Website](https://lib-docs.delphidabbler.com/IOUtils/) | [SourceForge](https://sourceforge.net/projects/ddablib/files/ioutils/)<br>[GitHub](https://github.com/ddablib/ioutils/releases) | [Website](http://delphidabbler.com/software/ioutils) | Win32<br>Win64 | RTL | |
30 | | -| MD5 Message Digest Unit | [ddablib/md5](https://github.com/ddablib/md5) | [Website](https://lib-docs.delphidabbler.com/MD5/) | [SourceForge](https://sourceforge.net/projects/ddablib/files/md5/)<br>[GitHub](https://github.com/ddablib/md5/releases) | [Website](https://delphidabbler.com/software/md5) | Win32<br>Win64 | RTL | |
31 | | -| Message Dialogue Components | [ddablib/msgdlg](https://github.com/ddablib/msgdlg) | [Website](https://lib-docs.delphidabbler.com/MsgDlg/) | [SourceForge](https://sourceforge.net/projects/ddablib/files/msgdlg/)<br>[GitHub](https://github.com/ddablib/msgdlg/releases) | [Website](https://delphidabbler.com/software/msgdlg)| Win32<br>Win64 | VCL<br><strike>FMX</strike> | |
32 | | -| Resource File Unit | [ddablib/resfile](https://github.com/ddablib/resfile) | [Website](https://lib-docs.delphidabbler.com/ResFile/) | [SourceForge](https://sourceforge.net/projects/ddablib/files/resfile/)<br>[GitHub](https://github.com/ddablib/resfile/releases) | [Website](https://delphidabbler.com/software/resfile) | Win32<br>Win64 | RTL | |
33 | | -| Shell Folders Unit | [ddablib/shellfolders](https://github.com/ddablib/shellfolders) | [Website](https://lib-docs.delphidabbler.com/ShellFolders/) | [SourceForge](https://sourceforge.net/projects/ddablib/files/shellfolders/)<br>[GitHub](https://github.com/ddablib/shellfolders/releases) | [Website](https://delphidabbler.com/software/shellfolders) | Win32<br>Win64 | VCL<br><strike>FMX</strike> | |
34 | | -| Stream Extension Classes | [ddablib/streams](https://github.com/ddablib/streams) | [Website](https://lib-docs.delphidabbler.com/Streams/) | [SourceForge](https://sourceforge.net/projects/ddablib/files/streams/)<br>[GitHub](https://github.com/ddablib/streams/releases) | [Website](https://delphidabbler.com/software/streams) | Win32<br>Win64 | RTL | |
35 | | -| System Information Unit | [ddablib/sysinfo](https://github.com/ddablib/sysinfo) | [Website](https://lib-docs.delphidabbler.com/SysInfo/) | [SourceForge](https://sourceforge.net/projects/ddablib/files/sysinfo/)<br>[GitHub](https://github.com/ddablib/sysinfo/releases) | [Website](https://delphidabbler.com/software/sysinfo) | Win32<br>Win64 | RTL | |
36 | | -| Version Information Component | [ddablib/verinfo](https://github.com/ddablib/verinfo) | [Website](https://lib-docs.delphidabbler.com/VerInfo/) | [SourceForge](https://sourceforge.net/projects/ddablib/files/verinfo/)<br>[GitHub](https://github.com/ddablib/verinfo/releases) | [Website](https://delphidabbler.com/software/verinfo) | Win32<br>Win64 | VCL<br>FMX | |
37 | | -| Window State Components | [ddablib/wdwstate](https://github.com/ddablib/wdwstate) | [Website](https://lib-docs.delphidabbler.com/WdwState) | [SourceForge](https://sourceforge.net/projects/ddablib/files/wdwstate/)<br>[GitHub](https://github.com/ddablib/wdwstate/releases) | [Website](https://delphidabbler.com/software/wdwstate) | Win32<br>Win64 | VCL<br><strike>FMX</strike> | |
38 | | - |
39 | | -The **Source Code Repo** column contains a link to the project's Git repository. |
40 | | - |
41 | | -The **Documentation** column contains links to the projects documentation. _Here_ links to documentation within this repository, while _Website_ links to a page on <https://lib-docs.delphidabbler.com>. |
42 | | - |
43 | | -The **Releases** column contains links to the project's directory on the *SourceForge* file manager from where zip files containing all available releases can be downloaded. There are also links to the project's _Releases_ page on GitHub, which has only later releases available. |
44 | | - |
45 | | -The **More Info** column has links that take you to the library project's page on DelphiDabbler.com. |
46 | | - |
47 | | -The **Platforms** column notes the platforms that the project is compatible with. *Win32* is 32 bit Windows and *Win64* is 64 bit Windows. Struck out items, like *<strike>Win64</strike>*, indicate that the code is not compatible with the platform. IDE extensions are only ever 32 bit compatible. **Note:** No projects in this library have been tested on non-Windows platforms. |
48 | | - |
49 | | -The **Framework** column notes whether the project is compatible with either the VCL or FireMonkey, has no dependencies, or is an IDE extension. The following abbreviations are used: |
50 | | - |
51 | | - * *RTL* - requires only the Delphi run time library, so has no dependencies on either the VCL and FMX frameworks and can be used with either or none. |
52 | | - * *VCL* - compatible with the Visual Component Library framework. |
53 | | - * *FMX* - compatible with the FireMonkey framework. |
54 | | - * *IDE* - an IDE extension. |
55 | | - |
56 | | -Struck out frameworks such as *<strike>FMX</strike>* are not supported by the project. |
57 | | - |
58 | | -## FAQs |
59 | | - |
60 | | -Frequently asked questions for some of the Code Library projects are available and listed on the [FAQs](FAQs/FAQs.md) page. |
61 | | - |
62 | | -## Library News |
63 | | - |
64 | | -You can get the latest news about the Code Library by following the [DelphiDabbler Blog](https://delphidabbler.blogspot.com/). |
65 | | - |
66 | | -## License |
67 | | - |
68 | | -All the code in the library now uses the Mozilla Public License v2.0 (MPL 2.0). Earlier versions may use the Mozilla Public License v1.1. |
69 | | - |
70 | | -Note that the documentation is published under a different license: [see below](#documentation-license). |
71 | | - |
72 | | -## About this documentation |
73 | | - |
74 | | -### A little history |
75 | | - |
76 | | -The documentation started out as a wiki on Google Code, maintained in a Subversion repository as a branch of the DelphiDabbler Code Library Project. The wiki branch was extracted from the Subversion repository and converted to Git as at commit 1d1404b. The Git repository was placed on GitHub in the `delphidabbler/ddab-lib-docs` project. |
77 | | - |
78 | | -Development continued directly on the `master` branch until commit 39b9e5a when the GitFlow development model was adopted. |
79 | | - |
80 | | -Development then took place on a `develop` branch. Five releases were made before the GitFlow model was abandoned at commit 0697fcb. The `develop` branch was deleted at commit 979f604 and all the release tags were deleted. The associated change-log file was also removed. |
81 | | - |
82 | | -### Development model |
83 | | - |
84 | | -Since commit 979f604 a new development model was adopted. Changes are now made on branches off `master` and merged back into `master` once verified. |
85 | | - |
86 | | -### Contributing |
87 | | - |
88 | | -Contributions to this repository are no longer being accepted. |
89 | | - |
90 | | -> Please see the [`ddablib/ddablib.github.io`](https://github.com/ddablib/ddablib.github.io) successor repository instead. |
91 | | -
|
92 | | -### Documentation license |
93 | | - |
94 | | - |
95 | | - |
96 | | -DelphiDabbler Code Library Documentation by [Peter Johnson](https://en.gravatar.com/delphidabbler) is licensed under a Creative [Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/). |
97 | | - |
98 | | -Based on a work at https://github.com/delphidabbler/ddab-lib-docs. |
99 | | - |
100 | | -For full details see the `LICENSE` file. |
101 | | - |
102 | | -#### Reuse & Accreditation |
103 | | - |
104 | | -The Creative Commons CC BY-SA 4.0 license requires accreditation by anyone reusing this documentation. A suitable accreditation would be: |
105 | | - |
106 | | -```text |
107 | | -Based on a work by Peter Johnson (https://en.gravatar.com/delphidabbler), |
108 | | -at https://github.com/delphidabbler/ddab-lib-docs, copyright (c) 2022 and |
109 | | -licensed under the Creative Commons CC BY-SA license. No warranties are given. |
110 | | -``` |
111 | | - |
112 | | -If you make changes and distribute the changes then, in addition to the above, you must distribute the modified version under the same license, indicate you made changes and retain an indication of earlier changes. |
113 | | - |
114 | | -For authoritative details of the above see the [full license](https://creativecommons.org/licenses/by-sa/4.0/legalcode). |
| 11 | +* <https://github.com/ddablib/ddablib.github.io> |
0 commit comments