From 8bde6f998b7112a15624e24e2ee070ebf24a9172 Mon Sep 17 00:00:00 2001
From: ulrich
Date: Thu, 14 Nov 2024 08:58:10 +0000
Subject: [PATCH] Dokumentation in Arbeit

---
 src/de/uhilger/fm/package-info.java |   51 +++++++++++++++++++++++++++++++++++++++++++++++----
 1 files changed, 47 insertions(+), 4 deletions(-)

diff --git a/src/de/uhilger/fm/package-info.java b/src/de/uhilger/fm/package-info.java
index a3a487e..375d662 100644
--- a/src/de/uhilger/fm/package-info.java
+++ b/src/de/uhilger/fm/package-info.java
@@ -1,17 +1,17 @@
 /**
- * Klassen fuer das Dateimanagement mit java.nio.file. 
+ * Klassen fuer das Dateimanagement mit <code>java.nio.file</code>. 
  * 
  * Die folgenden Funktionen sind enthalten:
  * 
  * <pre>
  * Ordnerinhalt auflisten:    
- *    Lister().liste(ordnerName, ctx, basisOrdner)
+ *    Catalog().list(relPathAndName, miniUrlBase, baseDir)
  * 
  * Datei speichern:
- *    Writer.speichern(file, content)
+ *    Writer().speichern(file, content)
  * 
  * Dateien und Ordner loeschen:
- *    Eraser.deleteFiles(relPfad, dateiname, basis)
+ *    Eraser().deleteFiles(relPfad, dateiname, basis)
  * 
  * Kopieren von Dateien und Ordnern:
  *    Mover().copyOrMoveFiles(quelle, ziel, dateiNamen, op, base)
@@ -31,5 +31,48 @@
  * Entpacken einer ZIP-Datei:
  *    Inflator().extractZipfile(fileName, path, base)
  * </pre>
+ * 
+ * <p>Die folgenden Funktionalitaeten sind in dieser Auspraegung einer  
+ * Dateiverwaltung fest angelegt. Sie sind damit Kandidaten fuer eine 
+ * Erweiterung dieser Klassenbibliothek um andere evtl. benoetigte 
+ * Auspraegungen.</p>
+ * 
+ * <p>Handhabung von Bilddateien</p>
+ * 
+ * Neben der Datei eines Bildes in Originalgroesse werden weitere Dateien als Varianten 
+ * eines Bildes unterstuetzt.
+ * 
+ * In Dateilisten werden diese Varianten ausgeblendet und nur das Originalbild gezeigt. 
+ * 
+ * Die Dateinamen von Varianten eines Bildes muessen dazu einen mit Unterstrich beginnenden 
+ * Namenszusatz enthalten wie bspw. <code>_tn</code> fuer thumbnail oder <code>_sm</code> 
+ * fuer small usw. Gleichsam lassen sich damit Eigenschaften wie zum Beispiel 
+ * eine Base64-Kodierung kombinieren. Hier waere der Namenszusatz dann eine Kombination 
+ * aus Groesse und Kodierung wie mit <code>_sm_b64</code>, so dass sich fuer ein Bild stets 
+ * eine ganze Gruppe von Datien ergibt, z.B.:
+ * 
+ * <pre>
+ * bild.jpg
+ * bild_sm.jpg
+ * bild_sm_b64.jpg
+ * </pre>
+ * 
+ * Alle Dateioperationen dieser Klassenbibliothek wirken dennoch stets auf 
+ * alle Varianten des Bildes, wie es auf der Kommandozeile mit einem Wildcard-Operator 
+ * gemacht wuerde, z.B.
+ * 
+ * <pre>
+ *   cp /pfad/zum/bild*.jpg /pfad/zum/zielordner
+ * </pre>
+ * 
+ * Eine Dateiliste enthaelt aus diesem Grund fuer Bilddateien die beiden zusaetzlichen Angaben 
+ * <code>miniurl</code> und <code>imgsrc</code>. 
+ * 
+ * <p>Ordnerliste im JSON-Format</p>
+ * 
+ * Die Liste mit Dateien eines Ordners wird im JSON-Format ausgegeben. Ueber eine 
+ * entsprechende Erweiterung koennte die Ausgabe in verschiedenen waehlbaren Formaten 
+ * erfolgen.
+ * 
  */
 package de.uhilger.fm;
\ No newline at end of file

--
Gitblit v1.9.3