universaleditor/editor-legacy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated README.md

Browse Source
This commit is contained in:
Michael Becker 2014-12-01 15:50:25 -05:00
parent 819e3db0b8
commit 100de7f7fd
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
CSharp/README.md
View File

@ -3,6 +3,15 @@ UniversalEditor
A free, cross-platform modular data manipulation framework.
Philosophy
----------
UniversalEditor 4 has four components:
* *Editor* is responsible for modifying the content of the ObjectModel from a user's point of view.
* *ObjectModel* contains the user-friendly, DataFormat-agnostic representation of the data.
* *DataFormat* is responsible for converting on-disk representations of data to and from user-friendly ObjectModel representations.
* *Accessor* is responsible for reading from and writing to actual sources of data using the DataFormat as the translator. Therefore, any Accessor is irrevocably paired with exactly one DataFormat.
Prerequisites
-------------
* Glue (if building UserInterface)
@ -27,15 +36,6 @@ Project Types and Templates
* The *ProjectTypes* folder contains project type definitions. In the future it will be possible to provide project types via compiled assemblies (DLLs) and gain more control over the project process. ProjectTypes usually define build tasks that can be selected for each file in the project (for example, Compile/Content/EmbeddedResource) and provide other customization options.
* The *Templates* folder contains template definitions.
Philosophy
----------
UniversalEditor 4 has four components:
* *Editor* is responsible for modifying the content of the ObjectModel from a user's point of view.
* *ObjectModel* contains the user-friendly, DataFormat-agnostic representation of the data.
* *DataFormat* is responsible for converting on-disk representations of data to and from user-friendly ObjectModel representations.
* *Accessor* is responsible for reading from and writing to actual sources of data using the DataFormat as the translator. Therefore, any Accessor is irrevocably paired with exactly one DataFormat.
However, starting with Universal Editor 5, multiple Accessor/DataFormat pairs can be associated with an ObjectModel. This would allow an ObjectModel to store data simultaneously in one format in one file, and in another format in another file.
Therefore, UniversalEditor 5 introduces a new component, called an *Endpoint*, which pairs an Accessor and a DataFormat. If more than one Input Endpoint is specified, the resulting data gets concatenated to the ObjectModel. If more than one Output Endpoint is specified, the resulting data is written to each Accessor using the associated DataFormat.
Future Goals
------------
Starting with Universal Editor 5, multiple Accessor/DataFormat pairs can be associated with an ObjectModel. This would allow an ObjectModel to store data simultaneously in one format in one file, and in another format in another file. This is achieved through the use of a new component called an *Endpoint*, which pairs an Accessor and a DataFormat. If more than one Output Endpoint is specified, the resulting data is written to each Accessor using the associated DataFormat. <s>If more than one Input Endpoint is specified, the resulting data gets concatenated to the ObjectModel.</s> Multiple Input Endpoints will not be supported due to concerns about how to handle concatenation of the ObjectModel.