Dear council members,
I've completed a first phase of development of RomaJS (a placeholder name)
and I would like to both give you an update and seek volunteers for the
next phase of work. *The prompts for your contributions are highlighted in
bold below (bring friends!).*
The code is on GitHub: https://github.com/raffazizzi/romajs
1. Summary of work:
I've have been writing this Redux / React
<http://redux.js.org/docs/basics/UsageWithReact.html> application by
focusing on data operations first, user interface second. Briefly, the
application is now capable of:
- reading in an ODD file from the web or from disk
- reading in a source file (ie p5 subset in JSON format)
- add and remove modules
- add and remove elements
- write an updated ODD to disk (This is actually only mocked for user
testing at the moment.)
- provide basic UI components for these operations (working towards what's
been sketched in the wireframes
<https://docs.google.com/presentation/d/1sUESuY9pF3DkHoQMJJjrVMV2SPFQYE1YqmG…>
)
2. Tests
Each operation is comprehensively tested. I've aimed at creating a solid
testing infrastructure that is at the core of the application development.
I have created two wiki pages to help understanding and developing tests:
- a list of test scenarios
<https://github.com/raffazizzi/romajs/wiki/Test-scenarios>
- a short guide on how to write tests
<https://github.com/raffazizzi/romajs/wiki/How-to-write-tests>
*Please look at the list of test scenarios: have I not tested
something?* You'll
see that the list includes different ways of including/excluding modules
and elements in ODD. *Have I covered all the mechanisms for doing so?
What's missing?* We could discuss this on this email or on the wiki. It
would be awesome if then someone besides me would write new tests that
result from the discussion!
3. Parsing ODD
In order to avoid using a heavy DOM processor, and to make it possible to
include ODD directly in the application state, I've opted to convert ODD to
JSON. At first I was using an off the shelf library that served me very
well until I had to serialize back to XML and realized that mixed content
was all screwy...
So I wrote my own library here:
https://github.com/raffazizzi/squash-xml-json
The library is quite central to the success of RomaJS and while it has some
tests, it needs more extensive testing. *Would anyone like to help test and
develop it? Or perhaps know of viable alternatives I've overlooked?*
4. Getting started with the UI
I've created basic UI components to do the operations described above. Here
is the current very bare version: https://raffazizzi.github.io/romajs/
*Please try it out with as many (canonicalized) ODD files that you have
lying around. Does it do what you expect? Do you get back XML that matched
what you wanted? **Please break it (hopefully it will take a few hits
first).*
5. Next steps
I think I may focus more on UI development now (as per wireframes
<https://docs.google.com/presentation/d/1sUESuY9pF3DkHoQMJJjrVMV2SPFQYE1YqmG…>).
Getting started with a CSS framework library and nail down general
functionality up to the point where we are now. At the same time, I'd like
to get started on operations to change elements (basically creating
elementSpec[@mode="change"]).
*This would be a good time for others to step in the development process:
others could start writing operations and tests for changing elements while
I focus on UI. Or viceversa. The current module/element operations and
tests provide examples of how this all works (and of course I'd be happy to
explain stuff).*
6. Finally: decision tree
At the F2F we started talking about a possible "decision tree" as a way
into RomaJS. I started a document
<https://docs.google.com/document/d/1r33QbY7O0HqOHvTxZtOq_-MrYqtIE572YqPEY3J…>
with a list of possible questions to the user; James commented on it. *Please
comment and add your additions if you can. I would be thrilled if others
would want to explore this further as a mind map, etc. so that it's nicely
planned out before starting development on a decision tree feature.*
As development gains momentum, I hope to write similar reports to this one
at least once monthly.
Raff
Dear all,
As we decided on Thursday, we're going to try out having one volunteer a
month triage new tickets. That is, read them, decide whether they're valid
(not invalid, duplicates, etc.), and assign someone to investigate each
one, taking into account skillsets and workloads. We'll try it for the next
few months and see if we like it, https://doodle.com/poll/2wq9wtq6f69wfxc3
I will take May, and try to clean up the backlog as much as I can now that
the semester is over. I'd appreciate it if you could all take a look at the
unassigned tickets we have now and grab any that suit you. That would be
most helpful.
Thanks,
Hugh
Just come across issue #1584 <https://github.com/TEIC/TEI/issues/1584> form
February requesting that XML files should be served from tei-c.org with the
media type application/xml. I think this should be done. Can Kevin help?
More complex would be serving TEI files with the application/tei+xml media
type, because we'd need a list of files (ie we shouldn't assume that all
xml files on tei-c.org are TEI). Yet, serving p5subset.xml files as TEI
files would probably be a good and useful start.
Raff
Ack! Martin reminded me of something I should have put on the agenda
for our discussion yesterday, as this is really important.
The current released oXygen TEI frameworks (both the oXygen built-in
one and TEI-C stable one) are broken in various ways (some small)
because they rely on the released version of the Stylesheets. The
bleeding edge framework is not broken (or at least a lot less broken)
because it relies on the dev branch of the Stylesheets, which has
lots of fixes.[1]
To deal with this we should make a release of the Stylesheets and
then re-build the stable oXygen TEI framework. And, IMHO, we should
do this quite soon.
I have kinda forgotten how to go about building a new framework.
There are some instructions in TCW 22 but
a) they rely on downloading from Sourceforge, and
b) they say "ask Syd" :-{
I don't think I ever knew how to release the Stylesheets. TCW 22 says
"STEPS SIMILAR TO THE ABOVE SHOULD BE ADDED TO COVER THE RELEASE AND
MAKING CURRENT OF THE STYLESHEETS.". Eeek.
Notes
-----
[1] For a list of fixes see
https://github.com/TEIC/Stylesheets/issues?q=is%3Aissue+is%3Aclosed+sort%3A…
... all but the last 1/2 dozen or so have been fixed since the
last Stylesheets release, which was in mid-December.
Hi all - we are at the Dixit workshop in Athens, and it appears that tei-c
is inaccessible from our classroom, also from my Brown VPN. Roma, too.
Is it just us? did I miss a scheduled downtime message?
just checking, and thank you. --elli
Dear Hugh,
I'm in Montevideo, Uruguay (came here to teach
TEI), trying to join the meeting, but I don't find a message with the link.
Maybe it's not the right time...
Best,
Alex.-
At 18:14 25/04/2017, Hugh Cayless wrote:
>Here's the agenda:
>https://docs.google.com/document/d/1dOxR40h3SS01XyA1cW_0PIZYGXdkMfJnrhXf3hW….
>I'll set up a hangout link the morning of.
>
>Hugh
>
>On Mon, Apr 24, 2017 at 11:43 AM, Hugh Cayless <philomousos(a)gmail.com>
>wrote:
>
> > Hi All,
> >
> > We have a meeting at 09:00 EDT / 14:00 BST / 15:00 CEST this Thursday the
> > 27th. I'll be posting an agenda this afternoon, but can I ask that people
> > look at the use cases for bibliography in https://docs.google.com/
> > document/d/1cZ_LFHlKd4KBSypS8u8I7xFVr1lARMCiGY2HXsvHeLY/edit (at the end)
> > and comment or add your own. It would be nice if we could come to some
> > resolution on https://github.com/TEIC/TEI/issues/1431 soon.
> >
> > Thanks,
> > Hugh
> >
>--
>tei-council mailing list
>tei-council(a)lists.tei-c.org
>http://lists.lists.tei-c.org/mailman/listinfo/tei-council
>
>PLEASE NOTE: postings to this list are publicly archived
---------------------------------------------------------
ALEJANDRO BIA
e-mail: abia(a)umh.es
CIO - DEMI
Centro de Investigación Operativa
Departamento de Estadística, Matemáticas e Informática
Área de Lenguajes y Sistemas Informáticos
Universidad Miguel Hernández
Ed. Torretamarit, Av. Universidad s/n, CP:03202, Elche, ESPAÑA
Web: http://dhw.umh.es/alex-bia/
Tel: +34 966658973
Móvil: +34 644447008
Skype: alex-bia
Twitter: @alex_bia
---------------------------------------------------------
---
This email has been checked for viruses by Avast antivirus software.
https://www.avast.com/antivirus
Just to note that the oucs oxgarage had never been the official one and is several versions behind. The real one is the TEI' s at www.tei-c.org/oxgarage/
And for Kevin, I'll try to find a home for the static resources ... but how to determine what those are? Everything? I guess I could look at Web logs to see what people look at but something else that might disappear is some of the training materials available at Oxford. (I do make many of mine available at other locations.) I'll see about archiving them here.
James
--
Dr James Cummings, Academic IT Services, University of Oxford
On 24 Apr 2017 21:09, Raffaele Viglianti <raffaeleviglianti(a)gmail.com> wrote:
Hi James,
It is sad to hear about possible lack of support from Oxford in the future... Assuming static resources can be migrated, I worry about oxGarage. Could we get an oxgarage.tei-c.org<http://oxgarage.tei-c.org> pointer to http://oxgarage.oucs.ox.ac.uk/ and then change it when the time comes? I can also spin up a VM here at MITH, but it wouldn't be a long term solution.
Raff
On Mon, Apr 24, 2017 at 11:44 AM, James Cummings <James.Cummings(a)it.ox.ac.uk<mailto:James.Cummings@it.ox.ac.uk>> wrote:
Hi Council (MartinH CC'd),
Martin had noticed that the Guidelines Link checker couldn't find
http://tei.oucs.ox.ac.uk/Talks/2003-05-06-xmleurope2003/xmleurope2003.pdf
which is in the Bibliography as Rahtz2003.
This was because I tidied old repositories on tei.oucs (which really should be referred to as tei.it<http://tei.it> now anyway) by updating various quite old folders in SVN with set-depth=immediates which leaves the file in the repo but not checked out on the server. I've put it back now so the Guidelines Checker will not flag it as an error.
However, we discovered that the *only* place this is referenced is in the TEI Guidelines bibliography and that it is really quite out of date (talking about things pre-P5). Since the Bibliography here is functioning as a Works Cited or sources for examples, Martin suggests and I agree to just remove this entry from the bibliography. This seems like a corrigible error to us that doesn't need a ticket.
If no one shouts loudly in the next couple days or so then Martin or I will remove it.
Also note that _anything_ pointing at tei.it.ox.ac.uk<http://tei.it.ox.ac.uk> or tei.oucs.ox.ac.uk<http://tei.oucs.ox.ac.uk> or oxgarage.oucs.ox.ac.uk<http://oxgarage.oucs.ox.ac.uk> should be considered at risk since IT Services here actively does not care about the TEI any more, and for various reasons by the end of the summer may not exist. (This is also true for jenkins-oxford.tei-c.org<http://jenkins-oxford.tei-c.org>.)
Sadly,
-James
On 24/04/17 16:30, Martin Holmes wrote:
Do you want to nuke it now, or should we raise a ticket and have Council look at it?
I'm never sure what the right thing to do is in these cases. It seems a simple corrigible error we could just fix, but I worry about perhaps overstepping the mark.
Cheers,
Martin
On 2017-04-24 08:24 AM, James Cummings wrote:
Hi Martin,
Just to confirm that I can find _no_ usage of the string Rahtz2003 in
the TEI Guidelines sources except in the Bibliography.
-James
On 24/04/17 16:18, Martin Holmes wrote:
Hi James,
That's the only URL I can find which matches
\.((it)|(oucs))\.ox\.ac\.uk, so I think we're OK; there are a few in
the Defunct folder, but that's no problem.
As for that particular presentation (<biblStruct xml:id="Rahtz2003">),
I can't find any actual reference to it, unless I'm missing something;
it's in the bibliography but it doesn't seem to be referenced from
anywhere. If you can confirm this just to be sure, we can just nuke
it. That's on the assumption that the BIB is supposed to be a list of
referenced works, rather than a generic history-of-the-TEI list; I
don't think it should be the latter, although I think there should be
such a thing somewhere.
Cheers,
Martin
--
Dr James Cummings, James.Cummings(a)it.ox.ac.uk<mailto:James.Cummings@it.ox.ac.uk>
Academic IT Services, University of Oxford
--
tei-council mailing list
tei-council(a)lists.tei-c.org<mailto:tei-council@lists.tei-c.org>
http://lists.lists.tei-c.org/mailman/listinfo/tei-council
PLEASE NOTE: postings to this list are publicly archived
Hi Council (MartinH CC'd),
Martin had noticed that the Guidelines Link checker couldn't find
http://tei.oucs.ox.ac.uk/Talks/2003-05-06-xmleurope2003/xmleurope2003.pdf
which is in the Bibliography as Rahtz2003.
This was because I tidied old repositories on tei.oucs (which
really should be referred to as tei.it now anyway) by updating
various quite old folders in SVN with set-depth=immediates which
leaves the file in the repo but not checked out on the server.
I've put it back now so the Guidelines Checker will not flag it
as an error.
However, we discovered that the *only* place this is referenced
is in the TEI Guidelines bibliography and that it is really quite
out of date (talking about things pre-P5). Since the
Bibliography here is functioning as a Works Cited or sources for
examples, Martin suggests and I agree to just remove this entry
from the bibliography. This seems like a corrigible error to us
that doesn't need a ticket.
If no one shouts loudly in the next couple days or so then Martin
or I will remove it.
Also note that _anything_ pointing at tei.it.ox.ac.uk or
tei.oucs.ox.ac.uk or oxgarage.oucs.ox.ac.uk should be considered
at risk since IT Services here actively does not care about the
TEI any more, and for various reasons by the end of the summer
may not exist. (This is also true for jenkins-oxford.tei-c.org.)
Sadly,
-James
On 24/04/17 16:30, Martin Holmes wrote:
> Do you want to nuke it now, or should we raise a ticket and
> have Council look at it?
>
> I'm never sure what the right thing to do is in these cases. It
> seems a simple corrigible error we could just fix, but I worry
> about perhaps overstepping the mark.
>
> Cheers,
> Martin
>
> On 2017-04-24 08:24 AM, James Cummings wrote:
>>
>> Hi Martin,
>>
>> Just to confirm that I can find _no_ usage of the string
>> Rahtz2003 in
>> the TEI Guidelines sources except in the Bibliography.
>>
>> -James
>>
>> On 24/04/17 16:18, Martin Holmes wrote:
>>> Hi James,
>>>
>>> That's the only URL I can find which matches
>>> \.((it)|(oucs))\.ox\.ac\.uk, so I think we're OK; there are a
>>> few in
>>> the Defunct folder, but that's no problem.
>>>
>>> As for that particular presentation (<biblStruct
>>> xml:id="Rahtz2003">),
>>> I can't find any actual reference to it, unless I'm missing
>>> something;
>>> it's in the bibliography but it doesn't seem to be referenced
>>> from
>>> anywhere. If you can confirm this just to be sure, we can
>>> just nuke
>>> it. That's on the assumption that the BIB is supposed to be a
>>> list of
>>> referenced works, rather than a generic history-of-the-TEI
>>> list; I
>>> don't think it should be the latter, although I think there
>>> should be
>>> such a thing somewhere.
>>>
>>> Cheers,
>>> Martin
>>>
>>
>>
--
Dr James Cummings, James.Cummings(a)it.ox.ac.uk
Academic IT Services, University of Oxford
