topic Re: Help :- Alfresco API and Documentation in Detail in Alfresco Archive

Help :- Alfresco API and Documentation in Detail

nirvanvjain — Fri, 23 Sep 2011 13:36:06 GMT

Dear All,While Exploring Alfresco Share, I found these URLs or APIs. Alfresco.util.encodeHTMLAlfresco.constants.PROXY_URI_RELATIVEAlfresco.Search.superclass.constructor.callAlfresco.SearchAlfresco.component.BaseAlfresco.util.createYUIButton :- Extension of YUI API (Where is the DocS for this API)Alf

Re: Help :- Alfresco API and Documentation in Detail

mikeh — Fri, 23 Sep 2011 13:41:08 GMT

Most of those are in the alfresco.js client-side JavaScript file. Take a look in there for per-function documentation. Note: you'll have to look at alfresco.js not alfresco-min.js

Thanks,
Mike

Re: Help :- Alfresco API and Documentation in Detail

nirvanvjain — Mon, 26 Sep 2011 11:08:06 GMT

Dear MikeH,

Thanks for your quick reply.

I have also gone through that alfresco.js file but still have a lots of quest.

Please give some idea in depth.

Appreciate your help.

Thanks!
-Nirvan

Re: Help :- Alfresco API and Documentation in Detail

mikeh — Mon, 26 Sep 2011 11:49:15 GMT

I have also gone through that alfresco.js file but still have a lots of quest.

Please give some idea in depth.

Other than give you a line-by-line description of the source code (which, sorry, but I am not going to do) this question is too open-ended to be useful.

Is there something specific you're stuck with? Have you looked at how we use those functions ourselves within Share? What extra documentation do you think those functions need?

Thanks,
Mike

Re: Help :- Alfresco API and Documentation in Detail

nirvanvjain — Mon, 26 Sep 2011 13:45:01 GMT

Dear Mike,

Precisely, thats where I am stuck..!!! how we use those functions ourselves within Share?

As I mentioned above there are some syntaxs like :-

Alfresco.constants.URL_RESCONTEXT

Alfresco.constants.PROXY_URI_RELATIVE

Alfresco.util.encodeHTML

Alfresco.Search

Alfresco.Search.superclass.constructor.call

In alfresco.js these functions are used but how these work ? What are the Use of them, What they do?

This help is expected from your sir.

Thanks!
-Nirvan

Re: Help :- Alfresco API and Documentation in Detail

mikeh — Mon, 26 Sep 2011 13:52:56 GMT

Is there something specific you're stuck with? Have you looked at how we use those functions ourselves within Share? What extra documentation do you think those functions need?

I think you mis-read this. Particularly: Have you looked at how we use those functions ourselves within Share?

Re: Help :- Alfresco API and Documentation in Detail

afaust — Mon, 26 Sep 2011 13:57:45 GMT

Hello,

although Mike beat me to the punch on this, I have to ask: Aren't the names of the function you've listed self-explanatory? I mean, what does "encodeHTML" do? Of course encode a given text as HTML. "Alfresco.Search.superclass.constructor.call" is nothing which is really Alfresco-specific, just related to how JavaScript-OOP is handled. And the purpose of the constants can be derived by looking at their values using something like FireBug.

Regards
Axel

Re: Help :- Alfresco API and Documentation in Detail

nirvanvjain — Mon, 26 Sep 2011 14:46:00 GMT

Is there something specific you're stuck with? Have you looked at how we use those functions ourselves within Share? What extra documentation do you think those functions need?
I think you mis-read this. Particularly: Have you looked at how we use those functions ourselves within Share?

Dear Mike,

I am sure that I haven't mis-read your above posts. I really can't understand how these methods are being used in our other components JavaScripts ?

@AFaust » I think you can also add your valuable knowledge here. Before your replied my last post I got that those are constants which are used in many JS files but my doubt how these functions are used in other component JS?

Appreciate your help.

Thanks~!
-Nirvan

Re: Help :- Alfresco API and Documentation in Detail

mikeh — Mon, 26 Sep 2011 20:39:17 GMT

I think we're going round in circles here.

If there's a specific problem you're trying to solve, please let us know. However, "How does most of the (open) source code work?" I"m afraid is much too generic to answer usefully here.

Thanks,
Mike

Re: Help :- Alfresco API and Documentation in Detail

nirvanvjain — Sat, 08 Oct 2011 08:02:07 GMT

Dear MikeH , AFaust and Alfresco Team,

I want to reuse Alfresco Create Event functionality (which is in Calendar Add Event) [{ Not Entire Create Event Pop Up Functionality but Just Start Date and End Date ones }].

I want to reuse it in Upload Pop-Up. I am able to reuse the calender create event (Add Event)'s Start Date and End Date Function in flash-upload-min.js file.

In side that,there is one function named Alfresco.util.formatDate(x,y,..). After some what R & D, I came to know about some functions which are used from alfresco.js as per your above guidelines.

Now in other javascript files (such as search-min.js etc) where this Alfresco.util.formatDate(x,y,..) used inside bacause it automatically imports (gets reference of ) alfresco.js but in flash-upload.js file , it is not getting (Using) that alfresco.js , so How Alfresco Share uses automatically (adding ) in its some of the out of box functionality or say how Can I be able to add (import) that alfresco.js ( or Alfresco Share javascript API) File(s) in my custom javascript files?

I guess its much descriptive and detailed.

Please guide me to move ahead.

Thanks!
-Nirvan Jain

Re: Help :- Alfresco API and Documentation in Detail

afaust — Sat, 08 Oct 2011 10:09:30 GMT

Hello,

there is no "automatic" / "implicit" importing of alfresco.js anywhere in Alfresco - all JavaScript code loaded within Share pages always has access to functions from alfresco.js. This is possible since all page templates use alfresco-template.ftl, which explicitly renders HTML code to load global Alfresco JavaScript/CSS files (<= 3.4) or defines a region for a global compoenent which renders similar code (4.0).
So, all your custom JavaScript files loaded within Share pages / modules should ALWAYS also be able to access Alfresco.util.formatDate, unless you've changed either the alfresco.js itself, the templates/web scripts rendering the load code or have implemented a page which does not use these global templates/web scripts.

Regards
Axel

Re: Help :- Alfresco API and Documentation in Detail

nirvanvjain — Thu, 13 Oct 2011 05:26:24 GMT

Dear MikeH , AFaust and Alfresco Team,

@AFaust :: First of thanks a tonn for your quick response.

As you mentioned in your last post, I went through alfresco-template.ftl and got to know that from that file only everything gets loaded in each and every file of Alfresco Share.

Now, As I mentioned in above 08 Oct 2011's post that I want functions of [size=125]alfresco.js[/size] in flash-upload.js .

{Correct me if I am wrong}
As Flash-Upload in for upload pop-up flash-upload.get.html.ftl is loaded as FORM. I checked for this ftl template but unfortunately I could not able to find the template (so as not able to find include tag of alfresco-template.ftl) and I think for that only I am not able to get that function of alfresco.js.

Please Guide me further.

Appreciate your help.

MikeH and All,you can also guide me in this quest.

Thanks!
-Nirvan

Re: Help :- Alfresco API and Documentation in Detail

mikeh — Thu, 13 Oct 2011 07:10:56 GMT

What is it you are actually trying to achieve? I mean from a high level, not a JavaScript level.

You might want to investigate some online JavaScript courses, as I think your lack of JavaScript knowledge might be causing you problems – Alfresco Share is a very complex application using advanced JavaScript techniques. It's slightly concerning that you don't seem to have a good understanding of the basics before trying to customize something more advanced.

Thanks,
Mike

Re: Help :- Alfresco API and Documentation in Detail

nirvanvjain — Thu, 13 Oct 2011 14:45:31 GMT

What is it you are actually trying to achieve? I mean from a high level, not a JavaScript level.

You might want to investigate some online JavaScript courses, as I think your lack of JavaScript knowledge might be causing you problems – Alfresco Share is a very complex application using advanced JavaScript techniques. It's slightly concerning that you don't seem to have a good understanding of the basicsbefore trying to customize something more advanced.

Thanks,
Mike

Dear Mike,

On very high level I want to put one Date Field on Upload Pop Up after which Document is moved to certain folder.

I am able to customize the Upload Pop-Up Page and also kept one Date Field on that Page. I am able to save my custom date in to my custom content model's property in string format as I am not able to get that Alfresco.util.formatDate(x,y,..) function in my flash-upload(-min).js file.

Now I guess you understand properly on High Level.

C:\Alfresco\tomcat\webapps\share\WEB-INF\classes\alfresco\templates\org\alfresco

<#include "include/alfresco-template.ftl" /> is there in each and every template but I am not able to find it for Upload template or I might be referring wrong folder location.

Now,Expect your valuable reply.

Thanks!
-Nirvan