tiOPF: what changed

Revision 1 to 2. Removed lines have a minus sign; added lines have a plus sign.

Old	New		Line
1	1		### About
2	2
3	3		The [TechInsite Object Persistence Framework](http://tiopf.sourceforge.net) (tiOPF) is an Open Source framework of Delphi/Object Pascal code that simplifies the mapping of an object oriented business model into a relational database. The framework is mature and robust. It has been in use on production sites since 1999. It is free, open source, and available for immediate download with full source code.
4	4
5	5		Some of the key features of the tiOPF include:
6	6
7	7		- Lets you build an object oriented application that can swap databases with the flick of a switch like a command line parameter or a change of a compiler directive. Currently there are persistence layers for:
8	8		- Interbase via IBX
9	9		- Oracle via DOA
10	10		- MySQL via [[Zeos tutorial\|Zeos]]
11	11		- MySQL via [[SQLdb Package\|SqlDB]]
12	12		- XML via MSDOM
13	13		- XML via XMLLite
14	14		- Paradox via BDE
15	15		- MS Access via ADO
16	16		- MS SQL Server via ADO
17	17		- MS SQL Server via SqlDB
18	18		- Firebird via FBLib
19	19		- Firebird via SqlDB
20	20		- Firebird via Zeos
21	21		- PostgreSQL via SqlDB
22	22		- HTTP Remote Persistence (for n-tier applications with built-in generic application server)
23	23		- Text files (CSV and TAB files)
24	24		- Family of abstract base classes for building a complex object model
25	25		- 27 Persistent Object-aware components for building complex GUIs (Delphi only).
26	26		- Model-GUI-Mediators implementation for enabling any standard GUI component to become Object-aware. MGM currently has mediators defined for: VCL, LCL and [[fpGUI\|fpGUI Toolkit]].
27	27		- 1600+ DUnit2/[[FPTest]] tests to guarantee stability
28	28		- 160+ pages of documentation to get you started
29	29		- News groups for support
30	30		- Automated, daily builds and unit testing. This is done under Linux and Windows and uses FPC & Delphi compilers.
31	31		- Lots of demos focusing on specific parts of the framework for easy learning.
32	32		- Cross platform. Currently tested on Windows, Linux and FreeBSD (32 & 64-bit).
33	33
34	34		### Authors
35	35
36	36		Peter Hinrichsen - Original Developer.\
37	37		Graeme Geldenhuys - Ported to Free Pascal and current maintainer.
38	38
39	39		### License
40	40
41	41		tiOPF uses a dual license. Developers can use the [Mozilla Public License 1.1](http://opensource.org/licenses/mozilla1.1.php) or the Modified LGPL license (as used by libraries of FPC and Lazarus).
42	42
43	43		### Support
44	44
45	45		The best way to get support is by signing up to tiopf.support news group — see here: <http://tiopf.sourceforge.net/Support.shtml>
46	46
47	47		### Download
48	48
49	49		For some years now, the tiOPF project does not make official release downloads. The tiOPF projects works on a similar principal to a "rolling release". Thus if you want the latest version with the latest features and fixes, you must get the source code from the Git code repository.
50	50
51	51		You can use the following commands to check out the source:
52	52
53		-	~~`git clone git://tiopf.git.sourceforge.net/gitroot/tiopf/tiopf`~~
	53	+	```text
	54	+	git clone git://tiopf.git.sourceforge.net/gitroot/tiopf/tiopf
	55	+	```
54	56
55	57		You will now have a 'tiopf' directory containing the tiOPF repository. By default Git will also have checked out the 'master' branch for you. The tiOPF project doesn't use the 'master' branch for development, so switch to the 'tiopf2' branch as follows:
56	58
57		-	~~` git branch tiopf2 origin/tiopf2 (1)`\~~
58		-	~~` git checkout tiopf2 (2)`~~
	59	+	```text
	60	+	git branch tiopf2 origin/tiopf2 (1)
	61	+	git checkout tiopf2 (2)
	62	+	```
59	63
60	64		1. Creates a local branch named 'tiopf2', which points to the remote tiopf2 branch.
61	65		2. Switch to your local 'tiopf2' branch.
62	66
63	67		Another simpler way of doing this is:
64	68
65		-	~~`git clone --branch=tiopf2 git://tiopf.git.sourceforge.net/gitroot/tiopf/tiopf`~~
	69	+	```text
	70	+	git clone --branch=tiopf2 git://tiopf.git.sourceforge.net/gitroot/tiopf/tiopf
	71	+	```
66	72
67	73		You will now have a 'tiopf' directory containing the tiOPF repository.
68	74
69	75		> Note: When working with Free Pascal and tiOPF, the only supported compiler is the latest released FPC (and the related fixes branch), and the 'tiopf2' branch of tiOPF.
70	76
71	77		For a short introduction to using Git, you can refer to a message posted in the tiopf.development newsgroup. [tiopf.development;article=3272](http://geldenhuys.co.uk/webnews/webnews.cgi?user=anonymous;group=tiopf.development;article=3272). For very good and detailed documentation on Git, we highly recommend you browse through the official Git documentation as well, located here: [<http://git-scm.com/documentation>](http://git-scm.com/documentation)
72	78
73	79		### Dependencies / System Requirements
74	80
75	81		- Compiler: FPC 2.6.4. The latest released FPC version.
76	82		- Components for your required persistence layer, if it is not included with the compiler.
77	83
78	84		Status: Stable (tested on Windows, Linux and FreeBSD)
79	85
80	86		Issues: None
81	87
82	88		### Installation
83	89
84	90		#### The Packages
85	91
86	92		Inside the \<tiopf\>\Compilers\FPC directory there are four packages.
87	93
88	94		tiOPF.lpk
89	95		Core units (run-time only package)
90	96
91	97		tiOPFGUI.lpk
92	98		GUI related units and tiOPF+LCL custom components \[deprecated\] (run-time only package).
93	99
94	100		tiOPFGUIDsgn.lpk
95	101		Registers/Installs the tiOPF+LCL custom components into the Lazarus component palette (design-time only package). The tiOPF+LCL custom GUI components used under Lazarus are unmaintained and deprecated. It is preferred to use the Model-GUI-Mediator components instead. See tiOPFLCL.lpk package instead.
96	102
97	103		tiOPFLCL.lpk
98	104		GUI related units which replaces tiOPFGUI.lpk and does not contain any of the tiOPF custom GUI components. This packages uses the Mediators which makes standard LCL components "object-aware" and is the preferred way of hooking up your UI to you business objects. (run-time only package)
99	105
100	106		tiOPFHelpIntegration.lpk
101	107		Integrates the fpdoc generated help files into Lazarus's help system (design-time only package)
102	108
103	109		#### The Setup
104	110
105	111		- Open Lazarus IDE
106	112		- Open the package tiOPF.lpk with 'Package -\> Open Package File (.lpk)' located in the \<tiopf\>\Compilers\FPC\\ directory.
107	113		- Click on Compile
108	114		- Open the tiOPFLCL.lpk package and click Compile
109	115
110	116		Optional
111	117
112	118		- Open the tiOPFHelpIntegration.lpk package and click Compile and the Install (Lazarus should rebuild and restart).
113	119
114	120		NOTE \#1\
115	121		The SqlDB+Firebird database components are set as the default persistence layer for Free Pascal in the tiOPF.lpk package. This was simply done because SqlDB in included with the Free Pascal Compiler, and Firebird is a popular database option. If you don't need this persistence layer you can simply disable it as described below.
116	122
117	123		Persistence layers are controlled by a Compiler Directive under Compiler Options -\> Other -\> Custom Options. eg: The LINK_FBL directive relates to the FBLib components. The LINK_SQLDB_IB directive relates to the SqlDB (Interbase/Firebird) components. For all the available options see the end of the tiOPFManager.pas unit.
118	124
119	125		NOTE \#2\
120	126		For the Integrated Help to work, Lazarus needs to know how to find the html help files. Please read the tiOPFHelpIntegration.txt file located in \<tiopf\>\Compilers\FPC\\ for further instructions.
121	127
122	128		### Usage
123	129
124	130		In Lazarus, open your project and add tiOPF as a Required Package (Project -\> Project Inspector -\> Add). Include tiObject in your uses clause. You are now ready to create objects descending from TtiObject or TtiObjectList.
125	131
126	132		See the example projects in the Demos directory for additional examples.
127	133
128	134		### Links
129	135
130	136		tiOPF home page: <http://tiopf.sourceforge.net/>
131	137
132	138		#### Basics about tiOPF and Design Patterns
133	139
134	140		For people who are searching basics about tiOPF or Design Patterns, there are a couple of published articles at (http://geldenhuys.co.uk/articles/)
135	141
136	142		Written by Graeme Geldenhuys
137	143
138	144		2008-08
139	145		Simple Factory Pattern (download pdf) \[150KB\]
140	146
141	147		2008-09
142	148		Model-GUI-Mediator (download pdf - 251KB) & (source code - 9KB)
143	149
144	150		2008-11
145	151		Iterator Pattern (download pdf - 147KB) & (source code - 4KB)
146	152
147	153		2009-01
148	154		The Adapter Pattern (download pdf) \[237KB\]
149	155
150	156		2009-02
151	157		Intro to Git - source code management (download pdf) \[257KB\]
152	158
153	159		2009-03
154	160		The State Pattern (download pdf) \[217KB\]
155	161
156	162		2009-07
157	163		Relationship Manager (download pdf) \[375KB\]
158	164
159	165		2009-09
160	166		Hierarchies in SQL - Nested Sets (download pdf) \[163KB\]
161	167
162	168		2011-12
163	169		The Facade Design Pattern (download pdf) \[297KB\]
164	170
165	171		---
166	172		From the Free Pascal wiki, page "tiOPF", as it stood on 2017-10-23 after a change by Zoran, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).
167	173		Category: Databases
168	174		Category: Framework

Back to history