Skip to content

Commit

Permalink
[Docs] change tasks md dir
Browse files Browse the repository at this point in the history
  • Loading branch information
@edigonzales
edigonzales committed Jan 29, 2025
1 parent 829999f commit e6c9a7c
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 44 deletions.
1 change: 1 addition & 0 deletions docs/user/publisher.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Publisher


GRETL-Task, welcher für Vektordaten die aktuellen Geodaten-Dateien
bereitstellt und das Archiv der vorherigen Zeitstände pflegt.

Expand Down
3 changes: 2 additions & 1 deletion gretl/build.gradle
View file
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,8 @@ processIntegrationTestResources {
javadoc {
source = sourceSets.main.allJava
title = null
destinationDir = file("./build/docs/tasks/")
//destinationDir = file("./build/docs/tasks/")
destinationDir = file("./src/docs/tasks/")

include 'ch/so/agi/gretl/tasks/**'
options.doclet = "ch.so.agi.gretl.doclet.GretlDoclet"
Expand Down
5 changes: 0 additions & 5 deletions gretl/src/docs/_quarto.yml
View file

This file was deleted.

2 changes: 1 addition & 1 deletion gretl/src/docs/publisher.qmd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Bei Problemen mit der Datenqualität der Originaldaten schlägt der Task "pubEdi

## Parameter

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.Publisher.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.Publisher.md >}}

## XTF -> XTF

Expand Down
74 changes: 37 additions & 37 deletions gretl/src/docs/reference.qmd
100755 → 100644
View file
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ tasks.register('transform', Av2ch) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.Av2ch.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.Av2ch.md >}}

### Av2geobau

Expand Down Expand Up @@ -194,7 +194,7 @@ tasks.register('av2geobau', Av2geobau) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.Av2geobau.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.Av2geobau.md >}}

### Csv2Excel (incubating)
Konvertiert eine CSV-Datei in eine Excel-Datei (*.xlsx). Datentypen werden anhand eines INTERLIS-Modelles eruiert. Fehlt das Modell, wird alles als Text gespeichert. Die Daten werden vollständig im Speicher vorgehalten. Falls grosse Dateien geschrieben werden müssen, kann das zu Problemen führen. Dann müsste die Apache POI SXSSF Implementierung (Streaming) verwendet werden.
Expand All @@ -213,7 +213,7 @@ tasks.register('convertData', Csv2Excel) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.Csv2Excel.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.Csv2Excel.md >}}

### CsvExport
Daten aus einer bestehenden Datenbanktabelle werden in eine CSV-Datei exportiert. Geometriespalten können nicht exportiert werden.
Expand All @@ -235,7 +235,7 @@ tasks.register('csvexport', CsvExport) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.CsvExport.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.CsvExport.md >}}

### CsvImport
Daten aus einer CSV-Datei werden in eine bestehende Datenbanktabelle importiert.
Expand Down Expand Up @@ -263,7 +263,7 @@ tasks.register('csvimport', CsvImport) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.CsvExport.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.CsvExport.md >}}

### CsvValidator

Expand All @@ -279,7 +279,7 @@ tasks.register('validate', CsvValidator) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.CsvValidator.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.CsvValidator.md >}}

Falls die CSV-Datei eine Header-Zeile enthält (mit den Spaltennamen), wird im gegebenen Modell eine Klasse gesucht,
welche die Header-Spaltennamen enthält (Gross-/Kleinschreibung sowie optionale "Spalten" der Modell-Klasse werden ignoriert).
Expand Down Expand Up @@ -377,7 +377,7 @@ tasks.register('downloadJson', Curl) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.Curl.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.Curl.md >}}

### DatabaseDocumentExport (deprecated)

Expand Down Expand Up @@ -406,7 +406,7 @@ tasks.register('exportDocuments', DatabaseDocumentExport) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.DatabaseDocumentExport.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.DatabaseDocumentExport.md >}}

### Db2Db

Expand Down Expand Up @@ -475,7 +475,7 @@ tasks.register('transferSomeData', Db2Db) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.Db2Db.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.Db2Db.md >}}

Eine `TransferSet` ist

Expand Down Expand Up @@ -543,7 +543,7 @@ tasks.register('ftpdelete', FtpDelete) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.FtpDelete.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.FtpDelete.md >}}

### FtpDownload

Expand Down Expand Up @@ -576,7 +576,7 @@ tasks.register('ftpdownload', FtpDownload) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.FtpDownload.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.FtpDownload.md >}}

### FtpList

Expand All @@ -596,7 +596,7 @@ tasks.register('ftplist', FtpList) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.FtpList.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.FtpList.md >}}

### Gpkg2Dxf

Expand All @@ -615,7 +615,7 @@ tasks.register('gpkg2dxf', Gpkg2Dxf) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.Gpkg2Dxf.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.Gpkg2Dxf.md >}}

### Gpkg2Shp

Expand All @@ -634,7 +634,7 @@ tasks.register('gpkg2shp', Gpkg2Shp) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.Gpkg2Shp.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.Gpkg2Shp.md >}}

### GpkgExport

Expand Down Expand Up @@ -670,7 +670,7 @@ tasks.register('gpkgexport', GpkgExport) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.GpkgExport.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.GpkgExport.md >}}

### GpkgImport

Expand All @@ -697,7 +697,7 @@ tasks.register('gpkgimport', GpkgImport) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.GpkgImport.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.GpkgImport.md >}}

### GpkgValidator
Prüft eine GeoPackage-Datei gegenüber einem INTERLIS-Modell. Basiert auf dem [_ilivalidator_](https://github.com/claeis/ilivalidator).
Expand All @@ -712,7 +712,7 @@ tasks.register('validate', GpkgValidator) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.GpkgValidator.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.GpkgValidator.md >}}

### Gzip
Gzipped eine einzelne Datei. Es gibt einen eingebauten Tar-Task, der - nomen est omen - aber immer zuerst eine Tar-Datei erstellt.
Expand All @@ -726,7 +726,7 @@ tasks.register('compressFile', Gzip) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.Gzip.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.Gzip.md >}}

### Ili2gpkgImport

Expand All @@ -752,7 +752,7 @@ tasks.register('importData', Ili2gpkgImport) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.Ili2gpkgImport.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.Ili2gpkgImport.md >}}

Für die Beschreibung der einzenen ili2gpkg-Optionen: https://github.com/claeis/ili2db/blob/master/docs/ili2db.rst#aufruf-syntax

Expand Down Expand Up @@ -789,7 +789,7 @@ tasks.register('deleteDataset', Ili2pgDelete) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.Ili2pgDelete.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.Ili2pgDelete.md >}}

Für die Beschreibung der einzenen ili2pg-Optionen: https://github.com/claeis/ili2db/blob/master/docs/ili2db.rst#aufruf-syntax

Expand Down Expand Up @@ -832,7 +832,7 @@ tasks.register('exportData', Ili2pgExport) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.Ili2pgExport.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.Ili2pgExport.md >}}

Für die Beschreibung der einzenen ili2pg-Optionen: https://github.com/claeis/ili2db/blob/master/docs/ili2db.rst#aufruf-syntax

Expand Down Expand Up @@ -882,7 +882,7 @@ tasks.register('importData', Ili2pgImport) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.Ili2pgImport.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.Ili2pgImport.md >}}

Für die Beschreibung der einzenen ili2pg-Optionen: https://github.com/claeis/ili2db/blob/master/docs/ili2db.rst#aufruf-syntax

Expand All @@ -907,7 +907,7 @@ tasks.register('importSchema', Ili2pgImportSchema) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.Ili2pgImportSchema.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.Ili2pgImportSchema.md >}}

Für die Beschreibung der einzenen ili2pg-Optionen: https://github.com/claeis/ili2db/blob/master/docs/ili2db.rst#aufruf-syntax

Expand Down Expand Up @@ -946,7 +946,7 @@ tasks.register('importData', Ili2pgReplace) {
datasetSubstring = 0..4
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.Ili2pgReplace.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.Ili2pgReplace.md >}}

Für die Beschreibung der einzenen ili2pg-Optionen: https://github.com/claeis/ili2db/blob/master/docs/ili2db.rst#aufruf-syntax

Expand Down Expand Up @@ -974,7 +974,7 @@ tasks.register('updateData', Ili2pgUpdate) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.Ili2pgUpdate.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.Ili2pgUpdate.md >}}

Für die Beschreibung der einzenen ili2pg-Optionen: https://github.com/claeis/ili2db/blob/master/docs/ili2db.rst#aufruf-syntax

Expand All @@ -1000,7 +1000,7 @@ tasks.register('validate', Ili2pgValidate) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.Ili2pgValidate.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.Ili2pgValidate.md >}}

Für die Beschreibung der einzenen ili2pg-Optionen: https://github.com/claeis/ili2db/blob/master/docs/ili2db.rst#aufruf-syntax

Expand All @@ -1017,7 +1017,7 @@ tasks.register('validate', IliValidator) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.IliValidator.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.IliValidator.md >}}

Zusatzfunktionen (Custom Functions): Die `pluginFolder`-Option ist zum jetzigen Zeitpunkt ohne Wirkung. Die Zusatzfunktionen werden als normale Abhängigkeit definiert und in der ilivalidator-Task-Implementierung registriert. Das Laden der Klassen zur Laufzeit in _iox-ili_ hat nicht funktioniert (`NoClassDefFoundError`...). Der Plugin-Mechanismus von _ilivalidator_ wird momentan ohnehin geändert ("Ahead-Of-Time-tauglich" gemacht).

Expand All @@ -1036,7 +1036,7 @@ tasks.register('importJson', JsonImport) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.JsonImport.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.JsonImport.md >}}

### PostgisRasterExport

Expand All @@ -1058,7 +1058,7 @@ tasks.register('exportTiff', PostgisRasterExport) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.PostgisRasterExport.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.PostgisRasterExport.md >}}

### Publisher

Expand All @@ -1082,7 +1082,7 @@ tasks.register('copyFiles', S3Bucket2Bucket) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.S3Bucket2Bucket.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.S3Bucket2Bucket.md >}}

### S3Download

Expand All @@ -1102,7 +1102,7 @@ tasks.register('downloadFile', S3Download) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.S3Download.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.S3Download.md >}}

### S3Upload

Expand All @@ -1125,7 +1125,7 @@ tasks.register('uploadDirectory', S3Upload) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.S3Upload.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.S3Upload.md >}}

### ShpExport
Daten aus einer bestehenden Datenbanktabelle werden in eine SHP-Datei exportiert.
Expand All @@ -1145,7 +1145,7 @@ tasks.register('shpexport', ShpExport) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.ShpExport.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.ShpExport.md >}}

### ShpImport

Expand Down Expand Up @@ -1173,7 +1173,7 @@ tasks.register('shpimport', ShpImport) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.ShpExport.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.ShpExport.md >}}

### ShpValidator

Expand All @@ -1194,7 +1194,7 @@ tasks.register('validate', ShpValidator) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.ShpValidator.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.ShpValidator.md >}}

### SqlExecutor

Expand Down Expand Up @@ -1253,7 +1253,7 @@ tasks.register('executeSomeSql', SqlExecutor) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.SqlExecutor.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.SqlExecutor.md >}}

### XslTransformer (incubating)

Expand Down Expand Up @@ -1287,4 +1287,4 @@ tasks.register('transform', XslTransformer) {
}
```

{{< include ../../build/docs/tasks/_ch.so.agi.gretl.tasks.XslTransformer.md >}}
{{< include ./tasks/_ch.so.agi.gretl.tasks.XslTransformer.md >}}

0 comments on commit e6c9a7c

Please sign in to comment.