add overview for translations

pull/427/head
kalleen 2018-09-23 15:46:29 +02:00
rodzic 684828de5f
commit ebea26d05a
32 zmienionych plików z 401 dodań i 31 usunięć

Wyświetl plik

@ -20,14 +20,14 @@ We are using the [Minimal Mistakes Theme](https://mmistakes.github.io/minimal-mi
### Basic File Structure
* `_posts` news
* `_docs` documentation
* `_tutorials` tutorial main pages
* `_tutorial` specific tutorials
* `_developers` developers documentation
* `_pages` static pages such as about, terms or sitemap
* `assets` media files (images) and website styling (css)
* `_data/navigation.yml` data for every navigation found in the website
* `_collections/_posts/language` news
* `_collections/_docs/language` documentation
* `_collections/_tutorials/language` tutorial main pages
* `_collections/_tutorial/language` specific tutorials
* `_collections/_developers/language` developers documentation
* `_pages/language` static pages such as about, terms or sitemap
* `assets/language` media files (images) and website styling (css)
* `_data/navigation_language.yml` data for every navigation found in the website
### Changing Existing Files
Change the content as you wish. Style your text with [markdown](https://help.github.com/articles/basic-writing-and-formatting-syntax/), which is also used with github issues, etc.

Wyświetl plik

@ -0,0 +1,84 @@
{%- assign page_lang = '/en' -%}
{% for lang in site.languages %}
{% if lang[0] != blank %}
### {{ lang[1] }}
{% for collection in site.collections %}
{% assign label = collection.label %}
#### {{ label | capitalize }}
{%- assign pages = collection.docs | where: "lang", "en" -%}
{%- for post in pages -%}
{%- if label == 'posts' -%}
{%- assign page_url = post.url | replace_first: page_lang, '' -%}
{%- assign new_url = '/' | append: lang[0] | append: page_url -%}
{%- assign lang_page = collection.docs | where: "url", new_url | where_exp: "item", "item.lang != 'en'" | where_exp: "item", "item.date < post.date" -%}
{%- if lang_page == blank -%}
{%- assign missing_lang = collection.docs | where: "url", new_url -%}
{% if missing_lang == blank %}
- New: {{ post.date | date: '%Y-%m-%-d' }} - [{{ post.title }}]({{ post.url }})
{% endif %}
{%- endif -%}
{%- else -%}
{%- assign page_url = post.permalink | replace_first: page_lang, '' -%}
{%- assign new_url = '/' | append: lang[0] | append: page_url -%}
{%- assign lang_page = collection.docs | where: "permalink", new_url | where_exp: "item", "item.lang != 'en'" | where_exp: "item", "item.last_modified_at < post.last_modified_at" -%}
{%- if lang_page == blank -%}
{%- assign missing_lang = collection.docs | where: "url", new_url -%}
{% if missing_lang == blank %}
- New: {{ post.date | date: '%Y-%m-%-d' }} - [{{ post.title }}]({{ post.url }})
{% endif %}
{%- endif -%}
{%- endif -%}
{% for please_update in lang_page %}
{% if label == 'posts' %}
{%- assign permalink = please_update.url -%}
{%- assign post_permalink = post.url -%}
{%- assign modified_at = please_update.date -%}
{%- assign post_modified_at = post.date -%}
{% else %}
{%- assign permalink = please_update.permalink -%}
{%- assign post_permalink = post.permalink -%}
{%- assign modified_at = please_update.last_modified_at -%}
{%- assign post_modified_at = post.last_modified_at -%}
{% endif %}
- {{ please_update.path }}
|---|---|
|{{ modified_at | date: "%Y-%m-%-d" }}|[{{ please_update.title }}]({{ permalink }})|
|{{ post_modified_at | date: "%Y-%m-%-d" }}|[{{ post.title }}]({{ post_permalink }})|
{% endfor %}
{%- endfor -%}
{% endfor %}
#### Pages
{% assign pages = site.pages | where: "lang", "en" | where_exp: "item", "item.last_modified_at != blank" %}
{% for post in pages %}
{%- assign page_url = post.permalink | replace_first: page_lang, '' -%}
{%- assign new_url = '/' | append: lang[0] | append: page_url -%}
{%- assign lang_page = site.pages | where: "permalink", new_url | where_exp: "item", "item.lang != 'en'" | where_exp: "item", "item.last_modified_at < post.last_modified_at" -%}
{% for please_update in lang_page %}
- {{ please_update.path }}
|---|---|
|{{ please_update.last_modified_at }}|[{{ please_update.title }}]({{ please_update.permalink }})|
|{{ post.last_modified_at }}|[{{ post.title }}]({{ post.permalink }})|
{% endfor %}
{%- if lang_page == blank -%}
{%- assign missing_lang = site.pages | where: "url", new_url -%}
{% if missing_lang == blank %}
- New: {{ post.date | date: '%Y-%m-%-d' }} - [{{ post.title }}]({{ post.url }})
{% endif %}
{%- endif -%}
{% endfor %}
{% endif %}
{% endfor %}

Wyświetl plik

@ -15,7 +15,6 @@ A list of all the posts and pages found on the site. For you robots out there is
{% for collection in site.collections %}
{% unless collection.output == false or collection.label == "posts" %}
{{ collection.blubb }}
{% capture label %}{{ collection.label }}{% endcapture %}
{% if label != written_label %}
<h1 style="border-bottom: 1px solid gray; margin-top: 1.5em;">{{ label }}</h1>

Wyświetl plik

@ -1,7 +1,7 @@
---
title: "Get Involved"
permalink: /de/developers/introduction/
last_modified_at: 2018-07-21
last_modified_at: 2018-07-20
toc: false
---
This section will provide information for developers, translators and documenters.

Wyświetl plik

@ -1,7 +1,7 @@
---
title: "Developing Ink/Stitch"
permalink: /de/developers/inkstitch/
last_modified_at: 2018-07-21
last_modified_at: 2018-07-20
toc: true
---
## Ink/Stitch Organization

Wyświetl plik

@ -1,7 +1,7 @@
---
title: "Manual Setup"
permalink: /de/developers/inkstitch/manual-setup/
last_modified_at: 2018-07-21
last_modified_at: 2018-07-20
toc: false
---
A manual setup will allow you to edit the code while running the extension.

Wyświetl plik

@ -1,7 +1,7 @@
---
title: "Python Modules"
permalink: /de/developers/inkstitch/python-modules/
last_modified_at: 2018-07-22
last_modified_at: 2018-07-10
toc: false
---
Ink/Stitch uses various Python modules. Follow the links to learn more about specific ones. Bold modules are not part of the standard python library and are also listed in the `requirement.txt` file. The ones being displayed in cursive style belong to the [Inkscape Python modules for extensions](http://wiki.inkscape.org/wiki/index.php/Python_modules_for_extensions).

Wyświetl plik

@ -2,7 +2,7 @@
title: "Documentation"
permalink: /de/developers/documentation/
excerpt: ""
last_modified_at: 2018-07-21
last_modified_at: 2018-07-20
---
We want to describe every possible function with text, images and/or videos. Also provide instructions about the installation process and give an overview of the best workflow. Additionally we want to provide sample files which other users can make use of. It also would be nice to get some example images of embroidered designs to prove what Ink/Stitch is able to do.

Wyświetl plik

@ -2,7 +2,7 @@
title: "Ink/Stitch Localization"
permalink: /de/developers/localize/
excerpt: ""
last_modified_at: 2018-04-14
last_modified_at: 2018-04-10
toc: false
---
The goal of the Ink/Stitch project is to put free, high-quality embroidery design tools in the hands of folks that might normally not have access to such tools. To further that goal, we seek to support as many languages and locales as possible.

Wyświetl plik

@ -2,7 +2,7 @@
title: "Report Bugs "
permalink: /de/developers/report-bugs/
excerpt: ""
last_modified_at: 2018-06-05
last_modified_at: 2018-06-01
---
**Having Issues with Ink/Stitch?**

Wyświetl plik

@ -2,15 +2,134 @@
title: "Documentation"
permalink: /developers/documentation/
excerpt: ""
last_modified_at: 2018-07-21
last_modified_at: 2018-09-23
toc: true
---
We want to describe every possible function with text, images and/or videos. Also provide instructions about the installation process and give an overview of the best workflow. Additionally we want to provide sample files which other users can make use of. It also would be nice to get some example images of embroidered designs to prove what Ink/Stitch is able to do.
An other and quiet unfinished part of the documentation will be, to help other developers to get started diving into the code. Enable them to introduce new functionalities to Ink/Stitch or whatever they might come up with.
An other and yet quiet incomplete part of the documentation will be, to help other developers to get started diving into the code. Enable them to introduce new functionalities to Ink/Stitch or whatever they might come up with.
## Get involved
This website needs a lot of care. Generating new content and updating existing content with the ongoing developement of Ink/Stitch. We could use any helpful hand.
This website needs a lot of care. Generating new content and updating existing content with the ongoing developement of Ink/Stitch. We could use any helping hand.
You do not need to know how to build a website, since we use [Markdown](https://help.github.com/articles/basic-writing-and-formatting-syntax/) for text formatting. More information about the documentation project can be found in the [README](https://github.com/inkstitch/inkstitch/tree/gh-pages) file on github. That is also where you will find all files needed to build this website.
You do not need to know how to build a website, since we use [Markdown](https://help.github.com/articles/basic-writing-and-formatting-syntax/) for text formatting. All files needed to build the website can be found in the [gh-pages-branch](https://github.com/inkstitch/inkstitch/tree/gh-pages) GitHub.
If you have interest to help with the documentation, file an issue on [github](https://github.com/inkstitch/inkstitch/issues) and tell us, that you are willing to help.
## Working with Github-Pages
Github-Pages make use of [Jekyll](https://jekyllrb.com/), a static page generator. It is also possible to install it locally for test purposes. For instructions see their website.
We are using the [Minimal Mistakes Theme](https://mmistakes.github.io/minimal-mistakes/), with very little customizations.
### Basic File Structure
* `_collections/_posts/language` news
* `_collections/_docs/language` documentation
* `_collections/_tutorials/language` tutorial main pages
* `_collections/_tutorial/language` specific tutorials
* `_collections/_developers/language` developers documentation
* `_pages/language` static pages such as about, terms or sitemap
* `assets/language` media files (images) and website styling (css)
* `_data/navigation_language.yml` data for every navigation found in the website
### Changing Existing Files
Change the content as you wish. Style your text with [markdown](https://help.github.com/articles/basic-writing-and-formatting-syntax/), which is also used with github issues, etc.
Before saving the file, please also change the date on top of the page.
### Adding New Files
#### Docs, Tutorials, Developers
When adding new pages please be aware of the file name numbering (docs and tutorials).
Numbers are set to be able to use previous/next links below the article. They also fit to the sidebar menu structure, which you also should update when adding new sites.
Changing file names will not prevent the website from finding the files, since they use permalinks. So you can go ahead and change the numbers to your needs.
Every page should start with something like this:
```
---
title: "Some Title"
permalink: /unique/permalink
excerpt: "Small description what the document is about"
last_modified_at: yyyy-mm-dd # e.g. 2018-05-05
toc: true # set to false or delete if you don't wish to display a table of contents
---
```
#### Posts (News)
Post file names follow a certain structure, they should be named like this: yyyy-mm-dd-title.md
Every post should start with the following entry:
```
---
title: "Some News"
date: yyy-mm-dd
categories: news-category
---
```
### Additional Functions
#### Galleries
Adding galleries has become really simple: upload files into a new folder within `/assets/images/galleries/`.
Then add:
{% raw %}
```
{% include folder-galleries path="new-folder-name/" %}
```
{% endraw %}
where ever you want to display a gallery containing `new-folder-name`s content.
If you want to provide preview images for faster loading, add -th to filename. E.g. `image.jpg` would use `image-th.jpg` as it's preview. Both files have to be in the same folder as specified in the include statement.
#### Categorising tutorials
Tutorial files in `_tutorial` folder should contain some keywords in the header to describe the particular tutorial. This could look like this:
```
---
permalink: /tutorials/applique/
title: Applique
last_modified_at: 2018-05-11
excerpt: "Applique example file"
image: "/assets/images/tutorials/samples/Applique Color Change.svg"
language: en
tutorial-type:
- Sample File
- Text
stitch-type:
- Running Stitch
- Fill Stitch
- Satin Stitch
techniques:
- Applique
field-of-use:
user-level: Beginner
---
```
These categories then can be used to list tutorials with a specific keyword, e.g.
{% raw %}
```
{% include tutorials/tutorial_list key="stitch-type" value="Fill Stitch" %}
```
{% endraw %}
would display a list of all tutorial files which have fill stitch specified in their header.
They can also be used to display a full list of categories. In this case categories need to be specified by every call of tutorial lists. Example:
{% raw %}
```
{% assign tutorial_cats = 'Tutorial Type*Stitch Type*Techniques*Field Of Use*User Level' | split: '*' %}
{% include tutorials/display_tutorials tutorial_cats=tutorial_cats %}
```
{% endraw %}

Wyświetl plik

@ -3,7 +3,7 @@ title: "Ink/Stitch Localization"
permalink: /developers/localize/
excerpt: ""
last_modified_at: 2018-04-14
toc: false
toc: true
---
The goal of the Ink/Stitch project is to put free, high-quality embroidery design tools in the hands of folks that might normally not have access to such tools. To further that goal, we seek to support as many languages and locales as possible.
@ -24,3 +24,11 @@ Approved contributors can accept your translations, which causes them to be subm
When new code is added to ink/stitch, user-facing text can change and new messages can be added. CrowdIn picks these changes up automatically and makes the new messages available to translators.
When CrowdIn creates a pull request, our [Travis-CI](http://travis-ci.org) integration (also generously provided for free!) picks up the new translations and builds a new version of Ink/Stitch as a development release. Once Travis-CI finishes building, the new version is posted to our releases page [here](https://github.com/inkstitch/inkstitch/releases/tag/dev-build-l10n), and you can install it and make sure everything looks right before we merge.
## Localize Ink/Stitch Website
This website is multilingual. When you are willing to translate the documentation please ask for directions on [GitHub](https://github.com/inkstitch/inkstitch/issues).
If your native language is already translated, you might want to have a look at the list below. The list contains pages which are not translated yet or will need an update.
{% include compare_translations %}

Wyświetl plik

@ -24,6 +24,8 @@ Shortcut Keys | Effect
**r** | restart animation
**q** | close
It is also possible to zoom and pan the simulation with the mouse.
## Run Simulator Independently
Run the simulator by itself on any supported embroidery file:

Wyświetl plik

@ -0,0 +1,9 @@
---
layout: single
title: "Video Demo on how to use the extension"
date: 2017-12-06 06:00:00 -0600
categories: Tutorial
---
{% include video id="qXntE1X1RIw" provider="youtube" %}

Wyświetl plik

@ -0,0 +1,8 @@
---
layout: single
title: "Video Demo of the New Live Stitch Preview Feature"
date: 2018-01-01 06:00:00 -0600
categories: Tutorial
---
{% include video id="QY9NcLN3oJM" provider="youtube" %}

Wyświetl plik

@ -0,0 +1,9 @@
---
layout: single
title: "Default DPI changed to 96, to match Inkscape."
date: 2018-01-05 00:00:00 -0600
categories: Releases
---
Default DPI changed to 96, to match Inkscape.

Wyświetl plik

@ -0,0 +1,12 @@
---
layout: single
title: "Want to help translate?"
date: 2018-02-05 06:00:00 -0600
categories:
- Get involved
- Releases
---
February 5, 2018: Portuguese (pt_PT) translation added!
[Want to help translate](/docs/help/localize/)?

Wyświetl plik

@ -0,0 +1,9 @@
---
layout: single
title: "Windows Support Added"
date: 2018-02-22 00:00:00 -0600
categories: Releases
---
Get the [latest release](https://github.com/lexelby/inkstitch/releases/latest).

Wyświetl plik

@ -0,0 +1,14 @@
---
layout: single
title: "Documentation Website"
date: 2018-04-15 00:00:00 -0600
categories:
- Information
- Get involved
---
We created a new website to help you understand Ink/Stitch.
If you already have an understanding of it, you are welcome to help us.
More information: [#121](https://github.com/lexelby/inkstitch/issues/121)

Wyświetl plik

@ -0,0 +1,31 @@
---
layout: single
title: "Ink/Stitch Version 1.7.1 released"
date: 2018-05-05 00:00:00 -0600
categories: Releases
---
## [v1.7.1: Merge pull request #162 from lexelby/lexelby-fix-palette-crash](https://github.com/lexelby/inkstitch/releases/tag/v1.7.1) ##
* handle case where no palette is used
## v1.7.0: enhanced printing and thread manufacturer palettes ##
* thread palettes
* new extension to install Inkscape palettes for many manufacturers' thread catalogs
* Print extension uses thread names from the palette you chose
* (you can override the palette if necessary)
* more print-out customization
* set names for threads
* add operator notes for each color block
* choose your own branding icon
* drag and zoom stitch previews
* print-out customizations saved into the SVG
* certain settings can also be saved as global defaults
* deprecated 0.5px running stitch
* previously, a stroke width of 0.5px told Ink/Stitch to use running stitch
* this still works but results in a deprecation warning
* instead, set a dashed stroke to signify running stitch
* any kind of dashes will do

Wyświetl plik

@ -0,0 +1,15 @@
---
layout: single
title: "Ink/Stitch v1.8.0: simplified extension packaging"
date: 2018-05-20
categories: Releases
---
Please fully delete Ink/Stitch from your extensions directory before installing this version.
{: .notice--warning}
Ink/Stitch was previously a set of separate scripts, each implementing an extension in a one-to-one correspondence. Now all of the extensions are implemented by a single python script. This is an "under-the-hood" only change that should not have any noticeable effects.
There is one big visible improvement: the zip for Linux is one third of the previous size!
[Download](https://github.com/lexelby/inkstitch/releases/tag/v1.8.0){: .btn .btn--primary .btn--large }

Wyświetl plik

@ -0,0 +1,21 @@
---
layout: single
title: "Ink/Stitch v1.8.1: Several Bugfixes"
date: 2018-05-30
categories: Releases
---
**Changelog:**
* add STOP commands as stand-alone stitches rather than attaching to an existing stitch
* PES requires this, along with possibly other formats
* fixes #170
* ignore "TRIM after" at the end of a color block
* the machine will trim the thread anyway
* fixed two bugs in running stitch
* the bugs:
* the first stitch was duplicated
* the last stitch was omitted
* these bugs totally screwed up tie-in/tie-off stitches!
* don't do ties around the fake color change of a "STOP after"
* add a JUMP at the start of each color block
[Download](https://github.com/lexelby/inkstitch/releases/tag/v1.8.1){: .btn .btn--primary .btn--large }

Wyświetl plik

@ -0,0 +1,15 @@
---
layout: single
title: "Ink/Stitch v1.8.2: A Few Little Things"
date: 2018-06-08
categories: Releases
---
**Changelog:**
* add "expand" option for fills to complement "inset" for fill underlay
* don't crash on empty subpaths
* some paths from AI would trigger this crash
* add examples:
* monogram
* free-standing lace
[Download](https://github.com/lexelby/inkstitch/releases/tag/v1.8.2){: .btn .btn--primary .btn--large }

Wyświetl plik

@ -0,0 +1,15 @@
---
layout: single
title: "Ink/Stitch v1.9.0: Realistic Rendering in Print Preview"
date: 2018-06-10
categories: Releases
---
**Changelog:**
Huge new feature: **realistic rendering**!
When printing, select the "Realistic" checkbox to switch a preview image to realistic thread
rendering. Note that rendering can take awhile, so don't be surprised if the view doesn't change for 10-20 seconds. Gives equally good results in "print to PDF" or direct printing. Realistic images are
rendered at 600dpi.
[Download](https://github.com/lexelby/inkstitch/releases/tag/v1.9.0){: .btn .btn--primary .btn--large }

Wyświetl plik

@ -1,6 +1,6 @@
---
title: Das Inkscape Logo sticken
permalink: /tutorials/lex-neva-video-tutorial-1/
permalink: /de/tutorials/lex-neva-video-tutorial-1/
last_modified_at: 2018-05-11
language: de
excerpt: Das ist ein Screencast wie man die Ink/Stitch nutzen kann, um ein Stickdesign zu erstellen.

Wyświetl plik

@ -1,7 +1,7 @@
---
title: Free Standing Lace - Schmetterling
permalink: de/tutorials/fsl/
last_modified_at: 2018-08-06
permalink: /de/tutorials/fsl/
last_modified_at: 2018-08-05
language: de
excerpt: Free Standing Lace - Schmetterling
image: "/assets/images/tutorials/samples/Bfly FSL.svg"

Wyświetl plik

@ -1,7 +1,7 @@
---
title: Fransen
permalink: /de/tutorials/fringe/
last_modified_at: 2018-05-11
last_modified_at: 2018-05-10
language: de
excerpt: "Fringe example file"
image: "/assets/images/tutorials/samples/Fringe Example.svg"

Wyświetl plik

@ -1,7 +1,7 @@
---
title: Stickrahmen Template
permalink: /de/tutorials/resources/hoop-template/
last_modified_at: 2018-05-23
last_modified_at: 2018-05-20
language: de
excerpt: "Template for multiple hoop sizes"
image: "https://user-images.githubusercontent.com/11083514/40359689-87495ec8-5dbb-11e8-8ef9-80d4fac89d72.png"

Wyświetl plik

@ -1,7 +1,7 @@
---
permalink: /de/tutorials/resources/inkstitch-logo/
title: "Ink/Stitch Logo & Branding Guide"
last_modified_at: 2018-06-21
last_modified_at: 2018-06-20
language: de
excerpt: "Ink/Stitch logo as SVG file, digitized version and branding guide."
toc: true

Wyświetl plik

@ -1,7 +1,7 @@
---
title: Monogram
permalink: /de/tutorials/monogram/
last_modified_at: 2018-08-06
last_modified_at: 2018-08-01
language: de
excerpt: "Monogram Frame Example"
image: "/assets/images/tutorials/samples/Monogram Frame Example.svg"

Wyświetl plik

@ -1,7 +1,7 @@
---
title: "Puff"
permalink: /tutorials/puff/
last_modified_at: 2018-05-11
permalink: /de/tutorials/puff/
last_modified_at: 2018-05-10
language: de
excerpt: Puff example file
image: /assets/images/tutorials/samples/PuffRegular.svg

Wyświetl plik

@ -1,7 +1,7 @@
---
title: Zugausgleich
permalink: /de/tutorials/push-pull-compensation/
last_modified_at: 2018-05-30
last_modified_at: 2018-05-20
language: de
excerpt: Push/Pull Compensation
image: /assets/images/tutorials/embroidery/push-pull-effect.svg