policy:naming

Questa è una vecchia versione del documento!


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

Ad ogni media deve corrispondere una pagina che fungerà da namespace per il media, in breve se ho la pagina iata i file andranno caricati nel namespace iata del gestore media.

  • policy/naming.1546465847.txt.gz
  • Ultima modifica: 15/03/2023 08:38
  • (modifica esterna)