search

semanticClimate / city-open-climate-reader

City - Open Climate Reader: A proof-of-concept prototype for a semanticClimate publication built on a Quarto / Jupyter Notebook model for computational publishing
https://semanticclimate.github.io/city-open-climate-reader/
MIT License
1 stars 3 forks source link

Manual Question and Answer Process #9

Open mrchristian opened 1 year ago

mrchristian commented 1 year ago
  1. Use question to search AR6 or AR5 content. The search seems to be best done in a completely manual way, i.e., use your familiarity with content and document navigation to find sections - working group names, chapter names, read table of contents, etc. Web searches, IPCC site searches, and in-PDF searches are not able to pinpoint exact document parts because of the PDF formats and poor document management on part of publishers, producers, etc.
  2. What is the criteria for finding a search result. Only a reasonable close match to an result / answer is needed, something that will make sense to the reader as this is only for demonstration purposes as a mock-up to show the value of the proposal of a search and reader compiler system.
  3. Add the document title, section name, and URL to your issue.
  4. Files can be editor in GitHub direct online or by editing locally and pushing back to Main.
  5. Copy the content direct into your questions Markdown file in Quarto, e.g., q2.qmd - you will need to add your own Markdown formatting and copy paste content from the sources doc. Add as much content as needed to make a complete read, most report content is made in stand along units. To start with keep things simple and we edit and add further formatting later. See the example here with the 'Renewable Energy' example.
  6. Citation information and titling of documents - once again with IPCC content this is difficult as titles are not clear and citation information is inconsistent, or contradictory, e.g., WGIII content is published by Cambridge University Press and is available on IPCC website with different publishing dates, citation information, and open access notices that are not supported by policies and licencing. Here is a style guide to deal with adding content, see the example here : a. Add a short title with ? to your Markdown file H1 to show in web ToC; b. Add question and result title as H2 to doc; Add citation information, if you are unsure about this ask on the issue, you can also use the Open Climate Knowledge Zotero Group to generate citations; and, then under Content add your article.
  7. Note you can preview your content in your local environment as a plain Markdown preview or a Quarto preview.
  8. You do NOT need to render your article this will be done by the publication manager. When done report the process complete to the publication manager.