The API reference for Drupal 5 (http://api.drupal.org/api/5) shows under Components of Drupal an item called 'File upload system'. When one clicks on this, one is taken to a page called 'File interface' which lists various functions defined in includes/file.inc.

Then, when one searches through the list of functions, one comes across a bunch of functions prefixed with fileupload_ which, in contrast to most of the other functions in that list, are not immediately available but turn out to be functions belonging to an example called the fileupload.module.
fileupload.module, I then found out, is not part of the standard installation and cannot be downloaded from the modules page either. It is a good example of how one can use the functions defined in includes/file.inc, don't get me wrong, but I was under the impression that they where part of the API.

Perhaps a heading of 'Examples' could be added to http://api.drupal.org/api/5 with a link to fileupload.module and other example projects could be added, with an explanation of their status (proven code / probably ok / use at your own risk)?

Comments

sepeck’s picture

Title: Drupal5 documentation concerning file uploads is confusing » Add link under example to fileupload module for Drupal5 on api.drupal.org
Project: Documentation » Drupal.org site moderators
Component: Developer Guide » Broken link
Category: bug » task

The landing page http://api.drupal.org/api/5 has a section to example modules already and the heading example serves to identify their purpose. The description of fileupload also identifies it as an example. http://api.drupal.org/api/file/developer/examples/fileupload.module/5

http://api.drupal.org/api/5

Moving to webmasters queue to add a link to the fileupload module added to the existing examples

avpaderno’s picture

Status: Active » Postponed (maintainer needs more info)

What should the link text be?

avpaderno’s picture

Title: Add link under example to fileupload module for Drupal5 on api.drupal.org » Add a link to fileupload.module on api.drupal.org for Drupal 5
Status: Postponed (maintainer needs more info) » Fixed

I have added the link in the examples section. The committed code will be available in the next 12 hours (less or more).

Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.