Structure and Naming of Cookbook Contribution Folders - IUPAC/WFChemCookbook GitHub Wiki

All files needed for a Cookbook contribution are organized in a contribution folder. This document describes the structure of the contribution folder and guidelines for file naming (naming conventions). An example contribution folder is shown below:

Contributors should create a "short name" of their contribution with a suggested max length of 18 characters, using _ for spaces. This is appended to the contributors initials, concatenated with a '_', as the folder name for the contribution (sjc_iupac_units_excel above).

Inside the contribution folder a Markdown (MD) or Jupyter Notebook (JN) file should be saved using the short name as the file name with the appropriate extension (iupac_units_excel.md above). Inside the contribution folder supplementary files should be organized similarly to the folder structure above. If these files are referenced in the MD or JN file this should be done using relative path links (except for videos) as indicated below:

• Files: ‘../files/’ + filename
• Images: ‘../images/’ + filename
• Videos: No folder, just use the short YouTube video URL (e.g. https://youtu.be/seKOq-VMJgY)

If there are multiple image files used in the MD or JN file they should be named with the short name and appended with ‘_fig1’, ‘_fig2’, etc. to give unique names. Figures 1 and 2 in the example above are named ‘...excel_fig1.png’ and ‘...excel_fig2.png’ respectively.