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 linkString = 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 linkString = thisLink._makeLink(this.url);
105 linkString = thisLink._makeSrcLink(this.src);
107 else if (this.file) {
108 linkString = thisLink._makeFileLink(this.file);
120 /** Create a link to a snother symbol. */
121 _makeSymbolLink : function(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]);
139 var linkBase = Link.base+ imports.JSDOC.BuildDocs.BuildDocs.symbolsDir;
140 var linkTo = Link.symbolSet.getSymbol(alias);
142 var target = (this.targetName)? " target=\""+this.targetName+"\"" : "";
144 // is it an internal link?
145 if (alias.charAt(0) == "#") {
147 fullLinkPath = alias;
149 // if there is no symbol by that name just return the name unaltered
150 } else if (!linkTo) {
152 if (typeof(Link.builtins[alias]) != 'undefined') {
153 return "<a href=\""+ Link.builtins[alias]+"\""+target+">"+alias+"</a>";
156 return this.text || alias;
159 // it's a symbol in another file
162 if (!linkTo.is("CONSTRUCTOR") && !linkTo.isNamespace) { // it's a method or property
163 linkPath = escape(linkTo.memberOf) || "_global_";
164 linkPath += imports.JSDOC.Options.Options.ext + "#" + Link.symbolNameToLinkName(linkTo);
167 linkPath = escape(linkTo.alias);
168 linkPath += imports.JSDOC.Options.Options.ext + (this.classLink? "":"#" + Link.hashPrefix + "constructor");
170 //linkPath = linkBase + linkPath;
171 fullLinkPath = linkBase + linkPath;
174 var linkText = this.text || alias;
176 var link = {linkPath: linkPath, linkText: linkText, fullLinkPath: fullLinkPath};
178 //if (typeof JSDOC.PluginManager != "undefined") {
179 // JSDOC.PluginManager.run("onSymbolLink", link);
182 return "<a href=\""+link.fullLinkPath+"\""+target+" roo:cls=\""+link.linkPath+"\">"+link.linkText+"</a>";
186 /** Create a link to a source file. */
187 _makeSrcLink : function(srcFilePath) {
188 var target = (this.targetName)? " target=\""+this.targetName+"\"" : "";
190 // transform filepath into a filename
191 var srcFile = srcFilePath.replace(/\.\.?[\\\/]/g, "").replace(/[:\\\/]/g, "."); // was _
192 var lsrcFile = srcFilePath.replace(/\.\.?[\\\/]/g, "").replace(/[:\\\/]/g, ".");
193 var outFilePath = Link.base + '/symbols/' + srcFile.replace(/.js$/, '') +
194 imports.JSDOC.Options.Options.publishExt;
196 if (!this.text) this.text = srcFilePath; //FilePath.fileName(srcFilePath);
197 return "<a href=\""+outFilePath+"\""+target+" roo:cls=\"src/"+lsrcFile+"\">"+this.text+"</a>";
200 /** Create a link to a source file. */
201 _makeFileLink : function(filePath) {
202 var target = (this.targetName)? " target=\""+this.targetName+"\"" : "";
204 var outFilePath = Link.base + filePath;
206 if (!this.text) this.text = filePath;
207 return "<a href=\""+outFilePath+"\""+target+">"+this.text+"</a>";
214 /** prefixed for hashes */
215 Link.hashPrefix = "";
217 /** Appended to the front of relative link paths. */
220 Link.symbolNameToLinkName = function(symbol) {
222 if (symbol.isStatic) linker = ".";
223 else if (symbol.isInner) linker = "-";
225 return Link.hashPrefix+linker+symbol.name;
230 'Object' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object',
231 'Object...' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object',
232 'Function' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Function',
233 'String' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:String',
234 'Number' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Number',
235 'Boolean' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean',
236 'HTMLElement' : 'http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037'