View previous topic :: View next topic |
Author |
Message |
jay l33t
Joined: 08 May 2002 Posts: 980
|
Posted: Thu Oct 30, 2003 10:20 pm Post subject: |
|
|
Das Projekt sieht jetzt schon vielversprechend aus.
Dinge, die mir noch aufgefallen sind.
- Im Text-Modus solle es einen Button "Insert Link" geben, der automatisch
<uri link="...your link here..."> ... </uri> einfügt.
- Der OK Button sollte im Editiermodus nicht nur unten, sondern auch rechts von der Textbox sein (hab zuerst lang gesucht).
- Wenn man als Admin einen User hinzufügt, wird man hinterher wieder auf diesselbe Seite gebracht. Stattdessen sollte man ins Hauptmenue zurück.
- In Codelisting sollte es einen Button "Insert Codenote" geben, der
<codenote>Your note here!</codenote> einfügt.
- Codenote Tags werden nicht rot dargestellt!
- <path>...</path> Tags werden nicht in fixed width dargestellt!
- Es fehlen Punkte "Insert Ordered List" "Insert Unordered List". Diese könnten einfach für jeden Listpunkt ein Eingabefeld darstellen. Am besten sollten immer Ausgefüllte Eingabefelder + 5 freie Felder zur Eingabe dargestellt werden.
Ok, ich hoffe, ich hab Dich jetzt nicht ganz umgehauen _________________ Do you want your posessions identified? [ynq] (n) |
|
Back to top |
|
|
ian! Bodhisattva
Joined: 25 Feb 2003 Posts: 3829 Location: Essen, Germany
|
Posted: Fri Oct 31, 2003 8:14 pm Post subject: |
|
|
jay wrote: | Ok, ich hoffe, ich hab Dich jetzt nicht ganz umgehauen |
Nein. Das schockt mich in keinster weise.
Mir ist bewusst, dass es noch viele Anforderungen zu erfüllen gibt.
BTW:
pre3 released
Changlog:
- added ui-design to 'import Guide-XML'
- added 'publish' function
- added 'modify publishing groups' to admin menu
- added 'move up' and 'move down' functions in edit view
- added another 'ok' button to edit view on the left of the selected textelement (requested by jay)
- changed redirect to 'main menu' instead of 'add user' when adding a user was successful (requested by jay)
- added abstract input to 'create new document'
- added auto-focus to inputboxes
- added 'insert link' dialog
Mehr habe ich heute nichtmehr geschafft. Der 'insert link' funktioniert auch zunächst nur insofern, das man einen Link einfügen kann. Die Daten werden allerdings noch nicht geparst.
Allerdings wollte ich heute unbedingt noch die pre3 rausbringen.
Gruß,
ian! _________________ "To have a successful open source project, you need to be at least somewhat successful at getting along with people." -- Daniel Robbins |
|
Back to top |
|
|
bmichaelsen Veteran
Joined: 17 Nov 2002 Posts: 1277 Location: Hamburg, Germany
|
Posted: Sun Nov 02, 2003 2:33 pm Post subject: |
|
|
Es existiert hier eine Testimplementation für ein Gentoo Kernel and Hardware Wiki. Es hat sich dort auch bereits etwas an Infos angesammelt. Das Wiki ist von der Struktur her hauptsächlich auf Hardware und Hardwareconfiguartion ausgelegt. Wenn wir neue Ansätze in die gentoo-Docs bringen wollen, sollten wir die Ansätze vielleicht koordinieren?
Gruss, Björn |
|
Back to top |
|
|
ian! Bodhisattva
Joined: 25 Feb 2003 Posts: 3829 Location: Essen, Germany
|
Posted: Sun Nov 02, 2003 3:06 pm Post subject: |
|
|
bmichaelsen wrote: | Wenn wir neue Ansätze in die gentoo-Docs bringen wollen, sollten wir die Ansätze vielleicht koordinieren? |
Das sollten wir wahrlich. Obwohl ich denke, dass die eine Lösung die andere nicht ausschliesst.
Der gendocedit-Editor ist hauptsächlich zur einfachen Erzeugung, Überarbeitung, Übersetzung und Veröffentlichung von Gentoo-Dokumentationen gedacht. Entstanden ist das Projekt durch Unzufriedenheit der bestehenden Dokumentation (obwohl diese ja eigentlich schon sehr gut ist). Zudem verlieren wir viel Dokumentation in den Foren und die Infos sind oft nur mühsam wieder aufzufinden. Man muss sich oft erst durch mehrere Threads hangeln um daraus eine Lösung für sein Problem zurecht zu legen.
Somit haben wir auf der einen Seite viel Knowhow (Foren) aber auf der anderen Seite keine Dokumentation, da diese nicht so einfach zu erstellen ist, wie ein Foren-Post (Guide-XML-Konventionen). Deshalb der Editor, der auf einfachem Wege Dokumentationen erzeugen und warten lässt. Hierbei sind wir auch nicht vom docs-Team abhängig, da der Editor diese selbst publizieren kann (Modul wird mit pre4 veröffentlicht).
Warum ich nicht einfach ein Wiki o.ä. aufgesetzt habe hat einen ganz einfachen Grund. In einem Wiki haben wir die Dokumentation zwar dann vorliegen, aber diese ist dann wieder nicht im Guide-XML Format vorhanden. Eine einfache Veröffentlichung auf gentoo.org oder gentoo.de wäre somit nicht ohne weitere Arbeiten möglich. Das ist aber Ziel der ganzen Sache.
Jetzt ist nur die Frage, wie wir beide Ansätze zusammenführen.
Um den Editor besser verstehen zu können skizziere ich hier mal einen Beispiel Workflow:
1.) Ein User möchte eine Dokumentation zu einem gewessen Thema verfassen.
2.) Der User meldet einen Account im Editor an. (Oder der Admin macht das.)
3.) Der Benutzer kann sofort beginnen ein Dokument zu verfassen.
4.) Sobald das Dokument aus Sicht des Users fertig ist, gibt er es frei zum Review. (Somit erlangt man eine gewisse Qualitätssicherung).
5.) Ein anderer Benutzer, der Reviewerrechte hat, schaut sich das Dokument an. Er kann dies entweder kommentieren (Verbesserungsvorschläge einbringen) und es ablehnen oder als "in Ordnung" freigeben.
6.) Der User bekommt die Freigabe und kann das Dokument veröffentlichen. Das Dokument kann er in eine ihm freigegebene Ordnerstruktur freigeben (z.B. "Desktop", "Kernel", "Hardware", "FAQ", etc.)
7.) Das Dokument ist ab sofort für alle sichtbar und kann benutzt werden.
8.) Übersetzer können das Dokument in die jeweilige Sprache übersetzen. (Hier gilt dann wieder der gleiche Prozess für diese Dokumente von Punkt 3 an.)
... Zeit vergeht ...
9.) Das Originaldokument wird überarbeitet/verändert.
10.) Es muss wiederrum reviewed und dann veröffentlicht werden.
11.) Alle von dem Dokument abhängigen Übersetzungen werden benachrichtigt, dass sich das original Dokument verändert hat.
12.) Übersetzer können das Dokument in die jeweilige Sprache übersetzen. (diff)
So ist das gedacht.
Wie bekommen wir das jetzt zusammen (Wiki & Editor)? Oder sollen wir zwei Schienen fahren und sehen, was besser angenommen wird?
Mir liegt die Erstellung von Guide-XML konformen Dokumenten sehr am Herzen. Somit würden wir den Gentoo-Doku-Standart einhalten/entsprechen und hätten mehrfach verwertbare Dokus.
Gruß,
ian! _________________ "To have a successful open source project, you need to be at least somewhat successful at getting along with people." -- Daniel Robbins |
|
Back to top |
|
|
bmichaelsen Veteran
Joined: 17 Nov 2002 Posts: 1277 Location: Hamburg, Germany
|
Posted: Sun Nov 02, 2003 3:48 pm Post subject: |
|
|
Quote: | Wie bekommen wir das jetzt zusammen (Wiki & Editor)? Oder sollen wir zwei Schienen fahren und sehen, was besser angenommen wird? |
Hmm, das Gentoo Kernel and Hardware Wiki soll sich mal zu einer Referenz für Kerneloptionen und Hardware (identifiziert nach lspci) entwickeln. Es soll eigentlich garnicht vollständige FAQs ersetzten, sodern nur kuze Infos über eine spezielle Hardware enthalten - GentooDoc ist dafür eingentlich ungeeignet, es sei denn man stellt Infos über Hardwaregruppen zusammen. Das Wiki exportiert nach XML und mit einem kleinen Python/Perl Script sollte man dort sehr schnell ein GentooDoc draus machen können. Allerdings ändert sich Hardware schneller als es bei anderen Themen der Fall ist. Ich denke also wir sollten zweigleisig fahren. Für jeden Job das passende Werkzeug.
Andere die sich mit der Besserung der gentooDocu beschäftigen und mit denen wir uns koordinieren sollten:
tobi123 Brauchen wir / Wollt ihr ein neues FAQ System?
sehr ähnlicher ansatz oder?
telex4 http://www.newtolinux.org.uk/ Dies überscheindet sich mit deinem und meinem Ansatz.
https://forums.gentoo.org/viewtopic.php?t=13028 Bevor die noch ein Projekt starten.
Gruss, björn
https://forums.gentoo.org/viewtopic.php?t=13028 |
|
Back to top |
|
|
dertobi123 Retired Dev
Joined: 19 Nov 2002 Posts: 2679 Location: Oberhausen, Germany
|
Posted: Sun Nov 02, 2003 5:08 pm Post subject: |
|
|
Wir haben: 3 verschiedene Projekte, mit 3 verschiedenen Ansätzen.
- gendocedit zielt primär darauf ab, Doku aus den Foren zu sammeln, diese so einfach wie in den Foren editieren zu können, bei Interesse wird die einfache Übersetzung in andere Sprachen ermöglicht
- Das HardwareWiki zielt darauf ab, Informationen um mögliche und unmögliche Hardware und deren Linuxunterstützung zu sammeln.
- Die Gentoo FAQ spiegelt die aktuell in den Foren am meisten und häufigsten gestellten Fragen wieder.
Nur eines der Projekte, gendocedit, ist mehrsprachig konzipiert. Bei der FAQ ist die Unterstützung meherer Sprachen prinzipiell möglich, erfordert aber einen gewissen Aufwand. Das HardwareWiki zielt rein auf die englische Sprache ab.
Nur eines der Projekte, gendocedit, nutzt GuideXMl; bzw. kann GuideXML exportieren.
Das sind meiner Meinung nach die beiden wichtigsten Punkte:
- GuideXML Kompabilität
- Mehrsprachigkeit
Ohne diese beiden Punkte wird das Rad zwangsläufig immer wieder neu erfunden werden müssen.
Die Frage wie man die GendocEdit und die FAQ unter ein Dach bekommen kann werde ich mit ian! in der nächsten Woche erörtern.
Soviel bis hierher als "Bestandsaufnahme", demnächst mehr,
Tobias _________________ Ganz frisch: Praxisbuch Nagios
Gentoo Linux - Die Metadistribution (2. Auflage) |
|
Back to top |
|
|
ian! Bodhisattva
Joined: 25 Feb 2003 Posts: 3829 Location: Essen, Germany
|
Posted: Sun Nov 02, 2003 5:12 pm Post subject: |
|
|
bmichaelsen wrote: | Hmm, das Gentoo Kernel and Hardware Wiki soll sich mal zu einer Referenz für Kerneloptionen und Hardware (identifiziert nach lspci) entwickeln. Es soll eigentlich garnicht vollständige FAQs ersetzten, sodern nur kuze Infos über eine spezielle Hardware enthalten - GentooDoc ist dafür eingentlich ungeeignet, es sei denn man stellt Infos über Hardwaregruppen zusammen. Das Wiki exportiert nach XML und mit einem kleinen Python/Perl Script sollte man dort sehr schnell ein GentooDoc draus machen können. Allerdings ändert sich Hardware schneller als es bei anderen Themen der Fall ist. Ich denke also wir sollten zweigleisig fahren. Für jeden Job das passende Werkzeug. |
Gut. Auch wenn es dann wieder dezentral ist.
Wird bereits koordiniert. Ähnlicher Ansatz? Nein. Es geht mir darum die Technologie zu Verfügung zu stellen. Das wird wohl immer missverstanden.
Sehe ich nicht so. Wo sind da die Überschneidungen? Ich sehe das CMS nicht.
Scheint mir bereits gestorben zu sein. Ebenso churchers Projekt.
Gruß,
ian! _________________ "To have a successful open source project, you need to be at least somewhat successful at getting along with people." -- Daniel Robbins |
|
Back to top |
|
|
bmichaelsen Veteran
Joined: 17 Nov 2002 Posts: 1277 Location: Hamburg, Germany
|
Posted: Sun Nov 02, 2003 6:11 pm Post subject: |
|
|
Quote: | Wir haben: 3 verschiedene Projekte, mit 3 verschiedenen Ansätzen.
- gendocedit zielt primär darauf ab, Doku aus den Foren zu sammeln, diese so einfach wie in den Foren editieren zu können, bei Interesse wird die einfache Übersetzung in andere Sprachen ermöglicht
- Das HardwareWiki zielt darauf ab, Informationen um mögliche und unmögliche Hardware und deren Linuxunterstützung zu sammeln.
- Die Gentoo FAQ spiegelt die aktuell in den Foren am meisten und häufigsten gestellten Fragen wieder. |
Das sieht nach einem Erfolgsversprechenden Triumirat aus
Quote: | Wird bereits koordiniert. |
Cool! Sorry, ich habe in den Forum nur nach Wiki gesucht und endlos viele Posts gefunden, die ich aufgrund der Menge nicht alle gelesen habe. Vielleicht sollten die drei Projekte auch noch einmal in einem der englischen Posts erwähnt werden, um zu zeigen, dass sie koordiniert sind. Der Wust an alten Posts macht das Suchen nach solchen Projekten nicht gerade leicht.
Quote: | Das HardwareWiki zielt rein auf die englische Sprache ab.
|
Prinzipiell unterstützt moinmoin, auf das das Wiki aufbaut, Mehrsprachigkeit. Ich halte dies angesichts des Thema aber für schlichtweg nicht praktikabel. Falls man irgendwann einmal ein Auszug macht, und diesen dann nach GuideXML wandelt, kann man über Übersetzung reden.
Danke für eure schnellen Antworten!
Gruss, Björn |
|
Back to top |
|
|
ian! Bodhisattva
Joined: 25 Feb 2003 Posts: 3829 Location: Essen, Germany
|
Posted: Sun Nov 02, 2003 7:24 pm Post subject: |
|
|
pre4 released.
Changelog:
- webserver update to apache 2.0.48.
- added surname and givenname input to 'add user'
- changed redirect to 'edit view' when a new document is created in 'create new document' (requested by masseya)
- links are displayed in 'view xml' and 'view'. see bug #2.
- abstract is filled with content in xml-output
- parser for: [e] (emphasis), [b] (bold), [c] (codeline)
- added dialogs for 'insert bold', 'insert italic', 'insert codeline'
http://213.146.113.231/cgi-bin/gendocedit/index.pl
(Login-Button oben rechts)
User: gentoo-forums
Passwort: demo _________________ "To have a successful open source project, you need to be at least somewhat successful at getting along with people." -- Daniel Robbins |
|
Back to top |
|
|
jay l33t
Joined: 08 May 2002 Posts: 980
|
Posted: Mon Nov 03, 2003 10:30 am Post subject: |
|
|
Habe pre4 getestet:
- Drückt man in den Codeline/Insert Link/ Italic "Enter" statt auf OK zu klicken, dann wird die Eingabe nicht übertragen und die Seite im Popup-Fenster geladen.
- Popupfenster sind in Epiphany zu klein (Ok Cancel Button aus dem Sichtfeld), aber in Mozilla genau richtig.
- Insert Link/ Italic /Bold /Codeline sind auch innerhalb Note, Important und Warning zugelassen! Buttons fehlen hier noch. Bold und Italic werden
schon korrekt dargestellt. Nur Links und Codelines noch nicht.
- Fügt man einen fehlerhaften (zb vergessenes <) URI Link in Note hinzu, dann integriert gendocedit die edit tags in zu bearbeitenden Text !! Beim erneuten Bearbeiten wird der Code von Gendocedit innerhalb des Textareafeldes sichtbar. _________________ Do you want your posessions identified? [ynq] (n) |
|
Back to top |
|
|
ian! Bodhisattva
Joined: 25 Feb 2003 Posts: 3829 Location: Essen, Germany
|
Posted: Mon Nov 03, 2003 6:54 pm Post subject: |
|
|
pre5 released.
Changelog:
- minor ui enhancements
- added multi-language-ui support
- added german-ui-language-kit
- fixed bug #3
- review function complete
- documents can be published now (internal publishing function)
http://213.146.113.231/cgi-bin/gendocedit/index.pl
(Login-Button oben rechts)
User: gentoo-forums
Passwort: demo
So. Nun ist der Editor auch in deutsch verfügbar. Andere Sprachen sollen folgen. Hierfür wird eure Hilfe benötigt.
Desweiteren gibt es einen kleinen Vorgeschmack auf den "Publisher"; also jene Seite des Editors, die die veröffentlichten Dokumente anzeigen kann. Somit könnte man fast schon produktiv gehen. (Wenn auch nur für einfache Dokumente.)
Den Publisher findet ihr hier:
http://213.146.113.231/cgi-bin/gendocedit/gendocpublisher.pl
Ich habe zunächst nur zwei Dokumente "gepublished". Das soll einfach mal zeigen, wie soetwas aussehen könnte. Ein ordentliches Layout folgt.
Have fun,
ian! _________________ "To have a successful open source project, you need to be at least somewhat successful at getting along with people." -- Daniel Robbins |
|
Back to top |
|
|
jay l33t
Joined: 08 May 2002 Posts: 980
|
Posted: Tue Nov 04, 2003 11:09 am Post subject: |
|
|
Ich hätte noch einige Vorschläge:
- Statt der Option "Anzeigen" doch den Dokumentnamen direkt als
Link setzen. Oder evtl. auch zusätzlich. Wirkt für mich etwas intuitiver.
- Einen Menuepunkt "Optionen" oder "Dokumentoptionen" hinzufügen, wo man dann z.B. Dokumentnamen, Sprache, Autoren, Version, Abstract, Lizenz etc.. wieder ändern kann (bislang geht das nur z.T. via Neues Dokument erstellen)
- Wenn ein neues Dokument erstellt wurde, ist die Seite bis auf die Tools unten ganz leer. Eine kurze Message a la "This document contains no data yet" wäre ganz nett - ist aber kein Muss
- Beim Verschieben gibt es bislang nur eins rauf/bzw eins runter. Evtl. wäre ein "To Top" und "To Bottom" auch nicht schlecht.
Wie kann ich denn die Publish-Funktion testen? Braucht man dazu spezielle Rechte?
Kleine Bugs:
- In der Deutschen Version sind z.T. einige Zeilen noch englisch, so z.B.
"Sie haben Sich erfolgreich abgemeldet. You will be redirected to..."
-Ausserdem hat *hust hust* IE ein Problem mit der view as PDF Darstellung. Er meldet die Datei "index.pl" als unbekannt.
- Der IE zeigt ausserdem das zu bearbeitende Dokument immer ganz oben an. Das ist sehr lästig, wenn man z.B. ein Textfeld hinzufügt und dann bei längeren Dokumenten immer nach unten scrollen muss. _________________ Do you want your posessions identified? [ynq] (n) |
|
Back to top |
|
|
ian! Bodhisattva
Joined: 25 Feb 2003 Posts: 3829 Location: Essen, Germany
|
Posted: Fri Nov 07, 2003 4:43 pm Post subject: |
|
|
pre6 released!
Changelog:
- minor changes (corrections)
- editView: info if page is empty (requested by Jens Schittenhelm)
- link to 'view document' changed to document name. (requested by Jens Schittenhelm)
- rows are highlighted in 'browse documents' for easier navigation
- added 'user input' and 'codenote' to codelisting edit
- added dialog for 'insert email-address'
- fixed bug #4
- fixed bug #2
Und wie immer:
http://213.146.113.231/cgi-bin/gendocedit/index.pl
(Login-Button oben rechts)
User: gentoo-forums
Passwort: demo
Gruß,
ian! _________________ "To have a successful open source project, you need to be at least somewhat successful at getting along with people." -- Daniel Robbins |
|
Back to top |
|
|
ian! Bodhisattva
Joined: 25 Feb 2003 Posts: 3829 Location: Essen, Germany
|
|
Back to top |
|
|
jay l33t
Joined: 08 May 2002 Posts: 980
|
Posted: Sun Nov 09, 2003 8:49 pm Post subject: |
|
|
Und hier wieder meine Vorschläge:
-> rows are highlighted in 'browse documents' for easier navigation
a) Dies am besten auch für "modify publishing groups" einführen.
b) Der Gruppenname sollte ein Link sein und sollte dann das "browse documents" fenster öffnen, aber nur die Dokumente anzeigen die in dieser Gruppe published wurden. -> das wäre echt cool.
Neben Admin - Editor - Guest sollte es noch eine vierte Gruppe geben: "Locked" Benutzer dieser Gruppe sind komplett gesperrt. "Guests" sollten zumindest noch die Dokumente betrachten können.
Eventuell auch noch eine fünfte Gruppe "Reviewers" ..? Diese können Dokumente revoken oder review ok durchführen, aber keine Dokumente publishen (dies nur Editoren) oder auch umgekehrt.
In browse Documents sollte neben "Show languages" auch noch ein Drop-Down-Menue "Show Status" mit allen möglichen Statusoptionen
geben. Dann kann man blitzschnell alle Dokumente sehen, welche z.b. noch work in progress o.ä. sind.
_________________ Do you want your posessions identified? [ynq] (n) |
|
Back to top |
|
|
ian! Bodhisattva
Joined: 25 Feb 2003 Posts: 3829 Location: Essen, Germany
|
Posted: Mon Nov 10, 2003 6:50 pm Post subject: |
|
|
Erstmal ein dickes Dankeschön an jay, dertobi123, gentle2gentoo, carambola2 und alle anderen die sich bisher eingebracht haben!
pre8 released!
Changelog:
- rows are highlighted in 'modify publishing groups' and 'search documents' for easier navigation (requested by Jens Schittenhelm)
- added 'reviewer' to 'browse documents' table
- editView: added auto-focus on element that is selected for edit
- fixed a grave bug (I do _not_ want to explain this any further )
- fixed bug #5 (changed pdf generation process)
- added a 'refresh'-button in 'browse documents'. (useful if you want to see if changes were made in the meantime)
- added 'path'-tag dialog and parser
Testumgebung:
http://213.146.113.231/cgi-bin/gendocedit/index.pl
(User: gentoo-forums Pwd: demo)
Produktivumgebung:
http://213.146.113.231/cgi-bin/gendocedit_production/index.pl
Publisher:
http://213.146.113.231/cgi-bin/gendocedit_production/index.pl?action=publisher
Dokumente folgen... wer selbst Tätig werden möchte, maile mir bitte an die im Editor angegebene eMail-Adresse.
Gruß,
ian!
@Jay: Ich bleibe dran. Deine Vorschläge sind allesamt sehr gut. Auch wenn ich nicht so schnell hinterherkomme. Deine Vorschläge sind notiert (wenn auch nicht in der Wishlist) und werden nicht vergessen. Danke nochmal! _________________ "To have a successful open source project, you need to be at least somewhat successful at getting along with people." -- Daniel Robbins |
|
Back to top |
|
|
ian! Bodhisattva
Joined: 25 Feb 2003 Posts: 3829 Location: Essen, Germany
|
Posted: Tue Nov 11, 2003 8:07 pm Post subject: |
|
|
Nur der Vollständigkeit halber:
pre9 released
Changelog:
- hopefully fixed some special character issues (german charset; needs testing)
- added 'create copy' of document function
- added treeview to 'browse documents' to display relationships/history of documents
- added functions to create and manage subgroups of publishing-groups
Have fun,
ian! _________________ "To have a successful open source project, you need to be at least somewhat successful at getting along with people." -- Daniel Robbins |
|
Back to top |
|
|
|
|
You cannot post new topics in this forum You cannot reply to topics in this forum You cannot edit your posts in this forum You cannot delete your posts in this forum You cannot vote in polls in this forum
|
|