scossu/pocket_archive
1
0
Fork 0
Code Issues 25 Pull requests Releases Packages Wiki Activity Actions

Redesign structure handling #25

New issue
Closed
opened 2026-01-11 00:28:59 +00:00 by scossu · 2 comments
scossu commented 2026-01-11 00:28:59 +00:00
Owner
Copy link

Mixing curatorial resources and structural elements (bricks) in the same graph was a bad idea.

Bricks can be hard to clean up and update when updating a resource and its tree structure. They also make for complicated laundry lists when these are recreated from archived resources.

A better solution would be to handle structures separately from curatorial resources:

  • Structures can be created from LL layout, as they do now.
    • (in a later release users can also provide a structured file, e.g. JSON, to define a custom structure -- not for v1.0)
  • Each resource with members gets a pas:hasTree relationship that points to a named graph.
    • Named graphs haven't been used in Pocket Archive, so that's a good use for them. All curatorial resources are in one main graph.
    • For simplicity's and practicality's sake, there is only one tree per resource. As usual, any resource can be in any number of trees.
  • The tree starts with the related resource URI, and branches off from there.
  • Tree branches are created as bricks in the same way they are created now. Each tree is contained in its own named graph.
  • Presentation can build the structure from the related tree, if present. Instead of looking for pas:first, it looks for pas:hasTree and then for the subject inside the tree.
  • When a resource with a related structure is updated, the whole tree is removed and recreated from the updating LL. That is easy to do because the whole structure is in the same named graph.
Mixing curatorial resources and structural elements (bricks) in the same graph was a bad idea. Bricks can be hard to clean up and update when updating a resource and its tree structure. They also make for complicated laundry lists when these are recreated from archived resources. A better solution would be to handle structures separately from curatorial resources: - Structures can be created from LL layout, as they do now. - (in a later release users can also provide a structured file, e.g. JSON, to define a custom structure -- not for v1.0) - Each resource with members gets a `pas:hasTree` relationship that points to a named graph. - Named graphs haven't been used in Pocket Archive, so that's a good use for them. All curatorial resources are in one main graph. - For simplicity's and practicality's sake, there is only one tree per resource. As usual, any resource can be in any number of trees. - The tree starts with the related resource URI, and branches off from there. - Tree branches are created as bricks in the same way they are created now. Each tree is contained in its own named graph. - Presentation can build the structure from the related tree, if present. Instead of looking for `pas:first`, it looks for `pas:hasTree` and then for the subject inside the tree. - When a resource with a related structure is updated, the whole tree is removed and recreated from the updating LL. That is easy to do because the whole structure is in the same named graph.
scossu added this to the v1.0.0 milestone 2026-01-11 00:28:59 +00:00
scossu commented 2026-01-11 21:49:59 +00:00
Author
Owner
Copy link

Note that this will break serialization until Volksdata implements a triG codec. See #26

Note that this will break serialization until Volksdata implements a triG codec. See https://git.knowledgetx.com/scossu/pocket_archive/issues/26
scossu commented 2026-01-14 13:48:58 +00:00
Author
Owner
Copy link

Tasks (in named_tree branch):

  • Replace pas:Brick type with pas:Proxy type
  • Remove brick content type from content model
  • Functions to create trees from a submission (one per top-level resource)
  • Adjust repo to handle multiple named graphs
  • Assign trees to resources before calling rsrc_to_graph
  • Delete each existing resource tree graph after calling rsrc_to_graph
  • Link new trees to resources
  • Rework presentation to handle trees in resource view
  • Special handling of collections: they get a flat, ordered tree, and each direct member gets its own tree (stretch goal)
  • Clean up and debug
  • Update tests
  • Update documentation
Tasks (in `named_tree` branch): - [X] Replace `pas:Brick` type with `pas:Proxy` type - [x] Remove `brick` content type from content model - [X] Functions to create trees from a submission (one per top-level resource) - [X] Adjust repo to handle multiple named graphs - [x] Assign trees to resources before calling `rsrc_to_graph` - [x] Delete each existing resource tree graph after calling `rsrc_to_graph` - [x] Link new trees to resources - [x] Rework presentation to handle trees in resource view - [x] Special handling of collections: they get a flat, ordered tree, and each direct member gets its own tree (stretch goal) - [x] Clean up and debug - [x] Update tests - [x] Update documentation
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
master
named_tree
v1.0b6
v1.0b5
v1.0b4
v1.0b3
v1.0b2
v1.0b1
v1.0a9
v1.0a8
v1.0a7
v1.0a6
v1.0a5
v1.0a4
v1.0a3
v1.0a2
v1.0a1
v1.0a0
Labels
Clear labels   
area/api

   
area/content_model

   
area/framework

   
area/io

   
area/presentation

   
area/preservation

   
area/rdf

   
area/security

   
area/submission

   
area/ui
  
p
critical
The issue is blocking major development tasks, is causing significant issues, or is a security/data integrity threat. It must be resolved before all other issues and must be in the current milestone.

  
p
high
The issue is causing notable problems. It must be in a milestone. It must be resolved in order for the milestone to be completed.

  
p
low
The issue may be in a milestone. It may be moved to another milestone or unassigned one, if necessary.

  
p
medium
The issue may be in a milestone. It should be completed in order to close the milestone.

  
s
blocked

  
s
done

  
s
progress

  
s
testing

  
s
wontfix

  
t
bug

  
t
documentation

  
t
enhancement

  
t
feature

  
t
test

No labels
area/api
area/content_model
area/framework
area/io
area/presentation
area/preservation
area/rdf
area/security
area/submission
area/ui
p
critical
p
high
p
low
p
medium
s
blocked
s
done
s
progress
s
testing
s
wontfix
t
bug
t
documentation
t
enhancement
t
feature
t
test
Milestone
Clear milestone
No items
No milestone
v1.0.0
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
scossu/pocket_archive#25
No description provided.