Seite 1 von 1

Welches Wiki zur Dokumentation von PB ?

Verfasst: 23.09.2005 13:03
von PAMKKKKK
Es geht hier um die Frage welches Wiki wir weiterentwickeln wollen:

1. PureBasic Wikibooks
http://de.wikibooks.org/wiki/Purebasic (Deutsch)

oder

2. PureWiki von purearea.net:
http://www.purearea.net/pb/english/pure ... :Main_Page (Deutsch)

Hier ein paar Meinungen dazu:
Robert Wünsche hat geschrieben: Hi PAMKKKKK,
ich finde es schön, das du dich für http://de.wikibooks.org/wiki/Purebasic in Wikibooks einsetzt.

Deine Idee mit der Projektkoordination finde ich auch gut, aber ich denke das Andre im Moment wenig zeit hat.
In der deutschen Purewiki sind die Artikel meines Erachtens gut aufgehoben, und außerdem hat man dort mehr Platz fürs gesamte Purebasic und es ist nicht alles so zerstreut.
Ich habe nichts gegen Wikibooks, aber es ist nun mal nur für Bücher bestimmt, was bei der Purewiki nicht der Fall ist, weil man da auch Tutorials, Quellcode usw. sinnvoll miteinander verlinken kann.
Das PureWiki von purearea.net hat auch ein Englisches Schwesterprojekt das schon etwas weiter ist und dasselbe Inhaltsverzeichnis hat wie das deutsche.
(siehe Englische Purewikiseite: http://www.purearea.net/pb/english/pure ... /Main_Page und hier der dazugehörige Thread aus'm englischen Forum http://forums.purebasic.com/english/vie ... hp?t=15901)

Wer sich den Englischen Thread durchliest wird merken viele unserer Fragen dort auch schon diskutiert wurden. Die haben sich für das Englische PureWiki von purearea.net entschieden.

Die Französischen Wikis (ich kann kein Französisch) sind wohl unabhängig entwickelt worden.

Also geht es hier um die Frage welches Wiki wir weiterentwickeln wollen:

1. PureBasic Wikibooks
http://de.wikibooks.org/wiki/Purebasic (Deutsch)

oder

2. PureWiki von purearea.net:
http://www.purearea.net/pb/english/pure ... :Main_Page (Deutsch)

Offizielle Seite des PureBasic DokuTeams:
http://www.purearea.net/pb/english/pure ... c_DokuTeam

Verfasst: 23.09.2005 22:55
von Andre
Hi, leider bin ich erst heute wieder im Forum (meine Freizeit reichte die ganze letzte Woche nur für Mails etc.).

Ich bin jedenfalls immer mehr oder weniger für / rund um PureBasic tätig, auch wenn ich mal nicht im Forum lese+poste. :mrgreen:

@PAMKKKK: erstmal vielen Dank für Dein Engagement, mit dem Du offensichtlich hinter diesem Ziel (= Verbesserung der PB Dokumentation stehst) :allright:

Die auf WikiBooks zu findenden Dokumentationen finde ich auch durchaus gelungen, d.h. als Vorlage zum Abschauen des "Wie mache ich das am besten....?" sehr gut geeignet. Letztlich kommt es jedoch nicht auf die Plattform, sondern auf die Schreiber in einem Wiki an... :twisted:

Ok - also, auch wenn man mir natürlich "Parteilichkeit" unterstellen könnte, hier mal meine Antwort... :wink:

PureWiki sollte eigentlich erstmal "geheim" bleiben, da ich zumindest die vorhandene Befehlsreferenz uploaden wollte, bevor das Projekt an die Öffentlichkeit geht.

Letztlich ist PureWiki von mir inzw. nur bereits bekanntgegeben worden, da im angesprochenen Thread im engl. Forum auch als Ziel gerade ein Hoster und eine Wiki-Distribution gesucht wurde. Und da wollte ich natürlich unnötige Arbeit, Aufwände, Kosten, etc. vermeiden und habe mein Projekt vorgestellt. Dies wurde - wie bekannt - auch als Plattform ausgewählt.

Die von mir ausgewählte MediaWiki-Distribution (wird auch von Wikipedia verwendet) ist auch allgemein als eine der TOP-Wiki-Distributionen bekannt. Technisch also eine solide Plattform. (Der einzige Vorteil der WikiBooks, den ich auf die schnelle erkennen konnte, ist die eingebaute Druckfunktion. Aber dies lässt sich sicher auch noch beim PureWiki nachrüsten.)

Inzw. ist im "Hintergrund" jedoch auch schon einiges passiert, u.a. gibt es eine Gruppe "PureBasic Documentation Project" (englischsprachig), in der bereits einige technische Details zur Umsetzung besprochen wurden.

Ein wichtiges davon ist, dass nur ein PureWiki als einheitlicher "Adressraum" genutzt werden sollte. Dabei gilt englisch als Hauptsprache und anderssprachige Beiträge werden mit dem entsprechenden Länderkürzel eingebunden.

Ein Beispiel:
Die Dokumentation für den PB-Befehl "Input()" würde im PureWiki unter ".../Input" abgespeichert. Die deutsche Variante dann unter ".../DE:Input".

Bei den Namenskonventionen für einen Wiki-Beitrag in deutsch, französisch, etc. wird nach Möglichkeit auf den englischen Originalnamen zurückgegriffen. Also z.B. "Data types" als englische Hauptseite, dann auch "De:Data types" als deutsche Ausgabe und nicht "De:Datentypen".

Ein einziges PureWiki hat den wesentlichen Vorteil, dass
* technische Erweiterungen nur einmal installiert werden müssen
* Bilder und Logos nur einmal hochgeladen werden müssen
* leichtes Verknüpfen zwischen verschiedenen Sprachversionen eines Beitrags möglich
* die Schreiber orientieren sich an einheitlichen Vorgaben, was Inhaltsverzeichnis und Gliederung angeht (welche dennoch kein Dogma sind, d.h. durchaus Unterschiede zwischen den Sprachversionen bestehen könnten)
* usw.

Von daher bitte ich also darum, mit dem Editieren in den deutschsprachigen Seiten des englischen PureWiki weiterzumachen. Beachte auch hier das Länderkürzel - Remi Meier ist übrigens im PB Documentation Project mit angemeldet und hat die hier verlinkte deutsche Hauptseite erstellt.

Die Beachtung dieser "Spielregeln" macht das Administrieren wesentlich einfacher. Wenn sich diese Ansicht durchsetzt, werde ich das jetzt noch gesonderte deutsche Wiki auf PureArea.net über kurz oder lang abschalten.

Vorher müssen natürlich noch die bereits existierenden Beiträge ins engl. PureWiki (mit entsprechendem "DE:...."-Kürzel übertragen werden.

Eine weitere gute Nachricht: ich habe bereits ein Output-Modul für den DocMaker (Tool, mit dem die PB-Doku wie z.B. die Hilfe-Datei erstellt wird) erstellt, welches mir das Exportieren der kompletten PB-Doku ins PureWiki-Format ermöglicht.

Abgesehen von einer unnötigen Zersplitterung kann ich auch deshalb nicht noch andere PB-Wiki-Plattformen unterstützen.

Ein Beispiel, wie die exportierte PB-Doku aussieht: http://www.purearea.net/pb/english/pure ... 2D_Drawing

Nachdem erstmal die komplette PB-Doku auf PureWiki hochgeladen ist, besteht z.B. für weitere Autoren die Möglichkeit zum Ergänzen neuer/besserer Beispiele, usw.

Dabei möchte ich jedoch auch möglichst ein einheitliches Layout vorgeben. Daher (hoffentlich) im Laufe des Wochenendes mehr hier in diesem Thread.

PS: Ich besitze übrigens die originalen Word-Dateien des Topos-Handbuchs (da ja von mir geschrieben) und ich habe über den damals beim Topos-Verlag für das Publishing Verantwortlichen R.-J. Kraft auch das Einverständnis, diese originalen Quellen weiterverwenden und veröffentlichen zu können. Also ein weiterer Grund, wenn mit dem PureWiki auf PureArea.net eine INet-Plattform von mir genutzt wird... :wink:

So, jetzt aber erstmal genug geschrieben.

PS: Ach ja, auch die "Franzosen" haben sich für das englische PureWiki mit Sprachkürzel "FR:Seitenname" entschieden.

PPS: Natürlich habe ich auch im Sinn, Verbesserungen in der Online-PureBasic-Doku (PureWiKi) in die originale Hilfe einfließen zu lassen. Aufrufen der .chm Hilfe per F1 ist halt immer noch am bequemsten...
Wer damit ein Problem hat, sollte dies bitte sagen.

Verfasst: 24.09.2005 10:11
von hardfalcon
Ich bin für PureBasic Wikibooks, weil ich der Meinung bin, dass dadurch der Bekanntheitsgrad von PureBasic erheblich gesteigert wird. Ausserdem wird Andres Geldbeutel (Traffic) dann nicht so sehr belastet. :wink:

Verfasst: 24.09.2005 10:30
von ts-soft
@hardfalcon: Ich hoffe Du hast Deine Spende an Wikibooks schon geleistet :lol:

Verfasst: 24.09.2005 10:47
von hardfalcon
Nein, leider (noch) nicht. Und zwar aus folgenden Gründen:
1.) Wegen Taschengeldmangel herrscht in meinem Geldbeutel grade Ebbe.
2.) In Luxemburg ist offenbar kein Paypal verfügbar. Und Überweisung finde ich umständlich. Und eine Kreditkarte habe ich nicht.

Verfasst: 24.09.2005 11:18
von PAMKKKKK
@hardfalcon
Ich habe anfangs genauso gedacht wie du. Da ich aber einer International gemeinsamen Lösung den Vorrang gebe (siehe meine Signatur), habe ich mich für
2. PureWiki von purearea.net:
http://www.purearea.net/pb/german/purewiki (Deutsch)
entschieden.
Ich wollte das hier nicht kundtun um niemanden zu beeinflussen.

@Andre
Vielen dank für diesen sehr aufschlussreichen (langen) Post.
Eine weitere gute Nachricht: ich habe bereits ein Output-Modul für den DocMaker (Tool, mit dem die PB-Doku wie z.B. die Hilfe-Datei erstellt wird) erstellt, welches mir das Exportieren der kompletten PB-Doku ins PureWiki-Format ermöglicht.
:allright: :allright: :allright: :allright: :allright: :allright: :allright:

So ein ding wollte ich auch schon Proggen, weil ich gerne Wiki Beiträge Offline und WYSYWIG Editieren würde.
Gibt es dafür den Sourcecode irgendwo ?

Ein offline (WYSYWIG) Editor (oder HTML zu Wiki Wandler) für Wiki Beiträge in PB geschrieben, würde das ansehen von PB mit Sicherheit vermehren.

=============================================

Ein copy und paste der PB Hilfe, ist zwar ein guter start, die PB Hilfe sollte aber im Referenz style bleiben und als ein eigenständiger Teil des (Wikis) Referenziert werden.
(Referenz = Befehls-Syntax, Rückgabewerte und ein kleines Beispiel).

Wikis haben das Problem das sie eher wie Lexika gesehen werden und auch in diesem style geschrieben werden.

Ich möchte das Wiki in der Prosa eines „PureBasic for Dummies“ (Programmieren lernen mit PB) schreiben, und nicht als Referenz oder Lexikon.

Eine deutsche Dokumentation zum DocMAker gibt es Hier:
http://forums.purebasic.com/german/viewtopic.php?t=4920

Verfasst: 25.09.2005 21:37
von Andre
Um kurz auf den DocMaker einzugehen: mein Output-Modul für PureWiki ist ein Bestandteil des DocMaker, also nicht allein lauffähig. Darum auch kein "Public Source".

Was das editieren im PureWiki angeht: bitte die Sprachenkürzel vor dem Seitennamen beachten! PAMKKKK hat ja bereits die neue Doku zum DocMaker hinzugefügt. Ich habe diese jedoch wie folgt geändert:

"PureBasic DocMaker" => englische Seite
"De:PureBasic DocMaker" => deutsche Seite

=> also für deutsche Seiten immer "De:" vor dem Seitennamen. Dies ist insbesondere wichtig bei Seiten zu Befehlsdokumentationen (z.B. "StartDrawing" => deutsche Seite "De:StartDrawing")

Eine (englische) Hilfe dazu habe ich auch eben zum PureWiki hinzugefügt: http://www.purearea.net/pb/english/pure ... p:Contents
PAMKKKK hat geschrieben:Ich möchte das Wiki in der Prosa eines „PureBasic for Dummies“ (Programmieren lernen mit PB) schreiben, und nicht als Referenz oder Lexikon.
Das ist auch ok, die Befehlsreferenz nimmt ja gerade mal 1-2 Kapitel im Inhaltsverzeichnis von PureWiki ein. :mrgreen:

Die anderen Kapitel sind ja auch in etwa so aufgebaut, wie Du es vorhast.

Verfasst: 26.09.2005 07:57
von PAMKKKKK
"PureBasic DocMaker" => englische Seite
"De:PureBasic DocMaker" => deutsche Seite

=> also für deutsche Seiten immer "De:" vor dem Seitennamen. Dies ist insbesondere wichtig bei Seiten zu Befehlsdokumentationen (z.B. "StartDrawing" => deutsche Seite "De:StartDrawing")
Jo ich habs jetzt, glaube ich, geschnallt.....
Bin halt dumm und brauche immer ein Beispiel :wink:

Verfasst: 26.09.2005 22:11
von Andre
PAMKKKKK hat geschrieben:Jo ich habs jetzt, glaube ich, geschnallt.....
Bin halt dumm und brauche immer ein Beispiel :wink:
Hehe.... :mrgreen:

Keine Angst, ich beschäftige mich auch erst seit ca. 3 Monaten (mit Urlaubsunterbrechung) mit dem Wiki-Format und allem drumherum. Ich weiß also bei weitem auch nicht alles darüber. Schwierig ist insbesondere, dass für mein Empfinden nicht auf jeder Wiki-Distribution alle Code-Tags u.ä. unterstützt werden. Aber in dieser Beziehung ist das verwendete MediaWiki schon recht gut.

Man ist halt auch darauf angewiesen, auf entsprechenden Links mit Dokumentation zum (Media)Wiki-Format nachzulesen, zu probieren, etc.... :wink: