Manpage bbcode?

[reox]

Nachdem es hier ja schon bug, deb und deb-src als debian spezifischen bbcode gibt - wie wäre es mit einem bbcode für manpages, welcher automatisch auf manpages.debian.org auflöst? oder gibts das eh schon und ich finds nur nicht?

[eggy]

Glaub das gibt's noch nicht, die Idee klingt aber gut
Das einzubauen wär ein Fall für den Häuptling, ich hab ihm mal ne PM geschickt.

[feltel]

Ich hatte den Wunsch schon gesehen, wollte aber noch ein bisschen abwarten ob und was für Input kommt.

[eggy]

Ich würde es vermutlich selten nutzen - aus reiner Faulheit, die bug/deb/...-tags nutz ich auch so gut wie nie.

Ich seh aber nen guten Mehrwert, als jemand der anderen gerne mal nen freundliches gemeintes informatives "weitere Details in der manpage" vor die Füsse wirft: fertigen Link anklicken ist für den durchschnittlichen Leser[*] vermutlich zugänglicher als extra nen Terminal aufmachen und das Manpagegeraffel dort lesen. Vielleicht lesen durch den Codetag ja sogar viel mehr Leute Manpages und werden in Folge noch richtige Bücherwürmchen, wenn das darin geheimgehaltene Wissen nur noch einen schicken Link entfernt ist? Mehr Links sind immer gut. Das Internet lebt von Links. Und verlinkte Manpages sind doch ganz besonders toll


* : Meillos stellen hier die statistische Ausnahme und sind explizit nicht mitgemeint


Aber eine technische Frage: Was verlinkt man? https://manpages.debian.org/

Navigate to the manpage’s address, using this URL schema:
/<suite>/<binarypackage>/<manpage>.<section>.<language>.html
Any part (except <manpage>) can be omitted, and you will be redirected according to our best guess.

Aktuelles stable, ja klar. Aber wie stellt man sicher, dass die Links nach dem nächsten Release noch auf den damals genutzen Text zeigen und die Inhalte nicht durch neues Release inhaltlich kaputtgehen? Kann man das Codetag-Ziel beim nächsten Releasewechsel einfach ändern, oder geht dann rückwirkend bei alten Artikeln was kaputt? Mehrere Codetages, für jedes Release jeweils eins? "man9", "man10" ,"man11", "man12" ... wäre vermutlich machbar und als Guibutton immer nur den aktuellen stablebutton anzeigen? Aber schön ist auch anders. Und die Wartungsarbeit bleibt wieder am Häuptling hängen, jemand muss den Kram ja auch pflegen...

(von daher könnt ich aber auch gut verstehen, wenn Du sagst, ist die Mühe nicht wert @feltel)

[feltel]

Soweit ich das durchdringe stellt manpages.d.n "nur" für stable, testing und sid die jeweiligen Manpages bereit. Für ältere Releases wohl nicht. Auf der anderen Seite ändert sich bei den Manpages ja nicht so viel, es sei denn ein Paket fällt aus Debian raus, da hätte man dann natürlich tote Links.

[Meillo]

Selbst ein Meillo wuerde so Manpage-Tags toll finden. (Auch wenn ich natuerlich niemals *extra* ein Terminal aufmachen muss. )


Die Frage ist aber schon, wie man das mit den Sektionen und den Sprachen realisiert.

Um Releases wuerde ich mir keine grossen Gedanken machen. Da koennte man einfach das aktuelle Stable nehmen. Wenn jemand bislang schreibt: ``in der Manpage soundso'', dann schaut jeder von uns ja auch auf seinem eigenen System nach, was zwischen unstable und oldoldoldstable vermutlich alle beinhaltet. Das ist auch nicht so das Problem, denke ich.

Am besten faende ich es, wenn es bei den Debian-Manpages eine Art Uebersichtsseite gibt, die, wenn ich z.B. `crontab' eingebe, mir sowohl crontab(1) als auch crontab(5) anbietet und ich bei beiden eine Sprachauswahl habe.

Das erreicht man eigentlich mit folgender URL: https://manpages.debian.org/crontab ... da kann man dann rechts sowohl die Sprache als auch die Sektion auswaehlen/aendern.

[JTH]

Ich verlinke gelegentlich auch gerne direkt auf Manpages (statt sie nur zu erwähnen) und fänd so ein [man] nicht verkehrt. Es gab schon mal einen Vorschlag dafür (man-Tag), der aber auf ein paar Gegenargumente gestoßen ist.

Das erreicht man eigentlich mit folgender URL: https://manpages.debian.org/crontab ... da kann man dann rechts sowohl die Sprache als auch die Sektion auswaehlen/aendern.

Wenn man an die URL am Ende einfach die konkrete Sektion anhängt, kommt man direkt zu der gewünschten, wenns mehrere gibt:
https://manpages.debian.org/crontab.1
https://manpages.debian.org/crontab.5

Das könnte man in einem BBCode-Tag ausnutzen: [man]crontab.1[/man] oder [man]crontab.5[/man].

Ein Problem könnte hier sein, wenn es mehrere Pakete gibt, die ein Kommando + Manpage enthalten. https://manpages.debian.org/crontab.1 führt z.B. zur Manpage aus bcron, statt aus cron, was wahrscheinlich meist unerwartet ist. Da müsste man das Paket wiederum explizit nennen:
https://manpages.debian.org/cron/crontab.1
https://manpages.debian.org/cron/crontab.5
und etwa [man]cron/crontab.1[/man] oder [man]cron/crontab.5[/man].

Ich seh schon, wo die Einwände in dem älteren Vorschlagsthread herkamen

[Meillo]

Das erreicht man eigentlich mit folgender URL: https://manpages.debian.org/crontab ... da kann man dann rechts sowohl die Sprache als auch die Sektion auswaehlen/aendern.

Wenn man an die URL am Ende einfach die konkrete Sektion anhängt, kommt man direkt zu der gewünschten, wenns mehrere gibt:
https://manpages.debian.org/crontab.1
https://manpages.debian.org/crontab.5

Das könnte man in einem BBCode-Tag ausnutzen: [man]crontab.1[/man] oder [man]crontab.5[/man].

Perfekt!

Ein Problem könnte hier sein, wenn es mehrere Pakete gibt, die ein Kommando + Manpage enthalten.

Das scheint mir zu viel Perfektion zu sein. Derzeit schreiben die User einfach nur hin: ``Manpage crontab'', es ist also keineswegs so, dass durch das Tag die Situation verschlechtert werden wuerde ... wir machen sie nur nicht perfekt ... aber das war sie zuvor auch nicht.

Wenn jemand eine ganz bestimmte Manpage meint, dann kann er sie auch einfach als URL verlinken. Das man-Tag muss IMO nicht alle Faelle abdenken, bloss den ueblichsten Fall verbessern, indem es einen bequemeren Zugang zu ihnen bietet, ... und Manpages insgesamt und der Seite https://manpages.debian.org etwas mehr Aufmerksamkeit schenken.

[JTH]

Das scheint mir zu viel Perfektion zu sein.

Das ist manchmal mein zweiterdritter Vorname

Derzeit schreiben die User einfach nur hin: ``Manpage crontab'', es ist also keineswegs so, dass durch das Tag die Situation verschlechtert werden wuerde ... wir machen sie nur nicht perfekt ... aber das war sie zuvor auch nicht.

Da geht es dann oft ja schon um ein konkretes Paket, auf dessen Manpage man verweisen möchte und das der Problemstellung wegen schon beim Fragenden installiert ist. Ich fänds nicht verkehrt, wenn man optional deshalb auf die Manpage eines bestimmten Pakets verweisen könnte.

Falls sich so ein BBCode-Tag leicht so umsetzen lässt (kenne mich mit den Möglichkeiten von phpBB nicht aus), dass einfach der Text zwischen dem öffnenden und schließenden an die erwähnte URL https://manpages.debian.org/ angehängt wird, wäre das ja auch mit abgedeckt:

[man]crontab[/man] -> man crontab [https://manpages.debian.org/crontab]
[man]crontab.5[/man] -> man crontab(5) [https://manpages.debian.org/crontab.5]
[man]cron/crontab[/man] -> man crontab [https://manpages.debian.org/cron/crontab]
[man]cron/crontab.5[/man] -> man crontab(5) [https://manpages.debian.org/cron/crontab.5]

Oder so in der Art.

Wie auf https://manpages.debian.org/ beschrieben, kann man Debianrelease, Sprache, Sektion und Paket ja beliebig anhängen oder weglassen und wird auf das passendste weitergeleitet.

[Meillo]

Falls sich so ein BBCode-Tag leicht so umsetzen lässt (kenne mich mit den Möglichkeiten von phpBB nicht aus), dass einfach der Text zwischen dem öffnenden und schließenden an die erwähnte URL https://manpages.debian.org/ angehängt wird, wäre das ja auch mit abgedeckt:

Genau so funktioniert das beim BBCode, meine ich. Damit kann man diese ganzen Faelle wunderbar abdecken.

Man muss eigentlich dann nur noch rausfinden was man wie eingeben kann, damit es auf manpages.debian.org funktioniert. Das aendert aber nichts an der BBCode-Umsetzung, die einfach das zwischen den Tags an `https://manpages.debian.org/' anhaengt und einen Link daraus macht. (Plus ein nettes Icon. )

[feltel]

Falls sich so ein BBCode-Tag leicht so umsetzen lässt (kenne mich mit den Möglichkeiten von phpBB nicht aus), dass einfach der Text zwischen dem öffnenden und schließenden an die erwähnte URL https://manpages.debian.org/ angehängt wird, wäre das ja auch mit abgedeckt:

Ja, das geht, zumindest in gewissen Grenzen. Man kann verschiedene Token-Typen zwischen die BBCode-Tags setzen. Je strikter oder lascher geht dann der Parser drüber, und man fängt sich ggf. andere Baustellen oder "Ausnutzungsmöglichkeiten" ein:

Code: Alles auswählen

{TEXT}	Jeder Text, einschließlich fremder Zeichen, Ziffern usw.
{SIMPLETEXT}	Zeichen des lateinischen Alphabets (A-Z), Ziffern, Leerzeichen, Komma, Punkt, Minus, Plus und Unterstrich
{INTTEXT}	Unicode-Buchstaben, Ziffern, Leerzeichen, Komma, Punkt, Minus, Plus, Bindestrich, Unterstrich und Leerräume.
{IDENTIFIER}	Zeichen des lateinischen Alphabets (A-Z), Ziffern, Bindestrich und Unterstrich
{NUMBER}	Ziffernfolgen
{EMAIL}	Eine gültige E-Mail-Adresse
{URL}	Eine gültige URL eines erlaubten Protokolls (http, ftp usw. — kann nicht für JavaScript-Exploits verwendet werden). Falls nicht angegeben, wird „http://“ vorangestellt.
{LOCAL_URL}	Eine lokale URL. Muss relativ zur Themenansicht angegeben werden. Protokoll und Domain darf nicht vorangestellt werden, da den Links „https://debianforum.de/forum/“ vorangestellt wird.
{RELATIVE_URL}	Eine relative URL. Kann verwendet werden, um Teile einer URL zu prüfen. Achtung: auch eine vollständige URL ist eine gültige relative URL. Wenn relative URLs zur Adresse des Boards verwendet werden sollen, sollte der LOCAL_URL-Token verwendet werden.
{COLOR}	Eine HTML-Farbe. Es kann entweder der hexadezimale Wert (z. B. #FF1234) oder ein CSS-Farbwert wie z. B. fuchsia oder InactiveBorder angegeben werden.

Ich würde hier wenn überhaupt SIMPLETEXT nehmen, da fällt dann aber sowas wie [man]cron/crontab[/man] weg, weil der Forward-Slash ein nicht erlaubtes Zeichen wäre.

[Meillo]

`RELATIVE_URL' waere der richtige Wert, da es sich darum ja auch handelt: der relative Pfad ausgehend von `manpages.debian.org/'.

Falls jemand Quatsch eintraegt, dann geht der generierte Link halt nicht, aber das ist bei [ url ]-Tags ja auch der Fall.

[feltel]

das könnte tatsächlich klappen.

[eggy]

Soweit ich das durchdringe stellt manpages.d.n "nur" für stable, testing und sid die jeweiligen Manpages bereit. Für ältere Releases wohl nicht. Auf der anderen Seite ändert sich bei den Manpages ja nicht so viel, es sei denn ein Paket fällt aus Debian raus, da hätte man dann natürlich tote Links.

Kann mich irren, aber ich dachte, der Service wäre noch relativ neu, und daher gäbe es halt noch nicht soviel .. wie gesagt, ka, nur ne Annahme. Hat jemand mehr Infos?

[JTH]

Hat jemand mehr Infos?

Am Beispiel crontab(1) geht die Seite immerhin zurück bis Wheezy: https://manpages.debian.org/wheezy/cron/crontab.1. Heißt natürlich nicht, dass es manpages.debian.org seitdem schon gibt.

Zweite Spur: Das Werkzeug debiman, dass anscheinend hinter dem Erzeugen der HTML-Manpages steckt, hatte seinen ersten Commit 2017.

2013 wurde manpages.debian.net zu manpages.debian.org. manpages.debian.net wurde 2007 anscheinend schon einmal wiederbelebt, es gab die Seite der Mail nach aber auch vorher schonmal.

So, genug Detektivarbeit für dieses Jahr

[reox]

Ja die Feinheiten sind sicherlich wichtig, aber ich denke mal in den meisten Fällen reicht ja ein das einfachste Format und ich glaube auch mit der relative URL könnte das schon gut klappen.
wichtig ist ja nur ein cooles icon sowas wie: in #CE0056 - wobei ich sehe, dass sowas ja schon das icon für deb-src ist. Alternativ ein Buch:
Würde für den Quellcode nicht eher sowas passen: ? Wobei ich schon verstehe, dass source code als dokument darzustellen und das paket ist ja eher dann das fertige. nicht so einfach