To submit code all you need to do is go to the Contribute
tab and then click on the “Submit Code”
option on the menu on the left.
You will be taken to a screen where you can cut and paste the source code into a box, or upload a file containing the code in a file with one of the following suffixes: txt, c, cc, c++, c#, cpp, h, h++, hpp and hh.
It is helpful if you read our Coding Arrangement, Programming and Documentation Guidelines before submitting any code. This will save you time in the future doing any corrections that are required.
Graphic of Submit Page
Once you click “Submit” our documentation wizard will examine the code and break it up into component functions. It will also try to extract any documentation, comments and other information that is in the code and present it for you to view on the “Analysis” page.
By clicking on the next / previous buttons at the top of the page you will then be guided through various screens so that you can check / add and documentation details that are necessary, as well as specify how you would like your code to be licensed.
Graphic of Analysis Page
Documentation
If your code contains multiple functions you will first be taken to a screen where you can add/check information that is general to all of the functions. This includes a Brief Summary and Detailed Summary of the module, as well as checking the author and inserting any references. Specific functions or units should NOT be described here.
By clicking you will then be taken to individual documentation pages for each functions and asked to fill in as much information as possible (there is one page for each module). If your module only contains one function you will have been taken directly here. The page is divided up as follows:
Function Description
In the “Detailed Description” box you should describe what your code does as clearly as possible. You can include examples and refer to other sources of information if necessary. Parameters and other relevant information should also be included. If you are unsure what to put then please read our Documentation Guidelines. The more detail you give the easier it will be for other to understand, and the more likely that others will want to use your code. You are not restricted for space so use
Parameters
The Code Wizard will have automatically extracted the parameters contained within the function. There is a space next to each parameter where you can briefly describe it. There is also a place where you can add any relevant notes or comments that you feel would be useful.
Example Usage
It is helpful to provide one or two working examples of how your code works. This will make it easier for other to understand what the code does, and it will therefore be more likely that others will want to use your code. You are not restricted for space so use as much of it as you need
Credits
If there is any addition information regarding the author, or additional reference, you can add them in this section.
Once you have completed all of the documentation you will be taking to a Module Information & Licensing page:
Module Information
In this section you are asked to select a category and sub category that you think this piece of code will best fit in. If you do not find a suitable category then you can always create a new one by selecting [new category] from the dropdown menu, this will reveal a entry box where you can enter the category name.
All new categories are checked by the CodeCogs team to ensure that are appropriate!
Finally you will be asked to give the piece of code a name and check that the name is available (i.e. it is not already being used by another request or piece of code that is already in the database.) Try and be as concise as possible when deciding on a name.
Licensing
The most common option is to select the “Commercial’ and “Public” boxes. This means that your approved submission will be available to other coders under the terms of the Free (GPL) or Commercial Licences. To find out more about the licences please click here.
You can also use CodeCogs.com as a private store for your code. By selecting the “Private” option your code will only be available for you to view via the “My Cogs page”. It will be completely hidden and unavailable to other users. You may want to use this option to backup your work, or as a place to store work that is in progress. You can be assured that this information will be kept securely, in your own private database, and will not be used (or even read) by CodeCogs or its affiliates. This information is available to you and only to you.
The Final Stage: Preview & Confirm
Before confirming your submission you will first be asked to read and agree to the terms and conditions of the “Transfer of Licence Agreement”. This document is important so please read it before submitting code.
Graphic of Preview/Confirm page
On this page you can also make a final check that you are happy with the source code and all information is correct. If there are any pieces of information missing from the submission you will see a notification in red. By click the back you can go back and correct/add the required information.
|