You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Heavily revised README.md and index.md
Revised credits.md:
* Changed text before 1st section.
* Renamed "Website" section as "License" and completely changed it.
This project contains the source code of the _ddablib_ DelphiDabbler Code Library documentation website.
3
+
This project contains the source code of the [_ddablib_](https://github.com/ddablib) DelphiDabbler Code Library documentation website.
4
4
5
-
The site has a custom URL: [https://lib-docs.delphidabbler.com/](https://lib-docs.delphidabbler.com/).
5
+
The website's URL is <https://lib-docs.delphidabbler.com/>.
6
6
7
-
> The GitHub Pages URL, [https://ddablib.github.io](https://ddablib.github.io), is also valid, but shouldn't be used. It simply redirects to the custom URL.
8
-
9
-
## α Code
10
-
11
-
This site is early in development at present and is being restructured. Many page URLs are in the process of being changed.
12
-
13
-
The project is based on [delphidabbler/ddab-lib-docs](https://github.com/delphidabbler/ddab-lib-docs) and was copied from that project on 2022-09-06. All the `ddab-lib-docs` history was brought forward.
14
-
15
-
Documentation of the following projects has been completed:
7
+
Documentation for each Code Library project is available:
16
8
17
9
| Project | Starting page URL |
18
-
|---------|-------------------|
10
+
|:--------|:------------------|
19
11
| About Box Component |<https://lib-docs.delphidabbler.com/AboutBox/>|
@@ -34,22 +26,10 @@ Documentation of the following projects has been completed:
34
26
| Version Information Component |<https://lib-docs.delphidabbler.com/VerInfo/>|
35
27
| Window State Components |<https://lib-docs.delphidabbler.com/WdwState/>|
36
28
37
-
Documentation of the following, unreleased, project is under construction:
38
-
39
-
| Project | Starting page URL |
40
-
|---------|-------------------|
41
-
| Binary Version Information Manipulation Units | 🚧 <https://lib-docs.delphidabbler.com/VIBin/>|
42
-
43
-
For all other projects you are advised to continue to use the original documentation at [delphidabbler/ddab-lib-docs](https://github.com/delphidabbler/ddab-lib-docs) for the time being.
The content of the website is licensed under the Creative Commons Attribution 4.0 International ([CC BY-4.0](https://creativecommons.org/licenses/by/4.0/)) license.
18
+
Much of the site is licensed under the the [Creative Commons Attribution-ShareAlike 4.0 International license](https://creativecommons.org/licenses/by-sa/4.0/) (CC BY-SA 4.0). Some source code files are MIT licensed: they contain an [MIT license](https://opensource.org/license/mit/) statement in their comments.
18
19
19
-
The site's source code is licensed under the [MIT License](https://delphidabbler.mit-license.org/2022/). It is maintained in the [`ddablib/ddablib.github.io`](https://github.com/ddablib/ddablib.github.io) repository on GitHub.
20
+
### Reuse & Accreditation
20
21
21
-
### Credits
22
+
The CC BY-SA 4.0 license requires accreditation by anyone reusing this documentation, in original or modified form. A suitable accreditation would be:
23
+
24
+
```text
25
+
Based on a work by Peter Johnson (https://en.gravatar.com/delphidabbler),
26
+
at https://github.com/ddablib/ddablib.github.io, copyright (c) 2023 and
27
+
licensed under the Creative Commons CC BY-SA license. No warranties are given.
28
+
```
29
+
30
+
If you make changes to the website and publish the changed version then the modified version must be made available under the same license.
31
+
32
+
For authoritative details of the above see the [full license](https://creativecommons.org/licenses/by-sa/4.0/legalcode).
33
+
34
+
## Credits
22
35
23
36
The site is generated using [Jekyll](https://jekyllrb.com/) and is hosted by [GitHub Pages](https://pages.github.com/).
24
37
25
-
## Third Party Code
38
+
###Third Party Code
26
39
27
40
The site uses the following 3rd party code. Some is linked to by each web page while other code is included in the site's Git repository.
Copy file name to clipboardExpand all lines: index.md
+13-45
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,11 @@
2
2
3
3
Welcome to the _DelphiDabbler Code Library Documentation Site_.
4
4
5
-
The library currently contains the following projects, all originally published on [DelphiDabbler.com](https://delphidabbler.com/codelib).
5
+
This website contains documentation of all [_DelphiDabbler Code Library_](https://delphidabbler.com/codelib) project releases.
6
6
7
-
|**Project**|**Description**|
8
-
|:------------|:----------------|
9
-
|[About Box Component](./AboutBox/index.md)| Non-visual component that encapsulates an About Box. Set properties or link to a [Version Information Component](./Docs/VerInfo.md) to customise the about box content. |
7
+
| Project | Description |
8
+
|:--------|:------------|
9
+
|[About Box Component](./AboutBox/index.md)| Non-visual component that encapsulates an About Box. Set properties or link to a [Version Information Component](./VerInfo/index.md) to customise the about box content. |
10
10
|[Clipboard Viewer Component](./CBView/index.md)| Component that triggers an event whenever the contents of the clipboard change. |
11
11
|[Console Application Runner Classes](./ConsoleApp/index.md)| Classes to control the execution of child console application processes and to redirect input and output where required. |
12
12
|[Drop Files Components](./DropFiles/index.md)| Components that enable applications, windows and other components to support drag and drop from Windows Explorer. |
@@ -30,54 +30,22 @@ Project releases are available in .zip format from [SourceForge](https://sourcef
30
30
31
31
## FAQs
32
32
33
-
Frequently asked questions for some of the Code Library projects are available and listed on the [FAQs](./faqs.md) page.
33
+
Frequently asked questions for some of the library projects are available and listed on the [FAQs](./faqs.md) page.
34
34
35
35
## Library News
36
36
37
-
You can get the latest news about the Code Library by following the [DelphiDabbler Blog](https://delphidabbler.blogspot.com/).
37
+
You can get the latest news about the _DelphiDabbler Code Library_ by following the [DelphiDabbler Blog](https://delphidabbler.blogspot.com/).
38
38
39
-
## License
40
-
41
-
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.
42
-
43
-
Note that the documentation is published under a different license: [see below](#documentation-license).
44
-
45
-
## About this documentation
46
-
47
-
### A little history
48
-
49
-
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.
50
-
51
-
Development continued directly on the `master` branch until commit 39b9e5a when the GitFlow development model was adopted.
52
-
53
-
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.
54
-
55
-
### Development model
39
+
## Contributing
56
40
57
-
Since commit 979f604 a new development model was adopted. Changes are now made on branches off `master` and merged back into `master` once verified.
41
+
You can contribute by editing web pages.
58
42
59
-
#### Contributing
43
+
There is a _Improve this page_ link at the bottom right of every page of the website. Clicking the link opens the page for editing on the [GitHub repository](https://github.com/ddablib/ddablib.github.io).
60
44
61
-
Anyone who would like to contribute to the documentation is welcome to do so. You should work on a fork of the GitHub `master` branch, create a suitably named branch for yourwork and open a pullrequest on GitHub when done.
45
+
Once you have made your suggested changes you will need to [create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
62
46
63
-
If you're unsure of the process [this tutorial](https://opensource.com/article/19/7/create-pull-request-github) explains it well.
47
+
The other way to contribute is to report errors using the [issue tracker](https://github.com/ddablib/ddablib.github.io/issues). Please check existing issues to see if anyone has reported anything similar already. If so you can add a comment to that issue or simply add a 👍 (`:+1:`) comment. If there isn't already a suitable issue then feel free to create a new one.
64
48
65
-
### Documentation license
66
-
67
-
68
-
69
-
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](https://creativecommons.org/licenses/by-sa/4.0/).
70
-
71
-
Based on a work at [https://github.com/ddablib/ddablib.github.io](https://github.com/ddablib/ddablib.github.io).
72
-
73
-
For full details see the `LICENSE` file.
74
-
75
-
#### Reuse & Accreditation
76
-
77
-
The Creative Commons CC BY-SA 4.0 license requires accreditation by anyone reusing this documentation. A suitable accreditation would be:
78
-
79
-
> Based on a work by Peter Johnson ([https://en.gravatar.com/delphidabbler](https://en.gravatar.com/delphidabbler)), at [https://github.com/delphidabbler/ddab-lib-docs](https://github.com/delphidabbler/ddab-lib-docs), copyright (c) 2022 and licensed under the Creative Commons CC BY-SA license. No warranties are given.
80
-
81
-
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.
49
+
## License
82
50
83
-
For authoritative details of the above see the [full license](https://creativecommons.org/licenses/by-sa/4.0/legalcode).
51
+
See the [License & Credits](./credits.md) page for details.
0 commit comments