rk.XML.about: Create XML node "about" for RKWard pluginmaps

In rkward-community/rkwarddev: A Collection of Tools for RKWard Plugin Development

Create XML node "about" for RKWard pluginmaps

Description

Create XML node "about" for RKWard pluginmaps

Usage

rk.XML.about(
  name,
  author,
  about = list(desc = "SHORT_DESCRIPTION", version = "0.01-0", date = Sys.Date(), url =
    "http://EXAMPLE.com", license = "GPL (>= 3)", long.desc = NULL)
)

Arguments

name	A character string with the plugin name.
author	A vector of objects of class person with these elements (mandatory): given Author given name family Author family name email Author mail address (can be omitted if role does not include "cre") role This person's specific role, e.g. "aut" for actual author, "cre" for maintainer or "ctb" for contributor. See person for more details on this, especially for valid roles.
about	A named list with these elements: desc A short description (mandatory) version Plugin version (mandatory) date Release date (mandatory); either a POSIXlt object, or character string in "%Y-%m-%d" format url URL for the plugin (optional) license License the plugin is distributed under (mandatory) category A category for this plugin (optional) long.desc A long description (optional, defaults to desc)

See Also

rk.XML.dependencies, Introduction to Writing Plugins for RKWard

Examples

about.node <- rk.XML.about(
  name="Square the circle",
  author=c(
    person(given="E.A.", family="Dölle",
      email="[e-mail]", role="aut"),
    person(given="A.", family="Assistant",
      email="[e-mail]", role=c("cre","ctb"))
    ),
  about=list(
    desc="Squares the circle using Heisenberg compensation.",
    version="0.1-3",
    date=Sys.Date(),
    url="http://eternalwondermaths.example.org/23/stc.html",
    license="GPL",
    category="Geometry")
)

cat(pasteXML(about.node, shine=2))

rkward-community/rkwarddev documentation built on May 9, 2022, 3:02 p.m.