policy:naming

Regole di naming

Per dare a TeleWiki un indice facile da consultare e ordinato è necessario rispettare alcune regole di naming quando si creano nuove pagine e si caricano file.

È buona cosa che l'indirizzo di ogni pagina sia coerente con la stessa, per permettere a TeleWiki di avere una struttura di indirizzi armoniosa si è creato uno standard per gli URL degli articoli a cui tutti devono attenersi:

https://it.tele.wiki/categoria/nomepagina

  1. Categoria: Indica la categoria a cui appartiene la pagina (es. gruppi - canali - bot)
  2. Nome: Indica il nome della pagina

es. La pagina di TagRobot, un bot per gestire i tag, avrà come URL https://it.tele.wiki/bot/tagrobot

Il namespace o categoria, indica una serie di pagine che hanno in comune un argomento specificato dalla stessa es. nel ns bot ci saranno solo pagine che trattano di bot. Ad ogni categoria corrisponde anche una pagina principale, ovvero una pagina collegata all'URL della categoria https://it.tele.wiki/categoria es. per la categoria bot esiste anche la pagina bot. Oltre le categorie base (gruppi - canali - bot) è possibile crearne di nuove, previa consultazione sul gruppo ufficiale, per network/community di CGB e per un argomento ancora non trattato da nessuna categoria preesistente.

La regola principale per dare un buon nome a una pagina è cercare di usare una sola parola per definirla. Non so come spiegarmi ma tipo per Open Telegram Italia è meglio usare l'acronimo OTI. Per tutti i GCB che hanno un link pubblico bisogna usare quello, tipo t.me/tagalertbot ⇒ nome tagalertbot mentre si può togliere bot se non strettamente necessario tipo t.me/grouphelpbot ⇒ grouphelp

Quando si carica un file tramite il gestore media è importante farlo nella maniera corretta, il namespace in cui va caricato il media deve corrispondere al nome della pagina di appartenenza secondo la seguente struttura:

https://it.tele.wiki/_media/categoria/nomepagina/nomefile.estensione

Per fare ciò bisogna accedere alla pagina alla quale si vuole aggiungere un media, cliccare su Gestore Media in alto a destra, poi Upload, selezionare il file da caricare e modificare il campo del nome con la seguente sintassi nomepagina:nomefile.estensione e infine premere su upload per eseguire il caricamento.
Nota: Ad ogni media caricato deve corrispondere una pagina, eventuali file orfani verranno cancellati dallo staff per non occupare inutilmente lo spazio dell'hosting.

È importante che ogni media abbia un nome autoesplicativo ma al contempo contenuto, ad esempio se devi caricare un immagine con il logo di Group Help puoi nominarla semplicemente logo.est invece di logogrouphelp.est visto che essendo caricata nel namespace gh è sottointeso che il logo sia di GroupHelp.

  • policy/naming.txt
  • Ultima modifica: 15/03/2023 08:38
  • da 127.0.0.1