Contributions:Contribution Wiki Template - Revision history

Mellinger at 15:02, 18 March 2010

2010-03-18T15:02:12Z

← Older revision		Revision as of 15:02, 18 March 2010
Line 39:		Line 39:
	module, then a description of each parameter should follow as indicated		module, then a description of each parameter should follow as indicated
	by the examples. For other types of contributions, omit this section.		by the examples. For other types of contributions, omit this section.
	~~Parameter~~ documentation ~~provided here~~ will be also be recognized by the help		When parameter names are formatted as subheadings as in the example below,
			parameter documentation will be also be recognized by the help
	system, i.e. it will be accessible through the operator module's help button.)		system, i.e. it will be accessible through the operator module's help button.)
	===SomeParameter===		===SomeParameter===

Mellinger at 10:34, 25 March 2008

2008-03-25T10:34:09Z

← Older revision		Revision as of 10:34, 25 March 2008
Line 38:		Line 38:
	(If the contribution is an ADC, signal processing filter, or application		(If the contribution is an ADC, signal processing filter, or application
	module, then a description of each parameter should follow as indicated		module, then a description of each parameter should follow as indicated
	by the examples. For other types of contributions, omit this section.)		by the examples. For other types of contributions, omit this section.
			Parameter documentation provided here will be also be recognized by the help
			system, i.e. it will be accessible through the operator module's help button.)
	===SomeParameter===		===SomeParameter===
	Description of the ''SomeParameter'' parameter.		Description of the ''SomeParameter'' parameter.

Mellinger at 10:27, 25 March 2008

2008-03-25T10:27:20Z

← Older revision		Revision as of 10:27, 25 March 2008
Line 1:		Line 1:
	To create a wiki page for your own contribution, you may follow these steps:		To create a wiki page for your own contribution, you may follow these steps:
	#Log into the wiki using your BCI2000 SVN account.		#Log into the wiki using your BCI2000 SVN account.
	#Create a new wiki page with the ''Contributions:'' name prefix, followed with the name of your contribution.<br />E.g., if your contribution is called ''TachyonADC'', then the wiki page ~~would~~ be named ''Contributions:TachyonADC''.		#Create a new wiki page with the ''Contributions:'' name prefix, followed with the name of your contribution.<br />E.g., if your contribution is called ''TachyonADC'', then the wiki page should be named ''Contributions:TachyonADC''.
	#Copy-and-paste the wiki code given below into your new page, and modify it to fit your needs.		#Copy-and-paste the wiki code given below into your new page, and modify it to fit your needs.
	#Go to the [[Contributions:Contents]] page, and pick a category that applies to your contribution. On that category's page, add a link to your wiki page, followed with a very short summary.		#Go to the [[Contributions:Contents]] page, and pick a category that applies to your contribution. On that category's page, add a link to your wiki page, followed with a very short summary.

Mellinger at 10:56, 10 March 2008

2008-03-10T10:56:51Z

← Older revision		Revision as of 10:56, 10 March 2008
Line 15:		Line 15:
	==Versioning==		==Versioning==
	===Author===		===Author===
	(Enter ~~all~~ author and contact information ~~that~~ you feel appropriate.)		(Enter author and contact information as you feel appropriate.)
	===Version History===		===Version History===
	(Give a short list of changes when appropriate. The full history will always be recorded by SVN.)		(Give a short list of changes when appropriate. The full history will always be recorded by SVN.)

Mellinger at 17:12, 8 November 2007

2007-11-08T17:12:02Z

← Older revision		Revision as of 17:12, 8 November 2007
Line 11:		Line 11:
	==Location==		==Location==
	(Provide a link to the source code directory in the following form:)		(Provide a link to the source code directory in the following form:)
	http://~~www.bci2000.org~~/~~SVN~~/trunk/src/contrib/SignalSource/RDAClient		http://{{SERVERNAME}}/svn/trunk/src/contrib/SignalSource/RDAClient

	==Versioning==		==Versioning==

Mellinger at 17:07, 8 November 2007

2007-11-08T17:07:37Z

← Older revision		Revision as of 17:07, 8 November 2007
Line 49:		Line 49:
	contributions, omit this section.)		contributions, omit this section.)
	</pre>		</pre>

			[[Category:Howto]][[Category:Development]]

Mellinger at 16:54, 8 November 2007

2007-11-08T16:54:27Z

← Older revision		Revision as of 16:54, 8 November 2007
Line 8:		Line 8:
	(Shortly describe what your contribution does, and what the user		(Shortly describe what your contribution does, and what the user
	might use it for.)		might use it for.)

			==Location==
			(Provide a link to the source code directory in the following form:)
			http://www.bci2000.org/SVN/trunk/src/contrib/SignalSource/RDAClient

	==Versioning==		==Versioning==

Mellinger at 16:10, 7 November 2007

2007-11-07T16:10:33Z

← Older revision		Revision as of 16:10, 7 November 2007
Line 9:		Line 9:
	might use it for.)		might use it for.)

	==Source Code Revisions==		==Versioning==
			===Author===
			(Enter all author and contact information that you feel appropriate.)
			===Version History===
			(Give a short list of changes when appropriate. The full history will always be recorded by SVN.)
			===Source Code Revisions===
	(In this section, indicate the BCI2000 source code revisions (changesets)		(In this section, indicate the BCI2000 source code revisions (changesets)
	that you used when developing your contribution, and information about		that you used when developing your contribution, and information about

Mellinger at 20:35, 6 November 2007

2007-11-06T20:35:56Z

New page

To create a wiki page for your own contribution, you may follow these steps:
#Log into the wiki using your BCI2000 SVN account.
#Create a new wiki page with the ''Contributions:'' name prefix, followed with the name of your contribution.<br />E.g., if your contribution is called ''TachyonADC'', then the wiki page would be named ''Contributions:TachyonADC''.
#Copy-and-paste the wiki code given below into your new page, and modify it to fit your needs.
#Go to the [[Contributions:Contents]] page, and pick a category that applies to your contribution. On that category's page, add a link to your wiki page, followed with a very short summary.
<pre>
==Synopsis==
(Shortly describe what your contribution does, and what the user
might use it for.)

==Source Code Revisions==
(In this section, indicate the BCI2000 source code revisions (changesets)
that you used when developing your contribution, and information about
testing/compilation. Adapt the list to your own needs.
Hint: You obtain the revision of a source code repository by
right-clicking its top level directory, and choosing "show log" from the
TortoiseSVN submenu.)
*Initial development: XXXX
*Tested under: YYYY
*Known to compile under: ZZZZ
*Broken since: UUUU

==Functional Description==
(Give a full description of what your contribution does. If the user
needs to perform additional installation steps, add an "Installation"
section.)

==Parameters==
(If the contribution is an ADC, signal processing filter, or application
module, then a description of each parameter should follow as indicated
by the examples. For other types of contributions, omit this section.)
===SomeParameter===
Description of the ''SomeParameter'' parameter.
===AnotherParameter===
Description of the ''AnotherParameter'' parameter.

==States==
(If the contribution is an ADC, signal processing filter, or application
module, then a description of each state should follow. For other types of
contributions, omit this section.)
</pre>