Actualizado el 14-01-2007
versión para imprimir

identificando a tu plugin

Cada plugin debe tener un nombre único, para evitar posibles errores.

Para evitar que el nombre de dos plugins pueda coincidir, la práctica aconsejada es la de anteponer las iniciales de su autor al propio archivo (irQuotes por ejemplo).

Si el plugin va a tener varios botones, es también aconsejable asegurar que su nombre sea único (añadiendo un prefijo, por ejemplo), aunque HTML-Kit puede renombrarlos automaticamente si detecta un conflicto de nombres.

Otra cuestion a tener en cuenta, relacionada con la identidad, es que si haces varias versiones del plugin y cada una tiene un nombre distinto, las versiones antiguas no serán removidas del directorio de plugins, con lo que el conflicto está prácticamente asegurado. Se recomienda por tanto conservar el nombre del plugin entre versiones, para que la nueva sobreescriba la anterior.

UPID

Si planeas distribuir tu plugin, debes añadirle una identificación adicional, el UPID, o Unique/Universal Plugin ID , un número único que servira no solo para identificarlo sino tambien para facilitar el acceso a recursos relativos al mismo (por ejemplo como referencia para ayuda online, etc).

Para conseguir la asignación de un UPID debes registrarte como usuario de la página del programa (user assistant).

El generador de UPIDs devuelve un rango de números distintos para cada futuro plugin; el primer número de la serie se suele usar para identificar al plugin:

hkp_DataAdd( pDataOut, "UPID", "30300001" );

en la funcion register del plugin, despues del NAME; los demás números están destinados a identificar cada botón:

function hkp_Register(pDataIn, pDataOut)
{
  hkp_DataSetGlobalSuffix( "_1" );

  /* Required Information */
  hkp_DataAdd( pDataOut, "NAME", "irNuevoPlugin" );
  hkp_DataAdd( pDataOut, "SECTION", "MyPlugins" );

  /* Optional Information */
  hkp_DataAdd( pDataOut, "VERSION", "1.0" );
  hkp_DataAdd( pDataOut, "UPID", "123456" );
  hkp_DataAddInt( pDataOut, "MODE_SHOW_STATUS", 0 );

  hkp_DataSetGlobalSuffix( "" );

  hkp_DataSetGlobalSuffix( "_2" );

  /* Required Information */
  hkp_DataAdd( pDataOut, "NAME", "Button2" );
  hkp_DataAdd( pDataOut, "SECTION", "MyPlugins" );

  /* Optional Information */
  hkp_DataAdd( pDataOut, "VERSION", "1.0" );
  hkp_DataAdd( pDataOut, "UPID", "123457" );
  hkp_DataAddInt( pDataOut, "MODE_SHOW_STATUS", 0 );

  hkp_DataSetGlobalSuffix( "" );
}

Si usas el Plugins Generator puedes introducir el UPID desde el panel de opciones avanzadas de cada botón (el Generator te permite introducir el UPID, pero el número en si debes obtenerlo en el user assistant).

El UPID no sustituye la necesidad de que cada plugin tenga un nombre único, y no es necesario para plugins que no vayan a ser distribuidos

This site powered by Phorum.