Help of JabRef
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github Add templates for issues and PRs Dec 29, 2016
_includes Add flattr meta Dec 18, 2017
_layouts Use https for the web page Nov 12, 2016
_scripts integrate _scripts/README.md into README.md Jan 29, 2018
css Use Google Custom Search for searching Sep 16, 2016
de Automated update on RFC to BibTeX non-english pages Apr 27, 2018
en typo (#191) Jul 8, 2018
fr Automated update on RFC to BibTeX non-english pages Apr 27, 2018
in Automated update on RFC to BibTeX non-english pages Apr 27, 2018
ja Automated update on RFC to BibTeX non-english pages Apr 27, 2018
.editorconfig Set indent size to 2 Dec 18, 2016
.gitattributes fix typo & better way to ensure line endings Sep 28, 2016
.gitignore Refine .gitignore Apr 16, 2017
.travis.yml Update .travis.yml May 12, 2018
404.html Add initial 404 page May 4, 2016
CNAME Revert "Updating CNAME file" Sep 16, 2016
CONTRIBUTING.md Add link to automate.py explanation Sep 4, 2017
Gemfile Update gemfile to new github pages version Sep 22, 2017
LICENSE.md Set license to CC-BY-4.0 Sep 28, 2016
README.md Refine serving help Jan 31, 2018
_config.yml gems is now plugins May 12, 2018
cibuild.sh Enable building on Travis Mar 14, 2016
crowdin.yml Update Crowdin configuration file Nov 29, 2017
favicon.ico Add new favicon Sep 22, 2017
index.md Move status.md one level up and only link it from the index Dec 22, 2016
jabref.ico new icon Sep 22, 2017
status.md Automated update on RFC to BibTeX non-english pages Apr 27, 2018

README.md

JabRef Web-based Help Build Status

This repository is serves the content of https://help.jabref.org/.

Feel free to improve the page using the issue tracker or pull requests.
The help content is licensed under CC-BY-4.0

See also our guidelines and quick start guide on contributing.

Installation of Jekyll to check the page locally

Execute following steps:

  1. gem install bundler
  2. bundle install
  3. bundle exec jekyll serve --incremental

Now, the page is served locally at http://localhost:4000/.

Source: https://help.github.com/articles/using-jekyll-with-pages/#installing-jekyll.

Script overview

The script automate.py has following commands available (each can be shown when called with the help parameter -h on any of the positional parameters):

  • $ python _scripts/automate.py status [-e|--extended] [-m --markdown]

    • prints the current status to the console
    • [-e|--extended] prints the relevant pages (also applies to the markdown mode)
    • [-m --markdown] write the status int the markdown syntax and opens the file
  • $ python _scripts/automate.py update [-e|--extended]

    • updates all the redirecting pages and the index file of each language as well as the include pages
    • [-e|--extended] prints the relevant pages
  • $ python _scripts/automate.py clean [-e|--extended]

    • removes all the generated pages, the help site may not work afterwards
    • [-e|--extended] prints the deleted pages
  • $ python _scripts/automate.py removeHelpSuffix [-e|--extended]

    • removes from all help pages the Help suffix and creates redirects for them, this gets also called on each update
    • [-e|--extended] prints the renamed pages

Installation notes

Windows

  1. Open cmd.exe with administrative privileges
  2. Install Chocolatey

For using automate.py:

  1. choco install python2
  2. Switch back to normal command prompt
  3. c:\tools\python2\Scripts\pip install python-frontmatter

For using Jekyll:

  1. choco install ruby --version 2.4.3.1. choco pin add -n ruby. - install Ruby 2.4 as version 2.5 is currently not supported by Jekyll's gem bundle
  2. refreshenv - to have ridk in the path
  3. ridk install - to start installing Ruby Development Kit
  4. Choose option 3
  5. Now, bundle install should succeed.

In case there are Jekyll plugins required, do these steps [source, linked from https://github.com/benbalter/jekyll-remote-theme/issues/17#issuecomment-350818119]:

  1. Download curl-7.40.0-devel-mingw64.zip
  2. Extract curl-7.40.0-devel-mingw64.zip to c:\temp\curl-7.40.0-devel-mingw64
  3. Run gem install curb --platform=ruby -- --with-curl-lib=C:/temp/curl-7.40.0-devel-mingw64/bin --with-curl-include=C:/temp/curl-7.40.0-devel-mingw64/include
  4. Alternative to step 4: Copy libcurl.dll to c:\tools\ruby24\bin [source]

Note: On windows, this works with RubyInstaller, version 2.4. This installer is used when using chocolatey. The separate Development Kit installer is not required anymore. JRuby doesn't work as the C extensions were dropped.