Revert "Revert "Merge pull #793: Dev Docs: New Glossary & JS Search Box""

This reverts commit 961d6c988f.
2025-07-27 09:46:12 +00:00 · 2015-04-14 08:06:08 -04:00 · 2015-04-14 08:06:08 -04:00 · a2a5f454cb
commit a2a5f454cb
parent ceaf266040
126 changed files with 3827 additions and 470 deletions
--- a/_config.yml
+++ b/_config.yml
@ -200,3 +200,282 @@ kramdown:
    coderay_tab_width: 4
    coderay_bold_every: 10
    coderay_css: style
+
+
+## Items in devsearches will appear in the search box in the order they
+## are listed below. For the top-level ("Glossary", "RPCs", etc...) this
+## is arbitrary based on whatever we think is most important. For the
+## second-level, this should be alphabetical order or another order that
+## will make intuitive sense to the user.
+devsearches:
+
+  ## Initialize the glossary array here so it appears first in the
+  ## search box. _plugins/glossary.rb will provide alphabetical ordering
+  "Glossary":
+
+  ## RPCs currently documented on Bitcoin.org. CamelCase names (with
+  ## leading capital) for easier quick scanning
+  "RPCs":
+    - 'AddMultiSigAddress': "/en/developer-reference#addmultisigaddress"
+    - 'AddNode': "/en/developer-reference#addnode"
+    - 'BackupWallet': "/en/developer-reference#backupwallet"
+    - 'CreateMultisig': "/en/developer-reference#createmultisig"
+    - 'CreateRawTransaction': "/en/developer-reference#createrawtransaction"
+    - 'DecodeRawTransaction': "/en/developer-reference#decoderawtransaction"
+    - 'DecodeScript': "/en/developer-reference#decodescript"
+    - 'DumpPrivKey': "/en/developer-reference#dumpprivkey"
+    - 'DumpWallet': "/en/developer-reference#dumpwallet"
+    - 'EncryptWallet': "/en/developer-reference#encryptwallet"
+    - 'EstimateFee': "/en/developer-reference#estimatefee"
+    - 'EstimatePriority': "/en/developer-reference#estimatepriority"
+    - 'GetAccount': "/en/developer-reference#getaccount"
+    - 'GetAccountAddress': "/en/developer-reference#getaccountaddress"
+    - 'GetAddedNodeInfo': "/en/developer-reference#getaddednodeinfo"
+    - 'GetAddressesByAccount': "/en/developer-reference#getaddressesbyaccount"
+    - 'GetBalance': "/en/developer-reference#getbalance"
+    - 'GetBestBlockHash': "/en/developer-reference#getbestblockhash"
+    - 'GetBlock': "/en/developer-reference#getblock"
+    - 'GetBlockChainInfo': "/en/developer-reference#getblockchaininfo"
+    - 'GetBlockCount': "/en/developer-reference#getblockcount"
+    - 'GetBlockHash': "/en/developer-reference#getblockhash"
+    - 'GetBlockTemplate': "/en/developer-reference#getblocktemplate"
+    - 'GetChainTips': "/en/developer-reference#getchaintips"
+    - 'GetConnectionCount': "/en/developer-reference#getconnectioncount"
+    - 'GetDifficulty': "/en/developer-reference#getdifficulty"
+    - 'GetGenerate': "/en/developer-reference#getgenerate"
+    - 'GetHashesPerSec': "/en/developer-reference#gethashespersec"
+    - 'GetInfo': "/en/developer-reference#getinfo"
+    - 'GetMempoolInfo': "/en/developer-reference#getmempoolinfo"
+    - 'GetMiningInfo': "/en/developer-reference#getmininginfo"
+    - 'GetNetTotals': "/en/developer-reference#getnettotals"
+    - 'GetNetworkHashPS': "/en/developer-reference#getnetworkhashps"
+    - 'GetNetworkInfo': "/en/developer-reference#getnetworkinfo"
+    - 'GetNewAddress': "/en/developer-reference#getnewaddress"
+    - 'GetPeerInfo': "/en/developer-reference#getpeerinfo"
+    - 'GetRawChangeAddress': "/en/developer-reference#getrawchangeaddress"
+    - 'GetRawMempool': "/en/developer-reference#getrawmempool"
+    - 'GetRawTransaction': "/en/developer-reference#getrawtransaction"
+    - 'GetReceivedByAccount': "/en/developer-reference#getreceivedbyaccount"
+    - 'GetReceivedByAddress': "/en/developer-reference#getreceivedbyaddress"
+    - 'GetTransaction': "/en/developer-reference#gettransaction"
+    - 'GetTxout': "/en/developer-reference#gettxout"
+    - 'GetTxoutSetInfo': "/en/developer-reference#gettxoutsetinfo"
+    - 'GetUnconfirmedBalance': "/en/developer-reference#getunconfirmedbalance"
+    - 'GetWalletInfo': "/en/developer-reference#getwalletinfo"
+    - 'GetWork': "/en/developer-reference#getwork"
+    - 'Help': "/en/developer-reference#help"
+    - 'ImportAddress': "/en/developer-reference#importaddress"
+    - 'ImportPrivkey': "/en/developer-reference#importprivkey"
+    - 'ImportWallet': "/en/developer-reference#importwallet"
+    - 'KeypoolRefill': "/en/developer-reference#keypoolrefill"
+    - 'ListAccounts': "/en/developer-reference#listaccounts"
+    - 'ListAddressGroupings': "/en/developer-reference#listaddressgroupings"
+    - 'ListLockUnspent': "/en/developer-reference#listlockunspent"
+    - 'ListReceivedByAccount': "/en/developer-reference#listreceivedbyaccount"
+    - 'ListReceivedByAddress': "/en/developer-reference#listreceivedbyaddress"
+    - 'ListSinceBlock': "/en/developer-reference#listsinceblock"
+    - 'ListTransactions': "/en/developer-reference#listtransactions"
+    - 'ListUnspent': "/en/developer-reference#listunspent"
+    - 'LockUnspent': "/en/developer-reference#lockunspent"
+    - 'Move': "/en/developer-reference#move"
+    - 'Ping': "/en/developer-reference#ping-rpc"
+    - 'SendFrom': "/en/developer-reference#sendfrom"
+    - 'SendMany': "/en/developer-reference#sendmany"
+    - 'SendRawTransaction': "/en/developer-reference#sendrawtransaction"
+    - 'SendToAddress': "/en/developer-reference#sendtoaddress"
+    - 'SetAccount': "/en/developer-reference#setaccount"
+    - 'SetGenerate': "/en/developer-reference#setgenerate"
+    - 'SetTxFee': "/en/developer-reference#settxfee"
+    - 'SignMessage': "/en/developer-reference#signmessage"
+    - 'SignRawTransaction': "/en/developer-reference#signrawtransaction"
+    - 'Stop': "/en/developer-reference#stop"
+    - 'SubmitBlock': "/en/developer-reference#submitblock"
+    - 'ValidateAddress': "/en/developer-reference#validateaddress"
+    - 'VerifyChain': "/en/developer-reference#verifychain"
+    - 'VerifyMessage': "/en/developer-reference#verifymessage"
+    - 'WalletLock': "/en/developer-reference#walletlock"
+    - 'WalletPassphrase': "/en/developer-reference#walletpassphrase"
+    - 'WalletPassphraseChange': "/en/developer-reference#walletpassphrasechange"
+
+  ## Op codes currently implemented in Bitcoin Core master branch. After
+  ## we document them on Bitcoin.org, these links will be updated
+  "Op codes":
+    - "OP_0 (OP_FALSE)": "https://en.bitcoin.it/wiki/Script#Constants"
+    - "OP_PUSHDATA1": "https://en.bitcoin.it/wiki/Script#Constants"
+    - "OP_PUSHDATA2": "https://en.bitcoin.it/wiki/Script#Constants"
+    - "OP_PUSHDATA4": "https://en.bitcoin.it/wiki/Script#Constants"
+    - "OP_1NEGATE": "https://en.bitcoin.it/wiki/Script#Constants"
+    - "OP_1 (OP_TRUE)": "https://en.bitcoin.it/wiki/Script#Constants"
+    - "OP_2": "https://en.bitcoin.it/wiki/Script#Constants"
+    - "OP_3": "https://en.bitcoin.it/wiki/Script#Constants"
+    - "OP_4": "https://en.bitcoin.it/wiki/Script#Constants"
+    - "OP_5": "https://en.bitcoin.it/wiki/Script#Constants"
+    - "OP_6": "https://en.bitcoin.it/wiki/Script#Constants"
+    - "OP_7": "https://en.bitcoin.it/wiki/Script#Constants"
+    - "OP_8": "https://en.bitcoin.it/wiki/Script#Constants"
+    - "OP_9": "https://en.bitcoin.it/wiki/Script#Constants"
+    - "OP_10": "https://en.bitcoin.it/wiki/Script#Constants"
+    - "OP_11": "https://en.bitcoin.it/wiki/Script#Constants"
+    - "OP_12": "https://en.bitcoin.it/wiki/Script#Constants"
+    - "OP_13": "https://en.bitcoin.it/wiki/Script#Constants"
+    - "OP_14": "https://en.bitcoin.it/wiki/Script#Constants"
+    - "OP_15": "https://en.bitcoin.it/wiki/Script#Constants"
+    - "OP_16": "https://en.bitcoin.it/wiki/Script#Constants"
+
+    - "OP_NOP": "https://en.bitcoin.it/wiki/Script#Flow_control"
+    - "OP_IF": "https://en.bitcoin.it/wiki/Script#Flow_control"
+    - "OP_NOTIF": "https://en.bitcoin.it/wiki/Script#Flow_control"
+    - "OP_ELSE": "https://en.bitcoin.it/wiki/Script#Flow_control"
+    - "OP_ENDIF": "https://en.bitcoin.it/wiki/Script#Flow_control"
+    - "OP_VERIFY": "https://en.bitcoin.it/wiki/Script#Flow_control"
+    - "OP_RETURN": "https://en.bitcoin.it/wiki/Script#Flow_control"
+
+    - "OP_TOALTSTACK": "https://en.bitcoin.it/wiki/Script#Stack"
+    - "OP_FROMALTSTACK": "https://en.bitcoin.it/wiki/Script#Stack"
+    - "OP_IFDUP": "https://en.bitcoin.it/wiki/Script#Stack"
+    - "OP_DEPTH": "https://en.bitcoin.it/wiki/Script#Stack"
+    - "OP_DROP": "https://en.bitcoin.it/wiki/Script#Stack"
+    - "OP_DUP": "https://en.bitcoin.it/wiki/Script#Stack"
+    - "OP_NIP": "https://en.bitcoin.it/wiki/Script#Stack"
+    - "OP_OVER": "https://en.bitcoin.it/wiki/Script#Stack"
+    - "OP_PICK": "https://en.bitcoin.it/wiki/Script#Stack"
+    - "OP_ROLL": "https://en.bitcoin.it/wiki/Script#Stack"
+    - "OP_ROT": "https://en.bitcoin.it/wiki/Script#Stack"
+    - "OP_SWAP": "https://en.bitcoin.it/wiki/Script#Stack"
+    - "OP_TUCK": "https://en.bitcoin.it/wiki/Script#Stack"
+    - "OP_2DROP": "https://en.bitcoin.it/wiki/Script#Stack"
+    - "OP_2DUP": "https://en.bitcoin.it/wiki/Script#Stack"
+    - "OP_3DUP": "https://en.bitcoin.it/wiki/Script#Stack"
+    - "OP_2OVER": "https://en.bitcoin.it/wiki/Script#Stack"
+    - "OP_2ROT": "https://en.bitcoin.it/wiki/Script#Stack"
+    - "OP_2SWAP": "https://en.bitcoin.it/wiki/Script#Stack"
+
+    - "OP_CAT (disabled)": "https://en.bitcoin.it/wiki/Script#Splice"
+    - "OP_SUBSTR (disabled)": "https://en.bitcoin.it/wiki/Script#Splice"
+    - "OP_LEFT (disabled)": "https://en.bitcoin.it/wiki/Script#Splice"
+    - "OP_RIGHT (disabled)": "https://en.bitcoin.it/wiki/Script#Splice"
+    - "OP_SIZE": "https://en.bitcoin.it/wiki/Script#Splice"
+
+    - "OP_INVERT (disabled)": "https://en.bitcoin.it/wiki/Script#Bitwise_logic"
+    - "OP_AND (disabled)": "https://en.bitcoin.it/wiki/Script#Bitwise_logic"
+    - "OP_OR (disabled)": "https://en.bitcoin.it/wiki/Script#Bitwise_logic"
+    - "OP_XOR (disabled)": "https://en.bitcoin.it/wiki/Script#Bitwise_logic"
+    - "OP_EQUAL": "https://en.bitcoin.it/wiki/Script#Bitwise_logic"
+    - "OP_EQUALVERIFY": "https://en.bitcoin.it/wiki/Script#Bitwise_logic"
+
+    - "OP_1ADD": "https://en.bitcoin.it/wiki/Script#Arithmetic"
+    - "OP_1SUB": "https://en.bitcoin.it/wiki/Script#Arithmetic"
+    - "OP_2MUL (disabled)": "https://en.bitcoin.it/wiki/Script#Arithmetic"
+    - "OP_2DIV (disabled)": "https://en.bitcoin.it/wiki/Script#Arithmetic"
+    - "OP_NEGATE": "https://en.bitcoin.it/wiki/Script#Arithmetic"
+    - "OP_ABS": "https://en.bitcoin.it/wiki/Script#Arithmetic"
+    - "OP_NOT": "https://en.bitcoin.it/wiki/Script#Arithmetic"
+    - "OP_0NOTEQUAL": "https://en.bitcoin.it/wiki/Script#Arithmetic"
+    - "OP_ADD": "https://en.bitcoin.it/wiki/Script#Arithmetic"
+    - "OP_SUB": "https://en.bitcoin.it/wiki/Script#Arithmetic"
+    - "OP_MUL (disabled)": "https://en.bitcoin.it/wiki/Script#Arithmetic"
+    - "OP_DIV (disabled)": "https://en.bitcoin.it/wiki/Script#Arithmetic"
+    - "OP_MOD (disabled)": "https://en.bitcoin.it/wiki/Script#Arithmetic"
+    - "OP_LSHIFT (disabled)": "https://en.bitcoin.it/wiki/Script#Arithmetic"
+    - "OP_RSHIFT (disabled)": "https://en.bitcoin.it/wiki/Script#Arithmetic"
+    - "OP_BOOLAND": "https://en.bitcoin.it/wiki/Script#Arithmetic"
+    - "OP_BOOLOR": "https://en.bitcoin.it/wiki/Script#Arithmetic"
+    - "OP_NUMEQUAL": "https://en.bitcoin.it/wiki/Script#Arithmetic"
+    - "OP_NUMEQUALVERIFY": "https://en.bitcoin.it/wiki/Script#Arithmetic"
+    - "OP_NUMNOTEQUAL": "https://en.bitcoin.it/wiki/Script#Arithmetic"
+    - "OP_LESSTHAN": "https://en.bitcoin.it/wiki/Script#Arithmetic"
+    - "OP_GREATERTHAN": "https://en.bitcoin.it/wiki/Script#Arithmetic"
+    - "OP_LESSTHANOREQUAL": "https://en.bitcoin.it/wiki/Script#Arithmetic"
+    - "OP_GREATERTHANOREQUAL": "https://en.bitcoin.it/wiki/Script#Arithmetic"
+    - "OP_MIN": "https://en.bitcoin.it/wiki/Script#Arithmetic"
+    - "OP_MAX": "https://en.bitcoin.it/wiki/Script#Arithmetic"
+    - "OP_WITHIN": "https://en.bitcoin.it/wiki/Script#Arithmetic"
+
+    - "OP_RIPEMD160": "https://en.bitcoin.it/wiki/Script#Crypto"
+    - "OP_SHA1": "https://en.bitcoin.it/wiki/Script#Crypto"
+    - "OP_SHA256": "https://en.bitcoin.it/wiki/Script#Crypto"
+    - "OP_HASH160": "https://en.bitcoin.it/wiki/Script#Crypto"
+    - "OP_HASH256": "https://en.bitcoin.it/wiki/Script#Crypto"
+    - "OP_CODESEPARATOR": "https://en.bitcoin.it/wiki/Script#Crypto"
+    - "OP_CHECKSIG": "https://en.bitcoin.it/wiki/Script#Crypto"
+    - "OP_CHECKSIGVERIFY": "https://en.bitcoin.it/wiki/Script#Crypto"
+    - "OP_CHECKMULTISIG": "https://en.bitcoin.it/wiki/Script#Crypto"
+    - "OP_CHECKMULTISIGVERIFY": "https://en.bitcoin.it/wiki/Script#Crypto"
+
+    - "OP_PUBKEYHASH (invalid)": "https://en.bitcoin.it/wiki/Script#Pseudo-words"
+    - "OP_PUBKEY (invalid)": "https://en.bitcoin.it/wiki/Script#Pseudo-words"
+    - "OP_INVALIDOPCODE (invalid)": "https://en.bitcoin.it/wiki/Script#Pseudo-words"
+
+    - "OP_RESERVED (reserved)": "https://en.bitcoin.it/wiki/Script#Reserved_words"
+    - "OP_VER (reserved)": "https://en.bitcoin.it/wiki/Script#Reserved_words"
+    - "OP_VERIF (reserved)": "https://en.bitcoin.it/wiki/Script#Reserved_words"
+    - "OP_VERNOTIF (reserved)": "https://en.bitcoin.it/wiki/Script#Reserved_words"
+    - "OP_RESERVED1 (reserved)": "https://en.bitcoin.it/wiki/Script#Reserved_words"
+    - "OP_RESERVED2 (reserved)": "https://en.bitcoin.it/wiki/Script#Reserved_words"
+    - "OP_NOP1 (reserved)": "https://en.bitcoin.it/wiki/Script#Reserved_words"
+    - "OP_NOP2 (reserved)": "https://en.bitcoin.it/wiki/Script#Reserved_words"
+    - "OP_NOP3 (reserved)": "https://en.bitcoin.it/wiki/Script#Reserved_words"
+    - "OP_NOP4 (reserved)": "https://en.bitcoin.it/wiki/Script#Reserved_words"
+    - "OP_NOP5 (reserved)": "https://en.bitcoin.it/wiki/Script#Reserved_words"
+    - "OP_NOP6 (reserved)": "https://en.bitcoin.it/wiki/Script#Reserved_words"
+    - "OP_NOP7 (reserved)": "https://en.bitcoin.it/wiki/Script#Reserved_words"
+    - "OP_NOP8 (reserved)": "https://en.bitcoin.it/wiki/Script#Reserved_words"
+    - "OP_NOP9 (reserved)": "https://en.bitcoin.it/wiki/Script#Reserved_words"
+    - "OP_NOP10 (reserved)": "https://en.bitcoin.it/wiki/Script#Reserved_words"
+
+  ## Only notable and non-withdrawn BIPs. Try to keep descriptions short
+  ## and focused on likely keywords
+  "BIPs":
+    - "BIP1: BIP purpose and guidelines": "https://github.com/bitcoin/bips/blob/master/bip-0001.mediawiki"
+    - "BIP11: m-of-n multisig transactions": "https://github.com/bitcoin/bips/blob/master/bip-0011.mediawiki"
+    - "BIP13: P2SH address format": "https://github.com/bitcoin/bips/blob/master/bip-0013.mediawiki"
+    - "BIP14: protocol version & user agent": "https://github.com/bitcoin/bips/blob/master/bip-0014.mediawiki"
+    - "BIP16: pay to script hash (P2SH)": "https://github.com/bitcoin/bips/blob/master/bip-0016.mediawiki"
+    - "BIP21: URI scheme": "https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki"
+    - "BIP22: GetBlockTemplate fundamentals": "https://github.com/bitcoin/bips/blob/master/bip-0022.mediawiki"
+    - "BIP23: GetBlockTemplate pooled mining": "https://github.com/bitcoin/bips/blob/master/bip-0023.mediawiki"
+    - "BIP30: dealing with duplicate transactions": "https://github.com/bitcoin/bips/blob/master/bip-0030.mediawiki"
+    - "BIP31: P2P pong message": "https://github.com/bitcoin/bips/blob/master/bip-0031.mediawiki"
+    - "BIP32: HD wallets": "https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki"
+    - "BIP34: block height in coinbase": "https://github.com/bitcoin/bips/blob/master/bip-0034.mediawiki"
+    - "BIP35: P2P mempool message": "https://github.com/bitcoin/bips/blob/master/bip-0035.mediawiki"
+    - "BIP37: bloom filtering": "https://github.com/bitcoin/bips/blob/master/bip-0037.mediawiki"
+    - "BIP38: passphrase-protected private key": "https://github.com/bitcoin/bips/blob/master/bip-0038.mediawiki"
+    - "BIP39: mnemonic code for HD wallets": "https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki"
+    - "BIP42: finite monetary supply": "https://github.com/bitcoin/bips/blob/master/bip-0042.mediawiki"
+    - "BIP44: HD wallet account hierarchy": "https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki"
+    - "BIP50: March 2013 fork post-mortem": "https://github.com/bitcoin/bips/blob/master/bip-0050.mediawiki"
+    - "BIP60: fixed-length version message": "https://github.com/bitcoin/bips/blob/master/bip-0060.mediawiki"
+    - "BIP61: P2P reject message": "https://github.com/bitcoin/bips/blob/master/bip-0061.mediawiki"
+    - "BIP62: dealing with malleability": "https://github.com/bitcoin/bips/blob/master/bip-0062.mediawiki"
+    - "BIP64: P2P geutxos message": "https://github.com/bitcoin/bips/blob/master/bip-0064.mediawiki"
+    - "BIP65: OP_CHECKLOCKTIMEVERIFY": "https://github.com/bitcoin/bips/blob/master/bip-0065.mediawiki"
+    - "BIP66: strict DER signatures": "https://github.com/bitcoin/bips/blob/master/bip-0066.mediawiki"
+    - "BIP70: payment protocol": "https://github.com/bitcoin/bips/blob/master/bip-0070.mediawiki"
+    - "BIP71: payment protocol MIME types": "https://github.com/bitcoin/bips/blob/master/bip-0071.mediawiki"
+    - "BIP72: payment protocol URIs": "https://github.com/bitcoin/bips/blob/master/bip-0072.mediawiki"
+    - "BIP73: accept header with payment protocol": "https://github.com/bitcoin/bips/blob/master/bip-0073.mediawiki"
+
+  ## Bitcoin P2P Protocol messages documented on Bitcoin.org
+  "P2P Messages":
+    - "addr":  "/en/developer-reference#addr"
+    - "alert":  "/en/developer-reference#alert"
+    - "block": "/en/developer-reference#block"
+    - "filteradd": "/en/developer-reference#filteradd"
+    - "filterclear": "/en/developer-reference#filterclear"
+    - "filterload": "/en/developer-reference#filterload"
+    - "getaddr": "/en/developer-reference#getaddr"
+    - "getblocks": "/en/developer-reference#getblocks"
+    - "getdata": "/en/developer-reference#getdata"
+    - "getheaders": "/en/developer-reference#getheaders"
+    - "headers": "/en/developer-reference#headers"
+    - "inv": "/en/developer-reference#inv"
+    - "mempool": "/en/developer-reference#mempool"
+    - "merkleblock": "/en/developer-reference#merkleblock"
+    - "notfound": "/en/developer-reference#notfound"
+    - "ping": "/en/developer-reference#ping"
+    - "pong": "/en/developer-reference#pong"
+    - "reject": "/en/developer-reference#reject"
+    - "tx": "/en/developer-reference#tx"
+    - "verack": "/en/developer-reference#verack"
+    - "version": "/en/developer-reference#version"