Skip to content

Conversation

@DunklesArchipel
Copy link
Member

  • Added a news file.

Literature Addition Checklist

For contributors and reviewers alike.

  • Name PR Add literature_identifier

Filename

  • Words and identifiers in the filenames must be lowercase.
  • The filename must be of type <Name>_<Year>_<FirstWordFirstPage>_<FirstPageNumber>_<fxy>_<Identifier>, where x is the figure number and y the subfigure label, i.e., 2b. For supporting information figures, use sfxy instead.
  • The figure number must match that of the figure in the article.

Bib file

  • The identifier must be identical with the filename as well as the citation key in the YAML.
  • Remove typos (or unwanted whitespace), specifically in the title such as Pt (111) to Pt(111).

SVG

  • The curve label should be short and unambiguous?
  • Figure label should be of type Figure: xy (not Figure: fxy).
  • The figure label must be identical to that in the article.
  • Comments should be complete sentences ending with a period.
  • A tags text label should be included in the SVG indicating the type of measurement (BCV, ORR, COOR, etc).
  • The units on the axis should be identical to those in the figure.
  • Considered a possible scaling factor?

YAML

  • The identifier must be identical to that in the filename.
  • Comments should be complete sentences ending with a period.

# We create a data package, i.e., a .csv and a .json file, from a .yaml and a
# .svg files by invoking the svgdigitizer.
${TARGET_DIR}/%.csv ${TARGET_DIR}/%.json : ${SOURCE_DIR}/%.yaml ${SOURCE_DIR}/%.svg
${SVGDIGITIZER} cv --sampling-interval ${SAMPLING_INTERVAL} --si-units --bibliography --metadata $< ${patsubst %.yaml,%.svg,$<} --outdir=${@D} 2>&1 | awk '{ print "'$<': "$$0 }'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do you not want to see stderr anymore here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Somehow, the test for building packages does not fail when the SVG is empty, as it is the case in the demo files below. At least now we can see in the tests (Checks) a Python error. Ideally, we we should add a test that first checks newly added files, then all tests can be evoked. This PR is merely a test. This can also be discussed in #45 .

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have no idea what you are saying here, sorry ;)
Maybe we can discuss that in our call.

Comment on lines 1 to 5
<?xml version="1.0" encoding="utf-8" ?>
<svg xmlns="http://www.w3.org/2000/svg" xmlns:ev="http://www.w3.org/2001/xml-events" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" xmlns:xlink="http://www.w3.org/1999/xlink" baseProfile="full" height="6497px" version="1.1" width="4961px">
<defs/>
<image height="6497px" sodipodi:insensitive="true" width="4961px" x="0" xlink:href="meng_2012_the_5222_p3.png" y="0"/>
</svg>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't there be something in here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants