RRM 3-13 Editing Tasks - Revision history

AndrewJohnson: /* To Do List */

2005-09-02T20:13:04Z

To Do List

← Older revision		Revision as of 20:13, 2 September 2005
Line 4:		Line 4:

	* Read [[RRM 3-13 Concepts\|Database Concepts]] and revise as necessary.		* Read [[RRM 3-13 Concepts\|Database Concepts]] and revise as necessary.
	* For [[RRM 3-13 dbCommon\|Fields Common to All Record Types]] update the field tables and descriptions.		** Maybe replace the existing CapFast diagrams with VDCT equivalents.
			* For [[RRM 3-13 dbCommon\|Fields Common to All Record Types]] update the field tables and descriptions according to how dbCommon has changed.
	* Check [[RRM 3-13 Common\|Fields Common to Many Record Types]] for typical changes made across all record types.		* Check [[RRM 3-13 Common\|Fields Common to Many Record Types]] for typical changes made across all record types.
	* For each existing record chapter we need to update its for		* For each existing record chapter we need to update its for

AndrewJohnson: /* To Do List */

2005-09-02T19:47:57Z

To Do List

← Older revision		Revision as of 19:47, 2 September 2005
Line 12:		Line 12:
	*** Missing sections		*** Missing sections
	*** Device support report() function prototypes		*** Device support report() function prototypes
			* For [[RRM 3-13 Menu Choices\|Menu Choices]] check and update the list of menus and choices in each.

	=== Record Documentation/Distribution Anomalies ===		=== Record Documentation/Distribution Anomalies ===

AndrewJohnson: First draft...

2005-09-02T19:33:10Z

First draft...

New page

== To Do List ==

The purpose of this list is to bring the existing R3.13 Record Reference Manual up to match the current R3.13.10 implementation. A separate effort can then be made to come out with a version of the manual for R3.14.x, starting from the R3.13.10 version.

* Read [[RRM 3-13 Concepts|Database Concepts]] and revise as necessary.
* For [[RRM 3-13 dbCommon|Fields Common to All Record Types]] update the field tables and descriptions.
* Check [[RRM 3-13 Common|Fields Common to Many Record Types]] for typical changes made across all record types.
* For each existing record chapter we need to update its for
** Changes to individual fields
** Changes made to the record processing description
** Fix shortcomings of the existing text, e.g.
*** Missing sections
*** Device support report() function prototypes

=== Record Documentation/Distribution Anomalies ===

These records are documented here but not present in any distribution of EPICS Base:

* Archive
* CPID

These records are not documented here, but are present in both the R3.13.10 and R3.14.x distributions:

* Analog Array Input
* Analog Array Output

These records are neither documented here nor present in any distribution of Base, but being commonly used they are candidates for possible inclusion in the documentation:

* Enhanced PID
* genSub
* Motor
* Transform
* Table
* waveformAnalysis
* ... other ...

Don't add pages for these obsolete records, which were present in the R3.13.10 distribution but removed in R3.14.x:

* Event Generator Event
* Event Generator
* Event Receiver Event
* Event Receiver
* GSub (not Andy Foster's genSub)
* recDynLink
* recWaitCa