Project

General

Profile

Taxonomic Editor » History » Version 93

Patrick Plitzner, 03/09/2018 03:17 PM

1 86 Niels Hoffmann
~~~
2
<code class="html">
3 90 Niels Hoffmann
<div style="font-size:300%; color: #600;">Outdated!</div>
4 86 Niels Hoffmann
~~~
5
6 91 Andreas Müller
Please see http://cybertaxonomy.eu/taxeditor for documentation or [[TaxonomicEditorDev]] for development resources.
7 87 Niels Hoffmann
8
9
10
----
11 86 Niels Hoffmann
12
13 93 Patrick Plitzner
{{toc}}
14 1
15
16
17 5 Markus Döring
# Taxonomic Editor
18 1
19 77 Niels Hoffmann
The Taxonomic Editor is the desktop application used to edit data stored in a [[CommunityStore]]. It edits data in either 
20 1
21
1. a remote source, or 
22 77 Niels Hoffmann
23 80 Niels Hoffmann
1. a local data source embedded in the application.
24 1
25
26 80 Niels Hoffmann
![](EDITTaxonomicEditor_Version2.2.1.jpg)
27 1
28 80 Niels Hoffmann
----
29 1
30 80 Niels Hoffmann
31
32
## Download
33
34
35 91 Andreas Müller
| Current stable release | http://cybertaxonomy.eu/download/taxeditor/stable/ |
36
| All versions | http://cybertaxonomy.eu/download/taxeditor/ |
37 80 Niels Hoffmann
38 91 Andreas Müller
Installation instructions may be found at the product website: http://cybertaxonomy.eu/cdm-setups/?q=node/3
39 80 Niels Hoffmann
40
41
42
----
43 35 Pepe Ciardelli
44
45 61 Pepe Ciardelli
## Overview
46 17 Pepe Ciardelli
47 66 Pepe Ciardelli
The goal of the Taxonomic Editor is to provide a next-generation tool that moves beyond the form-based data entry of web-based tools like the [Berlin Model Web Editor](http://www.bgbm.org/biodivinf/docs/bgbm-model/software.htm.)
48 1
49
50 61 Pepe Ciardelli
The core workflow is: 
51 1
52 61 Pepe Ciardelli
1. the user enters data in a freetext area (the middle area in the above screenshot); 
53 1
54 61 Pepe Ciardelli
1. the data is parsed on-the-fly, i.e. as it is entered;
55 1
56 61 Pepe Ciardelli
1. the user reviews whether the data has been parsed correctly in the structured data area on the right.
57 1
58
59 61 Pepe Ciardelli
Thus, the Editor offers the familiarity and user-friendliness of word processing programs, while keeping the CDM data structure visible at all times.
60 1
61 44 Pepe Ciardelli
62 61 Pepe Ciardelli
A second defining feature of the Editor is that the user will be allowed to enter erroneous data. Rather than enforcing data integrity upon input, the user will be warned when any rules have been broken, using the red and yellow squiggly underlines used by word processing software to show grammatical and spelling errors. When the mouse hovers over data that has been marked as flawed, the error will be explained, along with possible corrections.
63 44 Pepe Ciardelli
64
65 61 Pepe Ciardelli
Good interface design keeps to a minimum the number of new movements or gestures a user must learn in order to use a new piece of software; these should then be applied in as many different contexts as possible, so that the software feels intuitive. Thus, in every part of the Editor, the left mouse button will be used to drag and drop data elements, for example, to drag a name from the search results list onto a synonym list; and the right mouse button will open up a context menu containing a list of possible commands that can be performed on the data element the mouse is pointing at.
66 1
67
68 61 Pepe Ciardelli
Finally, note that the Editor is taxon-centric. Taxa are chosen from the left pane - from the taxonomic tree, recently viewed taxa, search, or favorites - and opened in the main editor area. At the bottom of each taxon editor area are tabs for individual taxon data categories, i.e. "Name", "Features", "Concepts", "Geography", etc.
69 1
70
71 64 Pepe Ciardelli
For a more in-depth discussion, please see the current draft of the [Editor Design Document](http://dev.e-taxonomy.eu/trac/attachment/wiki/TaxonomicEditor/EDIT%20Taxonomic%20Editor%20Design%200.2.pdf.)
72 1
73
74
75 85 Andreas Müller
## User Guide
76
77
78 91 Andreas Müller
The user guide for the last stable version of the Taxonomic Editor is available [here](http://cybertaxonomy.eu/download/taxeditor/stable/EDITTaxonomicEditor-UserManual.pdf) as pdf.
79 85 Andreas Müller
80
A separate documentation on how the name parser works is available on the [[NameParserDocumentation|name parser documentation site]]. 
81
82
83
84 61 Pepe Ciardelli
## Technology
85 1
86 61 Pepe Ciardelli
The Editor will be built using the [Eclipse Rich Client Platform](http://www.eclipse.org/eclipse/platform-ui/) (RCP). This is a collection of Java libraries used to build the Eclipse Java development environment, essentially a word processing tool for Java developers. In essence, we will take the code used to program Eclipse and adapt it to the Editor. The RCP libraries include basic application functionality such as window management and operating system integration, as well as word processing features like autocomplete and syntax and error highlighting.
87 44 Pepe Ciardelli
88 61 Pepe Ciardelli
89
90
## Use Cases / Requirements
91
92
A list of Taxonomic Editor functionality, based on the Berlin Model Web Editor, can be found under [[EditorRequirements]].
93
94
95 63 Pepe Ciardelli
Use cases for development of additional Editor modules can be found under [[PlatformUseCases]].
96 65 Pepe Ciardelli
97
98
A [[ConceptWorkshop]] was held in Berlin February 21-22, 2008 to discuss the design of the Editor, with a focus on the management of taxonomic concepts. The results of the workshop can be found [here](http://dev.e-taxonomy.eu/trac/attachment/wiki/ConceptWorkshop/2008_02_21-Berlin-ConceptWorkshop_Final.pdf.)
99 70 Andreas Müller
100
101
102
## Bug & Enhancement Reports
103
104 72 Andreas Müller
_registered users only_
105
106 70 Andreas Müller
107 73 Andreas Müller
To report bugs and submit enhancement requests please add a new ticket by using the following links for  
108
109 74 Andreas Müller
* [bugs](http://dev.e-taxonomy.eu/trac/newticket?component=taxeditor&milestone=TaxEditor+Release+2.0)
110 73 Andreas Müller
111
* [enhancements](http://dev.e-taxonomy.eu/trac/newticket?component=taxeditor&milestone=TaxEditor+Release+1.0)
112
113 83 Niels Hoffmann
You may use the prefilled ticket properties except for the priority property.
114
115
116
When filing bugs please answer these questions:
117
118
~~~
119
What steps will reproduce the problem?
120
1. 
121
2. 
122
3. 
123
124
What is the expected output? What do you see instead?
125
126
127
What version of the product are you using? On what operating system?
128
129
130
Please provide any additional information below.
131
~~~
132 70 Andreas Müller
133 71 Andreas Müller
134
Reported bugs you find at
135
136 84 Andreas Müller
* https://dev.e-taxonomy.eu/trac/report/30 (bugs) 
137 71 Andreas Müller
138 84 Andreas Müller
* https://dev.e-taxonomy.eu/trac/report/32 (enhancements)