Open data markup

[robertocarroll]

See https://github.com/robertocarroll/icc-alpha/issues/17 for details.

[robertocarroll]

Hi Simmi and Kyle,

Can I ask your thoughts on open data markup, in particular the use of schema.org and RDFa to make the ICC Beta pages machine readable and improve search engines' understanding of ICC information.

See here for details: https://mojdigital.blog.gov.uk/open-data-markup-on-dsd-informational-services/

Do you have any thoughts on:

• How easy it is to achieve in the context of Sharepoint?
• The choices of approach
• The time and effort of implementation vs the impact and use cases

[simmigaba]

Hi Rob Just to give you idea, every section that you currently see on Case, Situation or Home webpage is a Sharepoint Visual Web part which has two underlying components - a ASPX Page and C# code component. ASPX page is more of a placeholder (just have root panel or div etc) for ICC website as most of the UI and content is generated dynamically using C# Code which then adds UI components and content to associated ASPX Page root element. So C# Code component fetch data from underlying Sharepoint libraries and lists and then put it inside UI components like div, para, list, hyperlinks, etc. Some of these UI components are available as standard classes in C# library or we can just wrap any HTML content in generic C# class. At the moment I am trying to create a centralized C# library/ classes which will have functions like createImage, createDiv, createPara etc..so that we can call these common APIs from any webpart C# code to render a specific UI element. To these common classes we can also pass attributes which may differ from webpart to webpart e.g. image size, css class etc. And any standard attributes or CSS classes which are common for any UI element will be the part of centralized library. So in same common library I can also define open data markup attributes/ tags that should render whenever we are rendering UI elements for any specific web part. In order to implement the same, I will be needing some examples specific to new ICC public website. So if Kyle can modify the HTML code of any static web parts (in his version of ICC website) and add open data markup attributes and tags then I will be more clear that how I need to render same open data markup attributes and tags while dynamically building the ASPX page from C# code component for a specific webpart. So as a starting point, please implement it for any existing webpart present on case, situation or Home page and provide me with modified HTML code and then I will actually implement it for that webpart. And if it works fine and then we can replicate it for all existing webparts. Pls let me know if anything is not clear. Thanks

[robertocarroll]

Thanks for the information. I will investigate a simple schema that we can use and then see what you all think. (Assigning myself to this issue).

[kyleschaeffer]

The SharePoint web part structure cannot be changed, but we do have control over markup both outside web part zones, and within web parts, themselves. For example, all web parts in SharePoint look something like this:

<!-- I can edit the HTML here (before the zone) -->

<div class="ms-webpart-zone">

  <!-- repeats for every web part in the zone -->
  <div class="ms-webpartzone-cell">
    <div class="ms-webpart-chrome">
      <div class="ms-WPBody">

        <!-- We can edit the HTML here (inside the web part body) -->

      </div>
    </div>
  </div>
  <!-- end repeat -->

</div>

<!-- I can edit the HTML here (after the zone) -->

If Open Data can be implemented into this structure, it could work, but it sounds like a lot of work on Simmi's part.

[robertocarroll]

Added some preliminary examples for open data markup:

1. Breadcrumb
2. Court record
3. Person