Online Package Manager/es: what changed

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

Old	New		Line
1	1		## Acerca de
2	2
3	3		Online Package Manager(OPM) es una utilidad que automatiza el proceso de instalación, actualización y configuración de los paquetes de Lazarus. Los paquetes se almacenan en el repositorio principal como fichero .zip (ver columna de repositorio), junto con su correspondiente fichero JSON. El fichero JSON contiene toda la información necesaria sobre los paquetes. Realizada la petición los paquetes son descargados/extraidos/compilados/instalados en el IDE. También es posible actualizar un paquete previamente instalado si hay disponible una versión más actualizada en la página web del mantenedor (ver columna update). Hay además disponible una versión del Repositorio de Paquetes de Lazarus en el siguiente enlace: <http://packages.lazarus-ide.org/>.
4	4
5		-	~~` ``Please note:`` `\~~
6		-	` OPM lee la descripción del paquete a partir del fichero lpk. I can understand that the description of many packages is very minimalistic or even non-existent, but there is nothing I can do about it. `\
7		-	` It's not OK to modify package description or any other property for that matter, without the consent of the package developer. More over testing each and every package, then write a detailed `\
8		-	~~` description is not realistic.`~~
	5	+	```text
	6	+	<span style="color:red">Please note:</span>
	7	+	OPM lee la descripción del paquete a partir del fichero lpk. I can understand that the description of many packages is very minimalistic or even non-existent, but there is nothing I can do about it.
	8	+	It's not OK to modify package description or any other property for that matter, without the consent of the package developer. More over testing each and every package, then write a detailed
	9	+	description is not realistic.
	10	+	```
9	11
10	12		### Pantallazos
11	13
12	14		![](/wiki-images/6/6e/OPM6.png)
13	15
14	16		![](/wiki-images/b/b7/OPM7.png)
15	17
16	18		### Licencia
17	19
18	20		[GNU General Public License](https://opensource.org/licenses/gpl-license)
19	21
20	22		### Descargas
21	23
22	24		Online Package Manager (OPM) forma parte de las fuentes de Lazarus. Se encuentra en el directorio (\$LazarusDir)/components/onlinepackagemanager.
23	25
24	26		### Requerimientos del sistema / Dependencias
25	27
26	28		- FPC 3.0.0 o superior.
27	29		- Lazarus 1.8 o superior.
28	30		- Puedes descargar una versión más antigua para las series 1.6: [OPM 1.6](https://drive.google.com/open?id=0B9Me_c5onmWobVZOdVlXSlZRRmc)
29	31		- Estas versiones están disponibles a fecha de escritura de esta actualización.
30	32		- Testeado en los siguientes widgeset: win32/64, gtk2, carbon, qt(win)
31	33		- El gestor de paquetes no depende de otros paquetes externos.
32	34
33	35		### Installation
34	36
35	37		In Lazarus "Install/Uninstall Packages" window select "OnlinePackageManager" from the available packages, click "Install selection" and then rebuild the IDE.
36	38
37	39		### Support page
38	40
39	41		<http://forum.lazarus.freepascal.org/index.php/topic,34297.0.html>
40	42
41	43		## Using the package manager
42	44
43	45		### Getting started
44	46
45	47		Go to Lazarus Menu--\>Package--\>Online Package Manager(Shortcut key: \[Ctrl\] + \[Alt\] + O). On startup the package manager will automatically download a list with available repository packages, the list is displayed in a tree(see screenshots above).
46	48
47	49		### Filter the tree/Locate a package
48	50
49	51		![](/wiki-images/b/b3/OPM3.png)
50	52
51	53		You can filter the package list by:
52	54
53	55		- Packagename
54	56		- Package file(.lpk)--\>a repository package can contain multiple lpk files
55	57		- Package category
56	58		- Package status
57	59		- Version
58	60		- Description
59	61		- Author
60	62		- Lazarus compatibility
61	63		- FPC compatibility
62	64		- Supported widget sets
63	65		- Packagetype
64	66		- Dependencies
65	67		- License
66	68
67	69		### Operation with packages
68	70
69	71		![](/wiki-images/a/a5/OPM4.png)
70	72
71	73		#### Refresh package list
72	74
73	75		Press the "Refresh" button to update the package list.
74	76
75	77		#### Download package
76	78
77	79		Check one or more package then press the "Download" button. This will download/extract the packages to a preselected directory. Nothing gets installed. Useful when you want to install the packages manually or study their sources without installing.
78	80
79	81		#### Install a package
80	82
81	83		Check one or more package then press the "Install" button. The package manager will automatically download/extract/compile/install the selected packages(from the main repository), then rebuild the IDE if necessary(Designtime/Designtime_and_runtime packages). Confirm the rebuild by clicking the "Yes" button. Please note: The compile feature is only available in Lazarus 1.7+.
82	84
83	85		#### Update a package
84	86
85	87		Check one or more package then press the "Update" button. The package manager will update the selected packages from the maintainer's homepage(if available). The package must be installed first, a direct update although is possible, it's not allowed to prevent unresolved dependency error. Please note: downloading/installing packages from external link is not without a risk. Only update the package if you trust the package maintainer.
86	88
87	89		#### Difference between download/install/update
88	90
89	91		Download/Install --\> Operations between you and the main repository.
90	92
91	93		Update --\> Operations between you and the package maintainers.
92	94
93	95		![](/wiki-images/6/61/OPM10.png)
94	96
95	97		Video link: [Difference between download/install/update](https://www.youtube.com/watch?v=wiN2GoCvgjc)
96	98
97	99		#### Cleanup local repository
98	100
99	101		This operation will delete all non-installed packages/archives from the local repository. To cleanup the local repository press the "Cleanup" button.
100	102
101	103		#### Create
102	104
103	105		This section is for package maintainers. First you must go to Options--\>Profiles and select package maintainer.
104	106
105	107		##### Create repository package
106	108
107	109		To create a repository package press "Create repository package" menu item, then:
108	110
109	111		- select the package main directory(package manager will recursively search for all package files inside the folder)
110	112		- select the repository package(root node)
111	113		- choose category(obligatory)
112	114		- type display name(optional)
113	115		- home page(optional)
114	116		- update link(optional, for more details see "Create JSON for updates"[1](http://wiki.freepascal.org/Online_Package_Manager#Create_JSON_for_updates)" below)
115	117		- create JSON for updates(optional), has the same functionality as "Create JSON for updates"[2](http://wiki.freepascal.org/Online_Package_Manager#Create_JSON_for_updates)" dialog. It was also added here to speed up the process.
116	118
117	119		![](/wiki-images/6/6c/OPM15.png)
118	120
119	121		- check each package you wish to include, adjust package info if necessary(lazarus/fpc compatibility, supported widgetset, etc)
120	122
121	123		![](/wiki-images/6/6d/OPM16.png)
122	124
123	125		- press the create button, if all goes well you should get a zip and a json file. Upload somewhere the files and send the link to getmem1@gmail.com or
124	126		- press the submit button, the files are directly uploaded to a remote server.
125	127
126	128		Every package will be accepted after a short check(malware, license, etc). Multiple versions of the same package is also allowed.
127	129
128	130		##### Create JSON for updates
129	131
130	132		To allow the user to update the package directly form your webpage, follow this steps:
131	133
132	134		- Make sure your package is already in the main repository(see previous section)
133	135		- You can download and use the [[OPM External Update json Editor\|Online Package Manager External Update json Editor]]
134	136		- or via OnlinePackageManager:
135	137
136	138		- Check the package, press the "Create JSON for upates" menu item then create the JSON.
137	139
138	140		![](/wiki-images/d/d1/OPM11.png)
139	141
140	142		- Edit the JSON, upload to your webpage, then send me the link.
141	143
142	144		The JSON will look like this:
143	145
144	146		![](/wiki-images/0/09/OPM12.png)
145	147
146	148		Editable items in the JSON:
147	149
148	150		"DownloadZipURL" --\> Link to your new, updated package
149	151
150	152		"DisableInOPM" --\> If you want to temporary disable your package, set this boolean to true. It's useful for maintenance, the package will be grayed out in the tree. The user cannot download/install/update the package.
151	153
152	154		"Version"/"ForceNotify"/"InternalVersion" --\> To trigger an update message on the users computer, you can either:
153	155
154	156		- Increase the "Version" number. Useful when you want to release a new version of the package.
155	157		- Set "ForceNotify" to true. Useful after a minor change in your source, that does not require a version change or in case of trunk version. To prevent continous error messages, "ForceNotify" must be used in combination with "InternalVersion". After the user updates the package, OPM locally stores the "InternalVersion" value. If you want to trigger a new message, increase "InternalVersion" with one. If "ForceNotify" is true, "Version" is always ignored.
156	158
157	159		The most common scenario is this:
158	160
159	161		- Generate the JSON
160	162		- Modify "DownloadZipURL"
161	163		- Increase version number when necessary.
162	164
163	165		Please note: After you edited the JSON the changes are not immediately visible in the tree. Usually it takes 1-2 min. It also depends on the users setting(Options--\>General--\>Check for package updates).
164	166
165	167		#### Options
166	168
167	169		To display the options dialog press the "Options" button.
168	170
169	171		### Create a private repository
170	172
171	173		In order to create a private repository please do the following:
172	174
173	175		1\. First make sure profile "Package maintainer" is enabled in Options--\>Profiles, then open the private repository form(see screenshot below)
174	176
175	177		![](/wiki-images/b/b0/OPM17.png)
176	178
177	179		2\. Press the "Create" button. Enter repository Name, Address(optional), Description(optional). Save the repository to an empty folder
178	180
179	181		![](/wiki-images/c/c7/OPM18.png)
180	182
181	183		- If filled, the repository address(in this case <http://localhost/packages/>) is automatically added to available repository list(Options form)
182	184
183	185		![](/wiki-images/8/8e/OPM19.png)
184	186
185	187		3\. Start to add/delete packages. You have two choices:
186	188
187	189		a\. Create a new package via <http://wiki.freepascal.org/Online_Package_Manager#Create_repository_package>
188	190
189	191		b\. Add a previously saved package
190	192
191	193		![](/wiki-images/5/5b/OPM20.png)
192	194
193	195		4.You can also open a previously saved repository. The last repository is automatically opened on startup.
194	196
195	197		5.Upload the files(packagelist.json, *.zip) to your local or remote server.
196	198
197	199		6.Make sure the server is running, the change "Remote repository" in Options--\>General
198	200
199	201		---
200	202		From the Free Pascal wiki, page "Online Package Manager/es", as it stood on 2019-10-12 after a change by FTurtle, 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).

Back to history