From 3b94fd9e9e6d321b6ebcae6af9f829bd5b07a5f7 Mon Sep 17 00:00:00 2001 From: Riccardo Spagni Date: Thu, 19 Feb 2015 20:48:14 +0200 Subject: [PATCH] added h3 id tagging to moneropedia plugin, first entry for account, updated entry for block --- _includes/head.html | 4 +- _includes/header.html | 2 +- _layouts/moneropedia.html | 22 ++++++++ _plugins/moneropedia.rb | 7 ++- _strings_en.yml | 2 +- downloads/index.md | 2 +- knowledge-base/moneropedia/00-base-00 | 9 ++++ knowledge-base/moneropedia/account.md | 67 ++++++++++++++++++++++++ knowledge-base/moneropedia/block.md | 16 ++++-- knowledge-base/moneropedia/blockchain.md | 8 --- 10 files changed, 121 insertions(+), 18 deletions(-) create mode 100644 _layouts/moneropedia.html create mode 100644 knowledge-base/moneropedia/00-base-00 create mode 100644 knowledge-base/moneropedia/account.md delete mode 100644 knowledge-base/moneropedia/blockchain.md diff --git a/_includes/head.html b/_includes/head.html index 158ba063..59f73de6 100644 --- a/_includes/head.html +++ b/_includes/head.html @@ -4,7 +4,9 @@ -{% if page.title %} +{% if page.entry %} +{{ page.entry }} | {% t global.wiki %} | {% t index.page_title %} +{% elsif page.title %} {{ page.title }} | {% t index.page_title %} {% else %} {% t index.page_title %} diff --git a/_includes/header.html b/_includes/header.html index bfe9987c..be14fb22 100644 --- a/_includes/header.html +++ b/_includes/header.html @@ -39,7 +39,7 @@ <ul class="dropdown-menu" role="menu"> <li><a href="/knowledge-base/about">{% t menu.about %}</a></li> <li><a href="/knowledge-base/people">{% t menu.people %}</a></li> - <li><a href="/knowledge-base/moneropedia">{% t menu.wiki %}</a></li> + <li><a href="/knowledge-base/moneropedia">{% t global.wiki %}</a></li> <li class="divider"></li> <li><a href="/knowledge-base/user-guides">{% t menu.userguides %}</a></li> <li><a href="/knowledge-base/developer-guides">{% t menu.developerguides %}</a></li> diff --git a/_layouts/moneropedia.html b/_layouts/moneropedia.html new file mode 100644 index 00000000..49350724 --- /dev/null +++ b/_layouts/moneropedia.html @@ -0,0 +1,22 @@ +<!DOCTYPE html> +<html> + + {% include head.html %} + + <body> + + {% include header.html %} + + <div class="container main-content"> + <div class="page-title"> + <img src="//static.monero.cc/images/icon_wiki.svg" class="title-icon"><h2 class="inline">{{ page.entry }} - <span class="softyellow-kicks">{% t global.wiki %}</span></h2> + </div> + + {{ content }} + </div> + + {% include footer.html %} + + </body> + +</html> diff --git a/_plugins/moneropedia.rb b/_plugins/moneropedia.rb index dadece05..708ed4e3 100644 --- a/_plugins/moneropedia.rb +++ b/_plugins/moneropedia.rb @@ -51,12 +51,15 @@ module Jekyll end end - + # replace instances of @term with tooltips of the summary @@moneropedia.each do |entry| entry[:terms].each do |term| - content = content.gsub(/(@#{term})\b/i, '<a href="/knowledge-base/moneropedia/' + term + '" data-toggle="tooltip" data-placement="top" data-original-title="' + entry[:summary] + '">' + term + '</a>') + content = content.gsub(/(\@#{term})\b/i, '<a href="/knowledge-base/moneropedia/' + term + '" data-toggle="tooltip" data-placement="top" data-original-title="' + entry[:summary] + '">' + term + '</a>') end end + + # add H3 id tags + content.gsub(/(\n### .*\n)/, '\1' + ' {#' + '\1'.downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '') + '}') base_converter(content) end diff --git a/_strings_en.yml b/_strings_en.yml index bc6560d5..10186780 100644 --- a/_strings_en.yml +++ b/_strings_en.yml @@ -4,6 +4,7 @@ global: getting_started: Getting Started copyright: Copyright monero_project: The Monero Project + wiki: Moneropedia terms: Terms privacy: Privacy copyright: Copyright @@ -26,7 +27,6 @@ menu: accepting: Accepting Monero Payments about: About Monero people: The People Behind Monero - wiki: Moneropedia userguides: User Guides developerguides: Developer Guides openalias: The OpenAlias Project diff --git a/downloads/index.md b/downloads/index.md index 68daacee..65f3dc9a 100644 --- a/downloads/index.md +++ b/downloads/index.md @@ -11,7 +11,7 @@ attribution: "<!-- Icon is based on work by Freepik (http://www.freepik.com) and ### Monero Core -Monero Core consists of several applications, including bitmonerod (the daemon that maintains the connection to the network) and simplewallet (a Monero account manager application), as well as several other helper applications. +Monero Core consists of several applications, including bitmonerod (the daemon that maintains the connection to the network) and simplewallet (a Monero @account manager application), as well as several other helper applications. If you are using Monero Core for the first time you may want to download a @blockchain bootstrap to get you started. A link to download the @blockchain bootstrap is included in the listings below. diff --git a/knowledge-base/moneropedia/00-base-00 b/knowledge-base/moneropedia/00-base-00 new file mode 100644 index 00000000..86ace91b --- /dev/null +++ b/knowledge-base/moneropedia/00-base-00 @@ -0,0 +1,9 @@ +--- +layout: moneropedia +entry: "" +terms: ["", ""] +summary: "" +--- + +### The Basics + diff --git a/knowledge-base/moneropedia/account.md b/knowledge-base/moneropedia/account.md new file mode 100644 index 00000000..0b800282 --- /dev/null +++ b/knowledge-base/moneropedia/account.md @@ -0,0 +1,67 @@ +--- +layout: moneropedia +entry: "Account" +terms: ["account", "accounts"] +summary: "similar in function to a bank account, contains all of your sent and received transactions" +--- + +### The Basics + +Those familiar with Monero's predecessors will be more familiar with the term *wallet* to describe this. In Monero we call this an account, and it is a private account owned and operated by a Monero user. + +Your account contains all of the Monero @transactions you have sent and received. Your account balance is a sum of all the Monero you've received, less the Monero you've sent. When using Monero you may notice that your account has two balances, a locked and an unlocked balance. The unlocked balance contains funds that can be spent immediately, and the locked balance contains funds that you can't spend right now. You may receive a transaction that has an @unlocktime set, or you may have sent some Monero and are waiting for the @change to come back to your wallet, both situations that could lead to those funds being locked for a time. + +A key difference between traditional electronic currency and Monero is that your account resides only under your control, normally on your computer, and cannot be accessed by anyone else if you practice good security (see below). + +### Multiple Accounts + +There are no costs attached to creating a Monero account, and there are no fees charged except for individual @transaction fees that go to @miners. + +This means that individuals can easily create a Monero account for themselves as well as a joint account to share with their partner, and individual accounts for their children. Similarly, a business could create separate accounts for each division or group. Since Monero's @transaction fees are quite low, moving funds between accounts is not an expensive exercise. + +### Cryptographic Keys + +Monero relies heavily on a cryptography principle known as *public/private key cryptography* or *asymmetric cryptography*, which is thoroughly detailed in [this Wikipedia article](https://en.wikipedia.org/wiki/Public-key_cryptography). + +Your account is based on two keys, a @spendkey and a @viewkey. The @spendkey is special in that it is the single key required to spend your Monero funds, whereas the @viewkey is allows you to reveal your @transactions to a third party, for example for auditing or accounting purposes. These keys in your account also play an important role in Monero's @transactionprivacy. + +The private keys for both of these must be protected by you in order to retain your account privacy. On the other hand, the public keys are obviously public (they are part of your Monero account address). For normal public/private key cryptography someone could send you a private message by encrypting it with either of your public keys, and you would then be the only one able to decrypt it with your private keys. + +### Backing Up Your Account + +Because no body holds your Monero on your behalf, you are responsible for your account. Thankfully, Monero makes it very easy to backup your account. When creating a Monero account for the first time you will be given a unique @mnemonicseed for your account that consists of 13 or 25 words in the language of your choosing. **This seed is the only thing you need to backup for your account**, and so it is imperative that it is written down. + +{:.cli-code} +List of available languages for your wallet's seed: +0 : English +1 : Spanish +2 : Portuguese +3 : Japanese +Enter the number corresponding to the language of your choice: 0 +Generated new wallet: 4B15ZjveuttEaTmfZjLVioPVw7bfSmRLpSgB33CJbuC6BoGtZrug9TDAmhZEWD6XoFDGz55bgzisT9Dnv61sbsA6Sa47TYu +view key: 4130fa26463d9451781771a8baa5d0b8085c47c4500cefe4746bab48f1d15903 +\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* +Your wallet has been generated. +To start synchronizing with the daemon use "refresh" command. +Use "help" command to see the list of available commands. +Always use "exit" command when closing simplewallet to save +current session's state. Otherwise, you will possibly need to synchronize +your wallet again. Your wallet key is NOT under risk anyway.<br><br> +<span style="color: lime;">PLEASE NOTE: the following 25 words can be used to recover access to your wallet. Please write them down and store them somewhere safe and secure. Please do not store them in your email or on file storage services outside of your immediate control.</span><br><br> +aunt knuckle italics moisture hawk thorn iris abort +chlorine smog uphill glass aptitude nowhere sewage plywood +dual relic fierce divers anvil nodes bubble cabin abort +\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* +<span style="color: yellow;">[wallet 4B15Zj]: </span> <span style="color: gray;">█</span><br> + +As the example above indicates, it is incredibly important to store these words in safe locations. If you are concerned about the risk of critical loss at your home, for instance, you may want to store a second copy of your seed with your attorney or in a safety deposit box. It is also recommended that it is stored in a way that does not make it obvious that it is your seed, so writing it into a letter or as part of other notes is advisable. + +### Practicing Good Security + +Over and above backing up your @mnemonicseed so that you have access to your account in the event of critical data loss, it is also important to practice good security. Use a secure password when creating a local Monero account (not used on [MyMonero](https://mymonero.com) or other web-based account systems). + +Don't ever give your Monero account password to anyone, as this can be used to access the Monero on your computer without knowing your @mnemonicseed. Similarly, make sure you have running and up-to-date antivirus, especially on Windows computers. Finally, be careful when clicking links in emails or on unknown and untrusted websites, as malware installed on your computer can sit and wait for you to access your Monero account before taking the funds from it. + +### Leaving Your Account to Next of Kin + +Providing access to your Monero account to your next of kin is just as easy as it is to backup your Monero account. Simply leave your @mnemonicseed to them in your will, or store it somewhere save where it will be given to them upon the execution of your will. A key advantage to this is that your next of kin won't have to wait for months for a third party to release the funds to them. diff --git a/knowledge-base/moneropedia/block.md b/knowledge-base/moneropedia/block.md index 2729e23f..bdc0d429 100644 --- a/knowledge-base/moneropedia/block.md +++ b/knowledge-base/moneropedia/block.md @@ -1,8 +1,16 @@ --- -layout: static_page -title: "Block | Moneropedia" +layout: moneropedia +entry: "Block" terms: ["block", "blocks"] -summary: "Blocks rock my socks" +summary: "a container of transactions" --- -### Work in Progress +### The Basics + +A block is a container of @transactions, with a new block being added to the @blockchain once every 60 seconds, on average. + +Blocks also contain a special type of transaction, the @coinbase transaction, which add newly created Monero to the network. + +Blocks are created through the process of @mining, and the @node that successfully mines the block then broadcasts it to each of the @nodes connected to it, who subsequently re-broadcast the block until the entire Monero network has received it. + +Fake or bad blocks generally cannot be created, as @nodes that receive blocks always verify the @transactions they contain against a set of consensus rules that all nodes adhere to, including validating the cryptographic @signatures on each transaction. diff --git a/knowledge-base/moneropedia/blockchain.md b/knowledge-base/moneropedia/blockchain.md deleted file mode 100644 index 66e3dd10..00000000 --- a/knowledge-base/moneropedia/blockchain.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -layout: static_page -title: "Blockchain | Moneropedia" -terms: ["blockchain", "blockchains"] -summary: "The blockchain is a blockchain" ---- - -### Work in Progress