Browse Source

Add documentation and desktop starter for new hidden/continue mode

tags/v0.1
Nils 1 year ago
parent
commit
600790e0d0
12 changed files with 617 additions and 565 deletions
  1. +2
    -0
      Makefile.in
  2. +1
    -1
      README.md
  3. +10
    -0
      desktop/argodejo-continue.desktop
  4. +10
    -3
      documentation/argodejo.1
  5. +9
    -5
      documentation/english.adoc
  6. +9
    -5
      documentation/english.part.adoc
  7. +8
    -5
      documentation/german.adoc
  8. +8
    -5
      documentation/german.part.adoc
  9. +1
    -1
      documentation/nsm-data.1
  10. +15
    -8
      documentation/out/english.html
  11. +15
    -8
      documentation/out/german.html
  12. +529
    -524
      qtgui/resources.py

+ 2
- 0
Makefile.in View File

@@ -41,6 +41,7 @@ install:
install -D -m 644 LICENSE $(DESTDIR)$(PREFIX)/share/doc/$(PROGRAM)/LICENSE

install -D -m 644 desktop/desktop.desktop $(DESTDIR)$(PREFIX)/share/applications/$(PROGRAM).desktop
install -D -m 644 desktop/argodejo-continue.desktop $(DESTDIR)$(PREFIX)/share/applications/argodejo-continue.desktop

install -d $(DESTDIR)$(PREFIX)/share/man/man1
gzip -c documentation/$(PROGRAM).1 > $(DESTDIR)$(PREFIX)/share/man/man1/$(PROGRAM).1.gz
@@ -69,6 +70,7 @@ uninstall:
rm -f $(DESTDIR)$(PREFIX)/bin/$(PROGRAM)
rm -f $(DESTDIR)$(PREFIX)/bin/nsm-data
rm -f $(DESTDIR)$(PREFIX)/share/applications/$(PROGRAM).desktop
rm -f $(DESTDIR)$(PREFIX)/share/applications/argodejo-continue.desktop
rm -f $(DESTDIR)$(PREFIX)/share/man/man1/$(PROGRAM).1.gz

#Icons

+ 1
- 1
README.md View File

@@ -1,5 +1,5 @@

[//]: # (Generated 2020-05-17T23:16:59.789529. Changes belong into template/documentation/readme.template)
[//]: # (Generated 2020-06-11T19:20:27.804895. Changes belong into template/documentation/readme.template)

#Argodejo
Program version 0.1

+ 10
- 0
desktop/argodejo-continue.desktop View File

@@ -0,0 +1,10 @@
[Desktop Entry]
Type=Application
Name=Argodejo Continue
Comment=Music and audio production session manager based on NSM. Continue last session, start as TrayIcon.
Exec=argodejo --continue --hide
Icon=argodejo
Terminal=false
StartupNotify=false
Version=1.0
Categories=AudioVideo;Audio;X-Recorders;X-Multitrack;X-Jack;

+ 10
- 3
documentation/argodejo.1 View File

@@ -1,9 +1,9 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.15.
.TH ARGODEJO "1" "May 2020" "Argodejo 0.1" "User Commands"
.TH ARGODEJO "1" "June 2020" "Argodejo 0.1" "User Commands"
.SH NAME
Argodejo - Music and audio production session manager based on NSM.
.SH DESCRIPTION
usage: argodejo [\-h] [\-v] [\-V] [\-u URL] [\-\-nsm\-url URL] [\-s SESSION]
usage: argodejo [\-h] [\-v] [\-V] [\-u URL] [\-\-nsm\-url URL] [\-s SESSION] [\-c] [\-i]
.IP
[\-\-session\-root SESSIONROOT]
.PP
@@ -33,7 +33,14 @@ osc.udp://myhost.localdomain:14294/
Same as \fB\-\-url\fR.
.TP
\fB\-s\fR SESSION, \fB\-\-session\fR SESSION
Session to open on startup.
Session to open on startup. Overrides \fB\-\-continue\fR
.TP
\fB\-c\fR, \fB\-\-continue\fR
Autostart last active session.
.TP
\fB\-i\fR, \fB\-\-hide\fR
Start GUI hidden in tray, only if tray available on
system.
.TP
\fB\-\-session\-root\fR SESSIONROOT
Root directory of all sessions. Defaults to '$HOME/NSM

+ 9
- 5
documentation/english.adoc View File

@@ -293,10 +293,6 @@ hides Argodejo.
If you close Argodejo using the normal window manager function, such as a click on the [X], the
program and the session is not terminated, but minimized to the tray.

If the Argodejo window is hidden and closed via the tray menu (see below), Argodejo will be
minimized to the next start also started as tray icon. So it is possible to continue working
without having to deal with the program window.

A right click on the icon gives you access to common functions:

You can directly start the most recently used sessions.
@@ -319,9 +315,17 @@ complete list please use the --help parameter.

For example:

* `--session-root /home/user/production2030` sets the root directory. Only sessions in this directory are displayed, everything is stored here.
* `--session newAlbum/mySong` starts the given session.
* `--continue` starts the last active session.
* `--hide` starts Argodejo as TrayIcon.
* `--url osc.udp://myhost.localdomain:14294/` connects to this server, if available, or starts the internal session server at this address. This is a very technical option and probably not needed.
* `--session-root /home/user/production2030` sets the root directory. Only sessions in this directory are displayed, everything is stored here.

The combination of `--continue` and `--hide` is essentially what many people expect from Session
Management: Resuming at the previous state, without any extra windows in their way.
If your system uses a start menu you will find not only the normal Argodejo starter but also
"Argodejo Continue" to start this mode directly.


== Miscellaneous / Explanations / FAQ


+ 9
- 5
documentation/english.part.adoc View File

@@ -238,10 +238,6 @@ hides Argodejo.
If you close Argodejo using the normal window manager function, such as a click on the [X], the
program and the session is not terminated, but minimized to the tray.

If the Argodejo window is hidden and closed via the tray menu (see below), Argodejo will be
minimized to the next start also started as tray icon. So it is possible to continue working
without having to deal with the program window.

A right click on the icon gives you access to common functions:

You can directly start the most recently used sessions.
@@ -264,9 +260,17 @@ complete list please use the --help parameter.

For example:

* `--session-root /home/user/production2030` sets the root directory. Only sessions in this directory are displayed, everything is stored here.
* `--session newAlbum/mySong` starts the given session.
* `--continue` starts the last active session.
* `--hide` starts Argodejo as TrayIcon.
* `--url osc.udp://myhost.localdomain:14294/` connects to this server, if available, or starts the internal session server at this address. This is a very technical option and probably not needed.
* `--session-root /home/user/production2030` sets the root directory. Only sessions in this directory are displayed, everything is stored here.

The combination of `--continue` and `--hide` is essentially what many people expect from Session
Management: Resuming at the previous state, without any extra windows in their way.
If your system uses a start menu you will find not only the normal Argodejo starter but also
"Argodejo Continue" to start this mode directly.


== Miscellaneous / Explanations / FAQ


+ 8
- 5
documentation/german.adoc View File

@@ -285,10 +285,6 @@ Trayicon zeigt oder versteckt Argodejo.
Schließt man Argodejo über die normale Windowmanagerfunktion, etwa ein Klick auf das [X], wird das
Programm und die Session nicht beendet, sondern in den Tray minimiert.

Ist das Argodejofenster versteckt und wird über das Traymenü geschlossen (s.u.) wird Argodejo beim
nächsten Start auch als Trayicon gestartet. Somit ist es möglich weiter zu arbeiten ohne sich mit
dem Programmfenster befassen zu müssen.

Ein Rechtsklick auf das Icon bietet Schnellzugriff auf häufige Funktionen:

Sie können hier die zuletzt benutzen Sessions direkt starten.
@@ -310,9 +306,16 @@ angeben. Für eine vollständige Liste benutzen Sie bitte den --help Parameter.

Eine Auswahl:

* `--session-root /home/benutzer/produktion2020` setzt das Wurzelverzeichnis. Nur Sessions in diesem Verzeichnis werden angezeigt, alles wird dort gespeichert.
* `--session neuesAlbum/meinLied` startet direkt die angegebene Session.
* `--continue` startet die zuletzt benutzte Session
* `--hide` startet Argodejo als Trayicon.
* `--url osc.udp://myhost.localdomain:14294/` verbindet sich zu diesem Server, falls vorhanden, oder startet den internen Session-Server unter dieser Adresse. Dies ist eine sehr technische Option und wird wahrscheinlich nicht benötigt.
* `--session-root /home/benutzer/produktion2020` setzt das Wurzelverzeichnis. Nur Sessions in diesem Verzeichnis werden angezeigt, alles wird dort gespeichert.

Die Kombination von `--continue` und `--hide` ergibt einen Modus, den viele Leute vom Session Management
erwarten: dort weiter machen wo man aufgehört hat, ohne dass Extrafenster angezeigt werden.
Falls Ihr System über ein Startmenü verfügt finden Sie daher neben dem normalen Argodejo-Starter
auch eine "Argodejo Continue"-Verknüpfung für genau diesen Modus.

== Verschiedenes / Erklärungen / FAQ


+ 8
- 5
documentation/german.part.adoc View File

@@ -256,10 +256,6 @@ Trayicon zeigt oder versteckt Argodejo.
Schließt man Argodejo über die normale Windowmanagerfunktion, etwa ein Klick auf das [X], wird das
Programm und die Session nicht beendet, sondern in den Tray minimiert.

Ist das Argodejofenster versteckt und wird über das Traymenü geschlossen (s.u.) wird Argodejo beim
nächsten Start auch als Trayicon gestartet. Somit ist es möglich weiter zu arbeiten ohne sich mit
dem Programmfenster befassen zu müssen.

Ein Rechtsklick auf das Icon bietet Schnellzugriff auf häufige Funktionen:

Sie können hier die zuletzt benutzen Sessions direkt starten.
@@ -281,9 +277,16 @@ angeben. Für eine vollständige Liste benutzen Sie bitte den --help Parameter.

Eine Auswahl:

* `--session-root /home/benutzer/produktion2020` setzt das Wurzelverzeichnis. Nur Sessions in diesem Verzeichnis werden angezeigt, alles wird dort gespeichert.
* `--session neuesAlbum/meinLied` startet direkt die angegebene Session.
* `--continue` startet die zuletzt benutzte Session
* `--hide` startet Argodejo als Trayicon.
* `--url osc.udp://myhost.localdomain:14294/` verbindet sich zu diesem Server, falls vorhanden, oder startet den internen Session-Server unter dieser Adresse. Dies ist eine sehr technische Option und wird wahrscheinlich nicht benötigt.
* `--session-root /home/benutzer/produktion2020` setzt das Wurzelverzeichnis. Nur Sessions in diesem Verzeichnis werden angezeigt, alles wird dort gespeichert.

Die Kombination von `--continue` und `--hide` ergibt einen Modus, den viele Leute vom Session Management
erwarten: dort weiter machen wo man aufgehört hat, ohne dass Extrafenster angezeigt werden.
Falls Ihr System über ein Startmenü verfügt finden Sie daher neben dem normalen Argodejo-Starter
auch eine "Argodejo Continue"-Verknüpfung für genau diesen Modus.

== Verschiedenes / Erklärungen / FAQ


+ 1
- 1
documentation/nsm-data.1 View File

@@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.15.
.TH NSM-DATA "1" "May 2020" "nsm-data 1.0" "User Commands"
.TH NSM-DATA "1" "June 2020" "nsm-data 1.0" "User Commands"
.SH NAME
nsm-data \- manual page for nsm-data 1.0
.SH DESCRIPTION

+ 15
- 8
documentation/out/english.html View File

@@ -910,11 +910,6 @@ hides Argodejo.</p>
program and the session is not terminated, but minimized to the tray.</p>
</div>
<div class="paragraph">
<p>If the Argodejo window is hidden and closed via the tray menu (see below), Argodejo will be
minimized to the next start also started as tray icon. So it is possible to continue working
without having to deal with the program window.</p>
</div>
<div class="paragraph">
<p>A right click on the icon gives you access to common functions:</p>
</div>
<div class="paragraph">
@@ -950,16 +945,28 @@ complete list please use the --help parameter.</p>
<div class="ulist">
<ul>
<li>
<p><code>--session-root /home/user/production2030</code> sets the root directory. Only sessions in this directory are displayed, everything is stored here.</p>
<p><code>--session newAlbum/mySong</code> starts the given session.</p>
</li>
<li>
<p><code>--session newAlbum/mySong</code> starts the given session.</p>
<p><code>--continue</code> starts the last active session.</p>
</li>
<li>
<p><code>--hide</code> starts Argodejo as TrayIcon.</p>
</li>
<li>
<p><code>--url osc.udp://myhost.localdomain:14294/</code> connects to this server, if available, or starts the internal session server at this address. This is a very technical option and probably not needed.</p>
</li>
<li>
<p><code>--session-root /home/user/production2030</code> sets the root directory. Only sessions in this directory are displayed, everything is stored here.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>The combination of <code>--continue</code> and <code>--hide</code> is essentially what many people expect from Session
Management: Resuming at the previous state, without any extra windows in their way.
If your system uses a start menu you will find not only the normal Argodejo starter but also
"Argodejo Continue" to start this mode directly.</p>
</div>
</div>
</div>
<div class="sect1">
@@ -1241,7 +1248,7 @@ The easiest way is to contact the developers and they will setup the new languag
</div>
<div id="footer">
<div id="footer-text">
Last updated 2020-05-17 23:16:59 +0200
Last updated 2020-06-11 19:20:27 +0200
</div>
</div>
</body>

+ 15
- 8
documentation/out/german.html View File

@@ -901,11 +901,6 @@ Trayicon zeigt oder versteckt Argodejo.</p>
Programm und die Session nicht beendet, sondern in den Tray minimiert.</p>
</div>
<div class="paragraph">
<p>Ist das Argodejofenster versteckt und wird über das Traymenü geschlossen (s.u.) wird Argodejo beim
nächsten Start auch als Trayicon gestartet. Somit ist es möglich weiter zu arbeiten ohne sich mit
dem Programmfenster befassen zu müssen.</p>
</div>
<div class="paragraph">
<p>Ein Rechtsklick auf das Icon bietet Schnellzugriff auf häufige Funktionen:</p>
</div>
<div class="paragraph">
@@ -941,16 +936,28 @@ angeben. Für eine vollständige Liste benutzen Sie bitte den --help Parameter.<
<div class="ulist">
<ul>
<li>
<p><code>--session-root /home/benutzer/produktion2020</code> setzt das Wurzelverzeichnis. Nur Sessions in diesem Verzeichnis werden angezeigt, alles wird dort gespeichert.</p>
<p><code>--session neuesAlbum/meinLied</code> startet direkt die angegebene Session.</p>
</li>
<li>
<p><code>--session neuesAlbum/meinLied</code> startet direkt die angegebene Session.</p>
<p><code>--continue</code> startet die zuletzt benutzte Session</p>
</li>
<li>
<p><code>--hide</code> startet Argodejo als Trayicon.</p>
</li>
<li>
<p><code>--url osc.udp://myhost.localdomain:14294/</code> verbindet sich zu diesem Server, falls vorhanden, oder startet den internen Session-Server unter dieser Adresse. Dies ist eine sehr technische Option und wird wahrscheinlich nicht benötigt.</p>
</li>
<li>
<p><code>--session-root /home/benutzer/produktion2020</code> setzt das Wurzelverzeichnis. Nur Sessions in diesem Verzeichnis werden angezeigt, alles wird dort gespeichert.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>Die Kombination von <code>--continue</code> und <code>--hide</code> ergibt einen Modus, den viele Leute vom Session Management
erwarten: dort weiter machen wo man aufgehört hat, ohne dass Extrafenster angezeigt werden.
Falls Ihr System über ein Startmenü verfügt finden Sie daher neben dem normalen Argodejo-Starter
auch eine "Argodejo Continue"-Verknüpfung für genau diesen Modus.</p>
</div>
</div>
</div>
<div class="sect1">
@@ -1247,7 +1254,7 @@ Ansonsten starten Sie argodejo mit diesem Befehl, Sprachcode ändern, vom Termin
</div>
<div id="footer">
<div id="footer-text">
Last updated 2020-05-17 23:16:59 +0200
Last updated 2020-06-11 19:20:27 +0200
</div>
</div>
</body>

+ 529
- 524
qtgui/resources.py
File diff suppressed because it is too large
View File


Loading…
Cancel
Save