RE: Search in Apache Flex Docs?
Thank you Alex. There is another topic related to that, that was raised by someone in the mailing list: how to include/link to flashplayer and air player classes in the a.o asdoc? Maurice -Message d'origine- De : Alex Harui [mailto:aha...@adobe.com] Envoyé : lundi 31 mars 2014 05:44 À : dev@flex.apache.org; n...@joeflash.ca Objet : Re: Search in Apache Flex Docs? On 3/30/14 1:46 AM, Maurice Amsellem maurice.amsel...@systar.com wrote: Is it possible that Adobe shares with us their modified asdoc tools ? I'll look into it. -Alex
RE: Search in Apache Flex Docs?
Imo, Apache flex asdoc should link to adobe aslr for runtime api. I think I see javadoc for third party jars do similar. Sent via the PANTECH Discover, an ATT 4G LTE smartphone. Maurice Amsellem maurice.amsel...@systar.com wrote: Thank you Alex. There is another topic related to that, that was raised by someone in the mailing list: how to include/link to flashplayer and air player classes in the a.o asdoc? Maurice -Message d'origine- De : Alex Harui [mailto:aha...@adobe.com] Envoyé : lundi 31 mars 2014 05:44 À : dev@flex.apache.org; n...@joeflash.ca Objet : Re: Search in Apache Flex Docs? On 3/30/14 1:46 AM, Maurice Amsellem maurice.amsel...@systar.com wrote: Is it possible that Adobe shares with us their modified asdoc tools ? I'll look into it. -Alex
RE: Search in Apache Flex Docs?
Joseph is referring to the appendices section in the ASDOC: https://www.dropbox.com/s/ryp97xyeyns37rb/asdoc_appendices.png Unfortunately, I don't think creating a class called CompilerElement would work well, because it will display the mxml-only tags and props as if it was classes and props, which will add to the confusion IMO. Compare fx:Binding and BindingUtils class for example http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/mxml/binding.html http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/mx/binding/utils/BindingUtils.html Extending the asdoc compiler and xlst files to achieve a comparable result is probably too much work, as you say. Is it possible that Adobe shares with us their modified asdoc tools ? Maurice -Message d'origine- De : Alex Harui [mailto:aha...@adobe.com] Envoyé : dimanche 30 mars 2014 06:47 À : dev@flex.apache.org; n...@joeflash.ca Objet : Re: Search in Apache Flex Docs? Not sure I followed, but sounds like work ;-) Would it be sufficient if someone were to write up a class called CompilerElements.as and put it in the framework? -Alex On 3/29/14 9:46 PM, Joseph Balderson n...@joeflash.ca wrote: It would be useful to see all metadata, compiler directives (like conditinoal compilation), MXML compiler pseudo-properties (like itemCreationPolicy), have a mention in the ASDOCs, somewhere. So that if you're searching them, you don't have to wade through the wiki. The Adobe ASDOCs has two sections in the top left side menu: - Packages - Language Elements - Appendices (The Appendices in the Adobe asdocs have one Flex-specific section: MXML Only Tags -- we could migrate this information to the Apache Flex ASDOCs and/or Wiki.) I would recommend something similar for Apache Flex, only in the following categories: - Packages - Compiler Elements In Compiler Elements, you could have: - Namespaces - MXML language specifications - Compiler Directives - Metadata tags - MXML-only properties - etc. Basically anything that would be found in code not in the class packages, and not a part of the AS3 spec, would be in the second section. You could mention compiler-driven MXML language elements, without getting into lengthy descriptions and examples more suited to a wiki. These pages might lead to wiki pages, much as how the Adobe ASDOCs would lead to help pages with examples elsewhere in the Flex documentation. This would make more sense, since coding in Flex covers not just the class framework, but MXML compiler conventions. Right now the ASDOCs only cover the framework, not the compiler. ___ Joseph Balderson, Flex Flash Platform Developer :: http://joeflash.ca Author, Professional Flex 3 :: http://tinyurl.com/proflex3book Alex Harui wrote: On 3/27/14 7:07 PM, Joseph Balderson n...@joeflash.ca wrote: But it raises the question -- how do we get MXML coding conventions which are not a part of actual classes, but are compiler-interpreted, into the asdocs? Do you want to see it on the classes or is another doc chapter good enough? -Alex
Re: Search in Apache Flex Docs?
On 3/30/14 1:46 AM, Maurice Amsellem maurice.amsel...@systar.com wrote: Is it possible that Adobe shares with us their modified asdoc tools ? I'll look into it. -Alex
Re: Search in Apache Flex Docs?
It would be useful to see all metadata, compiler directives (like conditinoal compilation), MXML compiler pseudo-properties (like itemCreationPolicy), have a mention in the ASDOCs, somewhere. So that if you're searching them, you don't have to wade through the wiki. The Adobe ASDOCs has two sections in the top left side menu: - Packages - Language Elements - Appendices (The Appendices in the Adobe asdocs have one Flex-specific section: MXML Only Tags -- we could migrate this information to the Apache Flex ASDOCs and/or Wiki.) I would recommend something similar for Apache Flex, only in the following categories: - Packages - Compiler Elements In Compiler Elements, you could have: - Namespaces - MXML language specifications - Compiler Directives - Metadata tags - MXML-only properties - etc. Basically anything that would be found in code not in the class packages, and not a part of the AS3 spec, would be in the second section. You could mention compiler-driven MXML language elements, without getting into lengthy descriptions and examples more suited to a wiki. These pages might lead to wiki pages, much as how the Adobe ASDOCs would lead to help pages with examples elsewhere in the Flex documentation. This would make more sense, since coding in Flex covers not just the class framework, but MXML compiler conventions. Right now the ASDOCs only cover the framework, not the compiler. ___ Joseph Balderson, Flex Flash Platform Developer :: http://joeflash.ca Author, Professional Flex 3 :: http://tinyurl.com/proflex3book Alex Harui wrote: On 3/27/14 7:07 PM, Joseph Balderson n...@joeflash.ca wrote: But it raises the question -- how do we get MXML coding conventions which are not a part of actual classes, but are compiler-interpreted, into the asdocs? Do you want to see it on the classes or is another doc chapter good enough? -Alex
Re: Search in Apache Flex Docs?
Not sure I followed, but sounds like work ;-) Would it be sufficient if someone were to write up a class called CompilerElements.as and put it in the framework? -Alex On 3/29/14 9:46 PM, Joseph Balderson n...@joeflash.ca wrote: It would be useful to see all metadata, compiler directives (like conditinoal compilation), MXML compiler pseudo-properties (like itemCreationPolicy), have a mention in the ASDOCs, somewhere. So that if you're searching them, you don't have to wade through the wiki. The Adobe ASDOCs has two sections in the top left side menu: - Packages - Language Elements - Appendices (The Appendices in the Adobe asdocs have one Flex-specific section: MXML Only Tags -- we could migrate this information to the Apache Flex ASDOCs and/or Wiki.) I would recommend something similar for Apache Flex, only in the following categories: - Packages - Compiler Elements In Compiler Elements, you could have: - Namespaces - MXML language specifications - Compiler Directives - Metadata tags - MXML-only properties - etc. Basically anything that would be found in code not in the class packages, and not a part of the AS3 spec, would be in the second section. You could mention compiler-driven MXML language elements, without getting into lengthy descriptions and examples more suited to a wiki. These pages might lead to wiki pages, much as how the Adobe ASDOCs would lead to help pages with examples elsewhere in the Flex documentation. This would make more sense, since coding in Flex covers not just the class framework, but MXML compiler conventions. Right now the ASDOCs only cover the framework, not the compiler. ___ Joseph Balderson, Flex Flash Platform Developer :: http://joeflash.ca Author, Professional Flex 3 :: http://tinyurl.com/proflex3book Alex Harui wrote: On 3/27/14 7:07 PM, Joseph Balderson n...@joeflash.ca wrote: But it raises the question -- how do we get MXML coding conventions which are not a part of actual classes, but are compiler-interpreted, into the asdocs? Do you want to see it on the classes or is another doc chapter good enough? -Alex
Re: Search in Apache Flex Docs?
Actually, I take that back, my bad. It seems that the Apache flex ASDOCs are indeed SE crawled. (google for example state site:flex.apache.org/asdoc) I guess I had to have the misfortune of searching for a property (itemCreationPolicy) which is not actually a class property but a states-specific MXML convention, which is why Google was returning 0 results. I interpreted that to mean that the asdocs are not indexed, but they are. But it raises the question -- how do we get MXML coding conventions which are not a part of actual classes, but are compiler-interpreted, into the asdocs? ___ Joseph Balderson, Flex Flash Platform Developer :: http://joeflash.ca Author, Professional Flex 3 :: http://tinyurl.com/proflex3book Alex Harui wrote: It would save me much time if you find a different solution. Looks like some folks have suggested that we simply have the files indexed by a web search engine. -Alex On 3/24/14 2:38 AM, Maurice Amsellem maurice.amsel...@systar.com wrote: I could look into it, but it wouldn't be my highest priority. Thanks Alex, I have raised a JIRA ticket, for future reference: https://issues.apache.org/jira/browse/FLEX-34183 Do you think I can start working on it when I have time, maybe on a simpler implementation, of better to wait for Adobe's answer? Maurice -Message d'origine- De : Alex Harui [mailto:aha...@adobe.com] Envoyé : lundi 24 mars 2014 04:20 À : dev@flex.apache.org; n...@joeflash.ca Objet : Re: Search in Apache Flex Docs? On 3/23/14 11:41 AM, Maurice Amsellem maurice.amsel...@systar.com wrote: The Adobe ASLR does have search. I wonder what it would take to implement it. It does not seem to be that complicated ( file asdoc.js, doing a regexp match on a tags in the left list, and setting display style accordingly, to show or hide an item). Sorry for insisting, but could we get that asdoc extensions donated by Adobe, or at least permission to use them in Apache Flex ASDOC, or do we have to rewrite them? I could look into it, but it wouldn't be my highest priority. -Alex
Re: Search in Apache Flex Docs?
On 3/27/14 7:07 PM, Joseph Balderson n...@joeflash.ca wrote: But it raises the question -- how do we get MXML coding conventions which are not a part of actual classes, but are compiler-interpreted, into the asdocs? Do you want to see it on the classes or is another doc chapter good enough? -Alex
RE: Search in Apache Flex Docs?
I could look into it, but it wouldn't be my highest priority. Thanks Alex, I have raised a JIRA ticket, for future reference: https://issues.apache.org/jira/browse/FLEX-34183 Do you think I can start working on it when I have time, maybe on a simpler implementation, of better to wait for Adobe's answer? Maurice -Message d'origine- De : Alex Harui [mailto:aha...@adobe.com] Envoyé : lundi 24 mars 2014 04:20 À : dev@flex.apache.org; n...@joeflash.ca Objet : Re: Search in Apache Flex Docs? On 3/23/14 11:41 AM, Maurice Amsellem maurice.amsel...@systar.com wrote: The Adobe ASLR does have search. I wonder what it would take to implement it. It does not seem to be that complicated ( file asdoc.js, doing a regexp match on a tags in the left list, and setting display style accordingly, to show or hide an item). Sorry for insisting, but could we get that asdoc extensions donated by Adobe, or at least permission to use them in Apache Flex ASDOC, or do we have to rewrite them? I could look into it, but it wouldn't be my highest priority. -Alex
Re: Search in Apache Flex Docs?
It would save me much time if you find a different solution. Looks like some folks have suggested that we simply have the files indexed by a web search engine. -Alex On 3/24/14 2:38 AM, Maurice Amsellem maurice.amsel...@systar.com wrote: I could look into it, but it wouldn't be my highest priority. Thanks Alex, I have raised a JIRA ticket, for future reference: https://issues.apache.org/jira/browse/FLEX-34183 Do you think I can start working on it when I have time, maybe on a simpler implementation, of better to wait for Adobe's answer? Maurice -Message d'origine- De : Alex Harui [mailto:aha...@adobe.com] Envoyé : lundi 24 mars 2014 04:20 À : dev@flex.apache.org; n...@joeflash.ca Objet : Re: Search in Apache Flex Docs? On 3/23/14 11:41 AM, Maurice Amsellem maurice.amsel...@systar.com wrote: The Adobe ASLR does have search. I wonder what it would take to implement it. It does not seem to be that complicated ( file asdoc.js, doing a regexp match on a tags in the left list, and setting display style accordingly, to show or hide an item). Sorry for insisting, but could we get that asdoc extensions donated by Adobe, or at least permission to use them in Apache Flex ASDOC, or do we have to rewrite them? I could look into it, but it wouldn't be my highest priority. -Alex
RE: Search in Apache Flex Docs?
It would save me much time if you find a different solution. Looks like some folks have suggested that we simply have the files indexed by a web search engine. I understand, but that's a different usage. Adobe ASDOC has both: quick search field on top of the class list, and global search box top right of the page, near the Adobe logo. http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/ But I don't want to add you more work (and to me as well), so I leave this for now. Thanks for your advice. Maurice -Message d'origine- De : Alex Harui [mailto:aha...@adobe.com] Envoyé : lundi 24 mars 2014 17:45 À : dev@flex.apache.org; n...@joeflash.ca Objet : Re: Search in Apache Flex Docs? It would save me much time if you find a different solution. Looks like some folks have suggested that we simply have the files indexed by a web search engine. -Alex On 3/24/14 2:38 AM, Maurice Amsellem maurice.amsel...@systar.com wrote: I could look into it, but it wouldn't be my highest priority. Thanks Alex, I have raised a JIRA ticket, for future reference: https://issues.apache.org/jira/browse/FLEX-34183 Do you think I can start working on it when I have time, maybe on a simpler implementation, of better to wait for Adobe's answer? Maurice -Message d'origine- De : Alex Harui [mailto:aha...@adobe.com] Envoyé : lundi 24 mars 2014 04:20 À : dev@flex.apache.org; n...@joeflash.ca Objet : Re: Search in Apache Flex Docs? On 3/23/14 11:41 AM, Maurice Amsellem maurice.amsel...@systar.com wrote: The Adobe ASLR does have search. I wonder what it would take to implement it. It does not seem to be that complicated ( file asdoc.js, doing a regexp match on a tags in the left list, and setting display style accordingly, to show or hide an item). Sorry for insisting, but could we get that asdoc extensions donated by Adobe, or at least permission to use them in Apache Flex ASDOC, or do we have to rewrite them? I could look into it, but it wouldn't be my highest priority. -Alex
Re: Search in Apache Flex Docs?
Hi,
There is containercreationpolicy, creationpolicy and actualCreationPolicy that
I can see:
find . -name *.as -exec grep CreationPolicy {} \; -print
Justin
RE: Search in Apache Flex Docs?
The Adobe ASLR does have search. I wonder what it would take to implement it. It does not seem to be that complicated ( file asdoc.js, doing a regexp match on a tags in the left list, and setting display style accordingly, to show or hide an item). Sorry for insisting, but could we get that asdoc extensions donated by Adobe, or at least permission to use them in Apache Flex ASDOC, or do we have to rewrite them? Maurice -Message d'origine- De : Maurice Amsellem [mailto:maurice.amsel...@systar.com] Envoyé : samedi 22 mars 2014 08:49 À : dev@flex.apache.org; n...@joeflash.ca Objet : RE: Search in Apache Flex Docs? Yes, the index, but it's not as convenient as the search field. Some time ago, I checked how it was done at Adobe, and apparently, they modified the ASDOC templates to have this search field. Do you think the implementation could be donated as well? Maurice -Message d'origine- De : Alex Harui [mailto:aha...@adobe.com] Envoyé : samedi 22 mars 2014 06:36 À : dev@flex.apache.org; n...@joeflash.ca Objet : Re: Search in Apache Flex Docs? For your particular case, I think you could have used the index. The Adobe ASLR does have search. I wonder what it would take to implement it. -Alex On 3/21/14 9:40 PM, Joseph Balderson n...@joeflash.ca wrote: This may sound like a silly question, but how on earth do you search for anything in the Apache Docs, if you don't already know in which class it resides? The other day I wanted to know, out of curiosity, how many components implemented the itemCreationPolicy property, and I was unable to do a search to get an answer. Google 'itemCreationPolicy site:flex.apache.org/asdoc/' and you get 0 results. The docs themselves do not heave a search field like the old Adobe AS3/Flex docs have. This is a problem. I don't often use the search field in the AS3 reference, but when I do it's usually because I really need it. It is essential that the content in the Apache Flex docs also be searchable. Or am I missing something really simple here? -- ___ Joseph Balderson, Flex Flash Platform Developer :: http://joeflash.ca Author, Professional Flex 3 :: http://tinyurl.com/proflex3book
Re: Search in Apache Flex Docs?
On 3/23/14 11:41 AM, Maurice Amsellem maurice.amsel...@systar.com wrote: The Adobe ASLR does have search. I wonder what it would take to implement it. It does not seem to be that complicated ( file asdoc.js, doing a regexp match on a tags in the left list, and setting display style accordingly, to show or hide an item). Sorry for insisting, but could we get that asdoc extensions donated by Adobe, or at least permission to use them in Apache Flex ASDOC, or do we have to rewrite them? I could look into it, but it wouldn't be my highest priority. -Alex
RE: Search in Apache Flex Docs?
Yes, the index, but it's not as convenient as the search field. Some time ago, I checked how it was done at Adobe, and apparently, they modified the ASDOC templates to have this search field. Do you think the implementation could be donated as well? Maurice -Message d'origine- De : Alex Harui [mailto:aha...@adobe.com] Envoyé : samedi 22 mars 2014 06:36 À : dev@flex.apache.org; n...@joeflash.ca Objet : Re: Search in Apache Flex Docs? For your particular case, I think you could have used the index. The Adobe ASLR does have search. I wonder what it would take to implement it. -Alex On 3/21/14 9:40 PM, Joseph Balderson n...@joeflash.ca wrote: This may sound like a silly question, but how on earth do you search for anything in the Apache Docs, if you don't already know in which class it resides? The other day I wanted to know, out of curiosity, how many components implemented the itemCreationPolicy property, and I was unable to do a search to get an answer. Google 'itemCreationPolicy site:flex.apache.org/asdoc/' and you get 0 results. The docs themselves do not heave a search field like the old Adobe AS3/Flex docs have. This is a problem. I don't often use the search field in the AS3 reference, but when I do it's usually because I really need it. It is essential that the content in the Apache Flex docs also be searchable. Or am I missing something really simple here? -- ___ Joseph Balderson, Flex Flash Platform Developer :: http://joeflash.ca Author, Professional Flex 3 :: http://tinyurl.com/proflex3book
Re: Search in Apache Flex Docs?
In theory, the index might be an adequate substitute for search. But not every property is listed. 'itemCreationPolicy', for example, isn't. I wonder how many others are missing, hope I don't find out when I really need it. Even if it's only that the docs are transparent to search engines, so we can use Google, that might be something. But an incomplete index, unsearchable content, and no search field... well it's just not very usable. Search is essential. Thanks for listening. ___ Joseph Balderson, Flex Flash Platform Developer :: http://joeflash.ca Author, Professional Flex 3 :: http://tinyurl.com/proflex3book Alex Harui wrote: For your particular case, I think you could have used the index. The Adobe ASLR does have search. I wonder what it would take to implement it. -Alex On 3/21/14 9:40 PM, Joseph Balderson n...@joeflash.ca wrote: This may sound like a silly question, but how on earth do you search for anything in the Apache Docs, if you don't already know in which class it resides? The other day I wanted to know, out of curiosity, how many components implemented the itemCreationPolicy property, and I was unable to do a search to get an answer. Google 'itemCreationPolicy site:flex.apache.org/asdoc/' and you get 0 results. The docs themselves do not heave a search field like the old Adobe AS3/Flex docs have. This is a problem. I don't often use the search field in the AS3 reference, but when I do it's usually because I really need it. It is essential that the content in the Apache Flex docs also be searchable. Or am I missing something really simple here? -- ___ Joseph Balderson, Flex Flash Platform Developer :: http://joeflash.ca Author, Professional Flex 3 :: http://tinyurl.com/proflex3book
Re: Search in Apache Flex Docs?
OK, I give up. What was the answer? Grepping the source for 'itemCreationPolicy' didn't give any hits either. Is the index incomplete or is there no such property in the SDK? -Alex On 3/22/14 12:57 PM, Joseph Balderson n...@joeflash.ca wrote: In theory, the index might be an adequate substitute for search. But not every property is listed. 'itemCreationPolicy', for example, isn't. I wonder how many others are missing, hope I don't find out when I really need it. Even if it's only that the docs are transparent to search engines, so we can use Google, that might be something. But an incomplete index, unsearchable content, and no search field... well it's just not very usable. Search is essential. Thanks for listening. ___ Joseph Balderson, Flex Flash Platform Developer :: http://joeflash.ca Author, Professional Flex 3 :: http://tinyurl.com/proflex3book Alex Harui wrote: For your particular case, I think you could have used the index. The Adobe ASLR does have search. I wonder what it would take to implement it. -Alex On 3/21/14 9:40 PM, Joseph Balderson n...@joeflash.ca wrote: This may sound like a silly question, but how on earth do you search for anything in the Apache Docs, if you don't already know in which class it resides? The other day I wanted to know, out of curiosity, how many components implemented the itemCreationPolicy property, and I was unable to do a search to get an answer. Google 'itemCreationPolicy site:flex.apache.org/asdoc/' and you get 0 results. The docs themselves do not heave a search field like the old Adobe AS3/Flex docs have. This is a problem. I don't often use the search field in the AS3 reference, but when I do it's usually because I really need it. It is essential that the content in the Apache Flex docs also be searchable. Or am I missing something really simple here? -- ___ Joseph Balderson, Flex Flash Platform Developer :: http://joeflash.ca Author, Professional Flex 3 :: http://tinyurl.com/proflex3book
Re: Search in Apache Flex Docs?
Hi, We many need to request a solr setup/instance from infra - they mention as supporting it. [1] Justin 1. http://www.apache.org/dev/infrastructure.html
Re: Search in Apache Flex Docs?
For your particular case, I think you could have used the index. The Adobe ASLR does have search. I wonder what it would take to implement it. -Alex On 3/21/14 9:40 PM, Joseph Balderson n...@joeflash.ca wrote: This may sound like a silly question, but how on earth do you search for anything in the Apache Docs, if you don't already know in which class it resides? The other day I wanted to know, out of curiosity, how many components implemented the itemCreationPolicy property, and I was unable to do a search to get an answer. Google 'itemCreationPolicy site:flex.apache.org/asdoc/' and you get 0 results. The docs themselves do not heave a search field like the old Adobe AS3/Flex docs have. This is a problem. I don't often use the search field in the AS3 reference, but when I do it's usually because I really need it. It is essential that the content in the Apache Flex docs also be searchable. Or am I missing something really simple here? -- ___ Joseph Balderson, Flex Flash Platform Developer :: http://joeflash.ca Author, Professional Flex 3 :: http://tinyurl.com/proflex3book
