come si costruisce un pacchetto latex?

linden-limmer” post=121794Ciao a tutti,

1) come si costruisce un pacchetto latex ?
2) che tipo di materiale puo’ far parte di un pacchetto latex ?
3) che tipo di materiale non puo’ far parte di un pacchetto latex ?
4) quali sono le regole di “buona educazione”
da seguire nel creare un pacchetto latex ?

Saluti
Luciano

Le informazioni su “how to oploade a package” sono essenziali ma non rispondono alle tue 4 domande; I pacchetti che citi possono aggiungere qualche informazione, ma non rispondono alla tue 4 domande.

Un pacchetto LaTeX è un file .zip che contiene uno o più file di codice LaTeX (.cls, .sty, .def, .ldf, .fd, eccetera) accompagnati da almeno un file di documentazione. Di solito l’autore crea un file .dtx (documented-TeX file) che contiene intercali sia i testi di documentazione, sia le parti di codice; Se questo file è digerito da uno dei programmi di composizione, tipicamente pdfLaTeX, vengono estratti sia il o i file di documentazione in formato .pdf, sia i file di codice desiderati.

Tutto questo materiale è quello più difficile da creare, per il resto basta eseguire l’upload di un file .zip che contenga solo il file .dtx, il file .pdf, e un file README testuale (.txt) o markdown (.md) o multimarkdown (.mmd) dove viene specificata la licenza a cui è soggetto il pacchetto (di solito sl LaTeX Public Program Licence, LPPL, ma sono lecite altre licenza che prevedano la proprietà intellettuale, ma il permesso dell’uso libero e senza limiti; qualche modestissimo limite per le modifiche da parte di chiunque non sia l’autore/manutentore del pacchetto), il nome e indirizzi del manutentore se diverso dall’autore, l’elenco dei file contenuti nel pacchetto con la specificazione dei file che possono essere eventualmente cambiati/modificati dal singolo utente.

Quanto sopra dovrebbe rispodere alla domanda 1) e alal domanda 2).

Alla domanda 3) la risposta è semplice; non può far parte diel pacchetto nessun file che non sia stato creato dall’autore del pacchetto; per esempio, i file per la costruzione di tesi di laurea non possono contenere i file con i loghi degli atenei a cui si riferisce quel particolare stile di composizione di quella tesi. I loghi sono proprietà privata degli atenei o delle altre entità di cui quei loghi sono l’emblema.

Risposta alla domanda 4). Le regole di buona educazione sono ovvie, direi; nel senso che la lingua inglese è obbligatoria; se il file è destinato ad una utenza nazionale, il corpo della documentazione può anche essere in lingua nazionale, ma ci deve essere almeno un sommario/abstract in inglese che descriva brevemente a che cosa serve il pacchetto; Sono purtroppo frequenti i casi di pacchetti, anche importanti, documentati solo nella lingua dell’autore; capita spesso con pacchetti creati da autori cinesi e orientali in genrale. ma succede spesso anche con autori francesi e slavi. Tieni presente che l’ottimo pacchetto tkz-euclide, nela sua prima versione era documentato solo in francese, Dopo aver insistito tanto con l’autore, sono riuscito a convincerlo a scrivere la documentazione in inglese e a chiedergli di spiegare meglio le costruzioni geometriche euclidee; ora la documentazione è in inglese, ma se non sei on ricercatore di geometria euclidea molto competente, spesso e volentieri non si capisce né lo scopo né il procedimenti seguito nella costruzione geometrica; colpa mia che non sono abbastanza ferrato in geometria se non capisco le costruzioni di quell’autore, ma se avesse descritto meglio le sue costruzioni, avrebbe fatto un piacere non solo a me, ma anche alla moltitudine di possibili utenti del suo pacchetto.
Bisogna inoltre evitare qualunque forma di plagio; non costa niente citare lavori altrui, codice altrui, immagini altrui, citando chi è questo “altrui”.

Credo di avere risposto, ameno in parte, alle tue 4 domande. Ti auguro di creare bei pacchetti e col tempo e la pratica imparerai a seguire le procedure giuste senza nemmeno rendertene conto.

5) cosruisci un file .zip che contenga solo il file .tex e il suo .pdf. più il solito README testuale

Non sarebbe l’unico file scritto senza che contenga nessun codice; tuttavia…

… se vi mettessi un template (codice) ecco che ci sarebbe il codice su cui gli eventuali utanti possono lavorare per personalizzarselo. Attento a scegliere il nome sia del documento sia del picolo file di codice da estrarre con il pre-preamblo del file .dtx, perché l’archivio CTAN probabilmente contiene già più di un pacchetto per cosruire poster. Sono sicuro di averne visti. Tuttavia, visto che usi (spero) TeX Live completo (non MiKTeX di base), non hai che da aprire l’Explorer, o Finder, o come si chiama il tuo applicativo per visualizzare le cartelle e i file che contengono, ed esamini il contenuto della cartella …/texlive/2022/texmf-dist/tex/latex/ per vedere di quali pacchetti disponi già. A quel punto nella tua documentazione puoi aggiungere le informazioni che permettono di capire le differenze e i vantaggi di usare il tuo template, piuttosto che gli altri esistenti; Se invece non includi il tuo template, i confronti fra i pacchetti disponibili può essere prezioso.