What about creating a FAQ?
We could develop it progressively, based on the questions asked on the mailing list.

https://sourceforge.net/p/jabref/wiki/Main_Page/

When running the Swedish translation, JabRef looks for Swedish help pages. It would be great if a link pointing to the English (or available languages) showed up instead of the 404.

It would be cool to have script or whatever to automatically add the new untranslated page links to the other language index files.
This should be relative simple by just checking if the pagename is already present in the other language files. That would also work for non Latin-Languages like Japanese.

Currently the help pages for each index have to be adapted manually

Refs JabRef/jabref#1928

Can be removed, I think.

Among the various pages, some of them probably contain wrong URL.
Is there a mechanism to have the list of such URL (and the pages which contain them)?
(I guess this question is also valid for www.jabref.org)

In JabRef/jabref#1876 two new fields are introduced anykeyword and anyfield. Also see JabRef/jabref#1633 for some comments. I think a good idea would be to simply add more examples and possibly also list the pseudo fields in a table.

Gh Pages updated to jekyll 3.3:
https://github.com/blog/2277-what-s-new-in-github-pages-with-jekyll-3-3

I'll add a link to the forum on the main Help-Pages of each language.

Another idea: Shall we add a link "Need more help? Visit the forum" to the general template next to " Back to table of contents" and "Edit this page"?

Some content should be imported automatically or generated by the build script. This includes the importFormat example and the translation status. See #11 for a bit more context and some pointers to how this can be achieved.

Currently, the FAQ is hosted here: http://www.jabref.org/faq/
My position is that the FAQ should be part of the help index (help.jabref.org).

Since JabRef 3.7, DOI-, Diva- and ISBN-to-BibTeX are not under WebSearch anymore.
They are now in BibTeX --> New entry...

Help files should be updated accordingly.

While the table is correctly shown at
https://github.com/JabRef/help.jabref.org/blob/gh-pages/en/MedlineRIS.md
it is not at
http://help.jabref.org/en/MedlineRIS

Could not find a syntax error...

Firefox 48 & Chromium 52

Currently, ScienceDirect is not part of the web fetchers anymore, but may be sometimes (see JabRef/jabref#1258). Hence, the help file (https://github.com/JabRef/help.jabref.org/blob/gh-pages/en/ScienceDirect.md) was kept out of the index (http://help.jabref.org/en/).

Following the introduction of the automatization script, the help file is now listed in the index.

Refs JabRef/jabref#1651

Most help files have the suffix Help, while some do not. See for instance https://github.com/JabRef/help.jabref.org/tree/gh-pages/fr

I would propose to remove the Help suffix completely at all help files.

It would be nice to have guidelines describing how to move from Endnote, Mendeley, etc., to JabRef

In http://help.jabref.org/en/DatabaseProperties , section "Override default file directories":
what is the difference between "general file directory" and "user-specific file directory"?

It would be good if we had an instant search for the help. Currently not possible using gh-pages. Proposals at stackoverflow: http://stackoverflow.com/a/28553417/873282

automate.py should sort the contents of each section alphabetically in the English index.md and then use that sort order for the other language files.

For instance, instead of

Autosave
Backup
The JabRef main window
Best Practices
Command line use and options
The entry editor
Installation
JabRef
Remote operation

There should be

Autosave
Backup
Best Practices
Command line use and options
Installation
JabRef
Remote operation
The entry editor
The JabRef main window

The help page about custom import filters (http://help.jabref.org/en/CustomImports) has a section dedicated to Creating an import filter. It seems (partly ?) outdated:

• The example is given for JabRef 2.0 and JSDK 1.4 .
• Another procedure is described here https://github.com/JabRef/custom-imports

Additionally, the first sentence ("For examples and some helpful files on how to build your own importer, please check our download page") is about an unspecified download page...

Help pages should be available as early as possible. Since we have help pages for non-released features (e.g., #108), they could be merged if the header showed since which version this help is valid.

"valid-for" could be an alternative, but it seems harder to maintain. Maybe "valid-since" is a good compromise to cover changed functionality , too.
#92 can be implemented in parallel.

Some help pages are really out of date.

I suggest to:

1. label them by indicating at the top of the page if the content is deprecated, up-to-date, etc.
2. set priorities for updating the pages
3. inform translators when a new page is considered up-to-date, and so worth translating

I could work on it. But before I start, if you have any suggestions, they are very welcome!

#130

As 2016-11-02 1539 EDT fetching article information from Medline fails with blank message dialog pops up then another message dialog with "no references found".

JabRef version: 3.6 release

The test target: https://www.ncbi.nlm.nih.gov/pubmed/15325740/

The test was performed during NCBI secure website test, see also https://www.ncbi.nlm.nih.gov/home/bulletins/https-tests.shtml

See JabRef/jabref#1931

Key field (not bibtex key!) -> BIBTEX_Key
Number -> number if not entry is patent and not issue is present

The code example is not valid (e.g. Util.createNeutralId()). Also, there are references to SourceForge.

Finally, are there any existing custom importers that we would like to add directly to JabRef?

If/when JabRef/jabref#1894 is merged, there are two new modifiers for keys: title which converts to title case and camel which converts to camel case.

camel is what was requested in JabRef/jabref#1506 but title may be useful in combination with abbr. For example, An awesome paper on JabRef will become AnAwesomePaperOnJabref with camel, AnAwesomePaperonJabref with title, AAPOJ with camel:abbr, and AAPoJ with title:abbr.

Refs JabRef/jabref#1876

Added two new pseudo-fields for search: anykeyword to search for a specific keyword and anyfield to search in all fields (useful in combination with search in specific fields)

In particular, with respect to the new telemetry collection we should add a short privacy statement.

Examples:

• Vivaldi
• Microsoft
• Google
• Firefox

Add a video explaining following steps:

1. Add entry using the DOI (Web Search -> DOI to BibTeX)
2. Drag'n'drop the PDF into the preview panel of the entry
3. JabRef then asks to rename the PDF according to the bibtex data

The page https://github.com/JabRef/help.jabref.org/blob/gh-pages/en/TranslatingGUI.md introduced a section "Contributing".
While it was merged 25 days ago, the index does not list this page nor the section "Contributing".

Is it a bug, or does the update of the index needs to be triggered manually?

Benutzerdefiniete (Export / Importfilter) sollte

Benutzerdefinierte heißen

Ref JabRef/jabref#1899

• Link to Custom Layout

I do not think the support for custom formatters is working anymore (typical indication: add a formatter without adding it to the huge switch in LayoutEntry leads to no formatter found). Maybe we should confirm that and remove the help text and remaining code.

Or even better: get it back working again.

Refs JabRef/jabref#1144 JabRef/jabref#1114 and more importantly a PR I cannot find where the support was removed.

Describe the export format and which bibtex/biblatex fields are mapped to which xml fields

JabRef/jabref#1765
Refs: JabRef/jabref#1765

At least until 3.6 is released pages should be available under both names.

(See JabRef/jabref#1704)

JabRef/jabref#1731 http://help.jabref.org/en/CustomImports

The ImportFormat constructor now has a mandatory argument ImportFormatPreferences importFormatPreferences which provides some information to the custom import format.

Hence, we need to add a constructor to the example code:

public SimpleCSVImporter(ImportFormatPreferences importFormatPreferences) {
    super(importFormatPreferences);
}

and add some explanation of the preferences that are of (general) interest. Those are

• Charset getEncoding() returns the encoding set in the preferences.
• String getKeywordSeparator() returns the keyword separator. For example, this can be used as an argument to bibEntry.addKeywords(...);
• BibtexKeyPatternPreferences getBibtexKeyPatternPreferences() returns the BibtexKeyPatternPreferences for generating keys with BibtexKeyPatternUtil.makelLabel(...);

Maybe one should update the example to add some examples of the use of these?

I am planning to create a file about how to translate the help files. Steps described below.

Issue: how to avoid to have a quasi-duplicate of https://github.com/JabRef/help.jabref.org/blob/gh-pages/CONTRIBUTING.md ?
Suggestion: the automate.py script should duplicate the file en/TranslatingHelp.md into CONTRIBUTING.md

1. Create a file https://github.com/JabRef/help.jabref.org/blob/gh-pages/en/TranslatingHelp.md
2. get and update information from
   https://github.com/JabRef/jabref/wiki/Translating-JabRef-Interface
   and
   https://github.com/JabRef/help.jabref.org/blob/gh-pages/CONTRIBUTING.md
3. Mention the specific status of index.md (It is generated by a script)
4. Status of translations: Mention script: https://github.com/JabRef/help.jabref.org/pull/77
5. Explain how to translate section headers (files like https://github.com/JabRef/help.jabref.org/blob/gh-pages/en/localization_en.json)

The current version of JabRef (3.3) does not include a help about the feature "Merge with DOI information".
A help file should be written. It should include the recent improvement (highlighting of differences in merge entries). See JabRef/jabref#1022.

To be done for the next version of JabRef (3.4)

On-hold for now.

Several (numerous?) features do not have an help page yet (e.g. Cleanup entries, Manage protected terms). How to foster their writing?

1. create an issue signaling the missing help page and calling for a contribution.
   or
2. create a help file with a message stating that a contribution is welcome.

I believe option 2 is preferable because:

• it will give more chance to find contributors.
• by counting the number of connections to the help page, we will know which help pages to write in priority (related to https://github.com/JabRef/help.jabref.org/issues/11)

Any thought?

To do...

Normally, relative links should work as expected. For instance, clicking "The JabRef main window" in http://help.jabref.org/en/JabRefHelp/ should lead to http://help.jabref.org/en/BaseFrameHelp/ and not to 404.

Possible solutions:

• Remove the trailing slash in the page names. (Meaning http://help.jabref.org/en/JabRefHelp as new name) This would invalidate all existing URLs, but enable consistent relative links (thereby reducing the efforts of the authors).
• Add some baseurl html magic in the header

I opt for the first solution, as the URLs are then cleaner. I will try the next days. If I don't succeed, I will go for the section option. Any objections @JabRef/developers?

Save actions are introduced as a new feature. This should be documented.

The feature itself is not that complex, but the variety of formatters that are available are not documented. Hence, we need a short documentation for each formatter.

I just add this here as a useful resource:
The following web service allows to generate markdown tables, it also supports the conversion from a csv file.
http://www.tablesgenerator.com/markdown_tables

The title of the file fr/Autosave is very long (and the same as the first line after the frontmatter).
It should be fairly simple but as my french is a bit rusty I would let do it someone else.

Background: I need the correct title to generate the index files (#77)

Outdated help files are indicated in their source header with the line outdated: true. This causes a header box to be displayed (see http://help.jabref.org/en/FileLinks), asking for help and giving a direct link for edition.

When a help file is just a stub (because https://github.com/JabRef/help.jabref.org/issues/88), a similar header box should be added. The text in the header could be

Notice: This help page is just a stub. Please help us to develop this page on GitHub.

In the source header, the line could be stub: true

Saved from (now closed) issue #6