Jump to content
Wiki Home
EPrints Home
Bazaar
Files
Main menu
Main menu
move to sidebar
hide
Navigation
Front Page
EPrints 3 Manual
EPrints Training Course
EPrints Glossary
Installing EPrints
How-to Configure EPrints
EPrints 3.2+ API
EPrints 3 Reference
EPrints Plugins
Wiki
All categories
Recent changes
Main Page
Help
EPrints Documentation
Search
Search
Appearance
Log in
Request account
Personal tools
Log in
Request account
Pages for logged out editors
learn more
Contributions
Talk
Editing
YAML Specification for EPrints Ingredients
(section)
Page
Discussion
British English
Read
Edit
View history
Tools
Tools
move to sidebar
hide
Actions
Read
Edit
View history
General
What links here
Related changes
Special pages
Page information
Appearance
move to sidebar
hide
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
== Specification == === id === The unique identifier for the component. This should be made up of two parts, the type of component followed by a descriptive identifier for the component. The latter would typically be the same as the Git repository it comes from. (E.g. the ''richtext'' ingredient at https://github.com/eprints/richtext has the '''id''' of <code>ingredient:richtext</code>. === name === A short descriptive name for the component. Typically this will be a more human-readable version of the '''id''', (e.g. <code>ingredient:richtext</code> has the name <code>Rich Text Ingredient</code>). === type === The type of component. Although this will likely be captured in the prefix of the '''id''', this should be explicitly specified as either <code>ingredient</code>, <code>flavour</code>. <code>core</code> or <code>other</code>. <code>core</code> represents the core codebase and is used in EPrints 3.5's <code>lib/component.yml</code>. <code>other</code> does not yet have a specific use but is a catch-all for anything that does not fall under one of the other three types. === version === The version of the component. As well as being useful information, the value can be checked against the requirements of other components (e.g. ingredients) and that of the archive (under the '''requires''' attribute or <code>component.yml</code> files and the '''includes''' attribute of an archive's <code>cfg/package.yml</code> file. === maintainers === Specifies sub-attributes of '''name''' and '''email''' of all the people or organisations responsible for maintaining the component. === description === A description of the purpose of the component, such as explaining what functionality it provides. === requires === Any dependencies on other components and what particular versions of those components are required. This has two sub attributes '''component''', which is the '''id''' of the component required and '''version''' that specifies the version required. '''version''' has special syntax, such as <code><</code>, <code><=</code>, <code>=</code> <code>>=</code>, <code>></code> and <code>~</code>, to represent less than, less than or equal to, equal to, greater than or equal to, greater than or same version family. When using <code>~</code>, if the version needs to be some version of 2, then specifying <code>~ 2</code> would cover all versions from 2.0 up to 2.9 or whatever the last version of 2 is, including sub-versions (e.g. 2.3.4 or 2.4.5). === notes === This typically covers basic installation instructions or critical information the installer should be aware. === readme === This should be a URL pointing at a large readme file that provided more comprehensive installation instructions and information. Typically, this might be the readme file in the Git repository.
Summary:
Please note that all contributions to EPrints Documentation may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see
EPrints Documentation:Copyrights
for details).
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)