On Fri, Apr 22, 2016 at 6:17 PM, Dan Haywood <[email protected]> wrote:
> I'm intending to look at that notes issue soon, probably tomorrow. > That would be great. > > ~~~ > With respect to a user manual, I was mostly thinking in terms of some sort > of overlay that would render a help page for the current object.... a bit > like how in gmail pressing "?" will pop up shortcut keys. The viewer could > search for an associated file, eg Customer.adoc (similar to how it searches > for Customer.layout.xml or Customer.png), and if present, pass the .adoc > through a rendered to generate HTML to be shown in the overlay. > > This could also be used as an extended tooltip for individual object > members, eg Customer#placeOrder.adoc etc. > > Thoughts? > Having the same approach as tor the layout.xml would be good, and to be able to similarly generate a whole set of .adoc files even better. At the moment I have one .adoc file for each class but they are all in one folder. That was to make it easy to create a user 'manual' . I have a book.adoc in the same folder that has lots of import::fileXYZ.adoc statements, this seems to be the only way to create your desired ordering of sections in the book, via the sequence of imports. I also make use lots of links to minimise duplication of information. So, I think in any system implemented its desireable that, after opening a help page via "?" to get to contextual info, you can then browse further va links (to be in an iframe essentially). Inside each class adoc file I create BlockIds using the [[ClassName]] (at the start) and [[ClassName__methodName]] conventions, I think there was an issue with using only legal characters in the Id. Creating a hyperlink is usually then <<ClassName, ClassName>> as you know. Maybe to use a fully qualified class name is not such a big issue to ensure uniqueness of keys. You can do a global search and replace after writing a page, looking for the [[ and << markers to know where to add in the missing path. Once you've done that the Isis help system should be able to find the relevant method or property block to display within a single class adoc file, rather than having lots of files, or if its been converted to HTML its trivial to identify the HTML Id to use in a internal URL. > > Dan > > > > > > On 22 April 2016 at 07:33, Stephen Cameron <[email protected]> > wrote: > > > Hi > > > > Most probably. > > > > There is still that small problem of the Street Name value not being > > determined after updating the child object, but that is not layout just > > something I am seeing now in 1.12. that is minor for my demo. > > > > Probably the key issue for me now is having the Notes functionality back. > > Is there any chance of you taking a look at that exception, if you've not > > already I was just about to check. > > > > On another topic altogether, I have been writing a user manual in > Asciidoc > > and am interested to look at how to integrate it with Isis. There is a > > ticket on this already, and scheduled inclusion in 1.14 I think. But > maybe > > its something I can look at that is not too complex. > > > > Thanks > > Steve > > > > > > > > > > > > > > > > On Fri, Apr 22, 2016 at 4:20 PM, Dan Haywood < > [email protected] > > > > > wrote: > > > > > Yes, so the viewer attempts to honour both annotations and XML layout, > if > > > present. If they contradict each other, then it can result in these > > sorts > > > of issues. > > > > > > What I'd like to do in the future is to deprecate and eventually remove > > > some of the annotations, to avoid these sort of issues. I didn't want > to > > > do that in this release though; we aim to follow semantic versioning, > so > > > such a change would clearly break that. > > > > > > But, for Isis 2.0, I could see that maybe the @XxxLayout annotations > > might > > > disappear. > > > > > > Anyway, so far as I understand, you've resolved the layout issues, yes? > > > > > > Thx > > > Dan > > > > > > On 22 April 2016 at 05:43, Stephen Cameron <[email protected] > > > > > wrote: > > > > > > > On Fri, Apr 22, 2016 at 2:10 PM, Stephen Cameron < > > > > [email protected] > > > > > wrote: > > > > > > > > > Hmm, probably its reconciling the XML and the old annotations, > sorry > > > > > > > > > > > > > Yes that explained it, I had the following: > > > > > > > > @Property(editing = Editing.DISABLED) > > > > @PropertyLayout(hidden = Where.ALL_TABLES) > > > > @MemberOrder(name = "Contact Details", sequence = "2") > > > > @Column(allowsNull = "true") > > > > public Address getMailAddress() { > > > > return mailAddress; > > > > } > > > > > > > > @Action(semantics = SemanticsOf.IDEMPOTENT) > > > > @MemberOrder(name = "mailaddress", sequence = "1") > > > > public Person updateMailAddress(@ParameterLayout(named = "Street > > 1") > > > > String street1, @Parameter(optionality = Optionality.OPTIONAL) > > > > @ParameterLayout(named = "Street 2") String street2, > > > > @ParameterLayout(named = "Suburb") String suburb, > > > > @ParameterLayout(named = "Postcode") String postcode) { > > > > Address newAddress = > > > container.newTransientInstance(Address.class); > > > > newAddress.setStreet1(street1); > > > > newAddress.setStreet2(street2); > > > > newAddress.setPostcode(postcode); > > > > newAddress.setSuburb(suburb); > > > > Address oldMailAddress = getMailAddress(); > > > > container.persist(newAddress); > > > > setMailAddress(newAddress); > > > > if (oldMailAddress != null && oldMailAddress != > > > getStreetAddress()) > > > > container.removeIfNotAlready(oldMailAddress); > > > > return this; > > > > } > > > > > > > > If I then comment out the @MemberOrder attributes then Street Address > > and > > > > Mail Address items only appear once each and the action buttons then > > > don't > > > > duplicate, they were being carried by the Street Address and Email > > > Address > > > > properties into the header of their relevant groups as I'd linked > them > > to > > > > those properties using annotations. > > > > > > > > > > > > > On Fri, Apr 22, 2016 at 1:11 PM, Stephen Cameron < > > > > > [email protected]> wrote: > > > > > > > > > >> Hi Dan, Jeroen > > > > >> > > > > >> Here are a couple more pics of what I assume is the same problem. > > The > > > > >> actions buttons appear more than once. > > > > >> > > > > >> > http://expirebox.com/download/d38f977ebe3d396c0f1b6b278efa38c1.html > > > > >> > http://expirebox.com/download/f09dd76628bf5a9b77cc741fe8838f9f.html > > > > >> > > > > >> I have another problem too, between the two images note that the > > > Street > > > > >> Address value changes, Person2.png is what I see after selecting > an > > > link > > > > >> icon in a collection of Persons, Person3.png is what I see after > > > simply > > > > >> refreshing the page. > > > > >> > > > > >> If I grab the Layout XML from that page this is what I get: > > > > >> > > > > >> > > > > >> <?xml version="1.0" encoding="UTF-8" standalone="yes"?> > > > > >> <grid xsi:schemaLocation=" > > > > http://isis.apache.org/applib/layout/component > > > > >> http://isis.apache.org/applib/layout/component/component.xsd > > > > >> http://isis.apache.org/applib/layout/grid/bootstrap3 > > > > >> > http://isis.apache.org/applib/layout/grid/bootstrap3/bootstrap3.xsd > > " > > > > >> xmlns="http://isis.apache.org/applib/layout/grid/bootstrap3"; > > > > xmlns:ns2=" > > > > >> http://isis.apache.org/applib/layout/component"; xmlns:xsi=" > > > > >> http://www.w3.org/2001/XMLSchema-instance";> > > > > >> <row> > > > > >> <col span="12" unreferencedActions="true"> > > > > >> <ns2:domainObject/> > > > > >> <ns2:action id="clearHints"/> > > > > >> <ns2:action id="downloadLayoutXml"/> > > > > >> <ns2:action id="downloadJdoMetadata"/> > > > > >> <ns2:action id="rebuildMetamodel"/> > > > > >> </col> > > > > >> </row> > > > > >> <row> > > > > >> <col span="12"> > > > > >> <tabGroup> > > > > >> <tab name="General"> > > > > >> <row> > > > > >> <col span="6"> > > > > >> <ns2:fieldSet name="General" > > id="general" > > > > >> unreferencedProperties="true"> > > > > >> <ns2:property > id="salutationName"/> > > > > >> <ns2:property id="firstname"/> > > > > >> <ns2:property id="preferredname"/> > > > > >> <ns2:property id="middlename"/> > > > > >> <ns2:property id="surname"/> > > > > >> <ns2:property id="birthdate"/> > > > > >> <ns2:property id="englishSkill"/> > > > > >> <ns2:property > id="contactTypeName"/> > > > > >> <ns2:property id="sex"/> > > > > >> <ns2:property id="region"/> > > > > >> <ns2:property id="contactType"/> > > > > >> <ns2:property id="salutation"/> > > > > >> </ns2:fieldSet> > > > > >> </col> > > > > >> <col span="12" > > > unreferencedCollections="true"/> > > > > >> </row> > > > > >> </tab> > > > > >> <tab name="Contact"> > > > > >> <row> > > > > >> <col span="6"> > > > > >> <ns2:fieldSet name="Contact" > > > > >> id="contactDetails"> > > > > >> <ns2:property > id="homePhoneNumber"/> > > > > >> <ns2:property > > id="mobilePhoneNumber"/> > > > > >> <ns2:property id="emailAddress"/> > > > > >> <ns2:property > > id="fixedPhoneNumber"/> > > > > >> <ns2:property id="faxNumber"/> > > > > >> <ns2:property id="streetAddress"/> > > > > >> <ns2:property id="mailAddress"/> > > > > >> </ns2:fieldSet> > > > > >> </col> > > > > >> <col span="6"> > > > > >> <ns2:fieldSet name="Address" > > > > >> id="addressDetails"> > > > > >> <ns2:action > id="updateStreetAddress" > > > > >> position="PANEL"/> > > > > >> <ns2:action id="updateMailAddress" > > > > >> position="PANEL"/> > > > > >> <ns2:property id="streetAddress"/> > > > > >> <ns2:property id="mailAddress"/> > > > > >> <ns2:property id="location"/> > > > > >> </ns2:fieldSet> > > > > >> </col> > > > > >> </row> > > > > >> </tab> > > > > >> <tab name="Other"> > > > > >> <row> > > > > >> <col span="4"> > > > > >> <ns2:fieldSet name="Admin" id="admin"> > > > > >> <ns2:property id="oldId"/> > > > > >> <ns2:property > > id="datanucleusIdLong"/> > > > > >> <ns2:property > > > > >> id="datanucleusVersionLong"/> > > > > >> <ns2:property > > > > >> id="datanucleusVersionTimestamp"/> > > > > >> <ns2:property id="createdBy"/> > > > > >> <ns2:property id="createdOn"/> > > > > >> <ns2:property > id="lastModifiedBy"/> > > > > >> <ns2:property > id="lastModifiedOn"/> > > > > >> <ns2:property id="regionName"/> > > > > >> </ns2:fieldSet> > > > > >> </col> > > > > >> </row> > > > > >> </tab> > > > > >> </tabGroup> > > > > >> </col> > > > > >> </row> > > > > >> </grid> > > > > >> > > > > >> My layout file is close to that but the system has added the > > > > >> position="PANEL" attribute. > > > > >> > > > > >> If you cannot duplicate this I'll create some fixtures to see if > can > > > so > > > > >> as to debug. > > > > >> > > > > >> I was hoping to make use of 1.12 for a demo next Tuesday, but time > > is > > > > now > > > > >> running out to sort these problems, I don't have any time on the > > > > weekend. > > > > >> > > > > >> But once any issues are resolved it will be very nice! > > > > >> > > > > >> Steve > > > > >> > > > > >> On Fri, Apr 22, 2016 at 8:45 AM, Stephen Cameron < > > > > >> [email protected]> wrote: > > > > >> > > > > >>> Also noted that @MemberOrder#sequence is not being followed but > > > > >>> @MemberOrder#sequence#name is fine obviously. > > > > >>> > > > > >>> On Fri, Apr 22, 2016 at 7:31 AM, Stephen Cameron < > > > > >>> [email protected]> wrote: > > > > >>> > > > > >>>> > > > > >>>> > > > > > > > > > > https://github.com/Stephen-Cameron-Data-Services/isis-chats/blob/master/dom/src/main/java/au/com/scds/chats/dom/module/general/Person.java > > > > >>>> > > > > >>>> On Thu, Apr 21, 2016 at 10:50 PM, Dan Haywood < > > > > >>>> [email protected]> wrote: > > > > >>>> > > > > >>>>> ok, thanks. Is this code in a github repo? (and if so, can you > > > > remind > > > > >>>>> me > > > > >>>>> which) > > > > >>>>> > > > > >>>>> > > > > >>>>> > > > > >>>>> On 21 April 2016 at 13:30, Stephen Cameron < > > > > [email protected] > > > > >>>>> > > > > > >>>>> wrote: > > > > >>>>> > > > > >>>>> > > > > > http://expirebox.com/download/468e0d012f6f71fe8c31003a9d65b853.html > > > > >>>>> > > > > > >>>>> > On Thu, Apr 21, 2016 at 10:07 PM, Jeroen van der Wal < > > > > >>>>> [email protected]> > > > > >>>>> > wrote: > > > > >>>>> > > > > > >>>>> > > Attachments are removed from mailing list messages, use a > > > service > > > > >>>>> like > > > > >>>>> > > imugr to link screenshots. > > > > >>>>> > > > > > > >>>>> > > On 21 April 2016 at 13:59, Stephen Cameron < > > > > >>>>> [email protected]> > > > > >>>>> > > wrote: > > > > >>>>> > > > > > > >>>>> > > > Hi Dan, > > > > >>>>> > > > > > > > >>>>> > > > In the attached you can see that the 'Update Street > > Address' > > > > and > > > > >>>>> > 'Update > > > > >>>>> > > > Mail Address' action buttons are appearing twice. > > > > >>>>> > > > > > > > >>>>> > > > The should only appear in the Contact Details field-set. > > > > >>>>> > > > > > > > >>>>> > > > I'll all pages have tabs I think, but this is what the no > > > > layout > > > > >>>>> file > > > > >>>>> > is > > > > >>>>> > > > giving me. > > > > >>>>> > > > > > > > >>>>> > > > Steve > > > > >>>>> > > > > > > > >>>>> > > > > > > > >>>>> > > > > > > > >>>>> > > > > > > > >>>>> > > > > > > > >>>>> > > > > > > >>>>> > > > > > >>>>> > > > > >>>> > > > > >>>> > > > > >>> > > > > >> > > > > > > > > > > > > > > >
