12 |
Issues |
Issues |
13 |
------ |
------ |
14 |
|
|
|
- Defining standard fields? |
|
|
|
|
15 |
- Our own directives? |
- Our own directives? |
16 |
|
|
17 |
- Should we use urn-5 instead of serial numbers to avoid |
- Should we use urn-5 instead of serial numbers to avoid |
18 |
collisions? This could be a nice application. |
collisions? This could be a nice application. |
19 |
|
|
20 |
Low-level Format |
Names |
21 |
---------------- |
----- |
22 |
|
|
23 |
PEGs use the python reStructuredText_ markup language. |
The PEGs are not numbered but named, with names such as:: |
24 |
|
|
25 |
.. _reStructuredText: http://docutils.sourceforge.net |
move_vobs--benja |
26 |
|
move_vobs_2--benja |
27 |
|
meta_new_fields--tjl |
28 |
|
|
29 |
|
These names are used for the directory names. |
30 |
|
|
31 |
|
Inside the directory, there should be one reStructuredText file, |
32 |
|
called ``peg.rst'' and any number of other files (images, example code ...). |
33 |
|
|
34 |
Overall structure |
Overall structure |
35 |
----------------- |
----------------- |
46 |
|
|
47 |
Then, there can be free-form sections in which the changes proposed |
Then, there can be free-form sections in which the changes proposed |
48 |
are detailed. |
are detailed. |
49 |
|
|
50 |
|
|
51 |
|
Header |
52 |
|
------ |
53 |
|
|
54 |
|
The Header of the PEG should contain the following fields: |
55 |
|
|
56 |
|
Authors |
57 |
|
Comma-separated list of author names or handles |
58 |
|
Date |
59 |
|
CVS date tag |
60 |
|
Revision |
61 |
|
CVS revision tag |
62 |
|
Status |
63 |
|
The PEG status |
64 |
|
Date-Created |
65 |
|
The date when the PEG was created, for sorting |
66 |
|
|
67 |
|
Low-level Format |
68 |
|
---------------- |
69 |
|
|
70 |
|
PEGs use the python reStructuredText_ markup language. |
71 |
|
|
72 |
|
.. _reStructuredText: http://docutils.sourceforge.net |
73 |
|
|