Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Semantic overhaul of Scribble with RDFa

未关闭
#228 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
15/100
Issue 类型
功能
描述清晰度
需要澄清
活跃度
停滞

调研方向

该 issue 没有列出任何 repository 文件、测试或入口点。先分解所需工作——RDF Turtle/NQuads、JSON-LD、RDFa 解析、HDT FFI、一个 OWL 本体、Scribble 输出变更,以及对 HDT 或 triple-store 的查询——并在实现前定义范围;完成的标准是实现所描述的语义输出和查询改造。

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
Racket
星标
251
派生
101
平均合并
6 天 22 小时
30 天内合并 PR
1

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

racket/scribble 的其他 Issue

查看 racket/scribble 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。