Skip to content

Commit f99db2d

Browse files
tpetricektpetricek
committed
Update F# Formatting, add animated GIFs to homepage!
1 parent 9cfc4a1 commit f99db2d

24 files changed

+14895
-261
lines changed

‎docs/content/index.md

Lines changed: 57 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,70 @@
11
F# Data: Library for Data Access
22
================================
33

4-
The F# Data library (`FSharp.Data.dll`) implements everything you need to
5-
access data in your F# applications and scripts. It implements F# type
4+
The F# Data library implements everything you need to
5+
access data in your F# applications and scripts. It contains F# type
66
providers for working with structured file formats (CSV, JSON and XML)
7-
and for accessing the WorldBank and Freebase data. It also includes helpers for parsing
7+
and for accessing the WorldBank and Freebase services. It also includes helpers for parsing
88
JSON and CSV files and for sending HTTP requests.
99

10-
### Library philosophy
11-
12-
This library focuses on providing a simple read-only access to the structured documents
10+
This library focuses on providing a simple, mostly read-only, access to the structured documents
1311
and other data sources. It does not aim to be a comprehensive collection of F# type providers
1412
(which can be used for numerous other purposes). It's also designed to play well with other libraries
15-
like [Deedle](http://bluemountaincapital.github.io/Deedle), [F# R Type Provider](http://bluemountaincapital.github.io/FSharpRProvider), [F# Charting](http://fsharp.github.io/FSharp.Charting) and [FunScript](http://funscript.info).
16-
17-
### Library license
18-
19-
The library is available under Apache 2.0. For more information see the
20-
[License file][license] in the GitHub repository. In summary, this means that you can
21-
use the library for commercial purposes, fork it, and modify it as you wish.
22-
23-
<br/><hr/>
24-
25-
# How to get FSharp.Data
13+
like [Deedle](http://bluemountaincapital.github.io/Deedle), [R Type Provider](http://bluemountaincapital.github.io/FSharpRProvider),
14+
[F# Charting](http://fsharp.github.io/FSharp.Charting) and [FunScript](http://funscript.info).
15+
16+
### F# Data type providers in action
17+
18+
<div class="container-fluid" style="margin:15px 0px 15px 0px;">
19+
<div class="row-fluid">
20+
<div class="span1"></div>
21+
<div class="span10" id="anim-holder">
22+
<div id="wbtn" style="right:10px">WorldBank</div>
23+
<div id="jbtn" style="right:110px">JSON</div>
24+
<div id="cbtn" style="right:210px">CSV</div>
25+
<a id="lnk" href="images/start.png"><img id="anim" src="images/start.png" /></a>
26+
</div>
27+
<div class="span1"></div>
28+
</div>
29+
</div>
30+
<script type="text/javascript">
31+
$(function(){
32+
var wi = new Image();
33+
var ji = new Image();
34+
var ci = new Image();
35+
wi.src ='images/wb.gif';
36+
ji.src ='images/json.gif';
37+
ci.src ='images/csv.gif';
38+
$('#wbtn').click(function(){ $('#anim').attr('src',wi.src); $('#lnk').attr('href',wi.src); });
39+
$('#jbtn').click(function(){ $('#anim').attr('src',ji.src); $('#lnk').attr('href',ji.src); });
40+
$('#cbtn').click(function(){ $('#anim').attr('src',ci.src); $('#lnk').attr('href',ci.src); });
41+
});</script>
42+
43+
44+
### How to get F# Data
2645

2746
* The F# Data Library is available as <a href="https://nuget.org/packages/FSharp.Data">FSharp.Data on NuGet</a>.
28-
29-
* In addition to the official releases, you can also get NuGet packages from the [Continuous Integration package source](https://ci.appveyor.com/nuget/fsharp-data-q9vtdm6ej782).
47+
In addition to the official releases, you can also get NuGet packages from the [Continuous Integration
48+
package source](https://ci.appveyor.com/nuget/fsharp-data-q9vtdm6ej782).
3049

3150
* Alternatively, you can download the [source as a ZIP file][source] or download the [compiled binaries][compiled] as a ZIP. <br /> Please note that on windows when downloading a zip file with `dll` files the files will be blocked, and you have to manually unblock them in the file properties.
3251

33-
<br/><hr/>
3452

35-
# Using F# Data
53+
F# Data documentation and tutorials
54+
-----------------------------------
3655

3756
### F# type providers
3857

3958
The type providers for structured file formats infer the structure of a sample
4059
document (or a document containing multiple samples). The structure is then used
4160
to provide easy to use type-safe access to documents that follow the same structure.
42-
For more information see:
61+
The library also implements a type provider for accessing data from
62+
[the WorldBank](http://data.worldbank.org/) and [Freebase graph database](http://www.freebase.com/).
63+
4364

4465
* [XML Type Provider](library/XmlProvider.html) - discusses the `XmlProvider<..>` type
4566
* [JSON Type Provider](library/JsonProvider.html) - discusses the `JsonProvider<..>` type
4667
* [CSV Type Provider](library/CsvProvider.html) - discusses the `CsvProvider<..>` type
47-
48-
The library also implements a type provider for accessing data from
49-
[the WorldBank](http://data.worldbank.org/) and [Freebase graph database](http://www.freebase.com/).
50-
5168
* [WorldBank Provider](library/WorldBank.html) - discusses the `WorldBankData` type
5269
and the `WorldBankDataProvider<..>` type
5370
* [Freebase Provider](library/Freebase.html) - discusses the `FreebaseData` type
@@ -70,24 +87,32 @@ following topics:
7087
### Tutorials
7188

7289
The above articles cover all key features of the F# Data library. However, if you're interested
73-
in more samples or more details, then the following tutorials contain additional examples that use multiple different features together:
90+
in more samples or more details, then the following tutorials contain additional examples that
91+
use multiple different features together:
7492

7593
* [Converting between JSON and XML](tutorials/JsonToXml.html) - implements two serialization
7694
functions that convert between the standard .NET `XElement` and the `JsonValue` from F# Data.
7795
The tutorial demonstrates pattern matching on `JsonValue`.
78-
7996
* [Anonymizing JSON](tutorials/JsonAnonymizer.html) - implements a function to anonymize a `JsonValue` from F# Data.
8097
The tutorial demonstrates pattern matching on `JsonValue`.
8198

8299
### Reference Documentation
83100

84-
There's also [reference documentation](reference) available. Please note that everything under the `FSharp.Data.Runtime` namespace is not considered as part of the public API and can change without notice.
101+
There's also [reference documentation](reference) available. Please note that everything under
102+
the `FSharp.Data.Runtime` namespace is not considered as part of the public API and can change without notice.
85103

86-
<br/><hr/>
104+
Contributing and license
105+
------------------------
87106

88-
# Contributing
107+
The library is available under Apache 2.0. For more information see the
108+
[License file][license] in the GitHub repository. In summary, this means that you can
109+
use the library for commercial purposes, fork it, and modify it as you wish.
89110

90-
F# Data is made possible by the volunteer work [of more than a dozen contributors](https://github.com/fsharp/FSharp.Data/graphs/contributors) and we're open to contributions from anyone. If you want to help out but don't know where to start, you can take one of the [Up-For-Grabs](https://github.com/fsharp/FSharp.Data/issues?labels=up-for-grabs&state=open) issues, or help to improve the documentation.
111+
F# Data is made possible by the volunteer work [of more than a dozen
112+
contributors](https://github.com/fsharp/FSharp.Data/graphs/contributors) and we're open to
113+
contributions from anyone. If you want to help out but don't know where to start, you
114+
can take one of the [Up-For-Grabs](https://github.com/fsharp/FSharp.Data/issues?labels=up-for-grabs&state=open)
115+
issues, or help to improve the documentation.
91116

92117
The project is hosted on [GitHub][gh] where you can [report issues][issues], fork
93118
the project and submit pull requests. If you're adding new public API's, please also

‎docs/content/ja/index.md

Lines changed: 30 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,37 @@ F# Data ライブラリ (`FSharp.Data.dll`) にはF#アプリケーションや
99
また、JSONやCSVファイルを解析する機能や、
1010
HTTPリクエストを送信するための機能もあります。
1111

12-
<div class="row">
13-
<div class="span1"></div>
14-
<div class="span6">
15-
<div class="well well-small" id="nuget">
16-
F# Data Libraryは <a href="https://nuget.org/packages/FSharp.Data">NuGetの
17-
FSharp.Dataパッケージ</a>として公開されています。
18-
ライブラリをインストールするには、
19-
<a href="http://docs.nuget.org/docs/start-here/using-the-package-manager-console">
20-
パッケージ マネージャー コンソール</a>上から以下のコマンドを実行します：
21-
<pre>PM> Install-Package FSharp.Data</pre>
22-
</div>
23-
</div>
24-
<div class="span1"></div>
12+
<div class="container-fluid" style="margin:15px 0px 15px 0px;">
13+
<div class="row-fluid">
14+
<div class="span1"></div>
15+
<div class="span10" id="anim-holder">
16+
<div id="wbtn" style="right:10px">WorldBank</div>
17+
<div id="jbtn" style="right:110px">JSON</div>
18+
<div id="cbtn" style="right:210px">CSV</div>
19+
<a id="lnk" href="../images/start.png"><img id="anim" src="../images/start.png" /></a>
20+
</div>
21+
<div class="span1"></div>
22+
</div>
2523
</div>
26-
24+
<script type="text/javascript">
25+
$(function(){
26+
var wi = new Image();
27+
var ji = new Image();
28+
var ci = new Image();
29+
wi.src ='../images/wb.gif';
30+
ji.src ='../images/json.gif';
31+
ci.src ='../images/csv.gif';
32+
$('#wbtn').click(function(){ $('#anim').attr('src',wi.src); $('#lnk').attr('href',wi.src); });
33+
$('#jbtn').click(function(){ $('#anim').attr('src',ji.src); $('#lnk').attr('href',ji.src); });
34+
$('#cbtn').click(function(){ $('#anim').attr('src',ci.src); $('#lnk').attr('href',ci.src); });
35+
});</script>
36+
37+
F# Data Libraryは <a href="https://nuget.org/packages/FSharp.Data">NuGetの
38+
FSharp.Dataパッケージ</a>として公開されています。
39+
ライブラリをインストールするには、
40+
<a href="http://docs.nuget.org/docs/start-here/using-the-package-manager-console">
41+
パッケージ マネージャー コンソール</a>上から以下のコマンドを実行します：
42+
`Install-Package FSharp.Data`.
2743
あるいは [ソースコードをZIPファイルとしてダウンロード][source] したり、
2844
[コンパイル済みバイナリ][compiled] をZIPファイルとして
2945
ダウンロードすることもできます。

‎docs/content/styles/style.css

Lines changed: 0 additions & 193 deletions
This file was deleted.

0 commit comments

Comments
 (0)