Repository files navigation

This repository contains a collection of over 700 reusable Pascal code snippets. The majority are simple functions and procedures but there are also some constants and type definitions, including some advanced records with methods.

Snippets are grouped into categories, with each snippet belonging to exactly one category.

All of the snippets have been tested to some extent: some received basic testing while others have been tested more comprehensively. The collection contains details of the level of testing each snippet received.

The primary purpose of the collection is for use with theDelphiDabblerCodeSnip program.

However the intent is that other applications will also be able to use the collection by parsing the meta data provided with it.

The collection data format isfully documented indocs directory.

Anyone is welcome to write applications or web pages that access the snippets in the collection, subject to the terms of the license (see below). You should read the collection's documentation which explains the file formats in detail.

⚠️ Implementersmust not read the collection data directly from this GitHub repository - that could generate more than the permitted amount of traffic. Instead you must download a release from theReleases tab and either distribute the collection with the application or host it on a web server.

Unit tests and demonstration projects are available forsome of the snippets.

Source code for these tests and demonstrations is available in thetests directory. There is a sub-directory for each category where such code is available.

See theREADME.md file in thetests directory for full details.

Releases can be found on thereleases tab on the GitHub project page.

Each release¹ comprises three zip files, as follows (replaceX.Y.Z in the file names with the release version number):

• csdb-vX.Y.Z-data.zip - Contains all the data in the collection. Required by applications that access the collection.
• csdb-vX.Y.Z-docs.zip - Contains the documentation developers need to understand the structure of the data.
• csdb-vX.Y.Z-tests.zip - Contains the unit tests and demo code.

This repo uses theGit Flow methodology - i.e. development proceeds on thedevelop branch andfeature branches off it. Only released content appears on themaster branch.

This repository contains version 2 of the collection.

Version 1 was designed exclusively for use withDelphiDabblerCodeSnip (v4.15.1 and earlier). It was downloaded by the program directly from a web service on DelphiDabbler.com. This version was not developed under Git and is longer available.

Version 2 is designed to be able to be used by other applications in addition toCodeSnip (v4.16.0 or later). This version isnot backwards compatible with version 1.

The project's change log can be found inCHANGELOG.md.

This project is MIT Licensed. SeeLICENSE.md for full details.