Sviluppare un X-Software/How to develop an X-Software

Main menu

Links

winPenPack - The Portable Software Collection :: Forums :: X-Software development

<< Previous thread | Next thread >>

Sviluppare un X-Software/How to develop an X-Software

Go to page >>

Author

Post

Danix

Sun 01 Feb 2009 - 19:20

Registered Member #1

Joined: Fri 29 Dec 2006 - 05:38
Location: Sassari
Posts: 12956

Sviluppo X-Software
(ultima revisione: 05.08.2009)

Quali X-Software possono essere sviluppati: poiché per licenza non sono consentite modifiche sui software Freeware (nè tantomeno su quelli Shareware e Commerciali) lo sviluppo X-Software deve riguardare esclusivamente programmi rilasciati sotto licenza open source (GPL, LGPL, MPL, MIT, etc..), in caso contrario i topic relativi verranno chiusi e spostati d'ufficio nella sezione "Software NON portabilizzabili".
Ricerca: prima di iniziare lo sviluppo di un X-Software è necessario effettuare una ricerca nel sito per verificare che il software non sia già stato portabilizzato.
Programmi in .Net: è ammesso lo sviluppo di programmi che richiedono .Net Framework installato nel sistema.
Programmi in Java: è ammesso lo sviluppo di programmi che richiedono Java Runtime Environment (JRE), a patto che questa non debba essere installata nel sistema e che risieda nella sua forma portatile in $Lib$\Java. Nota: se esiste un'installazione di JRE nel computer ospite, l'X-Software deve utilizzare la versione portatile inclusa in $Lib$\Java.
X-Launcher: le portabilizzazioni devono essere effettuate utilizzando X-Launcher, per il cui utilizzo rimandiamo a questo tutorial e agli innumerevoli esempi di portabilizzazione presenti sul sito.
File INI: i file INI devono essere scritti secondo il modello di X-Launcher versione 1.3.1 o superiori, compilando i campi relativi al nome autore del file INI, al numero di [rev] (che identifica la revisione del launcher), al revisore (se l'autore originale è un altro), alla data in cui l'INI è stato scritto, alla lingua (opzioni: it, en), al nome del software, alla versione-software del programma associato al launcher, all'URL del sito web del programma originale ed infine alla licenza del software portabilizzato.

Esempio:

[Version] Ini Author=Nome autore Ini Revision=7 Ini Rev.Author=Nome revisore (solo se diverso dall'autore) Ini Date=30/10/2008 (nel formato gg/mm/yyyy) Ini Locale=it Software=OpenOffice.org Soft.Version=3.0.1 Web=http://www.openoffice.org/ Launcher=1.4 System= [Group] Category= Sub Category= License=GNU Lesser General Public License

Per la parte relativa alla portabilizzazione rimandiamo a questo tutorial e agli innumerevoli esempi di portabilizzazione presenti sul sito.
Splash screen "development": gli utenti interessati ad utilizzare gli X-Software presenti nella sezione "Sviluppo X-Software" devono essere informati chiaramente che si tratta di versioni di sviluppo. Ciascun X-Software deve pertanto mostrare all'avvio lo splash screen allegato, da includere in $Home$\$AppName$ e da attivare aggiungendo le seguenti istruzioni al file X-Software.ini:

[Options] ShowSplash=true [SplashScreen] Image=$Home$\$AppName$\x-splash_development.jpg Title= TimeOut=1500

x-splash_development.zip
Creazione del pacchetto: per la fase conclusiva, usare lo standard utilizzato per gli X-Software in download, includendo l'ultima cartella ReadMe (da copiare dall'ultimo X-Software in download) contenente le note di copyright e il file release.txt, al cui interno deve comparire un link che punta alla relativa discussione sul forum e i cui campi vanno compilati in modo tale che sia chiaro che la release non è stata ancora rilasciata ufficialmente dal Team di sviluppo:

X-Software (BETA-VERSION) for testing only developed on: 27/01/2009
http://www.winpenpack.com/main/e107_plugins/forum/forum_viewtopic.php?29751

Esempio:

=========================================================================== X-OpenOffice.org 3.0.1 [rev 7] Original software Home:http://www.openoffice.org/ Original software license: GNU Lesser General Public License X-Software (BETA-VERSION) for testing only developed on: 27/01/2009
http://www.winpenpack.com/main/e107_plugins/forum/forum_viewtopic.php?29751
===========================================================================
Nome del pacchetto: l'X-Software, una volta completato, deve essere compresso in formato ZIP e va rinominato usando lo standard:

X-Software_x.x_rev_x_test_x

dove "x.x" è la versione del software originale, "rev_x" è la revisione del file INI, "test_x" è il numero della versione di sviluppo.

Esempio:

X-Nomesoftware_1.2_rev_4_test_1
Upload: l'X-Software non va MAI allegato a un post nel forum, ma deve essere
caricato su un proprio spazio web o su spazi offerti da servizi come DivShare o esnips.
Segnalazione: la segnalazione va effettuata nella sezione "Sviluppo X-Software" o in "Pre-release/Beta-version" aprendo una discussione distinta per ciascun programma, solo se NON esiste una scheda ad esso relativa in "Richieste di portabilizzazione" o in "Sviluppo X-Software". In caso contrario, cioè se la richiesta di portabilizzazione (o la segnalazione in "Sviluppo") è già presente, la versione di TEST va postata in coda al topic esistente. Il Team di sviluppo si occuperà di spostare la discussione nella sezione apposita del forum. Per maggior chiarezza e per permettere di verificare che si è scaricato correttamente il file, va sempre indicata la dimensione del pacchetto segnalato.

Esempio di segnalazione:

Prima versione di TEST (14.665.89 Byte/13,9 Mb)
X-Nomesoftware_1.2_rev_4_test_1

Oppure:

Seconda versione di TEST (14.665.89 Byte/13,9 Mb)
X-Nomesoftware_1.2_rev_4_test_2

Tag di riferimento:

[file=indirizzo_web_pacchetto]X-Nomesoftware_1.2_rev_4_test_1[/file]
Dubbi e chiarimenti: eventuali chiarimenti/suggerimenti sulla procedura di sviluppo X-Software vanno postati in coda a questo stesso topic.

[ Edited Wed 05 Aug 2009 - 15:36 ]

Danix

Sun 01 Feb 2009 - 19:28

Registered Member #1

Joined: Fri 29 Dec 2006 - 05:38
Location: Sassari
Posts: 12956

X-Software Development
(last revision: 05.08.2009)

Policy for X-Software development: only software released under open source licenses (GPL, LGPL, MPL, MIT, etc.) is eligible for X-Software development. Freeware, Shareware and Commercial software are excluded due to license restrictions that do not allow modifications. Forum threads about non open source software will be closed and moved in the section "Programs that CAN'T be made portable".
Search before: before starting to develop a new X-Software, a site search must be done to check if the software has been already made portable.
.Net programs: X-Software development is allowed for programs that need .Net framework installed on the host system.
Java programs: X-Software development is allowed for programs that need Java Runtime Environment (JRE), provided that JRE can be used in its portable version, located in $Lib$\Java, and should not be installed on the host system. Note: a JRE can possibly reside on host system, but the X-Software must use the portable version in $Lib$\Java
X-Launcher: software must be made portable by means of X-Launcher. To learn how to use X-Launcher, please refer to this tutorial and to the many portabilization samples on the site.
INI files: the INI files needed to configure X-Launcher behaviour must comply with the INI template of X-Launcher ver. 1.3.1 (or higher). The following information about the INI file must be entered in the appropriate fields: name of the author, revision number of the file, name of the reviewer (only if different from author), date of composition, language (possible values: it, en). The following information about the original software must also be entered: name, version, URL of the website, type of license.

Example:

[Version] Ini Author=author name Ini Revision=7 Ini Rev.Author=reviewer name(only if different from author) Ini Date=30/10/2008 (gg/mm/yyyy format) Ini Locale=it Software=OpenOffice.org Soft.Version=3.0.1 Web=http://www.openoffice.org/ Launcher=1.4 System= [Group] Category= Sub Category= License=GNU Lesser General Public License

To learn how to make a software portable with X-Launcher, please refer to this tutorial and to the many samples on the site.
"Development" splash screen: users should be clearly informed that any X-Software found in "X-Software development" section is currently under development. So, during development, any X-Software must show the attached splash screen at startup. The image must be included in $Home$\$AppName$ and activated with the following instructions in the INI file:

[Options] ShowSplash=true [SplashScreen] Image=$Home$\$AppName$\x-splash_development.jpg Title= TimeOut=1500

x-splash_development.zip
Package creation: the package must follow the standard adopted for X-Softwares officially released and available for download. In particular the ReadMe folder must be present: its contents can be copied from the latest official X-Software, then copyright notes and file release.txt must be adapted. The release.txt must clearly state that the present X-Software is not yet officially released by winPenPack Development Team, and it must include a link to related thread in the forum:

X-Software (BETA-VERSION) for testing only developed on: 27/01/2009
http://www.winpenpack.com/main/e107_plugins/forum/forum_viewtopic.php?29751

Example:

=========================================================================== X-OpenOffice.org 3.0.1 [rev 7] Original software Home:http://www.openoffice.org/ Original software license: GNU Lesser General Public License X-Software (BETA-VERSION) for testing only developed on: 27/01/2009
http://www.winpenpack.com/main/e107_plugins/forum/forum_viewtopic.php?29751
===========================================================================
Package format and name: the package must be compressed in ZIP format and named according to this standard:

X-Software_x.x_rev_x_test_x

where "x.x" is the original software version, "rev_x" is the INI file revision, "test_x" is the development version number.

Example:

X-SoftwareName_1.2_rev_4_test_1
Upload: a packaged X-Software must NEVER be attached to a forum post. It should be made available on an owned web space or through freely accessible services like DivShare or esnips.
Announcement: when a packaged X-Software is available, the announcement must take place in "X-Software development" or "Pre-releases/Beta-versions" section ONLY IF a thread on that software DOES NOT exist in the same section or in "Portabilization requests" section. In the first case a new thread about the X-Software should be created. If a thread already exists, the announcement must be posted as a reply on that thread. The winPenPack Development Team will take care of moving the thread in the most appropriate forum section. The file size of package must also be entered to make sure that the file has been downloaded correctly.

Announcement example:

First TEST Version (14.665.89 Byte/13,9 Mb)
X-SoftwareName_1.2_rev_4_test_1

or:

Second TEST Version (14.665.89 Byte/13,9 Mb)
X-SoftwareName_1.2_rev_4_test_2

Tag to refer the package in the announcement:

[file=zipped_package_url_reference]X-SoftwareName_1.2_rev_4_test_1[/file]
Questions and explanations: possible questions, clarifications and suggestions about X-Software development must be sent as replies to this thread.

[ Edited Wed 05 Aug 2009 - 15:35 ]

Ketty

Mon 02 Feb 2009 - 15:17

Registered Member #5089

Joined: Sat 09 Jun 2007 - 02:27
Posts: 1461

12. Dubbi e chiarimenti: eventuali chiarimenti/suggerimenti sulla procedura di sviluppo X-Software vanno postati in coda a questo stesso topic.

Primo: confusione su questo:

compilando i campi relativi al nome autore dell'ini, al revisore (se l'autore originale è un altro)

esempio per Fmslogo -Link-

dove avevo buttato giù un ipotetico ini poi corretto da Danix.
Non so chi devo inserire da una parte e dall'altra

Secondo: avere una cartella con un nome identico ad una sotto cartella può creare conflitto? (Mi sono accorta di questo, con due pacchetti che ho preparato, anche se a dire il vero non ho rilevato problemi a riguardo)

Terzo: il file ini della lingua it o en. Quando l'x programma è solo in inglese o multilingua bisogna creare sempre la cartella English_users?

Ieri avevo tante domande ma mi sono scordata

Probabilmente per molti sono cose scontate, perdonate l'ignoranza a riguardo

Danix

Mon 02 Feb 2009 - 22:38

Registered Member #1

Joined: Fri 29 Dec 2006 - 05:38
Location: Sassari
Posts: 12956

@Ketty, cerco di chiarire i tuoi dubbi nel prossimo messaggio.

In questo post vorrei ringraziare PortableUmbo, che mi ha inviato la traduzione Inglese della versione italiana di questa pagina. E' stato un bel regalo, oltre che a un bellissimo gesto.

Grazie mille.

Danix

Mon 02 Feb 2009 - 23:00

Registered Member #1

Joined: Fri 29 Dec 2006 - 05:38
Location: Sassari
Posts: 12956

esempio per Fmslogo -Link-

dove avevo buttato giù un ipotetico ini poi corretto da Danix.
Non so chi devo inserire da una parte e dall'altra

In questo caso, poichè l'INI scritto dal primo autore non è stato oggetto di modifiche profonde e sostanziali da parte del revisore, ma solo di miglioramenti, occorre attribuire il Nome_autore al primo autore (e non al revisore) e aggiungere il Nome_revisore nell'apposito campo, indicando come numero revisione [rev2].

Se invece l'INI fosse stato scritto in modo completamente sbagliato dal primo autore e quindi il revisore avesse dovuto apportare modifiche fondamentali per il corretto funzionamento dell'X-Software, sarebbe dovuto essere considerato lui stesso autore, in questo caso attribuendo numero revisione [rev1].

Secondo: avere una cartella con un nome identico ad una sotto cartella può creare conflitto? (Mi sono accorta di questo, con due pacchetti che ho preparato, anche se a dire il vero non ho rilevato problemi a riguardo)

Non ho capito.

Terzo: il file ini della lingua it o en. Quando l'x programma è solo in inglese o multilingua bisogna creare sempre la cartella English_users?

Dipende dalle intenzioni e dalle capacità del portabilizzatore.

Ieri avevo tante domande ma mi sono scordata

Questo topic rimarrà aperto per chiarire dubbi, lungo il percorso.

[ Edited Mon 02 Feb 2009 - 23:01 ]

Ketty

Tue 03 Feb 2009 - 01:03

Registered Member #5089

Joined: Sat 09 Jun 2007 - 02:27
Posts: 1461

Prima cosa grazie per la pazienza

Per il primo punto, e riferendomi all'esempio citato, in sostanza Nome_autore Ketty e Nome_revisore Danix
(in caso Se i l'INI fosse stato scritto in modo completamente sbagliato, mi è chiaro)

Secondo: avere una cartella con un nome identico ad una sotto cartella può creare conflitto? (Mi sono accorta di questo, con due pacchetti che ho preparato, anche se a dire il vero non ho rilevato problemi a riguardo)

Non ho capito.

Mi ci sono ritrovata compilando l'ini per FLV Extract -Link-

(scusa se vado off per spiegarti)
Infatti Domino si è incasinato nella mia spiegazione perchè
Lo zip decompresso è:
FLV_EXTRACT con all'interno il suo eseguibile flvextract.exe e un ulteriore cartella di nome FLVEXTRACT
Inoltre salva in Application Data una cartella FLV EXTRACTOR

Cioè tutti nomi diversi e io ho voluto uniformare

Edit
Terzo punto lingua. Ho capito dove facevo casino.
Il doppio ini lo devo inserire solo nel caso la scelta della lingua avvenga proprio tramite file .ini

Grazie ancora

[ Edited Tue 03 Feb 2009 - 01:25 ]

Danix

Tue 03 Feb 2009 - 01:39

Registered Member #1

Joined: Fri 29 Dec 2006 - 05:38
Location: Sassari
Posts: 12956

(in caso Se i l'INI fosse stato scritto in modo completamente sbagliato, mi è chiaro)

Mi ci sono ritrovata compilando l'ini per FLV Extract -Link-

E' sempre bene uniformare, anche a costo di cambiare il nome al programma, ed evitando spazi. Ovviamente con le dovute eccezioni, ad esempio se un programma di suo crea una cartella in %AppData% con spazi o nome diverso rispetto a $AppName$. In questo caso, o si cerca di redirigerla in \User tramite una variabile, oppure va fatta una portabilizzazione forzata (copia/sposta).

Piuttosto, il pacchetto è stato rimosso, quindi non ho potuto testarlo.

[ Edited Tue 03 Feb 2009 - 01:41 ]

Ketty

Tue 03 Feb 2009 - 02:33

Registered Member #5089

Joined: Sat 09 Jun 2007 - 02:27
Posts: 1461

Danix wrote ...

(in caso Se i l'INI fosse stato scritto in modo completamente sbagliato, mi è chiaro)

Ho semplicemente sbagliato a copiare una tua frase per quotarla. Volevo dire che quel secondo punto dell'attribuzione autore e revisore INI l'ho capita

zandet2

Tue 03 Feb 2009 - 18:01

Registered Member #3184

Joined: Tue 06 Mar 2007 - 11:52
Location: Busto Arsizio
Posts: 3301

@Danix,
per maggior chiarezza andrebbe anche indicata sempre la dimensione del file di test in download:
questo permetterebbe di valutare l'onere dei test, oltre che di verificare se si è scaricato correttamente il file.

Esempio:

X-Software_XX_revX_TEST_X (14.665.89 Byte / 13,9 MB)

Danix

Tue 03 Feb 2009 - 20:18

Registered Member #1

Joined: Fri 29 Dec 2006 - 05:38
Location: Sassari
Posts: 12956

Ok, aggiunto.

Go to page >>

Moderators: Danix, Taf, Rcs, Energy, zandet2, ZioZione, Admin, LordJim60