s434730/RandomSec
3
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Mac instruction changes, autosave changes

Browse Source
This commit is contained in:
allanaaa 2021-01-14 13:12:21 -05:00
parent a54e86becc
commit 6fed414c09
4 changed files with 20 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/manual/columnediting.md
View File

@ -65,7 +65,7 @@ Through the <span class="menuItems">Add column by fetching URLs</span> function,
If you have a column of URLs and want to fetch the information that they point to, you can simply run the expression as `value`. If your column has, for example, unique identifiers for Wikidata entities (numerical values starting with Q), you can download the JSON-formatted metadata about each entity with
```
“https://www.wikidata.org/wiki/Special:EntityData/” + value + “.json”
"https://www.wikidata.org/wiki/Special:EntityData/" + value + ".json"
```
or whatever metadata format you prefer. Information about the format options in Wikidata can be found [here](https://www.wikidata.org/wiki/Wikidata:Data_access). The service you are fetching data from may have similar documentation on its provided options.

24
docs/docs/manual/installing.md
View File

@ -392,32 +392,12 @@ You can change this when you run OpenRefine from the terminal, by pointing to th
### Logs
OpenRefine does not currently output an error log, but because the OpenRefine console window is always open while OpenRefine runs in your browser, you can copy information from the console if an error occurs.
OpenRefine does not currently output an error log, but because the OpenRefine console window is always open (on Linux and Windows) while OpenRefine runs in your browser, you can copy information from the console if an error occurs.
<Tabs
groupId="operating-systems"
defaultValue="win"
values={[
{label: 'Mac', value: 'mac'}
]
}>
<TabItem value="mac">
You can access OpenRefine server logs from the terminal on Mac:
* Find the OpenRefine app/icon in Finder
* control-click on the icon and select “Show Package Contents” from the context menu that displays
* This should open a new Finder menu showing a folder called “Contents” - navigate into this folder then into the “MacOS” folder
* control-click on “JavaAppLauncher”
* Choose “Open With” from the menu, and select “Terminal”
Using a Mac, you can [run OpenRefine using the terminal](running#starting-and-exiting) in order to capture errors.
---
</TabItem>
</Tabs>
## Increasing memory allocation
OpenRefine relies on having computer memory available to it to work effectively. If you are planning to work with large datasets, you may wish to set up OpenRefine to handle it at the outset. By “large” we generally mean one of the following indicators:

19
docs/docs/manual/running.md
View File

@ -56,7 +56,14 @@ To exit OpenRefine, close all the browser tabs or windows, then navigate to the
<TabItem value="mac">
You can find OpenRefine in your Applications folder, or you can call it from the command line with `./refine`.
You can find OpenRefine in your Applications folder, or you can open it using Terminal.
To run OpenRefine using Terminal:
* Find the OpenRefine application / icon in Finder
* Control-click on the icon and select “Show Package Contents” from the context menu
* This should open a new Finder menu: navigate into the “MacOS” folder
* Control-click on “JavaAppLauncher”
* Choose “Open With” from the menu, and select “Terminal.”
To exit, close all your OpenRefine browser tabs, go back to the terminal window and press `Command` and `Q` to close it down.
@ -416,7 +423,7 @@ You can preserve your facets and filters for future use by copying a <span class
### History (Undo/Redo)
In OpenRefine, any activity that changes the data can be undone. Changes are tracked from the very beginning, when a project is first created. The change history of each project is saved with the project's data, so quitting OpenRefine does not erase the steps you've taken. When you restart OpenRefine, you can view and undo changes that you made before you quit OpenRefine.
In OpenRefine, any activity that changes the data can be undone. Changes are tracked from the very beginning, when a project is first created. The change history of each project is saved with the project's data, so quitting OpenRefine does not erase the steps you've taken. When you restart OpenRefine, you can view and undo changes that you made before you quit OpenRefine. OpenRefine [autosaves](starting#autosaving) your actions every five minutes by default, and when you close OpenRefine properly (using Ctrl + C). You can [change this interval](running#jvm-preferences).
Project history gets saved when you export a project archive, and restored when you import that archive to a new installation of OpenRefine.
@ -453,10 +460,14 @@ Not all operations can be extracted. Edits to a single cell, for example, can’
## Advanced OpenRefine uses
### Running OpenRefine's Linux version on a Mac
You can run OpenRefine from the command line in Mac by using the Linux installation package. We do not promise support for this method. Follow the instructions in the Linux section.
### Running as a server
:::caution
Please note that exposing an OpenRefine instance to the Internet is dangerous, as it gives anyone the ability to read and modify your projects and run arbitrary code on your computer. OpenRefine should at least be protected by an authenticating proxy.
Please note that if your machine has an external IP (is exposed to the Internet), you should not do this, or should protect it behind a proxy or firewall, such as nginx. Proceed at your own risk.
:::
By default (and for security reasons), OpenRefine only listens to TCP requests coming from localhost (127.0.0.1) on port 3333. If you want to share your OpenRefine instance with colleagues and respond to TCP requests to any IP address of the machine, start it from the command line like this:
@ -503,4 +514,4 @@ Some examples:
* And the same in Ruby: [Refine-Ruby](https://github.com/maxogden/refine-ruby)
* Another Python client library, by Paul Makepeace: [OpenRefine Python Client Library](https://github.com/PaulMakepeace/refine-client-py)
To look for other instances, search our Google Groups [for users](https://groups.google.com/g/openrefine) and [for developers](https://groups.google.com/g/openrefine-dev), where [these projects were originally posted](https://groups.google.com/g/openrefine/c/GfS1bfCBJow/m/qWYOZo3PKe4J).
To look for other instances, search our Google Groups [for users](https://groups.google.com/g/openrefine) and [for developers](https://groups.google.com/g/openrefine-dev), where [these projects were originally posted](https://groups.google.com/g/openrefine/c/GfS1bfCBJow/m/qWYOZo3PKe4J).

2
docs/docs/manual/starting.md
View File

@ -179,6 +179,8 @@ OpenRefine [saves all of your actions](running#history-undoredo) (everything you
It doesn’t, however, save your facets, filters, or any kind of view you may have in place while you work. This includes the number of rows showing, and any sorting or column collapsing you may have done. A good rule of thumb is: if it’s not showing in <span class="tabLabels">Undo/Redo</span>, you will lose it when you leave the project workspace.
Autosaving happens by default every five minutes. You can [change this preference by following these directions](running#jvm-preferences).
You can only save and share facets and filters, not any other type of view. To save current facets and filters, click <span class="menuItems">Permalink</span>. The project will reload with a different URL, which you can then copy and save elsewhere. This permalink will save both the facets and filters you’ve set, and the settings for each one (such as sorting by count rather than by name).
### Deleting projects