From a790f353d0b87a7326926e56492accf94740d25b Mon Sep 17 00:00:00 2001 From: Saivann Date: Thu, 9 Apr 2015 14:21:03 -0400 Subject: [PATCH] Glossary: Various small fixes and improvements Add link to the glossary from each definition Fix missing BIP37 link Fix searchbox width on mobiles Apply more consistent margin and padding for the searchbox Use H3 titles in the glossary_entry layout for better readability Always use HTML classes for CSS stylesheets Fix one typo in glossary.rb --- _data/glossary/en/bloom-filter.yaml | 2 +- _layouts/glossary_entry.html | 11 +++++------ _less/screen.less | 8 ++++++-- _plugins/glossary.rb | 4 ++-- en/developer-documentation.md | 2 +- en/developer-examples.md | 2 +- en/developer-glossary.html | 2 +- en/developer-guide.md | 2 +- en/developer-reference.md | 2 +- 9 files changed, 19 insertions(+), 16 deletions(-) diff --git a/_data/glossary/en/bloom-filter.yaml b/_data/glossary/en/bloom-filter.yaml index 7e08764f..55fa2026 100644 --- a/_data/glossary/en/bloom-filter.yaml +++ b/_data/glossary/en/bloom-filter.yaml @@ -22,7 +22,7 @@ optional: links_html_or_markdown_style_capitalize_first_letter: - "[Bloom filter](/en/developer-guide#bloom-filters) --- Bitcoin.org Developer Guide" - - "[BIP37: Connection Bloom Filtering] --- Bitcoin Improvement Proposals" + - "[BIP37: Connection Bloom Filtering](https://github.com/bitcoin/bips/blob/master/bip-0037.mediawiki)--- Bitcoin Improvement Proposals" - "[Pull request that implemented bloom filters in Bitcoin Core](https://github.com/bitcoin/bitcoin/pull/1795) --- GitHub" - "[Discussion about bloom filtering and SPV clients](https://bitcointalk.org/index.php?topic=252937.0) --- BitcoinTalk" diff --git a/_layouts/glossary_entry.html b/_layouts/glossary_entry.html index a4a89997..69c99193 100644 --- a/_layouts/glossary_entry.html +++ b/_layouts/glossary_entry.html @@ -15,11 +15,10 @@ lang: en # {{page.required.title_max_40_characters_no_formatting}} - +
-This is a technical glossary. Regular users should use the [vocabulary -page](/en/vocabulary). +This definition comes from the [technical glossary](/en/developer-glossary).
## Definition @@ -30,14 +29,14 @@ page](/en/vocabulary). {% endautocrossref %} -## Synonyms +### Synonyms {% for synonym in page.required.synonyms_shown_in_glossary_capitalize_first_letter %} * {{synonym}} {% endfor %} {% if page.optional.not_to_be_confused_with_capitalize_first_letter %} -## Not To Be Confused With +### Not To Be Confused With {% autocrossref %} @@ -50,7 +49,7 @@ page](/en/vocabulary). {% endif %} {% if page.optional.links_html_or_markdown_style_capitalize_first_letter %} -## Links +### Links {% for link in page.optional.links_html_or_markdown_style_capitalize_first_letter %} * {{link}} {% endfor %} diff --git a/_less/screen.less b/_less/screen.less index da1c3168..7487207e 100644 --- a/_less/screen.less +++ b/_less/screen.less @@ -664,7 +664,7 @@ table td,table th{ } .docreference a{ display:inline-block; - margin:0 0 40px 0; + margin:20px 0 40px 0; font-size:125%; width:150px; } @@ -907,9 +907,10 @@ table td,table th{ border:2px solid #ee9209; color:#fff; } -#glossary_term { +.glossary_term { display: block; width: 20em; + padding: 5px 10px; margin-right: auto; margin-left: auto; } @@ -2215,6 +2216,9 @@ h2 .rssicon{ display:block; margin:0 auto 40px auto; } + .glossary_term { + width: 80%; + } .toc{ position:static; margin-top:0px; diff --git a/_plugins/glossary.rb b/_plugins/glossary.rb index ec47d72c..b09b3f06 100644 --- a/_plugins/glossary.rb +++ b/_plugins/glossary.rb @@ -113,7 +113,7 @@ module Jekyll glossary_dir='_data/glossary/en' - #generate each release based on templates + #Generate each definition page based on templates Dir.foreach(glossary_dir) do |file| next if file == '.' or file == '..' lang = 'en' @@ -122,7 +122,7 @@ module Jekyll output_directory = lang + '/glossary/' site.pages << GlossaryPage.new(site, site.source, lang, glossary_dir, src, output_directory) end - #TODO releases are only generated for English language, + #TODO definition pages are only generated for English language, #but they could also be translated at some point. They would however #need to fallback to English when no translation is available. end diff --git a/en/developer-documentation.md b/en/developer-documentation.md index ebbc117c..2171d1a6 100644 --- a/en/developer-documentation.md +++ b/en/developer-documentation.md @@ -13,7 +13,7 @@ title: "Developer Documentation - Bitcoin"

Find useful resources, guides and reference material for developers.

- +
iconGuide diff --git a/en/developer-examples.md b/en/developer-examples.md index e706386c..f171bc8c 100644 --- a/en/developer-examples.md +++ b/en/developer-examples.md @@ -27,7 +27,7 @@ title: "Developer Examples - Bitcoin" {% include fragment_reviews_needed.md %} - + {% include example_intro.md %} diff --git a/en/developer-glossary.html b/en/developer-glossary.html index f6c7d3a7..60c5de82 100644 --- a/en/developer-glossary.html +++ b/en/developer-glossary.html @@ -11,7 +11,7 @@ lang: en {% capture markdown_content %} # Bitcoin Developer Glossary - +
This is a technical glossary. Regular users should use the [vocabulary diff --git a/en/developer-guide.md b/en/developer-guide.md index cfb2f35c..c0600636 100644 --- a/en/developer-guide.md +++ b/en/developer-guide.md @@ -32,7 +32,7 @@ of the following file. --> {% include fragment_reviews_needed.md %} - + {% include guide_intro.md %} diff --git a/en/developer-reference.md b/en/developer-reference.md index 17d024a7..defd6d65 100644 --- a/en/developer-reference.md +++ b/en/developer-reference.md @@ -29,7 +29,7 @@ title: "Developer Reference - Bitcoin" {% include fragment_reviews_needed.md %} - + {% include ref_intro.md %}