Skip to content

Commit 38f0b47

Browse files
garbastgarbast
committed
Improve documentation and prepare for new rendering
1 parent 292bfe3 commit 38f0b47

8 files changed

Lines changed: 150 additions & 5 deletions

File tree

‎Documentation/Includes.txt‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. This is 'Includes.txt'. It is included at the very top of each and
2+
.. every ReST source file in this documentation project (= manual).
3+
4+
.. role:: typoscript(code)
5+
6+
.. role:: ts(typoscript)
7+
:class: typoscript
8+
9+
.. role:: php(code)
10+
11+
.. highlight:: php
12+
13+
.. default-role:: code

‎Documentation/Index.rst‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
.. include:: Includes.txt
2+
3+
.. _start:
4+
5+
=========================================
6+
ew_llxml2xliff: Converting llxml to xliff
7+
=========================================
8+
9+
:Extension key:
10+
ew_llxml2xliff
11+
12+
:Version:
13+
|release|
14+
15+
:Language:
16+
en
17+
18+
:Description:
19+
Converting llxml to xliff
20+
21+
:Keywords:
22+
forDevelopers
23+
24+
:Copyright:
25+
2016-2019
26+
27+
:Author:
28+
evoWeb
29+
30+
:License:
31+
Open Content License available from http://www.opencontent.org/opl.shtml
32+
33+
:Rendered:
34+
|today|
35+
36+
The content of this document is related to TYPO3,
37+
a GNU/GPL CMS/Framework available from http://typo3.org
38+
39+
.. only:: html
40+
41+
.. tip::
42+
43+
:ref: `Sitemap`
44+
45+
**Table of Contents**
46+
47+
.. toctree::
48+
:maxdepth: 5
49+
:titlesonly:
50+
:glob:
51+
52+
Introduction/Index
53+
Installation/Index

‎Documentation/Installation/Index.rst‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
.. include:: ../Includes.txt
2+
3+
.. _installation:
4+
5+
============
6+
Installation
7+
============
8+
9+
10+
Download via Extension Manager
11+
------------------------------
12+
13+
In the TYPO3 Backend go to Admin Tools > Extensions. Change in the dropdown on
14+
the top left to 'Get Extensions', enter the extension key 'ew_llxml2xliff' in the
15+
text field below the headline 'Get Extensions' and hit go. In the result list
16+
install the extension by hitting the action for that.
17+
18+
19+
Download via Composer
20+
---------------------
21+
22+
Add evoweb/extender to the require in your composer.json like in the following
23+
example and run 'composer install'.
24+
25+
::
26+
27+
{
28+
"require": {
29+
"typo3/cms-core": "^10.0",
30+
"evoweb/ew-llxml2xliff": "*",
31+
}
32+
}
33+
34+
35+
Alternatively if you have an existing project with a configured composer.json you
36+
can add extender with the command by running 'composer require evoweb/ew-llxml2xliff'.

‎Documentation/Introduction/Index.rst‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
.. include:: ../Includes.txt
2+
3+
.. _introduction:
4+
5+
============
6+
Introduction
7+
============
8+
9+
10+
This Documentation was written for version 3.0.x of the extension.
11+
12+
13+
What does it do?
14+
----------------
15+
16+
17+
Converting llxml to xliff:
18+
~~~~~~~~~~~~~~~~~~~~~~~~~~
19+
20+
Provides a backend module to convert locallang.xml and locallang.php files
21+
to xliff. For every language, contained in the source file, an extra file gets created.
22+
23+
1. In the backend module select an extension to convert files for
24+
25+
2. Select the concrete file to convert
26+
27+
3. Confirm the conversion
28+
29+
After that the new file/s are created and can be added to git and the origin
30+
file can be deleted.

‎Documentation/Settings.cfg‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
[general]
2+
project = ew_llxml2xliff
3+
release = 3.0.1
4+
copyright = since 2016 by evoWeb
5+
6+
[html_theme_options]
7+
8+
github_branch = master
9+
github_repository = evoweb/ew-llxml2xliff
10+
11+
project_contact =
12+
project_discussions =
13+
project_home = https://github.com/evoweb/ew_llxml2xliff
14+
project_issues = https://github.com/evoweb/ew_llxml2xliff/issues
15+
project_repository = https://github.com/evoweb/ew_llxml2xliff

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Overview
1+
# ew_llxml2xliff
22
[![Build Status](https://travis-ci.org/evoWeb/ew_llxml2xliff.svg?branch=develop)](https://travis-ci.org/evoWeb/ew_llxml2xliff)
33

44
## Installation

‎composer.json‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@
44
"description": "Provides a backend module to convert locallang.xml and locallang.php files to xliff. For every language, contained in the source file, an extra file gets created.",
55
"homepage": "https://github.com/evoWeb/ew_llxml2xliff/",
66

7-
"license": [
8-
"GPL-2.0-or-later"
9-
],
7+
"license": "GPL-2.0-or-later",
108

119
"support" : {
1210
"issues" : "https://github.com/evoWeb/ew_llxml2xliff/issues"

‎ext_emconf.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
'author_email' => 'typo3@evoweb.de',
1010
'author_company' => 'evoWeb',
1111
'state' => 'stable',
12-
'version' => '3.0.0',
12+
'version' => '3.0.1',
1313
'constraints' => [
1414
'depends' => [
1515
'php' => '5.5.0-0.0.0',

0 commit comments

Comments
 (0)