Hi, here comes the design of the YAML component. But first I want to introduce myself as Derick asked me on IRC to do it. (If you don't care about me, just skip the next section.)
<!-- introduction I live in Freiburg, Germany. That is a really nice city in south-west Germany, around 60 km to Switzerland and 40 km to France. (It was rated to be second best city to live in Germany, it is the warmest city in Germany and one of the top cities regarding sunshine hours.) As I do not want to introduce Freiburg but myself, here some personal details: I'm married and we have a son of three years, the second child will be born around the beginning of June. I speak and write perfect German English. ;-) I'm developing software since 1987, use PHP/MySQL since 2000, studied computer science, wrote my diploma thesis at eZ Systems in Skien, Norway, organized a summer campus at our university with practical lessons, was employed one year at one of the top three e-shop providers in Germany, and learned much about software design and quality in the last few years. Since spring last year I've been working fulltime as freelance software developer (mainly backend) and/or project manager. The eZ Components are my preferred library. If you want to see the nice environment of my office, have a look at http://tinyurl.com/dmt6jl --> But now, let's talk about YAML... As it seemed that not everybody knows what YAML is about first a short overview: YAML is a format to serialize data structures from programming languages to plain text. The style is somehow like XML without the "<" and ">" - ordering is done via line indention. The main usage are configuration files (e.g. symfony uses them; and it seems to be much more used in the Python world). But YAML is not limited to configuration files. You can use it as simple exchange format between software systems, log file format and much more. Unfortunately it took longer than expected to write the design document. Find the updated requirements.txt (related to the feedback we got on the list) and the design.txt on http://svn.ez.no/svn/ezcomponents/experimental/Yaml/design/ Till now we mainly concentrated on the usage of the component. We planned to write some more details about the classes. But as this would have taken some more time and we wanted to ask for your feedback at the current state, we left it out till now. (If you say, the design is totally clear from the use cases, we'd skip that part. But as we just started describing the classes in an earlier state of our design process, it is no big problem to overwork that part and add it to the design document.) Now I kindly ask you to have a look at the design document. There are some questions mentioned. And probably we've overseen some aspects of the design that you will miss directly. Any feedback is welcome: typos, better names for methods or classes, questions, suggestions how to improve the API, ... Have a nice weekend Thomas -- Thomas Nunninger Steinhalde 108 79117 Freiburg Tel.: 0761 1201850 Mobil: 0163 7115153 http://nunninger.info USt-IdNr: DE259832548 -- Components mailing list Components@lists.ez.no http://lists.ez.no/mailman/listinfo/components
