Lazarus Examples Window: what changed

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

Old	New		Line
1	1		The new Example Window that exists in Lazarus 3.0 and beyond is documented below.
2	2
3	3		## For the end user
4	4
5	5		### Introduction
6	6
7	7		A Lazarus user gets to the Example Window after clicking the button on the Project Wizard screen or from the Tools Menu, "Example Projects". In either case you see a window offering a list of known examples. The list can be filtered by key words or by category (double click between category checkboxes turns all off). In basic use, it shows you all the examples shipped with Lazarus.
8	8
9	9		The Example Window will allow you to open, build (and edit) and run any example but note some have specific package requirements. When opened, the examples from the Lazarus Source code are copied to a (user writable) area in the Lazarus Config directory ([[pcp\|PCP]]) because, on some systems Lazarus Source is in read-only disk space.
10	10
11	11		Feel free to edit or make changes to examples in Lazarus Source, if you totally mess up, its easily refreshed from the Examples Window.
12	12
13	13		### Examples in Packages
14	14
15	15		When you install a package that has compliant examples, they will also appear in the Lazarus Examples Window. If they don't appear, the most likely reason is that they do not have an example meta data file. See below.
16	16
17	17		### Displaying your own Examples
18	18
19	19		If you have your own examples in one or more Lazarus projects, you can arrange to have them listed along with the built in examples supplied with Lazarus. Following the same rules as below, you would -
20	20
21	21		- Ensure each example is in its own directory and is self contained.
22	22		- Provide meta data files as described below. Perhaps set the category to something like "Private" ?
23	23		- Add an entry to the ./examples/examples.txt file in your Lazarus Source directory. The entry, see the existing ones, should have a relative path from the top of the lazarus source directory to your meta data file. If you are using a packaged version of Lazarus then this examples.txt file might be in read only space and you will need administrative access to it.
24	24		- Examples mentioned in examples.txt are always copied to a work area ensuring write access and allowing you to play without affecting the original.
25	25
26	26		### FPC Examples
27	27
28	28		FPC also provides a number of examples relating to its packages and RTL. These examples are generally command line driven and don't have the Lazarus project information so are unsuited to working with the Lazarus Examples Window. (It might be nice to find a way to display them however.)
29	29
30	30		## For the Developer
31	31
32	32		### Examples in the Lazarus Source
33	33
34	34		You can add an example anywhere you like in the Lazarus Source Tree, there are lots under ~/examples but also many associated with different Lazarus sub system. A few rules apply -
35	35
36	36		- The Example Name must be unique within Lazarus (when lowercased).
37	37		- The example should be self contained within its own directory. That directory (and any sub directories) will be copied to the work area so don't assume particular files are "just up one dir".
38	38		- The example should have an Example Metadata File, with a file name that corresponds to the project name and an extension of .ex-meta. The content of this file is JSON and must have a name, a category and should have a (multiline) description and keywords. See below.
39	39
40	40		If you add a new example (or remove one) to the Lazarus Source Tree, the file ~/examples/examples.txt needs to be refreshed. Its plain text, edit it directly or generate a new one with this command (on a *nix )-
41	41
42		-	~~`$> find . -name "*.ex-meta" > examples/examples.txt`~~
	42	+	```text
	43	+	$> find . -name "*.ex-meta" > examples/examples.txt
	44	+	```
43	45
44	46		### Examples in Third Party Packages
45	47
46	48		Again, you are free to place your package examples directory where you like but in order for the Lazarus Examples Window to find it, some things must be provided, note, different rules than above !
47	49
48	50		- The package must be currently installed in Lazarus (check ? see if its listed in ([[pcp\|PCP]])/staticpackages.inc)
49	51		- Your example should be in a directory of its own. You should not put more than one example in the same directory.
50	52		- In the case of Package Examples, the example directory is not moved to a work area so it can (but perhaps should not) be dependent on local, relative path files.
51	53		- It must have a Metadata File, see below.
52	54		- The Package file, that is the .lpk file must have entry such as \<ExamplesDirectory Value="../demo"/\>, typically just below the Author item. The value is the relative path from the .lpk file to a directory containing your example or examples. eg -
53	55
54		-	~~`[MyPackage]`\~~
55		-	~~` [demo]`\~~
56		-	~~` mypackage_demo1.ex-meta`\~~
57		-	~~` ....`\~~
58		-	~~` [demo2]`\~~
59		-	~~` mypackage_demo2.ex-meta`\~~
60		-	~~` ....`\~~
61		-	~~` [package]`\~~
62		-	~~` mypackage.lpk`~~
	56	+	```text
	57	+	[MyPackage]
	58	+	[demo]
	59	+	mypackage_demo1.ex-meta
	60	+	....
	61	+	[demo2]
	62	+	mypackage_demo2.ex-meta
	63	+	....
	64	+	[package]
	65	+	mypackage.lpk
	66	+	```
63	67
64	68		(Personally, I would put demo1 in its own directory too but the above would work !)
65	69
66	70		Note that, at present, Lazarus, when making a package, does NOT create the ExamplesDirectory entry, it will, but its a work in progress. If you want to test, manually adding that entry is the way to go right now.
67	71
68	72		### The Metadata File
69	73
70	74		> Note: If you add a new example (or remove one) to the Lazarus Source Tree, the file ~/examples/examples.txt needs to be refreshed. Its plain text, edit it directly or generate a new one with this command from the top level Lazarus directory (on a *nix )-
71	75		>
72	76		> `$> find . -name "*.ex-meta" > examples/examples.txt`
73	77
74	78		All examples that appear in the Example Window have a json metadata file with an extension ".ex-meta" in the top level directory of the example (not the package). Without a valid metadata file, the example will not be listed in the Example Window. An individual example project file would look like this -
75	79
76	80		```text
77	81		{
78	82		"Laz_Hello" : {
79	83		"Category" : "Beginner",
80	84		"Keywords" : ["Lazarus", "Hello World", "TButton", "TMemo"],
81	85		"Description" : "This might be your first Lazarus project, its the traditional Hello World. Two buttons have been dropped on the form, renamed and their captions set. A memo was then added and each button was double clicked and what they are expected to do was set."
82	86		}
83	87		```
84	88
85	89		In this case, the example project files would be in a subdirectory called laz_hello, same spelling but all lowercase consistent with Lazarus.
86	90
87	91		The three fields are free form text, there is no dictionary so, you are free to introduce both new Categories and new Key Words. Its desirable that we do not have too many Categories so, perhaps consider posting a message on the forum before using a new one ? At present, the following Categories are in use -
88	92
89	93		- Beginner
90	94		- General
91	95		- TAChart
92	96		- DBase
93	97		- LazReport
94	98		- ThirdParty
95	99
96	100		There is a rough and ready GUI app to make, edit and importantly, validate metadata files available at <https://github.com/davidbannon/ExampleMetaData> .
97	101
98	102		### Can the IDE find the example ?
99	103
100	104		If the IDE does not find an example, some things to check for -
101	105
102	106		- Does it have a metadata file ?
103	107		- Is there a message about the metadata from console ?
104	108		- If its a Lazarus Source example, is it mentioned in examples/examples.txt ?
105	109		- if a Package Example, is it mentioned in ([[pcp\|PCP]])/staticpackages.inc ? and in ([[pcp\|PCP]])/packagefiles.xml ? (Unlike the examples.txt file, do not manually edit these files, they should be updated when a package is installed into the the IDE.)
106	110
107	111		## Notes
108	112
109	113		The user can view the project content and, if they choose, build the project. Later, if the user users the Example Window to again open that project, they will be asked if they want to refresh it, doing so will erase any false edits they may have made.
110	114
111	115		Important to note -
112	116
113	117		- Example Projects will not be displayed in the Examples Window unless they have a valid metadata file. An error is dropped to the console if a metadata file with bad json is encountered.
114	118		- The original copy of the Example is not altered when the Example Window is used to open an Example. So, play away !
115	119		- New examples can, potentially be added via the normal Gitlab pull request system.
116	120		- When examples are added to or removed from the Lazarus Source, changes need be made to the (eg) ~/lazarus_3_0/examples/examples.txt file. See the Metadata section.
117	121		- Examples demonstrating aspects of third party packages are probably best added to that package rather than to Lazarus itself.
118	122
119	123		## See also
120	124
121	125		- <https://forum.lazarus.freepascal.org/index.php/topic,57680.0.html>
122	126		- <https://gitlab.com/freepascal.org/lazarus/lazarus/-/issues/37509>
123	127		- <https://gitlab.com/dbannon/laz_examples> - this is just a temp home.
124	128		- <https://gitlab.com/dbannon/laz_examples/-/tree/main/Utility/ExScanner> - a tool for manipulating Example Projects in and around the Lazarus Src Tree. Probably past its use by date. Also has a framework to 'exercise' the Lazarus Examples Window in a stand alone, easier to manage environment.
125	129		- <https://github.com/davidbannon/ExampleMetaData> - a very simple editor to make and validate the Example Meta Data files.
126	130		- <https://gitlab.com/freepascal.org/lazarus/lazarus/-/blob/main/components/exampleswindow/uexampledata.pas> the unit making decisions about your examples.
127	131
128	132		---
129	133		From the Free Pascal wiki, page "Lazarus Examples Window", as it stood on 2024-01-28 after a change by Dbannon, 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).
130	134		Category: Development
131	135		Category: Example programs
132	136		Category: Proposals

Back to history