diff --git a/README.md b/README.md index c7c38924a9ba96a42fe5838a27805b2ec0c2ae1c..80cfdd1ca867bf86df0d9e9a7eb140db901be8f4 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,17 @@ Python Skripte um Interaktionen mit einem DokuWiki zu Automatisieren. Nutzt das `xmlrpc` package um eine Verbindung zum wiki herzustellen. + +## Funktionen +### Verschieben von Seiten +Um einzelne Seiten zu verschieben oder umzubenennen, kann man `move_page` verwenden. +Den alten Namen (`original_page`) und den neuen Namen (`new_page`) übergeben; dabei darauf achten, dass der [namespace](https://www.dokuwiki.org/namespaces) mit enthalten ist (zB "kategorie:page" statt nur "page"). +Links auf die alte Seite werden automatisch angepasst (Ein hoch auf Backlinks!). +Standardmäßig wird die alte Seite nur zum Löschen markiert aber nicht gelöscht. +Wenn man die alte Seite automatisch Löschen will, einfach beim Methodenaufruf `delete=True` setzen. + +## Geplante Funktionen +- [ ] Wiki-Graph mit `networkx` +- [ ] Finden und Markieren von veralteten Seiten +- [ ] Was mir noch an Statistikgedöns einfällt +- [ ] CLI?