Commit 9653910b authored by Per Cederqvist's avatar Per Cederqvist
Browse files

(Aux-Item Types): Moved elisp-client-read-faq [10000] and

	elisp-client-rejected-recommendation [10001] to an appendix.
(Client-specific Aux-Item Types): New appendix.
(Document Edition History): Fixed broken @xref usage.
parent aa04791d
......@@ -388,6 +388,7 @@ The most up-to-date version if this document can always be found at
* Membership visibility:: How the security features interacts.
* Writing Clients:: A few tips for client writers.
* Importing and Exporting E-Mail:: A few thoughts on e-mail integration.
* Client-specific Aux-Item Types:: Informative info about more aux-items.
* Future changes:: The protocol is not yet perfect.
* Protocol Version History:: The protocol was even less perfect before.
* Document Edition History:: Changes in this document.
......@@ -8742,57 +8743,6 @@ Only the author of the text can set this item. The data must be the
empty string. The hide-creator, secret, dont-garb and inherit bits
are automatically cleared.
@item elisp-client-read-faq [10000] (letterbox)
This item indicates FAQs that the user has read. Data is a decimal
number indicating the conference for which a FAQ has been read,
followed by a space character and a second decimal number indicating
the text number of the FAQ. In the future, additional data may be
defined; clients should be prepared to accept and ignore a space and
any trailing data that may follow the second number.
Note that aux-items of this type should always be secret since they
may contain information about texts of conferences that are not
publicly visible.
A few examples might clarify what the data may look like:
@table @code
@item 459 11215
FAQ in text 11215 for conference 459 has been read.
@item 459 11215 garbage
FAQ in text 11215 has been read. Clients must ignore the trailing
garbage. Note that clients are not allowed to create aux-items of this
format, but they should be prepared to handle them correctly.
@end table
This aux-item is specific to the elisp client. Other clients are not
required to use or understand this item type.
@item elisp-client-rejected-recommendation [10001] (letterbox)
This item indicates a rejected membership recommendation. Data is a
decimal number indicating the conference for which the recommendation
was rejected. In the future, additional data may be defined; clients
should be prepared to accept and ignore a space and any trailing data
that may follow the second number.
Note that aux-items of this type should always be secret since future
extensions may contain sensitive data.
A few examples might clarify what the data may look like:
@table @code
@item 459
A recommendation for conference 459 has been rejected.
@item 459 garbage
A recommendation for conference 459 has been rejected. Clients must
ignore the trailing garbage. Note that clients are not allowed to
create aux-items of this format, but they should be prepared to handle
them correctly.
@end table
This aux-item is specific to the elisp client. Other clients are not
required to use or understand this item type.
@item mx-mime-belongs-to [10100] (text)
Data is a decimal text number that this text is an attachment to. Most
......@@ -8832,6 +8782,9 @@ when the user chooses to save the text.
@end table
See also @ref{Client-specific Aux-Item Types}, for information about
some non-standardized aux-item types.
@node Name Expansion
@chapter Name Expansion
......@@ -9553,6 +9506,78 @@ sequence number, or something else that makes the Message-ID unique.
@end table
@node Client-specific Aux-Item Types
@appendix Some Client-specific Aux-Item Types (informative)
This appendix contains some contributed information from client
writers about some of the aux-item types that they use. This
information may be updated at any time by the client writers. How
much the client writer cares about backward compatibility when they
make changes to these aux-item types may be beyond the control of the
authors of the Protocol A specification.
If any of the aux-item types defined here becomes widely used by
different clients, they should probably be standardized and moved to
the @ref{Aux-Item Types} chapter.
@c This marker is used by "make check". See Makefile.am.
@c BEGIN-EXTRA-AUX
@table @samp
@item elisp-client-read-faq [10000] (letterbox)
This item indicates FAQs that the user has read. Data is a decimal
number indicating the conference for which a FAQ has been read,
followed by a space character and a second decimal number indicating
the text number of the FAQ. In the future, additional data may be
defined; clients should be prepared to accept and ignore a space and
any trailing data that may follow the second number.
Note that aux-items of this type should always be secret since they
may contain information about texts of conferences that are not
publicly visible.
A few examples might clarify what the data may look like:
@table @code
@item 459 11215
FAQ in text 11215 for conference 459 has been read.
@item 459 11215 garbage
FAQ in text 11215 has been read. Clients must ignore the trailing
garbage. Note that clients are not allowed to create aux-items of this
format, but they should be prepared to handle them correctly.
@end table
This aux-item is specific to the elisp client. Other clients are not
required to use or understand this item type.
@item elisp-client-rejected-recommendation [10001] (letterbox)
This item indicates a rejected membership recommendation. Data is a
decimal number indicating the conference for which the recommendation
was rejected. In the future, additional data may be defined; clients
should be prepared to accept and ignore a space and any trailing data
that may follow the second number.
Note that aux-items of this type should always be secret since future
extensions may contain sensitive data.
A few examples might clarify what the data may look like:
@table @code
@item 459
A recommendation for conference 459 has been rejected.
@item 459 garbage
A recommendation for conference 459 has been rejected. Clients must
ignore the trailing garbage. Note that clients are not allowed to
create aux-items of this format, but they should be prepared to handle
them correctly.
@end table
This aux-item is specific to the elisp client. Other clients are not
required to use or understand this item type.
@end table
@c END-EXTRA-AUX
@node Future changes
@appendix Future changes (speculative)
......@@ -10004,7 +10029,7 @@ wrong. The @field{idle-time} field is only affected by the
Information}).
@emph{Protocol change:} Expanded the documentation of
@field{super-conf}. @xref{Conference Status Types}. Simplified the
@field{super-conf}. @xref{Conference Status Types}. Simplified the
rules for @field{super-conf}; a setting of 0 no longer means anything.
A new section contains a summary of how a client should decied where
to send a comment, and it contains the new rules. @ref{Recipients of
......@@ -10020,12 +10045,12 @@ letterbox.
@field{permitted-submitters}. @xref{set-permitted-submitters}.
Clarify that a person is a supervisor of himself, except for the
@req{set-supervisor} call; @xref{Conferences}.
@req{set-supervisor} call; see @ref{Conferences}.
Document the @priv{change-name} privilege bit; @xref{Security}.
Document the @priv{change-name} privilege bit; see @ref{Security}.
Document that @field{last-login} is also updated on logout;
@xref{Person Status Types}.
see @ref{Person Status Types}.
Clarify that the address part of @aux{redirect} [8] is a conference
number.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment