Handbuch

[klausundelke]

Ich bin mir schon darüber im Klaren, daß das lästige Arbeit ist, aber die Weiterentwicklung des CW geht dank der fleißigen Entwickler dermassen rasch voran, daß es schwierig ist da halbwegs am Ball zu bleiben.
Bei den NB's steht zwar in Kurzform, was geändert/ergänzt wurde, aber manchmal kann ich das nicht wirklich zuordnen.
Könnte man nicht bei neuen Funktionen / Programmänderungen dies gleich direkt im Handbuch mit einpflegen, damit das immer aktuell ist?

 

[MiK]

Das Handbuch wurde noch nicht mal für Version 1.0 fertig geschrieben. Leider haben sich dafür nicht genug engagierte Helfer gefunden.

Wenn sich mal 1-2 Leute bereit erklären würden, sich um das Handbuch zu kümmern, würden sie von den Entwicklern bestimmt auch jede Unterstützung dazu bekommen.

 

[Harry1999]

Wie sollte/könnte den das Doument bereit gestellt werden? Als Word-Doc? als HTML? im SVN? oder incrementel im Forum?

 

[MiK]

Ist das Anpinnen eines Threads eigentlich das gleiche wie ihn unsichtbar zu machen?

In diesem Thread sollte alles zum Thema Mitarbeit am Handbuch stehen: http://www.geoclub.de/viewtopic.php?f=40&t=24206

Aber wenn sich dafür ein neues Team findet, kann auch gerne auf ein anderes Format gewechselt werden. Auf jeden Fall sollte die Zusammenarbeit über das SVN erfolgen.

 

[klausundelke]

Könnte man das Thema Handbuch nicht 2-teilig angehen:

1) Das bestehende Handbuch mal auf den aktuellen Stand bringen.
2) Zukünftige Programmänderungen sofort einpflegen.

Zum Teil 1 könnte jeder mithelfen, ich werde mich am Wochenende mal einlesen...
Es wäre sicher optimal wenn Teil 2 immer gleich vom jeweiligen Entwickler erledigt
würde, da der natürlich seine Funktion am besten beschreiben kann.

 

[Harry1999]

In dem Thread steht sinngemäß drinne, dass es im Moment keine Möglichkeit gibt, etwas zu veröffentlichen. Für mich stellt sich dass dann wie folgt dar: Ich schreibe was, weiss aber nicht wohin damit. Es gibt keine "Redaktion" und es gibt auch keine "Veröffentlichung". So der Stand der Dinge.
Wenn jemand sich bereit finden würde, die Ergebnisse zu "veröffentlichen", so dass auch Jemand ohne SVN mitarbeiten kann, dann würde ich auch "Redaktionell" mitarbeiten bzw. sofern gewünscht auch Koordinieren und natürlich auch mit Inhalt füllen.

 

[MiK]

Also ich hab den Thread jetzt nicht noch mal gelesen. Aber so weit ich weiß, kann jeder mitarbeiten. SVN ist natürlich dafür Voraussetzung. Was meinst Du mit "Veröffentlichung"? Die Daten sind frei zugänglich. Als einfacher Download in PDF oder als HTML wird es zur Verfügung gestellt, wenn es einen dafür würdigen Zustand hat. Soweit ich weiß, war es das noch nicht.

Nur irgendwas schreiben und jemand anderes pflegt es dann ein, geht leider nicht. Dazu fehlen die Leute, dass jemand die Sekretärin spielen könnte.

Ich denke auch neue Features sollten nicht von den Programmierern im Handbuch beschrieben werden. Meist sind dazu reine Anwender besser geeignet dies verständlich zu formulieren. Bei Nachfragen kann man sich natürlich an die Entwickler wenden.

 

[MiK]

Hier steht genau Schritt für Schritt, was man tun muss um an der Doku etwas zu ändern: http://www.geoclub.de/viewtopic.php?p=383647#p383647

 

[Harry1999]

OK, die Anleitung hab ich vergessen, da dafür SVN benötigt wird. Wenn ich bedenke, wie lange ich gebraucht habe (ich komme aus der IT, bin aber kein Prgrammierer) bis ich CW das erste mal zum fliegen gebracht haben... das mag ich niemanden so zumuten.
Kriegt jeder das PW? Wer entscheidet das?

 

[Harry1999]

Ich kann den Editor nicht runterladen... gibt es den auch woanders?
hab es gefunden: http://www.xmlmind.net/xmleditor/_download/xxe-perso-4_5_0-setup.exe

 

[MiK]

Kriegt jeder das PW? Wer entscheidet das?

Da musst Du wie beschrieben Pfeffer fragen. Ich weiß das Passwort im Moment gar nicht.
Wenn aber jemand ernsthaft beim Handbuch die Regie übernehmen möchte und da mehr macht als nur mal einen Absatz beisteuern, dann bekommt derjenige seinen eigenen Account mit Passwort.

 

[Harry1999]

So... ich habe jetzt alles installiert (über 60MB), um festzustellen, dass der Editor tatsächlich "nur" XML editiert. Nun bin ich leider kein Programmierer und habe mit XML nur insofern was zu tun, als dass ich ungefähr weiss, was es ist.
Gibt es irgendeine andere Art und weise, Plain-Text bzw. Grafiken und Menu-Strukturen zur Docu beisteuern zu können? XML lernen nur um zu dokumentieren werde ich nicht. Jetzt glaube ich zu verstehen, warum niemand der nicht hier gecoded hat zur Doku beisteuert...

 

[MiK]

Da muss sich mal Pfeffer melden, weil ich daran nichts gemacht habe. Aber soweit ich weiß gab es da auch einen einfacheren Weg. In Richtung WYSIWYG. Ich bin mir zu 90% sicher, dass man kein XML schreiben musste.

Und falls doch: Dann exportieren wir das einmal in ein vernünftiges Format und machen in dem weiter. Ich hänge nicht an docbook. Aber wenn ich jetzt Latex vorschlage schreckt das wahrscheinlich auch wieder ab, also sag ich nichts.

 

[Harry1999]

Alles was komplizierter ist als ein Eintrag im Forum wäre nicht so schön. Bei allem anderen müsste es die besagte "Sekretärin" geben... was ich auch nicht so dolle fände...

 

[Harry1999]

Hab jetzt auch WJSIWJG - (wer lesen kann ist klar im Vorteil)

 

[Harry1999]

Ich gebe auf...
ich komme mit diesem Editor nicht klar. Weder in der Steuerung von elementaren Dingen wie Mausrad (beide Drehbewegungen verschieben das Dokument nach unten) bis hin zu ... Ich will ein Buchstabe verändern... oder gar ein Kapitel hinzufügen.
Nix ist mir gelungen...
Auch einen Export und Import gibt es nicht (wäre vielleicht die Rettung gewesen)

 

[pfeffer]

welchen Editor hast Du denn ausprobiert?

EDIT: XML Mind habe ich grad runtergeladen und mich erinnert: Editieren kann man nur das Dokument, dass einzeln geöffnet ist. die CacheWolf_Dokumentation.xml enthält praktisch nur Verweise auf die einzelnen Abschnitte der Doku, die in jeweils eigenen .xml gespeichert sind. Deswegen muss man wohl eigentlich über /edit/reference/edit referenced object die entsprechende .xml öffnen und dort müsste man sie dann editieren können. Leider klappt bei mir das Öffnen des referenzierten Objektes nicht :-(

EDIT2: Ich erinnere mich, dass das früher mal funktioniert hat. Mit dem XML Mind sind ja Beispiele mitgeliefert, mit denen geht es, wie ich grad beschrieben habe. Also: vielleicht wurde irgendwo im DocBook-Format was geändert? vielleicht gibt es Probleme mit relativen versus absouluten Pfaden?

Greiol hat da zu letzt was geändert - vermutlich kann er am besten was dazu sagen.

Gruß,
Pfeffer.

 

[greiol]

versuch mal http://www.syntext.com/products/serna-free/ mir persönlich hat er noch mit am besten gefallen

 

[klausundelke]

So, ich hab mir mal den Editor, den greiol empfohlen hat installiert.
Dann das Handbuch mit Tortoise runtergeladen und schon mal ein
Kapitel (Der erste Start) etwas aktualisiert.

Ich werd gleich noch ne PM an Pfeffer wg. der Passwort's fürs Hochladen schreiben.
Aber vorher hab ich eine Frage:

- Kann ich das endgültige Aussehen der Seite irgendwie kontrollieren? (Einige Funktionen des Editors waren mir nicht so klar, ich hab halt rumprobiert.) Ich will vermeiden, daß ich dabei evtl. irgendeinen Quatsch fabriziert hab und den jetzt veröffentliche.

 

[greiol]

der editor bietet die möglichkeit das produzuierte als html zu exportieren. dann kannst du es dir mit einem browser ansehen.