2008-11-10 36 views
11

Ich möchte allen Open-Source-Bibliotheken, die wir in unserer (kommerziellen) Anwendung verwenden, Anerkennung schenken. Ich dachte daran, eine HTML-Seite in unserem About-Dialog zu zeigen. Unser Build-Prozess verwendet ant und die Third-Party-Bibliotheken werden in svn festgeschrieben.So zeigen Sie Credits an

Was ist Ihrer Meinung nach der beste Weg, die HTML-Seite zu generieren?

  • Harte Code die HTML-Seite?
  • Schalter abhängigkeits Management-Efeu Apache und einige Ant-Task schreiben den HTML-Code
  • Verwenden Maven-ant-Aufgaben und schreiben einige Ant-Task zu erzeugen, um die HTML nur
  • Verwenden Maven zu erzeugen, um die Abhängigkeiten zu handhaben und die HTML einmal, lade sie herunter und verbinde sie. Der Rest von dem unverändert ant-scripts
  • Switch to maven2 getan wird (Hey Boss, ich mag Maven wechseln, in 1 Monat der Bau vielleicht wieder arbeiten ...)
  • ...

Welche Elemente sollte der About-Dialog zeigen?

  • Name der Bibliothek
  • Version
  • Lizenz
  • Autor
  • Homepage
  • Änderungen mit Link zum Quellarchiv
  • ...

einige besten Gibt es gemacht -Praxis-Beratung? Einige gute Beispiele (Anwendungen mit einem netten Dialog, der die Abhängigkeiten zeigt)?

Antwort

3

Es gibt zwei verschiedene Dinge, die Sie beachten müssen.

Zuerst müssen Sie möglicherweise die Lizenzen des Drittanbietercodes identifizieren. Dies ist oft mit einer THIRDPARTYLICENSE-Datei nicht möglich. Sun Microsystems tut dies sehr. Schauen Sie zum Beispiel im Installationsverzeichnis von OpenOffice.org nach. Es gibt Beispiele für .txt- und .html-Versionen solcher Dateien.

Zweitens möchten Sie vielleicht Ihre Abhängigkeiten im Feld Info auf kurze Weise identifizieren (und auch auf die Datei der Lizenzinformationen verweisen). Ich würde sicherstellen, dass die Versionen in der Info-Box angezeigt werden. Eine Sache, nach der Nutzer schnell suchen möchten, ist ein Hinweis darauf, ob die Kopie Ihres Codes ersetzt oder aktualisiert werden muss, da bei einem Ihrer Bibliotheksabhängigkeiten ein Fehler oder eine Sicherheitslücke in letzter Zeit aufgetreten ist.

Also ich denke, die andere Sache, die Sie in die About-Box aufnehmen möchten, ist eine Möglichkeit für Menschen, Ihre Support-Website und Hinweise für Benutzer der jeweiligen Version zu finden (unabhängig davon, ob Sie eine Bereitstellung in Ihrer App haben oder nicht) zur Online-Überprüfung auf Updates).

3

Ant Task scheint der beste Weg zu sein. Ähnliches machen wir in einem unserer Projekte. Alle Open Source-Bibliotheken sind in einem angegebenen Ordner vorhanden. Eine Ant-Task liest das Manifest dieser Bibliotheken, Versionen usw. und generiert einen HTML-Code, der in einen anderen angegebenen Ordner kopiert wird, von wo aus er vom Webcontainer abgerufen wird.

+0

Und was tun Sie, wenn das Manifest des Bibliotheksglases keine Informationen enthält? –

2

Das Generieren der Seite mit jedem Build wäre verschwenderisch, wenn sich die Bibliotheken nicht oft ändern würden. Bibliotheksversionen können sich ändern, die eigentlichen Bibliotheken jedoch nicht. Einfacher wäre es, einfach eine HTML-Seite zu erstellen, dies wäre der einfachste Ausweg, aber das ist ein weiterer Kopfschmerz. Generiere es einmal und füge es in das Paket ein. Das Skript kann immer erneut ausgeführt werden, wenn Änderungen an den Bibliotheken vorgenommen werden (Aktualisieren von Versionen, Hinzufügen neuer Bibliotheken).

Verwandte Themen