Skip to content

Add documentation for SLR#333

Closed
DominikVoigt wants to merge 1 commit intoJabRef:masterfrom
DominikVoigt:add-documentation-for-slr
Closed

Add documentation for SLR#333
DominikVoigt wants to merge 1 commit intoJabRef:masterfrom
DominikVoigt:add-documentation-for-slr

Conversation

@DominikVoigt
Copy link
Copy Markdown
Contributor

This adds documentation for the new features introduced in PR JabRef/jabref#7124.

@@ -0,0 +1,59 @@
# Conducting automated cross-library search

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It would be cool if you could describe the feature in one or two sentences.
e.g. JabRef has the possibilty to do automatic cross library searches for systematic literature review...

@koppor
Copy link
Copy Markdown
Member

koppor commented Nov 26, 2020

Please also add a description how to work with git here.

## Providing a study file for automated search

To provide automated search JabRef needs the set of targeted digital libraries and the used queries.
To provide these a `study.bib` file, also called study definition, has to be created.
Copy link
Copy Markdown
Contributor

@mlep mlep Nov 26, 2020

Choose a reason for hiding this comment

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

How this file is created?
Do the specific entry types (@study, @SearchQuery, @Library) have to be created into JabRef by the user through "Options -> Customize entry types"?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Hey there!
In the current version, these entries are created manually :).
But as we will switch to YAML this will be irrelevant.

@DominikVoigt
Copy link
Copy Markdown
Contributor Author

I close this PR for now as the change to the YAML format makes this documentation incorrect until it is updated.

@koppor
Copy link
Copy Markdown
Member

koppor commented Jul 4, 2021

@DominikVoigt Could you create a follow-up PR (because JabRef/jabref#7625 is merged now)?

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants