Documentation of endpoints

Poster Content
nk4um User
Posts: 90
November 12, 2015 11:52

Found the solution by accident: after a change in the documentation, the search index must be rebuilt for the spcae explorer as it uses a search endpoint to find the docs.

After all the dynamics in NK I didn't think about that. Maybe it can be added to the documantation, I didn't find this hint there.

Cheers, Stefan

Like · Post Reply
nk4um User
Posts: 90
November 5, 2015 12:18Documentation of endpoints

Hello,

most of the NetKernel endpoints in the Space explorer have additional text under the default endpoint metadata. I assume this comes from the Books.xml or Docs.xml documentation system. I tried to add this information to one of my endpoints but no luck: The text of a document shows up in the book documentation but never in the Space explorer.

Here is my configuration of the documentation system:

module.xml:

<rootspacename="testing - Documentation Space" public="true" uri="urn:stefan:lm:doc">
  <fileset>
    <regex>res:/etc/system/(Books|Docs).xml&lt;/regex&gt;
  &lt;/fileset&gt;
  <fileset>
    <regex>res:/resources/doc/.*&lt;/regex&gt;
  &lt;/fileset&gt;
&lt;/rootspace&gt;

The space with the endpoint that should be documented:

<rootspacename="testing - Data Space" uri="urn:stefan:lm:data" public="true">
  <accessor>
    <id>urn:stefan:lm:UpdateDataAccessor&lt;/id&gt;
    <name>UpdateDataAccessor&lt;/name&gt;
    <description>Receives data and updates items in the DB&lt;/description&gt;
    <grammar>
      <active>
        <identifier>active:updateData&lt;/identifier&gt;
        <argumentname="data" min="0" max="1" /&gt;
      &lt;/active&gt;
    &lt;/grammar&gt;
    <class>stefan.lm.UpdateDataAccessor&lt;/class&gt;
  &lt;/accessor&gt;
  <fileset>
    <regex>res:/etc/system/(Books|Docs).xml&lt;/regex&gt;
  &lt;/fileset&gt;
  <fileset>
    <regex>res:/resources/doc/.*&lt;/regex&gt;
  &lt;/fileset&gt;
  <import>
    <uri>urn:stefan:lm:doc&lt;/uri&gt;
  &lt;/import&gt;
&lt;/rootspace&gt;

The Docs.xml:

<docs>
  <doc>
    <id>urn:stefan:lm:guide&lt;/id&gt;
    <title>Guide to LM&lt;/title&gt;
    <desc /&gt;
    <uri>res:/resources/doc/doc_guide.txt&lt;/uri&gt;
  &lt;/doc&gt;
  <doc>
    <id>urn:stefan:lm:example&lt;/id&gt;
    <title>Reference for example endpoint&lt;/title&gt;
    <desc /&gt;
    <uri>res:/resources/doc/doc_example.txt&lt;/uri&gt;
  &lt;/doc&gt;
  <doc>
    <id>doc:stefan:lm:data:UpdateDataAccessor&lt;/id&gt;
    <title>Reference for UpdateDataAccessor&lt;/title&gt;
    <desc /&gt;
    <uri>res:/resources/doc/doc_UpdateDataAccessor.txt&lt;/uri&gt;
    <category>doc&lt;/category&gt;
  &lt;/doc&gt;
&lt;/docs&gt;

The Books.xml:

<books>
  <book>
    <id>book:urn:stefan:lm&lt;/id&gt;
    <title>LM&lt;/title&gt;
    <desc>The last image organizer&lt;/desc&gt;
    <toc>
      <itemid="urn:stefan:lm:guide" /&gt;
      <itemid="urn:stefan:lm:example" /&gt;
      <itemid="doc:stefan:lm:data:UpdateDataAccessor" /&gt;
    &lt;/toc&gt;
  &lt;/book&gt;
&lt;/books&gt;

The doc_UpdateDataAccessor.txt (without the quote, just for escaping); this is the text I would like to see in the Space explorer together with the endpoint:

{'endpoint}urn:stefan:lm:UpdateDataAccessor{/endpoint}
This stub is generated by the New Module Wizard.

I'missing something, but what?

Thanks in advance,

Stefan

Like · Post Reply