forked from JabRef/jabref-koppor
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #5 from JabRef/main
updates
- Loading branch information
Showing
638 changed files
with
6,693 additions
and
5,817 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| --- | ||
| parent: Requirements | ||
| --- | ||
| # AI | ||
|
|
||
| ## User Interface | ||
|
|
||
| ### Chatting with AI | ||
| `req~ai.chat.new-message-based-on-previous~1` | ||
|
|
||
| To enable simple editing and resending of previous messages, <kbd>Cursor Up</kbd> should show last message. | ||
| This should only happen if the current text field is empty. | ||
|
|
||
| Needs: impl | ||
|
|
||
| <!-- markdownlint-disable-file MD022 --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| --- | ||
| nav_order: 7 | ||
| has_children: true | ||
| --- | ||
| # Requirements | ||
|
|
||
| This part of the documentation collects requirements using [OpenFastTrace](https://github.com/itsallcode/openfasttrace). | ||
|
|
||
| ## Specifying requirements | ||
|
|
||
| One writes directly below a Markdown heading a requirement identifier. | ||
|
|
||
| Example: | ||
|
|
||
| ```markdown | ||
| ### Example | ||
| `req~ai.example~1` | ||
| ``` | ||
|
|
||
| It is important that there is no empty line directly after the heading. | ||
|
|
||
| {: note} | ||
| One needs to add `<!-- markdownlint-disable-file MD022 -->` to the end of the file, because the id of the requirement needs to follow the heading directly. | ||
|
|
||
| ## Linking implementations | ||
|
|
||
| Then, one writes down at the requirement. | ||
| Directly at the end, one writes that it requires an implementation: | ||
|
|
||
| ```markdown | ||
| Needs: impl | ||
| ``` | ||
|
|
||
| One can also state that there should be detailed design document (`dsn`). | ||
| However, typically in JabRef, we go from the requirement directly to the implementation. | ||
|
|
||
| Then, at the implementation, a comment is added this implementation is covered: | ||
|
|
||
| ```java | ||
| // [impl->req~ai.example~1] | ||
| ``` | ||
|
|
||
| When executing the gradle task `traceRequirements`, `build/tracing.txt` is generated. | ||
| In case of a tracing error, one can inspect this file to see which requirements were not covered. | ||
|
|
||
| ## More Information | ||
|
|
||
| - [User manual of OpenFastTrace](https://github.com/itsallcode/openfasttrace/blob/main/doc/user_guide.md) | ||
| - We cannot copy and paste real examples here, because of [openfasttrace#280](https://github.com/itsallcode/openfasttrace/issues/280). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
scripts/vms/windows/README.md → scripts/vms/windows10/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
scripts/vms/windows/Vagrantfile → scripts/vms/windows10/Vagrantfile
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| # Windows 11 VM | ||
|
|
||
| A Windows-based VM to test JabRef. | ||
| As user, you need to ensure to have the proper Windows license to use this VM. | ||
|
|
||
| In case you have many CPU cores, you can adapt `vb.cpus` in `Vagrantfile` to a higher number. | ||
|
|
||
| One has to install the [JabRef Browser Extension](https://addons.mozilla.org/en-US/firefox/addon/jabref/) manually. | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| ### "Waiting for machine to reboot..." | ||
|
|
||
| In case Vagrant reports "Waiting for machine to reboot..." and nothing happens, one has to "power off" the machine, execute `vagrant destory`, and then run `vagrant up` again. | ||
|
|
||
| ### `fatal: early EOF` | ||
|
|
||
| ```console | ||
| jabref-windows-sandbox: Cloning into 'jabref'... | ||
| jabref-windows-sandbox: error: RPC failed; curl 92 HTTP/2 stream 5 was not closed cleanly: CANCEL (err 8) | ||
| jabref-windows-sandbox: error: 6846 bytes of body are still expected | ||
| jabref-windows-sandbox: fetch-pack: unexpected disconnect while reading sideband packet | ||
| jabref-windows-sandbox: fatal: early EOF | ||
| jabref-windows-sandbox: fatal: fetch-pack: invalid index-pack output | ||
| ``` | ||
|
|
||
| The `git clone` command did not work. | ||
|
|
||
| Login, open `cmd` and then execute following commands: | ||
|
|
||
| ```cmd | ||
| git clone --recurse-submodules https://github.com/JabRef/jabref.git | ||
| cd jabref | ||
| gradlew run | ||
| ``` | ||
|
|
||
| ## Background | ||
|
|
||
| `Vagrantfile` is based on [SeisoLLC/windows-sandbox](https://github.com/SeisoLLC/windows-sandbox/tree/main). | ||
|
|
||
| The most use image seems to be the [Windows 10 image by `gusztavvargadr`](https://portal.cloud.hashicorp.com/vagrant/discover/gusztavvargadr/windows-10). | ||
| List of all images at <https://portal.cloud.hashicorp.com/vagrant/discover/gusztavvargadr>. | ||
|
|
||
| [Chocolatey](https://chocolatey.org/) is used instead of [winget-cli](https://learn.microsoft.com/en-us/windows/package-manager/), because Chocolatey installation does not hit GitHub's rate limits during unattended installation. | ||
|
|
||
| ## Atlernatives | ||
|
|
||
| - Atlernative Vagrant images: <https://app.vagrantup.com/boxes/search?q=windows+10&utf8=%E2%9C%93>. | ||
| - [Windows Sandbox](https://learn.microsoft.com/en-us/windows/security/application-security/application-isolation/windows-sandbox/windows-sandbox-overview) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| # -*- mode: ruby -*- | ||
| # vi: set ft=ruby : | ||
|
|
||
| NAME = "jabref-windows-11-sandbox" | ||
|
|
||
| Vagrant.configure("2") do |config| | ||
| # config.vm.box = "Caden/windows-11-pro-jp-22h2-22621.1992" | ||
| config.vm.box = "stromweld/windows-11" | ||
|
|
||
| config.vm.define NAME | ||
| config.vm.hostname = NAME | ||
|
|
||
| config.vm.provider "virtualbox" do |vb| | ||
| vb.name = NAME | ||
|
|
||
| vb.memory = 6000 | ||
| vb.cpus = 2 | ||
|
|
||
| vb.customize ['modifyvm', :id, '--clipboard-mode', 'bidirectional'] | ||
| vb.gui = true | ||
| end | ||
|
|
||
| config.vm.provision "shell", privileged: "true", powershell_elevated_interactive: "true", inline: <<-SHELL | ||
| # Install chocolatey | ||
| Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1')) | ||
| choco feature enable -n=allowGlobalConfirmation | ||
| choco install libericajdk | ||
| choco install git.install -y --params "/GitAndUnixToolsOnPath /WindowsTerminal /WindowsTerminalProfile" | ||
| # Required by AI functionaltiy | ||
| choco choco install vcredist140 | ||
| # choco install firefox | ||
| # choco install libreoffice-fresh | ||
| SHELL | ||
|
|
||
| config.vm.provision "shell", reboot: true | ||
|
|
||
| config.vm.provision "shell", privileged: "false", inline: <<-SHELL | ||
| cd \\users\\vagrant | ||
| git clone --depth=1 --recurse-submodules https://github.com/JabRef/jabref.git | ||
| # cd jabref | ||
| # .\\gradlew jar | ||
| SHELL | ||
| end |
Oops, something went wrong.