openProject( resource, interface )
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- html
- Domain
- frontend
Research direction
Start by locating the openProject(resource, interface) entry point in the TPEN3 codebase and inspect how interfaces are selected. Define the behavior for TPEN Project, Manifest, Canvas, Image, and Annotation resources, including the default transcription interface; done means the method returns the TPEN Project object to the selected interface.
Written by the indexing model from the issue text.
Description
Initialize or continue a project and open in the mentioned interface.
@params
resource ( String | Object )
Object or resolvable path to object on which the interface is based. One of:
- TPEN Project—config object with references to
sc:Manifestand project settings. - Manifest—
sc:Manifestobject to render in the interface. If no reference to an existing project is found, initialize a new one. - Canvas—
sc:Canvasobject to render in the interface. Conceal any Manifest-level interactions in the interface. - Image—any image-type acceptable to the interface specified. Create a
sc:Canvasto initialize the interface and reference in saved annotations. - Annotation—any specific
oa:Annotationmay be rendered in a viewing interface for read only access or individual manipulation.
In the future, it may be possible to pass in arrays of individual objects, though this may be relegated to some middleware.
interface ( String )
Optional keyword or URI for interface within which to open the referenced resource. Default is "transcription" within TPEN, but may also send out the response to an alternative interface. The only available interface planned within TPEN for now is transcription, but RERUM may provide for canvas annotation, text markup, simple manifest generation, etc.
@returns
Response sends the TPEN Project object to the interface.
- Dominant language
- HTML
- Stars
- 5
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from CenterForDigitalHumanities/TPEN3
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 20/100
-
Complete Core Workflow InterfacesMay be free again @cubap claimed this 513 days ago, and no pull request is open. Open
CenterForDigitalHumanities/TPEN3#53 · 1 assignee ·
-
Users: Auth0 User management and toolsMay be free again @thehabes claimed this 947 days ago, and no pull request is open. OpenUser Administration user module
CenterForDigitalHumanities/TPEN3#38 · 2 comments · 1 assignee ·
-
Start a Project on the TPEN websiteMay be free again @cubap claimed this 947 days ago, and no pull request is open. Openstory
CenterForDigitalHumanities/TPEN3#37 · 1 assignee ·
-
enhancement OSS
Difficulty 3/5 1-2 days Newbie friendliness 35/100
CenterForDigitalHumanities/TPEN3#32 · 1 comment ·
All issues in CenterForDigitalHumanities/TPEN3
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
keyxmakerx/Chronicle#1532 ·
Maintainers usually reply within 1 day
-
enhancement feature good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Vakore/ZappierGames#147 ·
-
bug desktop v3 windows
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
esengine/DeepSeek-Reasonix#13697 · 1 comment ·
Maintainers usually reply within 1 day
-
issue: Picking a prompt from the / menu in a channel inserts a command chip instead of the promptOpenbug confirmed issue
Difficulty 2/5 Half a day Newbie friendliness 78/100
open-webui/open-webui#32712 · 2 comments ·
Maintainers usually reply within 1 day