How to contribute - Revision history

Kgoetz: Fix my linking syntax

2018-08-23T01:37:58Z

Fix my linking syntax

← Older revision		Revision as of 01:37, 23 August 2018
Line 35:		Line 35:
	== Developer User Group ==		== Developer User Group ==

	A [[http://eprintsug.github.io \|communal development space]] has been set up on [[https://github.com/eprintsug \|GitHub]] to help facilitate 3rd party contributions to EPrints. Many plugins and Bazaar packages are maintained there ; so keep this option in mind when reading below!		A [http://eprintsug.github.io communal development space] has been set up on [https://github.com/eprintsug GitHub] to help facilitate 3rd party contributions to EPrints. Many plugins and Bazaar packages are maintained there ; so keep this option in mind when reading below!



	== Write a Plugin ==		== Write a Plugin ==

Kgoetz: New section for EPrints Github user group

2018-08-23T01:37:20Z

New section for EPrints Github user group

← Older revision		Revision as of 01:37, 23 August 2018
Line 32:		Line 32:

	The list of tickets and commits is accessible via the Web on our [https://github.com/eprints/eprints/ Github].		The list of tickets and commits is accessible via the Web on our [https://github.com/eprints/eprints/ Github].

			== Developer User Group ==

			A [[http://eprintsug.github.io \|communal development space]] has been set up on [[https://github.com/eprintsug \|GitHub]] to help facilitate 3rd party contributions to EPrints. Many plugins and Bazaar packages are maintained there ; so keep this option in mind when reading below!



	== Write a Plugin ==		== Write a Plugin ==

Th.lauke@arcor.de: How-to link and some typos corrected

2017-01-31T14:16:17Z

How-to link and some typos corrected

← Older revision		Revision as of 14:16, 31 January 2017
Line 2:		Line 2:
	''Contributing to EPrints development''		''Contributing to EPrints development''

	There's a number of different ways you can contribute to the EPrints project. This page covers all the ones we can think of...		There's a number of different ways you can contribute to the EPrints project. This page covers all the ones we can think of ...

	Always make an entry on http://files.eprints.org/ for your contribution, even if you don't upload the files. This will make it the one-stop shop for people to find EPrints extensions.		Always make an entry on http://files.eprints.org/ for your contribution, even if you don't upload the files. This will make it the one-stop shop for people to find EPrints extensions.
Line 14:		Line 14:
	=== Coding Style ===		=== Coding Style ===

	There is a definite ''style'' that ~~eprints~~ is written in. Please read the [[StyleGuide]] and follow it.		There is a definite ''style'' that Eprints is written in. Please read the [[StyleGuide]] and follow it.

	=== IDE-based Development ===		=== IDE-based Development ===
Line 31:		Line 31:
	WARNING: eprints-changes is HIGH traffic (every ticket and commit gets posted).		WARNING: eprints-changes is HIGH traffic (every ticket and commit gets posted).

	The list of tickets and commits is accessible via the Web on our [~~http~~://~~trac~~.eprints~~.org~~/ ~~Trac~~].		The list of tickets and commits is accessible via the Web on our [https://github.com/eprints/eprints/ Github].

	== Write a Plugin ==		== Write a Plugin ==
Line 43:		Line 43:
	Clever plugins can detect features they need and adapt to use the tools available, or disable themselves if they are missing required tools (rather than crash the system). Some specialised plugins are disabled in their default state and must be enabled in the repository configuration.		Clever plugins can detect features they need and adapt to use the tools available, or disable themselves if they are missing required tools (rather than crash the system). Some specialised plugins are disabled in their default state and must be enabled in the repository configuration.

	Another cool thing is that plugins are Perl Objects, which means you can subclass them. Here's an real-world example: We have a research group which uses BibTeX but over the years standardised within the group on an extra field. This is not a valid ~~bibtex~~ field, but are essential to their working because they have ancient and essential scripts which depend on it. To handle this we can subclass the default BibTeX Export plugin and override a single method (the data mapping one). We then just call the original parent plugins mapping method to do all the heavy lifting, then just add our non-standard extra field. Total code required: less than one screen. Number of happy researchers: none (they are never satisfied and will just demand the moon on the stick because you've already given them this nice new feature), but number of researchers able to get their work done: lots. Don't believe me? [[BibTeX Extension Example\|~~look~~ here]]!		Another cool thing is that plugins are Perl Objects, which means you can subclass them. Here's an real-world example: We have a research group which uses BibTeX but over the years standardised within the group on an extra field. This is not a valid BibTeX field, but are essential to their working because they have ancient and essential scripts which depend on it. To handle this we can subclass the default BibTeX Export plugin and override a single method (the data mapping one). We then just call the original parent plugins mapping method to do all the heavy lifting, then just add our non-standard extra field. Total code required: less than one screen. Number of happy researchers: none (they are never satisfied and will just demand the moon on the stick because you've already given them this nice new feature), but number of researchers able to get their work done: lots. Don't believe me? [[BibTeX Extension Example\|Look here]]!

	* See also [[Extension Packages]] for how to add configuration and resource files to plugins.		* See also [[Extension Packages]] for how to add configuration and resource files to plugins.
Line 57:		Line 57:
	==== Import Plugin ====		==== Import Plugin ====

	These are used to import data into a repository. They can take ~~datafiles~~ directly, or they can take an ID of a record that can be retrieved in a known way, or a URL of a file, or... whatever.		These are used to import data into a repository. They can take data files directly, or they can take an ID of a record that can be retrieved in a known way, or a URL of a file, or ... whatever.

	These are a bit trickier to write than export plugins as parsing data is harder than just "print"ing it, but they are still reasonably straight forward.		These are a bit trickier to write than export plugins as parsing data is harder than just "print"ing it, but they are still reasonably straight forward.
Line 109:		Line 109:
	===How to add your Translation===		===How to add your Translation===

	If you have translated ~~eprints~~ into a new language please package up the translated files with a file containing the GPL license called COPYING, and a file called COPYRIGHT which describes who owns the copyright of the translation (this may be important if we choose to package translations in the core, later).		If you have translated Eprints into a new language please package up the translated files with a file containing the GPL license called COPYING, and a file called COPYRIGHT which describes who owns the copyright of the translation (this may be important if we choose to package translations in the core, later).

	You may also wish to add a README file adding additional details such as which files (if not all) were translated.		You may also wish to add a README file adding additional details such as which files (if not all) were translated.
Line 129:		Line 129:
	== Write How-to's ==		== Write How-to's ==

	* Done something new or ~~unsual~~ with EPrints?		* Done something new or unusual with EPrints?
	* Installed it on a new platform or in an unusual way?		* Installed it on a new platform or in an unusual way?
	* Got annoyed figuring out how to do something, and wished there was a how-to?		* Got annoyed figuring out how to do something, and wished there was a how-to?

	Add a [[~~How-to~~]] to this wiki! It doesn't need to spend hours working on perfect layout and ~~grammer~~ (we can always fix that later). Put up useful information and step-by-step guides which you feel will help the next guy (or gal).		Add a [[:Category:Howto\|Howto]] to this wiki! It doesn't need to spend hours working on perfect layout and grammar (we can always fix that later). Put up useful information and step-by-step guides which you feel will help the next guy (or gal).

	== Hire EPrints Services! ==		== Hire EPrints Services! ==

Cjg: /* Report bugs */

2011-03-30T16:45:21Z

Report bugs

← Older revision		Revision as of 16:45, 30 March 2011
Line 123:		Line 123:
	== Report bugs ==		== Report bugs ==

	Oddly, we do like to hear about our mistakes. If you think you've found a bug then email ~~either~~ the eprints-tech mailing list ~~or Chris directly at cjg@ecs.soton.ac.uk (send to the list if you feel it's useful for other people to know about it and discuss it)~~.		Oddly, we do like to hear about our mistakes. If you think you've found a bug then email the eprints-tech mailing list.

	Send all the information you have- what version of EPrints and instructions of how to recreate the problem. If you've figured it out, tell us how to fix it too!		Send all the information you have- what version of EPrints and instructions of how to recreate the problem. If you've figured it out, tell us how to fix it too!

Cjg: /* Translate EPrints into your language */

2011-03-30T16:44:03Z

Translate EPrints into your language

← Older revision		Revision as of 16:44, 30 March 2011
Line 105:		Line 105:
	== Translate EPrints into your language ==		== Translate EPrints into your language ==

	A number of translations for EPrints v2 exist on http://files.eprints.org/ but these need updating for EPrints 3. Contact cjg@ecs.soton.ac.uk for advice on how to cut some corners (a good number of phrases remain unchanged from EPrints 2 so that should reduce effort. Contact us if you want a copy of the EPrints 3 phrases with as many as possible pre-translated using EPrints 2 data.		A number of translations for EPrints v2 exist on http://files.eprints.org/ but these need updating for EPrints 3.

	===How to add your Translation===		===How to add your Translation===

Pm705 at 12:55, 20 March 2010

2010-03-20T12:55:34Z

← Older revision		Revision as of 12:55, 20 March 2010
Line 1:		Line 1:
	[[Category:Contribute]]		[[Category:Contribute]]
	~~[[Category:Howto]]~~
	''Contributing to EPrints development''		''Contributing to EPrints development''

Pm705 at 15:15, 8 February 2010

2010-02-08T15:15:34Z

← Older revision		Revision as of 15:15, 8 February 2010
Line 1:		Line 1:
			[[Category:Contribute]]
			[[Category:Howto]]
	''Contributing to EPrints development''		''Contributing to EPrints development''

Tdb01r at 13:32, 12 August 2009

2009-08-12T13:32:06Z

@@ Line 5: / Line 5: @@
 Always make an entry on http://files.eprints.org/ for your contribution, even if you don't upload the files. This will make it the one-stop shop for people to find EPrints extensions.
-== EPrints Development ==
+== Writing EPrints Code ==
 We run two mailing lists for committers: eprints-devel and eprints-changes. To receive changes to our tickets and repository, subscribe to eprints-changes (read only). eprint-devel is a lower-traffic discussion of commits (questions will probably be ignored - use ep-tech instead).
@@ Line 16: / Line 30: @@
 WARNING: eprints-changes is HIGH traffic (every ticket and commit gets posted).
-The list of tickets and commits is accessible via the Web on our [http://trac.eprints.org/ EPrints Trac].
+The list of tickets and commits is accessible via the Web on our [http://trac.eprints.org/ Trac].
 == Write a Plugin ==

Kiz: /* Coding Style */

2009-08-07T16:37:23Z

Coding Style

← Older revision		Revision as of 16:37, 7 August 2009
Line 20:		Line 20:
	== Coding Style ==		== Coding Style ==

	There is a definite '''style''' that eprints is written in. Please read the StyleGuide and follow it.		There is a definite ''style'' that eprints is written in. Please read the [[StyleGuide]] and follow it.

	== Development Environment ==		== Development Environment ==

Kiz at 16:36, 7 August 2009

2009-08-07T16:36:52Z

← Older revision		Revision as of 16:36, 7 August 2009
Line 17:		Line 17:

	The list of tickets and commits is accessible via the Web on our [http://trac.eprints.org/ EPrints Trac].		The list of tickets and commits is accessible via the Web on our [http://trac.eprints.org/ EPrints Trac].

			== Coding Style ==

			There is a definite '''style''' that eprints is written in. Please read the StyleGuide and follow it.

	== Development Environment ==		== Development Environment ==