Zugg Software :: View topic - New simple URLs for Knowledge Base articles

Posted: Thu Jun 28, 2007 9:00 pm

I have set up some URL rules on the site for easier reference to the Knowledge Base. You can now do:

http://www.zuggsoft.com/kb/articlename

where "articlename" is the name of the article that you want. If you just put "cmud", then it will show the top level of the CMUD manual. If you just put "zmud" then you will get the zMUD manual, and if you use "zapp" you will get the zApp manual.

The knowledge base will first try to match the article with the index value (internal name) of "cmud_articlename". If this isn't found, then it will look for an index of just "articlename". If this isn't found, then it will look for an article with the title matching "articlename", first in the CMUD manual, and then anywhere in the knowledge base.

This *should* work the same as using the [[articlename]] syntax in the forum posts. Let me know if you find any problem using it.

Examples

http://www.zuggsoft.com/kb/cmud: Shows the CMUD manual contents
http://www.zuggsoft.com/kb/%23TRIGGER: Displays the page for the #TRIGGER command in CMUD. The %23 is used to represent the # character in the URL
http://www.zuggsoft.com/kb/%25additem: Displays the page for the %additem function in CMUD. The %25 is used to represent the % character in the URL

Posted: Fri Jun 29, 2007 12:47 am

The only problem with this is that it returns the first match rather than the best match. I tried using "database" and the link pointed to the "Database Module" file instead of the scripting reference file that's just called "database". Also, it'd be nice if there were some kind of icon on each kb page that would give you a link based on that page's real title, sort of like that little page icon at the top of each forum post that you can use to link back to it. It saves having to click on the comments link.

Posted: Fri Jun 29, 2007 5:06 pm

It tries the internal ID name before it tries the full title. That's why "database" returned the other file. The idea of a link on each help page is a good one and I'll add that to the to-do list. Also, remember that within the CMUD Help Window you can select Edit/Copy Link and it will copy the forum link text into the clipboard. This link has the format: [[articleid]text] and "articleid" would be what you would use with the "articlename" in the above URL format.

The main reason I added the new link URL structure is so that I can slowly convert some of the link on this site into more direct URLs, making it easier for Google to index this site (especially since we use the Google SiteSearch as the main search bar now).