Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Semantic overhaul of Scribble with RDFa

Aperta
  • Qualcosa non va?
#228 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
15/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Ambito
documentation, search

Direzione di ricerca

L’issue non indica file del repository, test o punti di ingresso. Inizia scomponendo il lavoro richiesto —RDF Turtle/NQuads, JSON-LD, parsing di RDFa, HDT FFI, un’ontologia OWL, modifiche all’output di Scribble e interrogazioni di HDT o di un triple store— e definendo l’ambito prima dell’implementazione; il lavoro sarebbe completo quando fosse realizzata la revisione dell’output semantico e delle interrogazioni descritta.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

This is a proposal for an overhaul of current Scribble implementation.

The goal of the project is for every document generated by Scribble to be semantically annotated with RDFa + JSON-LD and search to be (also) implemented with HDT/SPARQL as engine.

The benefits:
  • Flexible Datalog like querying for every facet of document
  • Possibility of building Natural Language Querying on top of RDF data and SPARQL- Ease of extending properties thanks to Open World Assumption of OWL.
  • Data annotation can be as granular as needed (e.g. it could include source code line on github for every paragraph).
  • Semantic annotation is accessible for search engines crawlers.
  • If packagsrc would implement semantic data the data integration between these 2 would be seamless (e.g. you could search for all packages that use SomeFunction)
  • Ability to reason about documentation (e.g. list documentation that doesn't fulfill certain criteria)
The means/Required work:
  1. implement RDF toolset in Racket:
  • RDF turtle/NQuads
  • JSON-LD (implemented by @cwebber)
  • RDFa parser
  • HDT ffi (for data storage and querying)
  1. Building OWL ontology for Scribble documentation/code
  2. Rework of Scribble output to replace current class based annotation with RDFa. If you are not familiar with Semantic annotation take a look at https://schema.org/Article especially scroll to the bottom to the RDFa tab.
  3. Data querying based on data stored in HDT files for local documentation and possibly triple store (e.g. RDF4J) for the server side documentation. http://www.rdfhdt.org/what-is-hdt/

If you have any questions regarding benefits/implementation details feel free to ask here.

Lingua principale
Racket
Stelle
251
Fork
101
Merge medio
11g 9h
PR unite (30g)
2

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di racket/scribble

Tutte le issue di racket/scribble

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.