comments

git-svn-id: https://svn.r-project.org/R/trunk@87327 00db46b3-68df-0310-9c12-caf00c1e9a41

Author: smeyer

src/library/tools/R/Rd2HTML.R

@@ -18,13 +18,15 @@
 
 ## also used by Rd2latex, but only 'topic' and 'dest'
 get_link <- function(arg, tag, Rdfile) {
-    ## 'topic' is the name to display, 'dest' is the topic to link to
-    ## optionaly in package 'pkg'.  If 'target' is set it is the file
-    ## to link to in HTML help
-
-    ## \link[=bar]{foo} means shows foo but treat this as a link to bar.
-    ## \link[pkg]{bar} means show bar and link to *file* bar in package pkg
-    ## \link{pkg:bar]{foo} means show foo and link to file bar in package pkg.
+    ## 'topic' is the text to display (used by Rd2latex, also as \index entry),
+    ## 'dest' is the topic to link to (unless for option [pkg:bar]).
+    ## Package-anchored links have non-NULL 'pkg' and 'targetfile',
+    ## where the latter is the topic/file to link to in HTML help.
+
+    ## \link{foo}: show and link to topic foo.
+    ## \link[=bar]{foo} means shows foo but treat this as a link to *topic* bar.
+    ## \link[pkg]{bar} means show bar and link to topic/file bar in package pkg.
+    ## \link[pkg:bar]{foo} means show foo and link to topic/file bar in package pkg.
     ## As from 2.10.0, look for topic 'bar' if file not found.
     ## As from 4.1.0, prefer topic 'bar' over file 'bar' (in which case 'targetfile' is a misnomer)
 

src/library/tools/R/install.R

@@ -2862,6 +2862,7 @@ if(FALSE) {
 		 sep = "", file=conn)
 	if (any(file.exists(file.path(outDir,
                                       c("NEWS", "NEWS.Rd", "NEWS.md")))))
+	    ## FIXME: link target needs adjustment for static help
 	    cat('<li><a href="../NEWS">Package NEWS</a>.</li>\n',
 		 sep = "", file=conn)