Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduction to Encoding Texts in TEI (translation from spanish) #610

Open
hawc2 opened this issue Mar 19, 2024 · 3 comments
Open

Introduction to Encoding Texts in TEI (translation from spanish) #610

hawc2 opened this issue Mar 19, 2024 · 3 comments

Comments

@hawc2
Copy link
Collaborator

hawc2 commented Mar 19, 2024

Programming Historian in English has received a proposal for a translation from Spanish, 'Introduction to Encoding Texts in TEI,' by @ashlynstewart404.

I have circulated this proposal for feedback within the English team. We have considered this proposal for:

  • Openness: we advocate for use of open source software, open programming languages and open datasets
  • Global access: we serve a readership working with different operating systems and varying computational resources
  • Multilingualism: we celebrate methodologies and tools that can be applied or adapted for use in multilingual research-contexts
  • Sustainability: we're committed to publishing learning resources that can remain useful beyond present-day graphical user interfaces and current software versions

We are pleased to have invited @ashlynstewart404 to develop this Proposal into a Submission to be developed under the guidance of @semanticnoodles as editor.

The Submission package should include:

  • Lesson text (written in Markdown)
  • Figures: images / plots / graphs (if using)
  • Data assets: codebooks, sample dataset (if using)

We ask @ashlynstewart404 to share their Submission package with our Publishing team by email, copying in @semanticnoodles .

We've agreed a submission date of late April. We ask @ashlynstewart404 to contact us if they need to revise this deadline.

When the Submission package is received, our Publishing team will process the new lesson materials, and prepare a Preview of the initial draft. They will post a comment in this Issue to provide the locations of all key files, as well as a link to the Preview where contributors can read the lesson as the draft progresses.

If we have not received the Submission package by May, @semanticnoodles will attempt to contact @ashlynstewart404. If we do not receive any update, this Issue will be closed.

Our dedicated Ombudspersons are Ian Milligan (English), Silvia Gutiérrez De la Torre (español), Hélène Huet (français), and Luis Ferla (português) Please feel free to contact them at any time if you have concerns that you would like addressed by an impartial observer. Contacting the ombudspersons will have no impact on the outcome of any peer review.

@charlottejmc
Copy link
Collaborator

charlottejmc commented May 3, 2024

Hello @ashlynstewart404 and @semanticnoodles,

You can find the key files here:

You can review a preview of the lesson here:


I noticed a couple minor things when processing this submission, which I've listed below:

  • I've replaced your image links with the liquid syntax we use in our lessons, which looks like this:
    {% include figure.html filename="file-name-1.png" alt="Visual description of figure image" caption="Figure 1. Caption text to display" %}
    I was able to fill in the captions you translated, but you'll see that this syntax also includes a placeholder for alt-text (Visual description of figure image). I would be grateful if you could provide this for each of the images. Unfortunately, the ES original lesson was published before we implemented alt-text, so I do not have any original text for you to translate.
  • I believe the image tei-translation-1.png which you provided for Figure 1 may be wrong, as it seems to be a replica of Figure 2. Could you please double-check, and perhaps send me the correct image if needed?
  • I'd also like to ask whether you could send me cropped versions of figures 2-8: this will allow us to size the images down (in line with our commitment to minimal compute and accessibility) while still retaining clarity.
    - 2, 3 and 4 could be cropped much closer to where the red circles appear
    - 5, 6, 7 and 8 could be cropped so as to remove empty space and show only the code
  • You'll see that I've added a YAML header to the lesson file. It contains an abstract and avatar_alt, which I've left in Spanish for now – could you please also translate these into English?

My colleague @anisa-hawes will invite you to join us here on GitHub as an Outside Collaborator. This will give you the Write access you'll need to edit your lesson directly.

Thank you very much for your time and your work! ✨

@semanticnoodles
Copy link

Hi @charlottejmc and @anisa-hawes, I wanted to flag some issues with the rendering of the page, but I can see you started fixing the problem, thanks!

@anisa-hawes
Copy link
Contributor

anisa-hawes commented May 3, 2024

Thank you, @charlottejmc!

--

Hello Ashlyn @ashlynstewart404,

I've sent you the invitation to join as an Outside Collaborator so you will be able to edit the abstract, avatar_alt etc. on your translation file here: /en/drafts/translations/encoding-texts-tei-1.md.

What's happening now?

Your lesson has been moved to the next phase of our workflow which is Phase 2: Initial Edit.

In this Phase, your editor Giulia @semanticnoodles will read your lesson, and provide some initial feedback. Giulia will post feedback and suggestions as a comment in this Issue, so that you can revise your draft in the following Phase 3: Revision 1.

At the moment, you'll notice that the Preview doesn't render images – we are waiting until we receive the revised files before uploading these. We'll send you a note to confirm when the preview is complete and ready to review.

%%{init: { 'logLevel': 'debug', 'theme': 'dark', 'themeVariables': {
              'cScale0': '#444444', 'cScaleLabel0': '#ffffff',
              'cScale1': '#882b4f', 'cScaleLabel1': '#ffffff',
              'cScale2': '#444444', 'cScaleLabel2': '#ffffff'
       } } }%%
timeline
Section Phase 1 <br> Submission
Who worked on this? : Publishing Assistant (@charlottejmc) 
All  Phase 1 tasks completed? : Awaiting revised images
Section Phase 2 <br> Initial Edit
Who's working on this? : Editor (@semanticnoodles)  
Expected completion date? : June 3
Section Phase 3 <br> Revision 1
Who's responsible? : Author (@ashlynstewart404) 
Expected timeframe? : ~30 days after feedback is received

Note: The Mermaid diagram above may not render on GitHub mobile. Please check in via desktop when you have a moment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 2 Initial Edit
Development

No branches or pull requests

4 participants