Restructure texinfo to improve readme formatting for code example

This commit is contained in:
lash
2023-08-02 10:19:33 +01:00
parent e3d0704d4f
commit f9d2af2e3b
18 changed files with 313 additions and 173 deletions

View File

@@ -4,11 +4,14 @@ Attached to @code{ERC20} and @code{ERC721} tokens that may be @emph{burned}.
Implements the @code{burn(...)} part of @code{ERC5679} for interoperability.
@table @dfn
@item ERC165 Interface identifier
@subsubsection ERC165 Interface identifier
@include ../../build/Burner.interface
@item Solidity interface definition
@subsubsection Solidity interface definition
@include ../../build/contract_Burner.texi
@item Example implementation
@subsubsection Example implementation
@uref{https://git.grassecon.net/cicnet/erc20-demurrage-token.git}
@end table

View File

@@ -5,11 +5,14 @@ Define a creation time for a resource.
Complements @code{ERC5007}.
@table @dfn
@item ERC165 Interface identifier
@subsubsection ERC165 Interface identifier
@include ../../build/Chrono.interface
@item Solidity interface definition
@subsubsection Solidity interface definition
@include ../../build/contract_Chrono.texi
@item Example implementation
@subsubsection Example implementation
@uref{https://git.defalsify.org/eth-erc721} (BadgeToken contract)
@end table

View File

@@ -10,11 +10,14 @@ Claims may be made with or without topics. A missing topic is synonymous with a
Any number of claims can be made about an address under any number of topics. All claims must be stored, and returned in the order which they were added.
@table @dfn
@item ERC165 Interface identifier
@subsubsection ERC165 Interface identifier
@include ../../build/Declarator.interface
@item Solidity interface definition
@subsubsection Solidity interface definition
@include ../../build/contract_Declarator.texi
@item Reference implementation
@subsubsection Reference implementation
@uref{git://holbrook.no/eth-address-index.git,}
@end table

View File

@@ -7,11 +7,14 @@ Primary use-case is the abstraction of self-describing @uref{https://multiformat
A default encoding @emph{must} always be defined, and the encoding of a valid digest @emph{must} succeed with the default encoding.
@table @dfn
@item ERC165 Interface identifier
@subsubsection ERC165 Interface identifier
@include ../../build/Digest.interface
@item Solidity interface definition
@subsubsection Solidity interface definition
@include ../../build/contract_Digest.texi
@item Example implementation
@subsubsection Example implementation
@uref{git://holbrook.no/eth-event-msg.git}
@end table

View File

@@ -5,11 +5,14 @@ Defines an expiry time after which token balances or supply @emph{cannot change}
A contract defining an expiry @emph{must not} allow changing the expiration time to a time in the past.
@table @dfn
@item ERC165 Interface identifier
@subsubsection ERC165 Interface identifier
@include ../../build/Expire.interface
@item Solidity interface definition
@subsubsection Solidity interface definition
@include ../../build/contract_Expire.texi
@item Example implementation
@subsubsection Example implementation
@uref{https://git.grassecon.net/cicnet/erc20-demurrage-token.git}
@end table

View File

@@ -24,16 +24,19 @@ The contract has sufficient token funds to dispense the current defined amount t
The @emph{check(address)} contract call @emph{must} evaluate all four criteria, and @emph{must} return @code{false} if any of the criteria are not met.
@table @dfn
@item ERC165 Interface identifier
@subsubsection ERC165 Interface identifier
@include ../../build/Faucet.interface
@item Solidity interface definition
@subsubsection Solidity interface definition
@include ../../build/contract_Faucet.texi
@item Reference implementations
@subsubsection Reference implementations
@itemize
@item
@uref{git://holbrook.no/erc20-faucet.git,}
@item
@uref{git://holbrook.no/eth-faucet.git,}
@end itemize
@end table

View File

@@ -8,17 +8,20 @@ It @emph{must} be possible to refer to all off-chain resources directly by the c
Furthermore, it @emph{should} be possible to refer to a resource by a fully-qualified location on the web or an overlay network (e.g. tor).
@table @dfn
@item ERC165 Interface identifier
@subsubsection ERC165 Interface identifier
@include ../../build/Locator.interface
@item Solidity interface definition
@subsubsection Solidity interface definition
@include ../../build/contract_Locator.texi
@item Example implementation
@subsubsection Example implementation
@uref{git://holbrook.no/eth-event-msg.git}
@end table
@subsubsection Expressing locators in terms of numetic token id
@subsubsection Expressing locators in terms of numeric token id
Given the numeric token id @code{1234567890987654321} (@code{0x112210f4b16c1cb1} hex), and a base url @code{https://contentgateway.grassecon.net}, the result of the methods may be as follows:

View File

@@ -4,11 +4,14 @@ Attached to @code{ERC20} and @code{ERC721} tokens that may be minted.
Implements the @code{mint(...)} and @code{safeMint(...)} parts of @code{ERC5679} for interoperability.
@table @dfn
@item ERC165 Interface identifier
@subsubsection ERC165 Interface identifier
@include ../../build/Minter.interface
@item Solidity interface definition
@subsubsection Solidity interface definition
@include ../../build/contract_Minter.texi
@item Example implementation
@subsubsection Example implementation
@uref{https://git.grassecon.net/cicnet/erc20-demurrage-token.git}
@end table

View File

@@ -7,11 +7,14 @@ The reference may or may not be mutable.
The interface complements @code{Locator} and @code{MultiHash} to generate locators for how to resolve the reference.
@table @dfn
@item ERC165 Interface identifier
@subsubsection ERC165 Interface identifier
@include ../../build/Msg.interface
@item Solidity interface definition
@subsubsection Solidity interface definition
@include ../../build/contract_Msg.texi
@item Example implementation
@subsubsection Example implementation
@uref{git://holbrook.no/eth-event-msg.git}
@end table

View File

@@ -11,13 +11,18 @@ Entry-point to discover all relevant contracts of CIC networks.
Unique (ERC20) token symbol resolver.
@end enumerate
@table @dfn
@item ERC165 Interface identifier
@subsubsection ERC165 Interface identifier
@include ../../build/RegistryClient.interface
@item Solidity interface definition
@subsubsection Solidity interface definition
@include ../../build/contract_RegistryClient.texi
@item Contract registry implementation
@subsubsection Contract registry implementation
@uref{git://holbrook.no/eth-contract-registry.git,}
@item Token index implementation
@subsubsection Token index implementation
@uref{git://holbrook.no/eth-contract-registry.git,}
@end table

View File

@@ -21,11 +21,14 @@ Allow ownership of a contract to be transferred
The expiry time of a token (see @code{Expire})
@end itemize
@table @dfn
@item ERC165 Interface identifier
@subsubsection ERC165 Interface identifier
@include ../../build/Seal.interface
@item Solidity interface definition
@subsubsection Solidity interface definition
@include ../../build/contract_Seal.texi
@item Example implementation
@subsubsection Example implementation
@uref{https://git.grassecon.net/cicnet/erc20-demurrage-token.git}
@end table

View File

@@ -6,14 +6,17 @@ It allows defining the granularity of the rate of change, aswell as a frequency
A method for canonical value change calculations is also provided.
@table @dfn
@item ERC165 Interface identifier
@subsubsection ERC165 Interface identifier
@include ../../build/TokenRateChange.interface
@item Solidity interface definition
@subsubsection Solidity interface definition
@include ../../build/contract_TokenRateChange.texi
@item Reference implementations
@subsubsection Reference implementations
@itemize
@item
@uref{git://holbrook.no/erc20-demurrage-token.git,}
@end itemize
@end table

View File

@@ -2,14 +2,17 @@
Token swap interface that can fit token escrow aswell as token swap contracts.
@table @dfn
@item ERC165 Interface identifier
@subsubsection ERC165 Interface identifier
@include ../../build/TokenSwap.interface
@item Solidity interface definition
@subsubsection Solidity interface definition
@include ../../build/contract_TokenSwap.texi
@item Reference implementations
@subsubsection Reference implementations
@itemize
@item
@uref{git://holbrook.no/erc20-vend.git,}
@end itemize
@end table

View File

@@ -10,14 +10,16 @@ Voted tokens @strong{SHOULD} be locked until the voting has finalized.
Finalization of voting should be callable by anyone.
@table @dfn
@item ERC165 Interface identifier
@subsubsection ERC165 Interface identifier
@include ../../build/TokenVote.interface
@item Solidity interface definition
@subsubsection Solidity interface definition
@include ../../build/contract_TokenVote.texi
@item Reference implementations
@subsubsection Reference implementations
@itemize
@item
@uref{git://holbrook.no/evm-tokenvote.git,}
@end itemize
@end table

View File

@@ -19,11 +19,14 @@ Change the amount dispensed by the faucet.
Edit access control lists.
@end itemize
@table @dfn
@item ERC165 Interface identifier
@subsubsection ERC165 Interface identifier
@include ../../build/Writer.interface
@item Solidity interface definition
@subsubsection Solidity interface definition
@include ../../build/contract_Writer.texi
@item Example implementation
@subsubsection Example implementation
@uref{https://git.grassecon.net/cicnet/erc20-demurrage-token.git}
@end table