Skip to content

Commit

Permalink
Update help URLs
Browse files Browse the repository at this point in the history
  • Loading branch information
koppor committed Nov 14, 2019
1 parent 8f7188d commit 9fe45ed
Show file tree
Hide file tree
Showing 13 changed files with 26 additions and 37 deletions.
3 changes: 1 addition & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,4 @@
- [ ] Tests created for changes
- [ ] Manually tested changed features in running JabRef
- [ ] Screenshots added in PR description (for bigger UI changes)
- [ ] Ensured that [the git commit message is a good one](https://github.com/joelparkerhenderson/git_commit_message)
- [ ] Check documentation status (Issue created for outdated help page at [help.jabref.org](https://github.com/JabRef/help.jabref.org/issues)?)
- [ ] [Checked documentation](https://docs.jabref.org/): Is the information available and up to date? If not: Issue created at <https://github.com/JabRef/user-documentation/issues>.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ We refer to [GitHub issues](https://github.com/JabRef/jabref/issues) by using `#
- Change default icon for groups to a circle because a colored version of the old icon was hard to distinguish from its black counterpart.
- In the main table, the context menu appears now when you press the "context menu" button on the keyboard. [feature request in the forum](http://discourse.jabref.org/t/how-to-enable-keyboard-context-key-windows)
- We added icons to the group side panel to quickly switch between `union` and `intersection` group view mode https://github.com/JabRef/jabref/issues/3269.
- We use `https` for [fetching from most online bibliographic database](https://help.jabref.org/en/#-using-online-bibliographic-database).
- We use `https` for [fetching from most online bibliographic database](https://docs.jabref.org/import-using-online-bibliographic-database).
- We changed the default keyboard shortcuts for moving between entries when the entry editor is active to ̀<kbd>alt</kbd> + <kbd>up/down</kbd>.
- Opening a new file now prompts the directory of the currently selected file, instead of the directory of the last opened file.
- Window state is saved on close and restored on start.
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,9 @@ The [latest stable release is available at FossHub](https://www.fosshub.com/JabR

JabRef runs on any system equipped with the Java Virtual Machine (Java 11 or higher), which can be downloaded at no cost from [AdoptOpenDJK](https://adoptopenjdk.net/).
From JabRef 4.0 onwards, [JavaFX] support has to be installed.
- Windows: JabRef offers an installer, which also adds a shortcut to JabRef to your start menu. Please also see our [Windows FAQ](https://help.jabref.org/en/FAQwindows)
- Linux: Please see our [Installation Guide](http://help.jabref.org/en/Installation).
- Mac OS X: Please see our [Mac OS X FAQ](https://help.jabref.org/en/FAQosx).
- Windows: JabRef offers an installer, which also adds a shortcut to JabRef to your start menu. Please also see our [Windows FAQ](https://docs.jabref.org/faq/faqwindows)
- Linux: Please see our [Installation Guide](https://docs.jabref.org/general/installation).
- Mac OS X: Please see our [Mac OS X FAQ](https://docs.jabref.org/faq/faqosx).

In addition, JabRef can be downloaded as an executable `.jar` file.
Try to double click the `jar` file or execute the following command:
Expand All @@ -78,7 +78,7 @@ Try to double click the `jar` file or execute the following command:

We are thankful for any bug reports or other feedback.
If you have ideas for new features you want to be included in JabRef, [tell us in our forum](http://discourse.jabref.org/c/features)!
If you need support in using JabRef, please read [the documentation](https://help.jabref.org/) first and have a look at our [community forum](http://discourse.jabref.org/c/help).
If you need support in using JabRef, please read [the documentation](https://docs.jabref.org/) first and have a look at our [community forum](https://discourse.jabref.org/c/help).
You can use our [GitHub issue tracker](https://github.com/JabRef/jabref/issues) to file bug reports.

An explanation of donation possibilities and usage of donations is available at our [donations page](https://donations.jabref.org).
Expand Down
2 changes: 1 addition & 1 deletion docs/adr/0001-use-crowdin-for-translations.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The JabRef UI is offered in multiple languages. It should be easy for translator
* Use [Crowdin](http://crowdin.com/)
* Use [popeye](https://github.com/JabRef/popeye)
* Use [Lingohub](https://lingohub.com/)
* Keep current GitHub flow. See the [Step-by-step guide](https://github.com/JabRef/help.jabref.org/blob/d5569bebdb0e1de5c71401bbfba45311c19c80a8/en/TranslatingGUI.md#step-by-step-guide).
* Keep current GitHub flow. See the [Step-by-step guide](https://docs.jabref.org/faq/how-to-translate-the-ui).

## Decision Outcome

Expand Down
2 changes: 1 addition & 1 deletion docs/adr/0004-use-mariadb-connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Context and Problem Statement

JabRef needs to connect to a MySQL database.
See [Shared SQL Database](https://help.jabref.org/en/SQLDatabase) for more information.
See [Shared SQL Database](https://docs.jabref.org/collaborative-work/sqldatabase) for more information.

## Considered Options

Expand Down
2 changes: 1 addition & 1 deletion docs/adr/0005-fully-support-utf8-only-for-latex-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Context and Problem Statement

The feature [search for citations](https://github.com/JabRef/help.jabref.org/issues/210) displays the content of LaTeX files.
The feature [search for citations](https://github.com/JabRef/user-documentation/issues/210) displays the content of LaTeX files.
The LaTeX files are text files and might be encoded arbitrarily.

## Considered Options
Expand Down
10 changes: 1 addition & 9 deletions src/main/java/org/jabref/gui/help/HelpAction.java
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,7 @@ public HelpAction(HelpFile helpPage) {
}

public static void openHelpPage(HelpFile helpPage) {
String lang = Globals.prefs.get(JabRefPreferences.LANGUAGE);
StringBuilder sb = new StringBuilder("https://help.jabref.org/");

if (AVAILABLE_LANG_FILES.contains(lang)) {
sb.append(lang);
sb.append("/");
} else {
sb.append("en/");
}
StringBuilder sb = new StringBuilder("https://docs.jabref.org/");
sb.append(helpPage.getPageName());
JabRefDesktop.openBrowserShowPopup(sb.toString());
}
Expand Down
14 changes: 6 additions & 8 deletions src/main/java/org/jabref/logic/help/HelpFile.java
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,13 @@
/**
* This enum globally defines all help pages with the name of the markdown file in the help repository at Github.
*
* @see <a href=https://github.com/JabRef/help.jabref.org>help.jabref.org@github</a>
* @see <a href="https://github.com/JabRef/user-documentation">user-documentation@github</a>
*/
public enum HelpFile {
COMMAND_LINE(""),
//Empty because it refers to the TOC/index
CONTENTS(""),
ENTRY_EDITOR("EntryEditor"),
STRING_EDITOR("StringEditor"),
// empty string denotes that it refers to the TOC/index
CONTENTS(""), // this is always the index
ENTRY_EDITOR("general/entryeditor"),
STRING_EDITOR("setup/stringeditor"),
SEARCH("Search"),
GROUP("Groups"),
CONTENT_SELECTOR("ContentSelector"),
Expand Down Expand Up @@ -51,8 +50,7 @@ public enum HelpFile {
FETCHER_SCIENCEDIRECT(""),
DATABASE_PROPERTIES("DatabaseProperties"),
FIND_DUPLICATES("FindDuplicates"),
SQL_DATABASE_MIGRATION("SQLDatabaseMigration"),
SQL_DATABASE("SQLDatabase");
SQL_DATABASE_MIGRATION("collaborative-work/sqldatabasemigration");

private final String pageName;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
/**
* Fetch or search from PubMed <a href="http://www.ncbi.nlm.nih.gov/sites/entrez/">www.ncbi.nlm.nih.gov</a>
* The MedlineFetcher fetches the entries from the PubMed database.
* See <a href="http://help.jabref.org/en/MedlineRIS">help.jabref.org</a> for a detailed documentation of the available fields.
* See <a href="https://docs.jabref.org/import-export/medlineris">docs.jabref.org</a> for a detailed documentation of the available fields.
*/
public class MedlineFetcher implements IdBasedParserFetcher, SearchBasedFetcher {
private static final Logger LOGGER = LoggerFactory.getLogger(MedlineFetcher.class);
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/jabref/model/entry/Month.java
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ public String getShortName() {
*
* See <a href="https://github.com/JabRef/jabref/issues/263#issuecomment-151246595">Issue 263</a> for a discussion on that thing.
* This seems to be an <em>invalid</em> format in terms of plain BiBTeX, but a <em>valid</em> format in the case of JabRef.
* The documentation is available at the <a href="http://help.jabref.org/en/Strings">Strings help</a> of JabRef.
* The documentation is available at the <a href="https://docs.jabref.org/fields/strings">Strings help</a> of JabRef.
*
* @return Month in JabRef format
*/
Expand Down
2 changes: 1 addition & 1 deletion src/test/java/org/jabref/logic/help/HelpFileTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

public class HelpFileTest {

private final String jabrefHelp = "https://help.jabref.org/en/";
private final String jabrefHelp = "https://docs.jabref.org/";

@Test
public void referToValidPage() throws IOException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1715,7 +1715,7 @@ void parseYear() throws Exception {

@Test
void parseEntryUsingStringConstantsForTwoAuthorsWithEtAsStringConstant() throws ParseException {
// source of the example: https://github.com/JabRef/help.jabref.org/blob/gh-pages/en/Strings.md
// source of the example: https://docs.jabref.org/fields/strings
Collection<BibEntry> parsed = parser
.parseEntries("@String { kopp = \"Kopp, Oliver\" }" +
"@String { kubovy = \"Kubovy, Jan\" }" +
Expand All @@ -1731,7 +1731,7 @@ void parseEntryUsingStringConstantsForTwoAuthorsWithEtAsStringConstant() throws

@Test
void parseStringConstantsForTwoAuthorsHasCorrectBibTeXEntry() throws ParseException {
// source of the example: https://github.com/JabRef/help.jabref.org/blob/gh-pages/en/Strings.md
// source of the example: https://docs.jabref.org/fields/strings
Collection<BibEntry> parsed = parser
.parseEntries("@String { kopp = \"Kopp, Oliver\" }" +
"@String { kubovy = \"Kubovy, Jan\" }" +
Expand All @@ -1747,7 +1747,7 @@ void parseStringConstantsForTwoAuthorsHasCorrectBibTeXEntry() throws ParseExcept

@Test
void parseStringConstantsForTwoAuthors() throws ParseException {
// source of the example: https://github.com/JabRef/help.jabref.org/blob/gh-pages/en/Strings.md
// source of the example: https://docs.jabref.org/fields/strings
Collection<BibEntry> parsed = parser
.parseEntries("@String { kopp = \"Kopp, Oliver\" }" +
"@String { kubovy = \"Kubovy, Jan\" }" +
Expand Down
8 changes: 4 additions & 4 deletions src/test/java/org/jabref/model/entry/BibtexStringTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -97,28 +97,28 @@ public void getContentNeverReturnsNull() {

@Test
public void authorTypeCorrectlyDetermined() {
// Source of the example: https://help.jabref.org/en/Strings
// Source of the example: https://docs.jabref.org/fields/strings
BibtexString bibtexString = new BibtexString("aKopp", "KoppOliver");
assertEquals(BibtexString.Type.AUTHOR, bibtexString.getType());
}

@Test
public void institutionTypeCorrectlyDetermined() {
// Source of the example: https://help.jabref.org/en/Strings
// Source of the example: https://docs.jabref.org/fields/strings
BibtexString bibtexString = new BibtexString("iMIT", "{Massachusetts Institute of Technology ({MIT})}");
assertEquals(BibtexString.Type.INSTITUTION, bibtexString.getType());
}

@Test
public void otherTypeCorrectlyDeterminedForLowerCase() {
// Source of the example: https://help.jabref.org/en/Strings
// Source of the example: https://docs.jabref.org/fields/strings
BibtexString bibtexString = new BibtexString("anct", "Anecdote");
assertEquals(BibtexString.Type.OTHER, bibtexString.getType());
}

@Test
public void otherTypeCorrectlyDeterminedForUpperCase() {
// Source of the example: https://help.jabref.org/en/Strings
// Source of the example: https://docs.jabref.org/fields/strings
BibtexString bibtexString = new BibtexString("lTOSCA", "Topology and Orchestration Specification for Cloud Applications");
assertEquals(BibtexString.Type.OTHER, bibtexString.getType());
}
Expand Down

0 comments on commit 9fe45ed

Please sign in to comment.