I'm guessing that navigation only works if you import the right things to start with - bit of a bootstrapping problem.
If you have a documentation-graph project, then if necessary you could cut a branch for each old and upcoming version - and just keep the head relevant to the latest release. The issue is really the bootstrap context and size - without importing the right things you cant find anything - and the size means that we need to be able to filter. such a project, based on the minimal setup you suggest could have a very simple README directing to the provided (as-is) view(s) - and would be a lot more accessible than having to bug you about where to start. The richness and extensibility makes it non-trivial, which is why a community model perhaps makes sense. Perhaps these are really EDG "EDG documentation assets" and we could import our own which annotate our own libraries, or add annotations to the existing partially self-documenting code? On Tue, 17 Jul 2018 at 12:51 Holger Knublauch <[email protected]> wrote: > On 17/07/2018 12:39, Rob Atkinson wrote: > > > Is there already a graph that imports all the key libraries (and any > critical information about which ones may be deprecated!) - you obviously > have one in your SWP - > > > No. What I do is to open swa.spin.ttl and add imports to > sparqlmotionfunctions.ttl and spinmapl.spin.ttl. If you want you could > create a new file that imports all three of the above. > > > > is this SWP accessible and customisable - so for example I can hack a copy > to filter the list of functions by the argument and/or return type? > > > Like all SWP code, you can modify it either by changing the source code > yourself or adding ui:overrides where needed. The entry point here is > spin.ui:ModulesPage (as you can see when you navigate to the Browser tab at > spin:Function as mentioned). > > > > Can we set up a community project for interactive documentation with this > stuff in it so we can share our favourite hacks? > > > If it's a community project then I presume anyone can start such a thing, > e.g. on github. > > We are of course trying to continually improve our documentation based on > feedback such as yours, yet as you all appreciate this is a non-trivial > amount of work, and the more documentation we offer, the higher the chances > that things will get outdated. With the sheer number of features that > TopBraid offers it is sometimes unavoidable to look into the underlying RDF > models and SWP code, typically from within TBC-ME. (BTW as I write this I > was looking into how to improve script-based importers based on your other > mail.) > > > Holger > > > > > > > > On Tue, 17 Jul 2018 at 12:04 Holger Knublauch <[email protected]> > wrote: > >> >> >> On 16/07/2018 13:29, Rob Atkinson wrote: >> >> >> The TBC reference looks like it is pretty close to that consolidated list >> - which is fine but it would be nice if it was a bit more tractable - it >> looks like its a ordered dump from graph >> >> The challenge is lack of context: >> >> e.g. TopBraid SPARQL Functions reference >> >> - *spr:colWidth >> >> <http://127.0.0.1:57911/help/ntopic/org.topbraidcomposer.core/html/smf.html#spr:colWidth>*: >> Gets the width (in pixels) of a given column >> >> operates on a spr:Table - so a facted search on all functions that take >> an spr:Table as an argument, and have "col" in the description of an >> argument would give a fairly useful short list of relevant stuff. >> >> So is there already a view we could invoke to get an EDG faceted search >> over this? >> >> >> The complication with this documentation page in particular is that it >> includes features that are also available to users of TBC Standard and Free >> Editions. These editions do not include support for SWP. So the page is >> regenerated as a static HTML file for each release. Naturally we use SWP >> for this generation: Open any file with function definitions, navigate to >> spin:Function and switch to the Browser tab to see this in action. Having a >> static HTML file also means that the page will be indexed correctly in the >> Eclipse Help. >> >> Your specific query above would be best done in SPARQL because it would >> be hard to build a faceted search engine that is smart enough to walk from >> a function into its spin:constraint/spl:valueType triples - the values of >> interest are two "hops" away. We have tried our best to group similar >> functions into namespaces (here: spr) but some namespaces such as smf have >> become rather random collections of functions so it requires some reading >> to find a suitable function. Text search is a decent option if you look for >> keywords. >> >> >> Holger >> >> >> >> >> >> >> On Mon, 16 Jul 2018 at 11:34 Steveraysteveray <[email protected]> >> wrote: >> >>> +++10 to this! >>> >>> >>> - Steve >>> >>> On Jul 15, 2018, at 5:44 PM, Rob Atkinson <[email protected]> >>> wrote: >>> >>> >>> working through some SWA/SWP/EDG development I keep finding myself >>> having to context-switch between different styles and locations for >>> functions. >>> >>> For SWP generally, http://uispin.org/ui.html >>> For SWA - its http://localhost:8083/tbl/swp?_viewClass=swadoc:Index >>> For teamwork - its >>> http://localhost:8083/tbl/swp?_viewClass=teamworkdoc:SPARQLFunctions >>> >>> then we have functions like smf:userWithName() - i havent found where >>> these are documented at all yet, >>> >>> then then are SPARQLmotion functions - these seem mainly available via >>> the TBC help system - maybe thats pulling in this >>> https://www.topquadrant.com/sparqlmotion/lib.html and restyling it? >>> Stiull havent found smf: and spif: yet ... >>> >>> The guide at >>> https://www.topquadrant.com/2010/01/05/how-to-write-new-sparql-functions-with-spin/ >>> says "The “TopBraid SPARQLMotion Functions Library” page of TopBraid >>> Composer's online help lists ... >>> >>> but this is sadly not a link .. >>> >>> There seem to be libraries for spif: and spl: here >>> http://spinrdf.org/spif and here http://spinrdf.org/spl# - but no >>> obvious links to documentation - and not finding it by google. >>> >>> also other namespaces for functions like afn:now() >>> >>> So, there seem to be at least 7 different libraries of useful stuff. I >>> suspect there are more. >>> >>> what about magic properties and SPIN templates accessible to EDG >>> developers for instance. >>> >>> Should I favour one over another - can we at least enumerate these in >>> some sort of hierarchy of stability and support both within TQ and the >>> wider community? >>> >>> Could perhaps an index of all the non-deprecated functions be published >>> as a RDF file - and rendered as HTML where each function is referenced >>> along with a link to its appropriate online documentation, and ideally >>> relevant guides and tutorials? >>> >>> >>> -- >>> You received this message because you are subscribed to the Google >>> Groups "TopBraid Suite Users" group. >>> To unsubscribe from this group and stop receiving emails from it, send >>> an email to [email protected]. >>> For more options, visit https://groups.google.com/d/optout. >>> >>> -- >>> You received this message because you are subscribed to the Google >>> Groups "TopBraid Suite Users" group. >>> To unsubscribe from this group and stop receiving emails from it, send >>> an email to [email protected]. >>> For more options, visit https://groups.google.com/d/optout. >>> >> -- >> You received this message because you are subscribed to the Google Groups >> "TopBraid Suite Users" group. >> To unsubscribe from this group and stop receiving emails from it, send an >> email to [email protected]. >> For more options, visit https://groups.google.com/d/optout. >> >> >> -- >> You received this message because you are subscribed to the Google Groups >> "TopBraid Suite Users" group. >> To unsubscribe from this group and stop receiving emails from it, send an >> email to [email protected]. >> For more options, visit https://groups.google.com/d/optout. >> > -- > You received this message because you are subscribed to the Google Groups > "TopBraid Suite Users" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > For more options, visit https://groups.google.com/d/optout. > > > -- > You received this message because you are subscribed to the Google Groups > "TopBraid Suite Users" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > For more options, visit https://groups.google.com/d/optout. > -- You received this message because you are subscribed to the Google Groups "TopBraid Suite Users" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. For more options, visit https://groups.google.com/d/optout.
