Integrierte Hilfe/Dokomentation

  • C#
  • .NET (FX) 4.5–4.8

Es gibt 3 Antworten in diesem Thema. Der letzte Beitrag () ist von Nofear23m.

    Integrierte Hilfe/Dokomentation

    Guten Morgen,

    ich würde in meine Anwendung gerne eine Hilfe/Dokumentation integrieren.

    Meine Idee bis jetzt:
    Ein Hilfesymbol in der TitleBar und wenn drauf geklickt wird, soll die Hifle zur aktuellen Anwendung (IP-Scanner, Port-Scanner usw.) angezeigt werden.

    Da ich die Dokumentation gleichzeitig auf Github/Wiki pflegen möchte, ein Webbrowser aber nicht unbedingt bei einem Netzwerktool (zum suchen von Netzwerkproblemen) in Frage kommt. Denke ich darüber nach, die Markdown-Dateien vom Wiki mit auszuliefern und in meiner Anwendung anzeigen zu lassen.


    Hat das von euch schonmal jemand gemacht oder kennt ein gutes Control/Libary dazu?

    CefSharp kann mit Markdown umgehen, ist aber etwas overkill. Und meine Anwendung würde nur auf x64 laufen.


    Gruß
    BornToBeRoot


    PS: Achja... das ganze soll für WPF geeignet sein. Habs trotzdem in diesem Unterforum gepostet, weil es kein reines WPF Problem ist.
    NETworkManager - A powerful tool for managing networks and troubleshoot network problems!

    Hallo

    Ich würde ja die F1 Taste verwenden.
    Wenn du das Wiki ja eh vor hast, warum machst du es nicht so das man wenn man auf das Symbol klick (oder F1) das man direkt zur richtigen Wiki-Seite kommt.
    so hast du auch nur 1x die Arbeit. Wiki machen und Fertig. Wie in VS wenn man F1 drückt.

    Grüße
    Sascha

    PS: Ich mach das immer so das ich ein eigenes WINDOW habe welches von Window erbt. Dieses implementiert die Funtionalität für F1 und ist gebunden an einen Command im ViewModel (ist bei mir im ViewModelBase damit jedes Fenster es hat) und der Command öffnet die Seite oder was auch immer. Im ViewModelBase igbt es dann noch ein Prop HelpLink welcher von jedem ViewModel überschrieben werden muss, damit jedes ViewModel seinen Link übergibt.
    If _work = worktype.hard Then Me.Drink(Coffee)
    Seht euch auch meine Tutorialreihe <WPF Lernen/> an oder abonniert meinen YouTube Kanal.

    ## Bitte markiere einen Thread als "Erledigt" wenn deine Frage beantwortet wurde. ##

    BornToBeRoot schrieb:

    ein Webbrowser aber nicht unbedingt bei einem Netzwerktool (zum suchen von Netzwerkproblemen) in Frage kommt


    Was mach ich, wenn jemand in einem Netzwerk ohne Internet unterwegs ist? (so wie ich öfters)
    Oder gerade ein Netzwerkproblem hat?!

    Online doku ist super, einmal pflegen, fertig. Aber hier ist das irgendwie suboptimal.
    NETworkManager - A powerful tool for managing networks and troubleshoot network problems!

    Sorry, überlesen.

    Aber du kannst es ja Offline mitliefern!
    Ansonsten eine CHM erstellen. Hier: chip.de/downloads/chmProcessor…M-Converter_73845467.html

    Ausserdem, ich finde das ein Netzwerktool nicht unbedingt impliziert das man Netzwerkprobleme hat. Habe auch Netzwerktools im Einsatz für diverse Dinge.
    Wenn ich Problemen auf die Spur gehe habe ich IMMER einen Rechner mit Internet dabei. Heute geht das auch mim Handy.

    Aber wenn du die HTMLs lokal hast kannst du diese Lokal auch immer aufrufen. Eifach vor jedem Update das WIKI herunterladen.
    Ich finde es immer SEHR schade wenn man etwas an mehr als einer Stelle warten muss.

    Grüße
    Sascha
    If _work = worktype.hard Then Me.Drink(Coffee)
    Seht euch auch meine Tutorialreihe <WPF Lernen/> an oder abonniert meinen YouTube Kanal.

    ## Bitte markiere einen Thread als "Erledigt" wenn deine Frage beantwortet wurde. ##