Tagging figure not clear for the authors

[eliselavy]

During the technical review , really often now mistakes in the tagging figures ,see example below

or here

[eliselavy]

again another example see https://github.com/C2DH/jdh-notebook/issues/112

[danieleguido]

Hi, it seems that the tagging of figure we had before was simpler in the end :) to be discussed...

[eliselavy]

• Rephrase in guidelines with example
• Example to add in the template repository https://github.com/C2DH/template_repo_JDH_R / https://github.com/C2DH/template_repo_JDH

[biumiamy]

I added this section to the guideline(-styling notebook) to explain the figure naming:

Do you think it is more clear now? @eliselavy @danieleguido ?

[eliselavy]

@biumiamy yes really clear in term of tagging, but maybe also insist that the same logic applies for tables , tag table-....

Maybe also a point of tagging is important so that items are reflected in the table of contents.

About the label, there is a mix in your example between metadata inserted at the level of the cell, and metadata pass in parameter in the display method. if markdown table for example , need to be inserted at the metadata cell level. Sometimes they are not aware where to find this metadata (see comment i made to author here https://github.com/C2DH/jdh-notebook/issues/105#issuecomment-1479717804)

Maybe a overview of the two methods.

[eliselavy]

@biumiamy you need to run the action https://github.com/C2DH/jdh-notebook/actions/workflows/github-actions-publishing.yml after having updating the guidelines notebook in order to have the version in production with the good size of the images

[biumiamy]

@eliselavy Should I always do the action after each commit? or after a I did a few corrections in a bundle? Probably each time I finished for the day. Perhaps that's the best.

Good point about the table!

About the ToC: do you mean on the frontend (with a name like "figure 1: blabla-name")? or in the Juypter Notebook ToC to see it while one writes?

About the metadata - are you refering to the part at the top? or the example images below? And what's the best way to display it then instead of how it is currently?

many questions :)

[eliselavy]

@biumiamy

• the ToC in the frontend - in the jupyter notebook the Toc is only generated with the markdown

• the metadata, yes i speak about the part here you put You need to specify for the author where to find the metadata cell as it different from the inserted the metadata by the code ( it means , after you put an example display(...., metadata-=metadata)) see my comments made here to one author https://github.com/C2DH/jdh-notebook/issues/105#issuecomment-1479717804

• about the publishing action , indeed each time you want to release the guidelines on master you need to run it as the guidelines is loaded from here: REACT_APP_NOTEBOOK_GUIDELINES_URL=https://journalofdigitalhistory.org/proxy-githubusercontent/C2DH/jdh-notebook/master/examples/Author_Guideline/skim-AuthorGuideline.ip

[biumiamy]

updated the skim action to work for all Guideline notebooks