GitHub Release Downloads permite obtener la cantidad de descargas, links y más información de las Releases de un repositorio de GitHub.
El plugin añade los siguientes shortcodes a WordPress:
- Número de descargas:
[grd_count] - Lista de descargas:
[grd_list] - Última versión:
[grd_latest_version]
Número de descargas
El shortcode [grd_count] devuelve un número, el cual corresponde a la suma de todas las descargas para las Releases seleccionadas. De esta forma, es posible obtener por ejemplo el número de descargas totales para un repositorio de GitHub.
| Atributos | Descripción |
|---|---|
user |
el nombre de usuario de GitHub |
repo |
el nombre del repositorio de GitHub |
latest |
sólo obtiene información de la última Release publicada en el repositorio |
tag |
sólo obtiene información de la Release con el tag especificado |
prereleases |
incluye borradores y prereleases. El valor por defecto es false. |
| Ejemplos | |
|---|---|
| Descargas totales del repositorio | [grd_count][grd_count user="IvanRF" repo="MassiveFileRenamer"] |
| Descargas de la última Release | [grd_count user="IvanRF" repo="MassiveFileRenamer" latest="true"] |
| Descargas de una Release específica | [grd_count user="IvanRF" repo="MassiveFileRenamer" tag="v1.6.0"] |
Nota: user y/o repo se pueden omitir si se establecieron los valores por defecto. Ver Configuración.
Lista de descargas
El shortcode [grd_list] devuelve una lista HTML para los Releases seleccionados, incluyendo el tag del release, la descripción y la lista de archivos que pueden ser descargados, como los release assets o el código fuente.
En cuanto al diseño, se proveen selectores class (por ejemplo: release-downloads-header, release-downloads, release-name, release-size, release-download-count).
| Atributos | Descripción |
|---|---|
user, repo, latest, tag, prereleases |
misma definición que arriba |
hide_description |
oculta la descripción del release |
hide_size |
oculta la información del tamaño del archivo |
hide_downloads |
oculta la información del número de descargas |
downloads_suffix |
se puede utilizar para traducciones. El valor por defecto es " downloads" |
hide_source_code |
oculta el enlace de descarga para el código fuente |
| Ejemplos | |
|---|---|
| Todas las descargas del repositorio | [grd_list][grd_list user="IvanRF" repo="MassiveFileRenamer"] |
| Descargas de la última Release | [grd_list user="IvanRF" repo="MassiveFileRenamer" latest="true"] |
| Descargas de una Release específica | [grd_list user="IvanRF" repo="MassiveFileRenamer" tag="v1.5.6"] |
| Tamaño de archivos oculto | [grd_list user="IvanRF" repo="MassiveFileRenamer" hide_size="true"] |
| Número de descargas oculto | [grd_list hide_downloads="true"] |
| Cambio del sufijo para descargas | [grd_list downloads_suffix=" descargas"] |
Nota: user y/o repo se pueden omitir si se establecieron los valores por defecto. Ver Configuración.
Los atributos de tipo Boolean pueden tomar cualquiera de los siguientes valores: «1», «true», «on», «yes»; o «0», «false», «off», «no».
Última versión
El shortcode [grd_latest_version] devuelve el tag de la última Release publicada en el repositorio.
Para tags con valores como «v1.6.0», devuelve «1.6.0» como el número de versión.
| Atributos | Descripción |
|---|---|
user, repo, prereleases |
misma definición que arriba |
Configuración
Dentro del menú Ajustes de WordPress se encuentra la página de opciones GitHub Release Downloads. En esta página se pueden establecer los valores para el nombre de usuario y el nombre del repositorio de GitHub que se utilizarán por defecto en los shortcodes.
Si se definen ambos valores, los shortcodes se pueden utilizar sin atributos (por ejemplo: [grd_count]) , ya que los valores por defecto para user y repo serán usados.
Los valores de los atributos tienen prioridad sobre los valores por defecto. Por ejemplo, [grd_count repo="MyRepo"] utilizará el nombre de usuario por defecto y el repositorio especificado en el shortcode.
