Adding mostly-empty docs (#2892)

Skeleton and initial content for documentation
This commit is contained in:
allanaaa 2020-07-07 15:16:27 -04:00 committed by GitHub
parent 48b5918408
commit ab2ec8d28f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
35 changed files with 887 additions and 188 deletions

View File

@ -0,0 +1,102 @@
---
id: exploring
title: Exploring data
sidebar_label: Exploring data
---
## Overview
### Cell data types
* Automatic recognition; colours, etc.
* [https://github.com/OpenRefine/OpenRefine/wiki/Cell-Editing](https://github.com/OpenRefine/OpenRefine/wiki/Cell-Editing)
* What an error looks like
### Null vs empty string
* Viewing null values
### Rows vs. records
* Functions that matter to rows/records distinction
## Facets
### Overview
(Types of Facet views and their common controls such as dragging Facets, organizing, sub elements like include/exclude, edit, sort by, change, reset, etc.)
### Text facet
### Numeric facet
### Timeline facet
### Scatterplot facet
### Custom facets:
* Word facet
* Duplicates facet
* Numeric log facet
* Text-length facet
### Facet by star or blank or flag
## Filtering
### Overview
Applying (case sensitivity; applying multiple in succession), inverting, and removing
### Permalink function
### Export data function
(only current view)
### Regular expressions
## Sort and View
### Sort
### View: Collapsing (and expanding)
### Show/hide “null”
### Reordering columns

View File

@ -1,7 +0,0 @@
---
id: csv
title: Exporting to CSV/TSV
sidebar_label: CSV/TSV
---

View File

@ -1,6 +0,0 @@
---
id: gsheets
title: Exporting to Google Sheets
sidebar_label: Google Sheets
---

View File

@ -1,6 +0,0 @@
---
id: ods
title: Exporting to ODS
sidebar_label: ODS
---

View File

@ -0,0 +1,39 @@
---
id: exporting
title: Exporting your work
sidebar_label: Exporting
---
## Overview
## Export data
Note you will only export data in the current view - that is, with current filters and facets applied.
* TSV/CSV
* HTML table
* Excel (XLS or XLSX)
* ODF spreadsheet
* Google Sheets \
* Custom tabular export
* SQL
* Templating export \
* Upload edits to Wikidata
* Export to QuickStatement
* Export Wikidata schema
## Export a project
* tar.gz only
* Optional rename
* Local or to Google Drive
* Doesnt supply a Google Drive link, just gives a confirmation message
* Other user (or you on another computer) will need to download it and save it locally in order to import it

View File

@ -0,0 +1,57 @@
---
id: expressions
title: Expressions
sidebar_label: Expressions
---
## Overview
* Tipbox for regexp basics - link to a good guide
* Expression Editor
* Where to find it
## GREL (General Refine Expression Language)
* Variables and attributes
* Syntax and controls
* String functions
* Array functions
* Date functions
* Project functions
* Math functions
_Content from_
[https://github.com/OpenRefine/OpenRefine/wiki/General-Refine-Expression-Language](https://github.com/OpenRefine/OpenRefine/wiki/General-Refine-Expression-Language)
[https://github.com/OpenRefine/OpenRefine/wiki/GREL-Functions](https://github.com/OpenRefine/OpenRefine/wiki/GREL-Functions)
[https://github.com/OpenRefine/OpenRefine/wiki/GREL-Other-Functions](https://github.com/OpenRefine/OpenRefine/wiki/GREL-Other-Functions)
etc.
## Jython
* Python syntax in OpenRefine
* Installing Python packages
## Clojure
* Clojure syntax in OpenRefine
* Using Java packages from Clojure

View File

@ -1,7 +0,0 @@
---
id: numeric
title: Numeric Facets
sidebar_label: Numeric
---
Numeric facets lets you inspect the distribution of numeric values in a column.

View File

@ -1,7 +0,0 @@
---
id: scatterplot
title: Scatterplot Facets
sidebar_label: Scatterplot
---

View File

@ -1,7 +0,0 @@
---
id: text
title: Text Facets
sidebar_label: Text
---
Text facets list the different values found in a column, with their occurence counts.

View File

@ -0,0 +1,5 @@
---
id: glossary
title: OpenRefine Glossary
sidebar_label: Glossary
---

View File

@ -1,6 +0,0 @@
---
id: cross
title: The cross function
sidebar_label: cross
---

View File

@ -1,6 +0,0 @@
---
id: facetCount
title: The facetCount function
sidebar_label: facetCount
---

View File

@ -1,6 +0,0 @@
---
id: toString
title: The toString function
sidebar_label: toString
---

View File

@ -1,7 +0,0 @@
---
id: csv
title: Importing CSV/TSV files
sidebar_label: CSV/TSV
---
Comma-Separated Values (CSV) and Tab-Separated Values (TSV) are widespread formats to represent tables.

View File

@ -1,7 +0,0 @@
---
id: json
title: Importing JSON files
sidebar_label: JSON
---
JSON (JavaScript Object Notation) is a hierarchical data format commonly used on the Web.

View File

@ -1,7 +0,0 @@
---
id: xml
title: Importing XML files
sidebar_label: XML
---

View File

@ -1,17 +0,0 @@
---
id: install
title: Installing OpenRefine
sidebar_label: Installing
---
OpenRefine is available for Windows, Mac OS and Linux. The install process depends on the platform.
# Windows
# Mac OS
# Linux
# Using Docker

View File

@ -0,0 +1,128 @@
---
id: installing
title: Installing OpenRefine
sidebar_label: Installing
---
## System requirements
* Java
* Browser
### Release versions
* Whats Changed (a plain language summary of major improvements only)
* Layman explainer of beta, RC, and final
* Beta
* Development version
* [Nightly releases](https://github.com/OpenRefine/OpenRefine-nightly-releases/releases)
* [Changelogs feed](https://github.com/OpenRefine/OpenRefine/releases)
* Other distributions
## Installing or upgrading
### Back up your data
* Windows
* Mac
* Linux
### Install/Upgrade
* Windows
* Mac
* Linux
### Where is data stored?
* Program directory
* Workspace directory
* Logs (error?)
## Increasing memory allocation
* Windows
* Mac
* Linux
## Installing extensions
Extensions have been created by our contributor community to add functionality or provide convenient shortcuts for common uses of OpenRefine. [We list extensions we know about on our downloads page](https://openrefine.org/download.html).
If you think youd like to create or modify an extension, [see our developer documentation here](https://github.com/OpenRefine/OpenRefine/wiki/Documentation-For-Developers). If youre having a problem, [use our downloads page](https://openrefine.org/download.html) to go to the extensions page and report the issue there.
### Two ways to install extensions
You can install extensions in one of two ways:
* [Into your OpenRefine program folder](installing.md#whereisdatastored), so they will only be available to that version/installation of OpenRefine (meaning the extension will not run if you upgrade OpenRefine), or
* Into your workspace, where your projects are stored, so they will be available no matter which version of OpenRefine youre using.
We provide these options because you may wish to reinstall a given extension manually each time you upgrade OpenRefine, in order to be sure it works properly.
### Find the right place to install
If you want to install the extension into the program folder, go to `OpenRefine/webapp/extensions` (or create it if not does not exist).
If you want to install the extension into your workspace, you can:
* launch OpenRefine and click “Open Project” in the sidebar
* At the bottom of the screen, click “Browse workspace directory”
* A file-explorer window will open in your workspace
* Create a new folder called “extensions” inside the workspace if it does not exist.
You can also [find your workspace on each operating system using these instructions](installing.md#whereisdatastored).
### Install the extension
Some extensions have their own instructions: make sure you read the documentation before you begin installing.
Some extensions may have multiple versions, to match OpenRefine versions, so be sure to choose the right release for your installation. If you have questions about compatibility or want to request or voice your support for an update, [use our downloads page](https://openrefine.org/download.html) to go to the extensions page and report the issue there.
Generally, the installation process will be:
* Download the extension (usually as a zip file from GitHub)
* Extract the zip contents into the `extensions` directory, making sure all the contents go into one folder with the name of the extension
* Start (or restart) OpenRefine.
To confirm that installation was a success, follow the instructions provided by the extension. Each extension will appear in its own way inside the OpenRefine interface: make sure you read the documentation to know where the functionality will appear, such as under specific dropdown menus.
## Advanced OpenRefine uses
### Running as a server
### Automating OpenRefine

View File

@ -1,7 +0,0 @@
---
id: add_column
title: Add Column Based on This Column
sidebar_label: Add Column
---
This operation lets you create a new column, whose values are computed using GREL or another expression language.

View File

@ -1,7 +0,0 @@
---
id: blank_down
title: Blank down
sidebar_label: Blank down
---

View File

@ -1,7 +0,0 @@
---
id: fill_down
title: Fill down
sidebar_label: Fill down
---

View File

@ -1,7 +0,0 @@
---
id: recon
title: Reconcile
sidebar_label: Reconcile
---
Reconciliation is the process of matching names to unique identifiers in third-party databases.

View File

@ -1,7 +0,0 @@
---
id: transform
title: Transforming Columns
sidebar_label: Transform
---
Transforming a column lets you derive new column values using expressions in GREL or other languages.

View File

@ -1,8 +0,0 @@
---
id: records_mode
title: The records mode
sidebar_label: Records mode
---

124
docs/docs/manual/running.md Normal file
View File

@ -0,0 +1,124 @@
---
id: running
title: Running OpenRefine
sidebar_label: Running
---
## Starting and exiting
* The window, multiple browser tabs, Ctrl-C, etc.
* Note that it runs offline - your data is private!
## The home screen
* Language Settings ( TIP: mention language stays set until changed by user in future)
* Preferences
* Command line options
* INI file options
## The project/work screen
Clicking the diamond (or on “OpenRefine")
(Dont click the browser back button!)
### Project title
### Open, Export, Help buttons
About metadata, Tags, Browse workspace, etc.
### The project header
Number of selected/ total rows/records, pagination, display rows
Rows vs. records
### Extensions dropdown
### The project grid
(or The grid, or The grid view, or The data grid, why have I seen so many different names for this)
### The project sidebar
#### Facet/Filter
Permalink
#### 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 undo/redo change history of each project is saved with the project's data, so quitting OpenRefine does not erase the history. When you restart OpenRefine, you can view and undo changes that you made before you quit OpenRefine.
Project history gets saved when you export a project archive, and restored when you import that archive to a new installation of OpenRefine.
![A screenshot of the History (Undo/Redo) tab with 5 steps.](img/history.jpg "A screenshot of the History (Undo/Redo) tab with 5 steps.")
##### Overview
When you click on “Undo / Redo” in the sidebar of any project, that projects history is shown as a list of changes in order, with the first "change" being the action of creating the project itself. (That first change, indexed as step zero, cannot be undone.) Here is a sample history with 3 changes:
```
0. Create project
1. Remove 7 rows
2. Create new column Last Name based on column Name by filling 67 rows with grel:value.split(" ")[1]
3. Split 230 cell(s) in column Address into several columns by separator
```
The current state of the project is highlighted with a dark blue background. If you move back and forth on the **_timeline_** you will see the current state become highlighted, while the actions that came after that state will be grayed out.
To revert your data back to an earlier state, simply click on the last action in the timeline you want to keep. In the example above, if we keep the removal of 7 rows but revert everything we did after that, then click on "Remove 7 rows." The last 2 changes will be undone, in order to bring the project back to state #1.
In this example, changes #2 and #3 will now be grayed out. You can redo a change by clicking on it in the history - everything up to and including it will be redone.
If you have moved back one or more states, and then you perform a new operation on your data, the later actions (everything thats greyed out) will be erased and cannot be re-applied.
The Undo/Redo tab will show you which step youre on, and if youre about to risk erasing work - by saying something like “4/5" or “1/7” at the end.
##### Reusing Operations
Operations that you perform in OpenRefine can be reused. For example, a formula you wrote inside one project can be copied and applied to another project later.
To reuse one or more operations, you first extract it from the project where it was first applied. Click to the Undo/Redo tab and click “Extract…”. This brings up a box that lists all operations up to the current state (it does not show undone operations). Select the operation or operations you want to extract using the checkboxes on the left, and they will be encoded as JSON on the right. Copy that JSON off to the clipboard.
Move to the second project, go to the Undo/Redo tab, click “Apply…” and paste in that JSON.
_Not all operations can be extracted. Edits to a single cell cant be replicated._
##### Known Issues
_If your project history is bigger than 100 MB (output file), Chrome will crash when you try to extract the JSON. Firefox can handle around 200 MB (output file). You may need to disable your spellchecker._
### Common extension buttons

View File

@ -0,0 +1,235 @@
---
id: starting
title: Starting a project
sidebar_label: Starting a project
---
## Overview
OpenRefine doesnt allow you to create a dataset from nothing - you can only start a project by importing in some existing data.
No matter where you pull in data from, OpenRefine doesnt modify your original data source. It copies all the information from your input, creates its own project file, and stores it in your [workspace directory](installing.md#whereisdatastored).
The data and all of your edits are automatically saved inside the project file. When youre finished modifying the data, you can export it back out into the file format of your choice.
You can also receive and open other peoples projects, or send them yours, by exporting a project archive and importing it.
## Create project by importing data
When you start OpenRefine, youll be taken to the `Create Project` screen. Youll see on the left side of the screen that your options are to:
* import data from a file on your computer
* import data from a link to the web
* import data by pasting in text from your clipboard
* import data from a database (using SQL), and
* import Sheets from Google Drive.
From these sources, you can load any of the following file formats:
* comma-separated values (CSV) or text-separated values (TSV)
* Text files
* Fixed-width columns
* JSON
* XML
* ODF spreadsheet (ODS)
* Excel (XLS or XLSX)
* PC-Axis
* MARC
* RDF data (JSON-LD, N3, N-Triples, Turtle, RDF/XML)
* Wikitext
More formats can be imported by [adding extensions that provide that functionality](https://openrefine.org/download.html).
For whichever method you choose, when you click `Next >>` you will be given a preview and a chance to configure the way OpenRefine interprets the file.
### Methods to import data
#### Get data from this computer
Click on `Browse…` and select a file on your hard drive. All files will be shown, not just compatible ones.
If you import an archive file (something with the extension `.zip`, `.tar.gz`, `.tgz`, `.tar.bz2`, `.gz`, or `.bz2`), OpenRefine detects the most common file extension in it and loads all files with that extension into a single project.
#### Web Addresses (URLs)
Type or paste the URL to the data file into the field provided. You can add as many fields as you want. OpenRefine will _____(something I havent quite figured out yet)______________________.
Do not use this form to load a Google Sheet by its link; use the Google Data form instead.
#### Clipboard
You can copy and paste in data from anywhere. OpenRefine will recognize comma-separated, tab-separated, or table-formatted information copied from sources such as word-processing documents, spreadsheets, and tables in PDFs. You can also just paste in a list of items that you want to turn into multi-column rows. OpenRefine recognizes each new text line as a row.
This can be useful if you want to pre-select a specific number of rows from your source data, or paste together rows from different places, rather than delete unwanted rows later in the project interace.
This can also be useful if you would like to paste in a list of URLs, which you can use later to fetch the data online and build columns with.
#### Database (SQL)
You may want to pull the latest dataset directly from an online database. This could include an online catalogue, a Wordpress or similar content management system, or a [digital repository or collection management system](https://bits.ashleyblewer.com/blog/2017/08/09/collection-management-system-collection/).
OpenRefine can connect to PostgreSQL, MySQL, MariaDB, and SQLite database systems. It will automatically populate the “Port” field based on which of these you choose, but you can manually edit this if needed.
To import data directly from a database online, you will need to do two things:
* Add OpenRefine (running from your computer) to an account authorized to access your database
* Set up OpenRefine to access that database using that account
![A screenshot of connecting to a database](img/databaseconnect.jpg "A screenshot of connecting to a database.")
Log in to your hosting provider. Get the database type (such as MySQL), database name, and the URL (either an IP address, such as `127.0.0.1`, or the domain that uses the database, such as _https://openrefine.org/category/blog.html_). Then look at the accounts authorized for access. You may wish to create a new account just for OpenRefine, or add OpenRefine to an existing account.
Each host will have a slightly different method, but generally speaking: look for “accounts with access” to the database you wish to authorize, and within the settings for that account, look for “allowable hosts” or “access hosts.”
In that list, add the IP address of your own computer, because that is where the OpenRefine access request will be coming from. You can find this easily, by clicking “Test” within OpenRefine once the rest of the information is filled out: OpenRefine will give you an error that looks like
``` error:Access denied for user 'yourusername'@'123-45-67-89.yourISP.com' ```
Take your IP address from this error message and put that, with periods instead of hyphens, into the “allowable hosts” field on the account youre trying to use. Add a wildcard to the end of your IP address (“123.45.67.89%”). Save that setting, and then test the connection again with OpenRefine.
You can either connect just once and gather data, or save the connection to use it again later. If you press “Connect” without saving, OpenRefine will forget all the information you just entered.
If youd like to save the connection, name your connection in a way you will recognize later. Click “Save” and it will appear in the “Saved Connections” list on the left. Now, click on the “...” ellipsis to the right of the connection youve saved, and click “Connect.”
If your connection is successful, you will see a Query Editor. From here you can write an [SQL query](https://www.w3schools.com/sql/) to pull the specific data you need.
If you need help, you may be able to find instructions from your hosting provider. Here are the guides from:
* [Dreamhost](https://help.dreamhost.com/hc/en-us/articles/214883058-How-do-I-connect-to-my-database-using-a-third-party-program-)
* [GoDaddy](https://ca.godaddy.com/help/connect-remotely-to-a-mysql-database-in-my-linux-hosting-account-16103)
#### Google Data
You have two ways to load in data from Google Sheets:
* A link to an accessible Google Sheet (that is, one with link-sharing turned on)
* Selecting a Google Sheet in your Google Drive
##### Google Sheet by URL
You can import data from any Google Sheet that has link-sharing turned on. Paste in a URL that looks something like
```https://docs.google.com/spreadsheets/……….../edit?usp=sharing```
This will only work with Sheets, not with any other Google Drive file that might have an available link.
##### Google Sheet from Drive
You can authorize OpenRefine to access your Google Drive data and import data from any Google Sheet it finds there. This will include Sheets that belong to you and Sheets that are shared with you, as well as Sheets that are in your trash.
OpenRefine will not show spreadsheets that are in your email inbox or stored in any other Google property - only in Drive. It also wont show all compatible file formats, only Sheets files.
OpenRefine will generate a list of all Sheets it finds, with the most recently modified Sheets at the top. If a file youve just added isnt showing in this list, you can close and restart OpenRefine, or simply navigate to an existing project, open it, then head back to the “Create Project” window and check again.
When you click “Preview” the Sheet will open in a new browser tab. When you click the Sheet title, OpenRefine will begin to process the data.
### Previewing the project
Once OpenRefine is ready to import the data, you will see a screen with “Configure Parsing Options” at the top. Youll see a preview of the first 100 rows and all identified columns.
At the bottom of the screen you will find options for telling OpenRefine how to process what it has found. You can tell it which row(s) to parse as column headers, as well as to ignore any number of rows at the top. You can also select a specific range of rows to work with, by discarding some rows at the top (excluding the header) and limiting the total number of rows it loads.
OpenRefine tries to guess how to parse your data based on the file extension. For example, .xml files are going to be parsed as though they are formatted in XML. An unknown file extension (or your clipboard copy-paste) is assumed to be either tab-separated or comma-separated. OpenRefine looks for a tab character; if one is found, it assumes you have imported tab-separated data.
If Google isnt certain what format you imported, it will provide a list of possibilities under “Parse data as” and some settings. You can specify a custom separator now, or split columns later on in the project interface.
If you imported a spreadsheet with multiple worksheets, they will be listed along with the number of rows they contain. You can only select data from one worksheet.
Note that OpenRefine does not preserve any formatting, such as cell or text colour, that my have been in the original data file.
You should create a project name at this stage. You can also supply tags to keep your projects organized. When youre happy with the preview, click “Create Project.”
## Import a project
### Overview
Because OpenRefine only runs locally on your computer, you cant have a project accessible to more than one person at the same time.
The best way to collaborate with another person is to export and import projects that save all your changes, so that you can pick up where someone else left off. You can also [export projects](export.md) and import them to new computers of your own, such as for working on the same project from the office and from home.
An exported project will include all of the [history](interface/projectscreen.md#history), so you can see (and undo) all the changes from the previous user. It is essentially a point-in-time snapshot of their work. OpenRefine only exports projects as `.tar.gz` files at this time.
### Instructions
Once someone has sent you a project archive file from their computer, you can save it anywhere, including your Downloads folder.
In the left-hand menu of the home screen, click “Import Project.” You will see the following screen:
![A screenshot of the Import screen](img/import.jpg "A screenshot of the Import screen.")
Click “Browse…” and navigate to wherever you saved the file you were sent (for example, your Downloads folder).
You can rename the project if youd like - we recommend adding your name, a date, or a version number, if youre planning to continue collaborating with another person (or working from multiple computers).
Then, click “Import Project.” Your project should appear with a step count beside “undo/redo” if steps were saved by the exporter.
OpenRefine will store the project in its own workspace directory, so you can now delete the original file that was sent to you.
## Project management
You can access all of your created projects by clicking on “Open Project.” Your project list can be organized by modification date, title, row count, and other metadata you can supply (such as subject, descripton, tags, or creator). To edit the fields you see here, click “About” to the left of each project. There you can Edit a number of available fields. You can also see the project ID that corresponds to the name of the folder in your work directory.
### Naming projects
You may have multiple projects from the same dataset, or multiple versions from sharing a project with another person. OpenRefine automatically generates a project name from the imported file, or “clipboard” when you use Clipboard importing. Project names dont have to be unique, so OpenRefine will create many projects with the same name unless you intervene.
You can name a project when you create it or import it, and you can rename a project by opening it and clicking on the project name at the top of the screen.
### Autosaving
OpenRefine saves all of your actions (everything you can see in the Undo/Redo panel). That includes flagging and starring rows.
It doesnt, 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, whether you are showing your data as rows or records, and any sorting or column collapsing you may have done. A good rule of thumb is: if its not showing in Undo/Redo, you will lose it when you leave the project workspace.
You can only save and share facets and filters, not any other type of view. To save current facets and filters, click “Permalink.” 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 youve set, and the settings for each one (such as sorting by count rather than by name).
### Deleting projects
You can delete projects, which will erase the project files from the work directory on your computer. This is immediate and cannot be undone.
Go to “Open Project” and find the project you want to delete. Click on the X to the left of the project name. There will be a confirmation dialog.
### Project files
You can find all of your raw project files in your work directory. They will be named according to the unique Project ID that OpenRefine has assigned them, which you can find on the “Open Project” screen, under the “About” button for each project.
You can point OpenRefine to use another work directory using [Preferences](running.md#preferences).

View File

@ -0,0 +1,118 @@
---
id: transforming
title: Transforming data
sidebar_label: Transforming data
---
# Transforming data
* Permanent “view” changes (not data changes, quite) like rearranging columns, removing columns, and renaming columns.
## Edit cells
### Overview
### Transform
* Transform…
* Common transforms
* Trim / Collapse
* Unescape
* Replace
* Case
* Data type
* To null/empty
### Fill down
### Blank down
### Split multi-valued cells...
### Join multi-valued cells...
### Cluster and edit...
### Replace
## Edit column
### Overview
### Split or Join
### Add column based on this column
### Add column by fetching URLs
### Add columns from reconciled values
### Rename or Remove
### Move
## Transpose
### Overview
### Transpose cells across columns into rows
### Transpose cells in rows into columns
### Columnize by key/value columns
## Reconcile
### Overview
### Sources
[https://github.com/OpenRefine/OpenRefine/wiki/Reconcilable-Data-Sources](https://github.com/OpenRefine/OpenRefine/wiki/Reconcilable-Data-Sources)
### Functions
* Match each cell to its best candidate
* Create a new item for each cell
* Create one new item for similar cells
* Match all filtered cells
* Discard all reconciliation judgments
* Clear reconciliation data
* Copy reconciliation data
* Use values as identifiers

View File

@ -0,0 +1,35 @@
---
id: troubleshooting
title: Troubleshooting
sidebar_label: Troubleshooting
---
## Frequently Asked Questions
We collect and share FAQs and responses on Github at [https://github.com/OpenRefine/OpenRefine/wiki/FAQ](https://github.com/OpenRefine/OpenRefine/wiki/FAQ). If you dont find your problem and solution there, continue on to the resources in the Community section to see more conversations and look for solutions.
## Community
If youre having a problem:
* Search the [User forum](https://groups.google.com/g/openrefine) to see if the problem is already reported
* Read [Github issues](https://github.com/OpenRefine/OpenRefine/issues) to see if the problem is already reported
* Read [Stack Overflow](https://stackoverflow.com/questions/tagged/openrefine) to see if the problem is already reported
* Check [Twitter](https://twitter.com/search?f=tweets&vertical=default&q=OpenRefine%20OR%20%22Open%20Refine%22%20OR%20%23OpenRefine&src=typd) to see if others are discussing the problem
* Report an issue:
* First as a new thread in the User forum
* Then, if you wish, you can create a Github issue
If you want to contribute:
* [We have a guide to contributing here.](https://github.com/OpenRefine/OpenRefine/blob/master/CONTRIBUTING.md)
* Contribute your feature requests in the User forum or as Github issues
* Share with us your successes and use cases in the User forum
* Add your blog posts, guides, tips, tricks, tutorials to our list
* Respond to our biennial user survey
* Join the User Forum and/or [Developer Forum](https://groups.google.com/g/openrefine-dev)

View File

@ -1,17 +0,0 @@
---
id: user_data
title: Backing Up Workspace Data
sidebar_label: Workspace Data
---
OpenRefine stores its workspace locally. The exact location depends on the operating system.
# Windows
# Mac OS
# Linux
# Using Docker

View File

@ -0,0 +1,33 @@
---
id: wikidata
title: Wikidata
sidebar_label: Wikidata
---
## Overview
* Former extension, now core [but you can remove it].
* Account required
## Features
* Edit Wikidata schema
* Manage Wikidata account
* Import schema
* Export schema
* Uploading edits to Wikidata
* QuickStatements export
* Schema alignment
* Issue detection
## More resources
[https://wdreconcile.toolforge.org/](https://wdreconcile.toolforge.org/)
[https://www.wikidata.org/wiki/Wikidata:Tools/OpenRefine](https://www.wikidata.org/wiki/Wikidata:Tools/OpenRefine)

View File

@ -1,38 +1,17 @@
module.exports = {
docs: {
'Getting Started': [
'User Manual': [
'index',
'manual/install',
'manual/user_data',
'manual/records_mode'
],
'Importing Data': [
'manual/importers/csv',
'manual/importers/json',
'manual/importers/xml'
],
'Operations': [
'manual/operations/transform',
'manual/operations/add_column',
'manual/operations/fill_down',
'manual/operations/blank_down',
'manual/operations/recon',
'manual/operations/key_value_columnize'
],
'Facets': [
'manual/facets/text',
'manual/facets/numeric',
'manual/facets/scatterplot'
],
'Exporters': [
'manual/exporters/csv',
'manual/exporters/gsheets',
'manual/exporters/ods'
],
'GREL': [
'manual/grel/cross',
'manual/grel/facetCount',
'manual/grel/toString'
'manual/installing',
'manual/running',
'manual/starting',
'manual/exploring',
'manual/transforming',
'manual/expressions',
'manual/wikidata',
'manual/exporting',
'manual/glossary',
'manual/troubleshooting'
],
'Technical Reference': [
'tech/architecture',

BIN
docs/static/img/databaseconnect.jpg vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

BIN
docs/static/img/history.jpg vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

BIN
docs/static/img/import.jpg vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB