R/rk.rkh.link.R

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

# Copyright 2010-2014 Meik Michalke <meik.michalke@hhu.de>
#
# This file is part of the R package rkwarddev.
#
# rkwarddev is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# rkwarddev is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with rkwarddev.  If not, see <http://www.gnu.org/licenses/>.


#' Create XML "link" node for RKWard help pages
#'
#' @param href Character string, either the URL to link to, name of an R package or ID of
#'    another plugin (see \code{type}).
#' @param text Character string, optional link text.
#' @param type Character string, one of the following valid entries:
#'    \itemize{
#'      \item{\code{"url"}}{\code{href} is assumend to be the actual URL.}
#'      \item{\code{"R"}}{\code{href} is assumend to be the name of an R package, i.e.,
#'        the link generated will look like \code{rkward://rhelp/<href>}.}
#'      \item{\code{"RK"}}{\code{href} is assumend to be the ID of another RKWard plugin, i.e.,
#'        the link generated will look like \code{rkward://component/<href>}.}
#'    }
#' @param i18n Either a character string or a named list with the optional elements \code{context}
#'    or \code{comment}, to give some \code{i18n_context} information for this node.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
#'    \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}}
#'    and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' package.link <- rk.rkh.link("Spice")
#' cat(pasteXML(package.link))

rk.rkh.link <- function(href, text=NULL, type="R", i18n=NULL){
  if(identical(type, "url")){
    text <- ifelse(is.null(text), href, text)
    link <- href
  } else if(identical(type, "R")){
    link <- paste0("rkward://rhelp/", href)
  } else if(identical(type, "RK")){
    link <- paste0("rkward://component/", href)
  } else {
    stop(simpleError(paste0("Invalid type for link node:", type)))
  }

  if(is.null(text)){
    text <- character()
  } else {}

  attr.list <- list(href=link)
  
  # check for additional i18n info
  attr.list <- check.i18n(i18n=i18n, attrs=attr.list)

  node <- check.i18n(
    i18n=i18n,
    node=XMLNode(name="link", text, attrs=attr.list),
    comment=TRUE
  )

  return(node)
}