636 Posts in 190 Topics by 159 members
| Go to End | Next > | |
| Author | Topic: | 2964 Views |
-
Re: New api.silverstripe.org: Version specific, searchable - needs your help!

5 May 2010 at 2:14pm
> classname/filename - why do we have them both listed separately? If we took out the filename-based items, the left hand list would be much shorter. I don't really think we need them, as all the info should be in the class with the same name anyway, but if there was a reason to keep them, how about popping files/classes in tabs?
Yeah I was thinking about that - thought somebody might want to find out what _config.php files are for (which wouldn't show in any class listings). At the moment most "non-classy" PHP files are filtered out anyway, so yeah the file listing is pretty nonsensical. Does anybody else have a use case for it?
> * possibly links to previous/future versions of each class (ie if I google search and come across DataObjectSet for v2.3 there should be a link to DataObjectSet in 2.4 somewhere useful
Good point, its already in the top navigation, but the URLs are pretty "guessable", should be able to link directly to them in other version. This will generate some broken links though (renamed classes like HTTPResponse->SS_HTTPResponse, as well as non-existing ones, e.g. Aggregate didnt exist in 2.3). Do you think thats acceptable?
> * links to the source code in trac
phpDocumentor has a --sourcecode option, I might give that a go. Trac links will be harder to generalize from a Smarty templating view (I'm not customizing the phpdocumentoar PHP classes at the moment).
-
Re: New api.silverstripe.org: Version specific, searchable - needs your help!

7 May 2010 at 9:36am
Sweet, i've hidden the file listing by default, its toggleable (I love this word...) by JavaScript.
-
Re: New api.silverstripe.org: Version specific, searchable - needs your help!

10 May 2010 at 11:10am
I've also put our javascript API docs online (via naturaldocs.org): http://api.silverstripe.org/js/trunk
This is for trunk only, as lots of the 2.4 javascript is de facto deprecated, and has little documentation.
You can see an example of the documentation style needed to generate these docs at http://open.silverstripe.org/browser/modules/cms/trunk/javascript/LeftAndMain.EditForm.jsPlease let me know if you think this will be useful, mainly for figuring out what/where to customize in the CMS UI. The whole jQuery.entwine "CSS selector = class" paradigm is still fairly young and unexplored, particularly around documenting stuff. Feedback welcome, as always!
-
Re: New api.silverstripe.org: Version specific, searchable - needs your help!

16 June 2010 at 2:02am
How can I search this? at the moment it is very annoying to find class definitions... I must be missing something...
-
Re: New api.silverstripe.org: Version specific, searchable - needs your help!

16 June 2010 at 12:27pm
Hey swaiba, the API search is work in progress. For now, I suggest you use the "element index" at http://api.silverstripe.org/2.4/elementindex.html.
Alternatively, you can use Google and limit to the api site: http://www.google.co.nz/search?hl=en&q=AsTableRow+site:api.silverstripe.com/2.4&aq=f&aqi=&aql=&oq=&gs_rfai=
-
Re: New api.silverstripe.org: Version specific, searchable - needs your help!

18 June 2010 at 9:38pm
Thanks Ingo... I have updated my homepage with...
<br /><center><form name=f1 method="get" action="http://www.google.com/search">
<input type="text" name="q" size="31" maxlength="255" value="" /><br />
<input type="radio" name="sitesearch" value="api.silverstripe.com/2.4" checked />Silverstripe API<br />
<input type="submit" value="Google Search" /><br /><br />
</form></center> -
Re: New api.silverstripe.org: Version specific, searchable - needs your help!

18 July 2010 at 11:30pm
Is it just me or is the api Site down?
It always times out.... -
Re: New api.silverstripe.org: Version specific, searchable - needs your help!

19 July 2010 at 8:11am
Yes, the server is down - we're looking into it.
| 2964 Views | ||
| Go to Top | Next > |


