Closed (fixed)
Project:
Universal Link Filter
Version:
5.x-1.x-dev
Component:
Miscellaneous
Priority:
Minor
Category:
Task
Assigned:
Unassigned
Reporter:
Created:
8 Jul 2007 at 13:15 UTC
Updated:
9 Dec 2007 at 03:57 UTC
The module/project description is unintelligible. Could someone with project familiarity please re-write the project description so that it is understandable to those not intimately familiar with the project. Thanks.
Comments
Comment #1
garthee commentedThank you for pointing out that..
In fact, I didn't spend much time in writing that, as I got caught busy with university work and as this is in development - means features may be added / removed / altered. Therefore I didn't pay much attention about the clearness. However, once I complete the coding - near to the code freeze I will provide a better program specification, read me (user guide) and developer guide. Also I will add the inline comments with the code.
Anyhow, I would be happy to have someone write them if they are interested in.
But for the moment, if you are interested in the program, but confused with the description here I explain the usage simply
1.ulink provides a basic skeleton for filtering. ie, other modules can hook into and provide their implementations for specific type. For example, image cache can provide only for image type.
2.however ulink provides default implementation (which is complete and sufficient) to match the normal requirement. And it also provides two additional implementations through ulink_gallery and ulink_imagecache for image type. They can be considered as typical examples for extensions.
3.in the default implementation, except for image type, ulink provides three types of implementation
a. default - hard coded - ie user can set few parameters such as what to use when text is empty, but not flexible enough.
b. macro substitution - tokens - using token module (here comes the dependancy on token module - when it is not present simply this option won't be available, however we can't bother the user to use tokens in other settings pages :-) ) where users can use macros like [ulink-text] (help is available) in simple html tags to define how the link should be rendered.
c. php code - which gives the full power of php scripting, where user can use the parsed information (help is available) to code as he wishes.
>> uauto module provides auto completion of links, ie it provides the client side UI, ajax calls and it performs the searches in the server side. The server side implementation is also extendable as ulink, ie through hooks other modules can alter, add or update search results for searched keywords. it completes the links and puts them in [l|href|text|attribute] or [l-macroname|href|text] format. So that it will be rendered appropriately by ulink
>> although ulink and uauto are two separate modules, i call them collectively ulink package.
* what is meant by help is available is, a reference table for relevant entries is provided in the settings page.
Comment #2
dldege commentedIn the most basic terms ulink is an input filter to make it easy to add hyperlinks to other content on your site without having to code the actual html
<a>tag.Ulink format of [l|node/1] with default options would give the same output as
<a href='http://example.com/node/1'>The title of node 1</a>At the core this is all it does but with the output tailored for the type of link being created, ie. a link to a node, link to a user, link to a file (image or otherwise).
On top of this is all sorts of support for module developers to add in specialized code handling of any and all link types making ulink a very generalized link notation input filter. The final piece is uauto which adds jquery powered autocompletion when you are typing the [l|.....] links to help you find content on your site.
Post questions here if you need more information and see http://mwt.argz.com for some examples.
Comment #3
garthee commentedREADME.txt, DEVELOPER.txt are provided with examples and extensive description.
Please post the feedbacks on them