1 //<script type="text/javascript">
3 XObject = imports.XObject.XObject;
6 * Generic Template Link handler..
12 /** Handle the creation of HTML links to documented symbols.
15 Link = XObject.define(
20 XObject.extend(this,opts);
27 * url {String} url for link..
31 * text {String} text to show on link.
37 * alias {String} not sure?
41 * src {String} not sure?
52 target : function(targetName) {
53 if (typeof(targetName) != 'undefined') this.targetName = targetName;
56 inner : function(inner) {
57 if (typeof(inner) != 'undefined') this.innerName = inner;
60 withText : function(text) {
61 if (typeof(text) != 'undefined') this.text = text;
64 toSrc : function(filename) {
65 if (typeof(filename) != 'undefined') this.src = filename;
69 toSymbol : function(alias) {
70 if (typeof(alias) != 'undefined') {
71 this.alias = new String(alias);
75 toClass : function(alias) {
76 this.classLink = true;
77 return this.toSymbol(alias);
79 toFile : function(file) {
80 if (typeof(file) != 'undefined') this.file = file;
84 toString : function() {
89 return this.alias.replace(/(^|[^a-z$0-9_#.:-])([|a-z$0-9_#.:-]+)($|[^a-z$0-9_#.:-])/i,
90 function(match, prematch, symbolName, postmatch) {
91 var symbolNames = symbolName.split("|");
93 for (var i = 0, l = symbolNames.length; i < l; i++) {
94 thisLink.alias = symbolNames[i];
95 links.push(thisLink._makeSymbolLink(symbolNames[i]));
97 return prematch+links.join("|")+postmatch;
102 return thisLink._makeLink(this.url);
105 return thisLink._makeSrcLink(this.src);
108 return thisLink._makeFileLink(this.file);
119 /** Create a link to a snother symbol. */
120 _makeSymbolLink : function(alias)
122 //print(JSON.stringify(alias));
123 // look for '/' in alias..
124 if (/\//.test(alias)) {
125 var bits = alias.split('/');
127 for(var i=0; i < bits.length; i++) {
131 ret += this._makeSymbolLink(bits[i]);
140 var linkTo = Link.symbolSet.getSymbol(alias);
143 var target = (this.targetName)? " target=\""+this.targetName+"\"" : "";
145 // is it an internal link?
146 if (alias.charAt(0) == "#") {
148 fullLinkPath = alias;
150 // if there is no symbol by that name just return the name unaltered
151 } else if (!linkTo) {
153 if (typeof(Link.builtins[alias]) != 'undefined') {
154 return "<a href=\""+ Link.builtins[alias]+"\""+target+">"+alias+"</a>";
157 return this.text || alias;
160 // it's a symbol in another file
163 if (!linkTo.is("CONSTRUCTOR") && !linkTo.isNamespace) { // it's a method or property
164 linkPath = escape(linkTo.memberOf) || "_global_";
165 linkPath += '.html#' + Link.symbolNameToLinkName(linkTo);
168 linkPath = escape(linkTo.alias);
169 linkPath += '.html' + (this.classLink? "":"#" + Link.hashPrefix + "constructor");
171 //linkPath = linkBase + linkPath;
172 fullLinkPath = linkBase + linkPath;
175 var linkText = this.text || alias;
177 var link = {linkPath: linkPath, linkText: linkText, fullLinkPath: fullLinkPath};
179 //if (typeof JSDOC.PluginManager != "undefined") {
180 // JSDOC.PluginManager.run("onSymbolLink", link);
183 return "<a href=\""+link.fullLinkPath+"\""+target+" roo:cls=\""+link.linkPath+"\">"+link.linkText+"</a>";
187 /** Create a link to a source file. */
188 _makeSrcLink : function(srcFilePath) {
189 var target = (this.targetName)? " target=\""+this.targetName+"\"" : "";
191 // transform filepath into a filename
192 var srcFile = srcFilePath.replace(/\.\.?[\\\/]/g, "").replace(/[:\\\/]/g, "."); // was _
193 var lsrcFile = srcFilePath.replace(/\.\.?[\\\/]/g, "").replace(/[:\\\/]/g, ".");
194 var outFilePath = Link.base + '/symbols/' + srcFile.replace(/.js$/, '') +
195 imports.JSDOC.Options.Options.publishExt;
197 if (!this.text) this.text = srcFilePath; //FilePath.fileName(srcFilePath);
198 return "<a href=\""+outFilePath+"\""+target+" roo:cls=\"src/"+lsrcFile+"\">"+this.text+"</a>";
201 /** Create a link to a source file. */
202 _makeFileLink : function(filePath) {
203 var target = (this.targetName)? " target=\""+this.targetName+"\"" : "";
205 var outFilePath = Link.base + filePath;
207 if (!this.text) this.text = filePath;
208 return "<a href=\""+outFilePath+"\""+target+">"+this.text+"</a>";
211 /** very basic link... */
212 _makeLink : function(url) {
213 var target = (this.targetName)? " target=\""+this.targetName+"\"" : "";
215 if (!this.text) this.text = url;
216 return "<a href=\""+url+"\""+target+">"+this.text+"</a>";
224 /** prefixed for hashes */
225 Link.hashPrefix = "";
227 /** Appended to the front of relative link paths. */
230 Link.symbolNameToLinkName = function(symbol) {
232 if (symbol.isStatic) linker = ".";
233 else if (symbol.isInner) linker = "-";
235 return Link.hashPrefix+linker+symbol.name;
240 'Object' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object',
241 'Object...' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object',
242 'Function' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Function',
243 'String' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:String',
244 'Number' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Number',
245 'Boolean' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean',
246 'HTMLElement' : 'http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037'