Papers and Contributions Course
Welcome to the Papers and Contributions Course! This course is for you, if you want to add or edit paper content for the ORKG. Additionally, we will show you some Dos and Don’ts for how you can semantically model your paper’s contributions.
Course Introduction
As the scientist that you are, you know what a scientific paper is. You know that this is the format in which most of scientific communication takes place and that thousands upon thousands of these papers are published every year. You also know that it is very tedious work to skim through them looking for a particular piece of information. With the ORKG, we aim at making this easier for you: We want to describe the scholarly knowledge of scientific papers in a structured manner. This makes the information machine-actionable and FAIR.
This is what a paper looks like in the ORKG:
-
These are some options that you have, when working with ORKG papers. A more detailed explanation of them can be found here.
-
This is the paper metadata, such as title, authors, DOI, publication date and venue.
-
Here, you can find additional ORKG related metadata, such as who initially added the paper to the ORKG and who contributed to its contents over time, as well as the Observatory it belongs to.
-
These are the paper’s contributions. A paper can have more than one scientificly relevant contribution, e.g. answers multiple research questions or deals with multiple research problems. In the ORKG each contribution data is shown in its own tab.
-
Here, you can find the actual contents of the contributions. This is the structured and machine-actionable data of paper contents. These are [modelled semantically]. On the left side, you find the properties, while on the right side are the values of these properties. If the values are displayed in an orange colour and are clickable, the values are resources, otherwise the value is called a literal.
Actions for ORKG papers
Access paper: This menu gives you the option to access the paper on pages outside of the ORKG. This includes, e.g. the publisher’s page or the TIB AV portal.
Discussion: If you want to comment on a paper and its contributions in any way, you can do that here.
Edit: This button takes you to the edit mode for that paper. This way, you can add or change contribution data or add more contributions for that paper.
Publish: You can publish your ORKG paper with a DOI. This way, your work is preserved permanently and cannot be changed.
View Graph: You can inspect the underlying knowledge graph of any paper in the ORKG. If you want to learn more about this tool, have a look here.
View Resource: An ORKG paper is also saved as a resource of the ORKG. More about resources can be found in this article.
About adding papers into the ORKG
There are many good reasons why you should contribute to the ORKG and there are mainly two ways of doing so.
One way is, to add the paper manually. This is the standard way of adding papers to the ORKG and you can do this with any published paper. You just need to be signed in and be able to provide some metadata for your paper.
The other way is for you, if you author a paper yourself that you then plan of adding to the ORKG. This way is utilizing SciKGTeX, our LaTeX package that makes it easy for any author of scientific papers to annotate their paper with ORKG properties in the process of writing the paper. This has the benefit that you can naturally integrate the ORKG in your existing workflow which keeps the overhead of work to a minimum.
Adding papers to the ORKG manually
To add a paper manually to the ORKG, you need to go through the following steps:
-
First, click on View > Add paper on the ORKG main page.
-
This leads you to the add paper wizard. The goal of this step is to enter the metadata of your paper into the ORKG. If you have a DOI, you can enter it in the respective field and click on Lookup. Then, the ORKG will automatically fetch all metadata for you. If you don’t have a DOI for your paper, you can enter it manually. In either case, you will need to choose the research field of your paper. If all the metadata is complete, you can click on Add paper and continue with the next step.
-
You are now on the paper’s page in the ORKG in edit mode. Now begins the most important part of the work. Below, you can see a screenshot of said page with the most important parts marked with a red frame.
-
These are the contributions. Your paper will alwas start with the default contribution Contribution 1. If you click on the pen icon, you can change the name of the contribution to something more meaningful. You can also add Contributions here by clicking on the plus icon to the right of this line.
-
Here, you can add properties to fill in your contribution with data. If you need help with modelling your paper’s contents for the ORKG, you can have a look here. Alternatively, you can also use a template to enter your data.
-
Here, we suggest four very general properties that are present in many research papers. If they also fit for your paper, you can simply add them by clicking on them here.
Once you’ve added all relevant information, you can end editing by clicking on Stop editing on the top right.
Adding papers to the ORKG with SciKGTeX
What is SciKGTeX
Scientific Knowledge Graph TeX (SciKGTeX) is a LaTeX package that allows annotating research contributions according to the ORKG schema directly in the TeX source code. Having a PDF file compiled from the annotated TeX source, the annotation is embedded into the PDF’s XMP metadata. It persists there for the lifetime of the document and can be retrieved by anyone who obtains the PDF document. Additionally, the contributions can easily be added automatically to the ORKG.
How to install SciKGTeX
You can use the Overleaf template to start making your own metadata annotations right away! In case of manual installation, you need to copy the files scikgtex.lua and scikgtex.sty from the package repo to your LaTeX projekt and to set
\usepackage[compatibility]{scikgtex}
in your document preamble.
How to annotate with SciKGTeX
The SciKGTeX annotation includes three commands for bibliographic properties:
-
\metatitle{..},
-
\metaauthor{..},
-
\researchfield{..}.
And five commands for contribution properties:
-
\researchproblem{..},
-
\objective{..},
-
\method{..},
-
\result{..},
-
\conclusion{..}.
Moreover, there are additional options, such as contribution numbering, invisible markup, referring to entities, and defining custom properties, see the package documentation. Finally, for the package to work you have to compile a PDF document from your TeX source with LuaLaTeX compiler.
How to import a with SciKGTeX annotated paper into the ORKG
Papers annotated with SciKGTeX can be imported into the ORKG via the add-paper tool with the PDF option:
-
Click on Add new > Paper on the ORKG main page.
-
Now, click on Upload PDF. This opens a pop up window that lets you upload a PDF of your paper via drag and drop.
-
Next, the ORKG extracts the paper’s metadata. You can double check their correctness and if you are satisfied, click on Next step.
-
Then, you will need to add a research field to the paper. If you have chosen the research field click on Next step.
-
Finally, you will see the contribution data of your SciKGTeX annotations of your paper. You can now edit the data or add more information to the ORKG paper. Once you are satisfied, click on Finish.
-
If everything worked correctly, you will see a page that confirms the addition of your paper to the ORKG and a button that leads you to the page of this paper.
This video shows the process with an example paper:
Next steps
-
Start getting active: Take a paper, preferably one of your own, and head over to the ORKG. Use one of the two ways described above to enter your paper into the ORKG.
-
The ORKG can also be used to compare knowledge from scientific papers. Learn all about his in our Comparison Course.