openlibhums / openlibhums/memory-alpha
Document file types from user's perspective
Nobody has claimed this yet.
- Dominant language
- Markdown
- Stars
- 0
- Forks
- 0
- Avg merge
- 4d 14h
- Merged PRs (30d)
- 2
Description
As a part of https://github.com/BirkbeckCTP/typesetting/pull/216 and https://github.com/BirkbeckCTP/janeway/pull/4327, it became clear that we need to help users understand the file types they are expected to know about in Janeway.
Here is a start, taken from the help texts I encoded into the Document Management page.
Manuscript File
Manuscript files hold the main text content of the article while it is being finalized. They are used across review, copyediting, and typesetting.
Figure/Data File
Figure files hold images that will be included in the article. Data files hold any other other content that is not an image or main text content but that will be included in the published article.
Galley File
Galleys are files that have been typeset or encoded, most often in XML, HTML, or PDF format, so that they are ready for proofing and publication.
Proofing File
Proofing files are copies of galleys that have been marked up to indicate corrections to be made in subsequent rounds of typesetting.
Source File
Source files are files created in typesetting while generating a galley. They are often in specialized file formats used by graphic design and document layout applications.
Supplementary File
Supplementary files are publication-ready pieces of content to be published alongside the article, often with their own DOIs.
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start by locating the documentation or help-content files in the memory-alpha repository and review how user-facing guidance is organized. Add the supplied definitions for manuscript, figure/data, galley, proofing, source, and supplementary files, then verify that each description is clear and consistently presented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 54/100