English
资源说明：Create, edit and use hierarchical taxonomies in Plone!
Taxonomy Vocabularies
=====================
|CI| |Coverage|
.. |CI| image:: https://github.com/collective/collective.taxonomy/workflows/CI/badge.svg
:target: https://github.com/collective/collective.taxonomy/actions
.. |Coverage| image:: https://coveralls.io/repos/github/collective/collective.taxonomy/badge.svg
:target: https://coveralls.io/github/collective/collective.taxonomy
Create, edit and use hierarchical taxonomies in `Plone`_.
This add-on provides support for hierarchical taxonomies in multiple
languages, letting users easily associate existing content with terms
from one or more taxonomies.
`Taxonomy `_ is the
"discipline of defining groups [...] on the basis of shared
characteristics and giving names to those groups. Each group is
given a rank and groups of a given rank can be aggregated to form
a super group of higher rank and thus create a hierarchical
classification".
Here's an example of the "taxonomic kingdoms of life"::
Living Organisms
Living Organisms -> Eukaryotic
Living Organisms -> Eukaryotic -> Simple multicells or unicells
Living Organisms -> Eukaryotic -> Multicellular
Living Organisms -> Eukaryotic -> Multicellular -> Autotrophic
Living Organisms -> Eukaryotic -> Multicellular -> ...
Living Organisms -> Prokaryotic
Living Organisms -> Prokaryotic -> Archaebacteria
Living Organisms -> Prokaryotic -> Eubacteria
Living Organisms -> Prokaryotic -> Eubacteria -> ...
Taxonomies can be quite large, sometimes in the tens of thousands
(10,000+). And in sites with multiple languages, each title – or
*caption* – must appear in translation.
Note that the selection of a term in the hierarchy implies the
selection of all its parents. In the example above this means that if
"Eubacteria" is selected, then also "Prokaryotic" and "Living
Organisms" will be.
Overview
========
The implementation tries to meet the following requirements:
#. Support many (10,000+) terms.
#. Terms can be organized in a hierarchical classification.
#. Easily import and export in a common format (VDEX).
#. Taxonomies will provide vocabularies that are translatable.
#. Use behaviors to provide a choice field for each taxonomy.
#. Manage taxonomies and assign to content types "through-the-web".
In the description below, we touch on each of these requirements.
Data structure
--------------
In order to limit both the memory and computation requirements, the
term data is contained in exactly one persistent index per language, a
mapping from the *materialized term path* to its *term identifier*.
The term::
Living Organisms -> Eukaryotic -> Simple multicells or unicells
will be indexed under this path::
"Living Organisms/Eukaryotic/Simple multicells or unicells"
The index allows us to provide an iterator over the sorted vocabulary
terms, virtually without cost (as well as containment queries).
At the same time, while the hierarchy is encoded, we can quickly look
up terms in a subtree.
Note: As ``collective.taxonomy`` uses slash as separator, you have to
monkey patch the ``PATH_SEPARATOR`` constant if you want to use '/' in
your terms.
Data exchange
-------------
While ``collective.taxonomy`` (this package) does make it possible to
create, manage and edit taxonomies from a browser-based interface, the
primary focus is to support the exchange of terms in the VDEX format:
The `IMS Vocabulary Definition Exchange
`_
React/Redux app to edit taxonomies
----------------------------------
The view ``@@taxonomy-edit-data`` that allow users to edit the taxonomy data
is a React/Redux app (the source code is in the ``javascripts`` directory.
Here's a preview of this view:
.. image:: https://raw.githubusercontent.com/collective/collective.taxonomy/master/images/edit_taxonomy_data.gif
:alt: Edit taxonomy data preview
The languages allowed for the taxonomies are the languages defined in ``portal_languages``.
Development
===========
Run the app, run ``npm start`` in the ``javascripts`` directory.
To make Plone use the development code, you need the ``NODE_ENV`` environment
variable to be set to ``development``:
::
NODE_ENV=development bin/instance fg
i18n
----
The app uses `react-intl `_ to handle i18n.
To translate the app, add a new language in the translations directory. For example,
create a ``es`` file in the translations directory that contains:
::
const es = {
submitLabel: 'Enviar',
}
export default es
Then, edit ``translations/index.js`` to add the language to the translations object:
::
import es from './es'
const translations = {
es,
fr
}
You'll have to rebuild the js bundle: ``npm run build``
That's it!
Translations
------------
This product has been translated into
- Danish.
- German.
- French.
- Spanish.
You can contribute for any message missing or other new languages, join us at
`Plone Collective Team `_. Just
remember to edit the vocabIdentifier and vocabName.
Contribute
==========
Have an idea? Found a bug? Let us know by `opening a ticket`_.
- Issue Tracker: https://github.com/collective/collective.taxonomy/issues
- Source Code: https://github.com/collective/collective.taxonomy
Contributors
============
Author
------
- Bo Simonsen
Contributors
------------
- Malthe Borch
- Thomas Clement Mogensen
- Thomas Desvenain
- Maurits van Rees
- Cédric Messiant
- Leonardo J. Caballero G.
- Peter Mathis
Existing work
=============
In 2010, Rok Garbas reimplemented and extended prior
work by `Seantis `_. This
package allows you to configure and populate vocabulary components
from a VDEX-specification. The package supports flat vocabularies
only, and support for multiple languages takes a different approach
(vocabularies are returned in an already translated form). Note that
vocabularies are loaded in a read-only mode, although it's been
proposed that vocabularies might be edited through-the-web.
In 2005, Jens Klein released
`ATVocabularyManager
本源码包内暂不包含可直接显示的源代码文件，请下载源码包。
