branch: master
commit e261832b1ab17a98cd2b5b706d7bf657589abfe0
Author: Noam Postavsky <npost...@users.sourceforge.net>
Commit: Noam Postavsky <npost...@users.sourceforge.net>
Add some styling to doc, improve top menu
* doc/snippet-expansion.org:
* doc/snippet-organization.org: Fix typos.
* doc/stylesheets/manual.css: Add some simple styling. Mainly, this
sets 'max-width' for the main text, and centers it. Adjust the
background color.
* doc/nav-menu.html.inc: Adjust 'class' of top menu.
* doc/yas-doc-helper.el (yas--make-preamble): New function, used for
:html-preamble. It sets the element for the current page in the top
menu as bolded text to aid navigation.
* doc/stylesheets/styles.css: Remove, it was unused since the old rst
manual was removed.
---
doc/nav-menu.html.inc | 4 +-
doc/snippet-expansion.org | 2 +-
doc/snippet-organization.org | 5 ++-
doc/stylesheets/manual.css | 33 ++++++++++------
doc/stylesheets/styles.css | 93 --------------------------------------------
doc/yas-doc-helper.el | 22 +++++++++--
6 files changed, 46 insertions(+), 113 deletions(-)
diff --git a/doc/nav-menu.html.inc b/doc/nav-menu.html.inc
index 2a3f0a1..3e74cf8 100644
--- a/doc/nav-menu.html.inc
+++ b/doc/nav-menu.html.inc
@@ -3,8 +3,8 @@
<li> <a href="index.html">Overview</a>
<li> <a
href="https://github.com/joaotavora/yasnippet/blob/master/README.mdown";>
Intro and Tutorial</a>
- <li class="center">Snippet
- <ul>
+ <li class="center border">Snippet
+ <ul class="nopad">
<li> <a href="snippet-organization.html">Organization</a>
<li> <a href="snippet-expansion.html">Expansion</a>
<li> <a href="snippet-development.html">Development</a>
diff --git a/doc/snippet-expansion.org b/doc/snippet-expansion.org
index f0fa029..a699d57 100644
--- a/doc/snippet-expansion.org
+++ b/doc/snippet-expansion.org
@@ -21,7 +21,7 @@
- Using hippie-expand
- - Call [[sym:yas-insert-snippet][=yas-insert-snippet=]] (use =M-x
yas-insert-snippet== or its
+ - Call [[sym:yas-insert-snippet][=yas-insert-snippet=]] (use =M-x
yas-insert-snippet= or its
keybinding =C-c & C-s=).
- Use m2m's excellent auto-complete
diff --git a/doc/snippet-organization.org b/doc/snippet-organization.org
index dc49249..22d3e46 100644
--- a/doc/snippet-organization.org
+++ b/doc/snippet-organization.org
@@ -4,8 +4,9 @@
* Basic structure
- Snippet collections can be stored in plain text files. They are arranged by
- sub-directories naming *snippet tables*. These mostly name Emacs major
names.
+ Snippet collections can be stored in plain text files. They are
+ arranged by sub-directories naming *snippet tables*. These mostly
+ name Emacs major mode names.
#+begin_example
.
diff --git a/doc/stylesheets/manual.css b/doc/stylesheets/manual.css
index 9580347..74bfe16 100644
--- a/doc/stylesheets/manual.css
+++ b/doc/stylesheets/manual.css
@@ -1,5 +1,14 @@
-nav > ul > li.center > ul {
- padding: 0;
+.center { margin-left: auto; margin-right: auto; text-align: center; }
+.current {
+ font-weight: bold;
+ background-color: #E0E8F0;
+}
+
+body { background-color: #E4F0F4 }
+div#content {
+ max-width: 20cm;
+ margin-left: auto;
+ margin-right: auto;
}
nav li {
@@ -9,20 +18,22 @@ nav li {
list-style-type: none;
padding: 0.5em;
}
-
nav > ul > li {
display: inline-block;
}
-
-/* match org's css for <pre> */
-code {
- background-color: #F3F5F7;
- font-family: courier, monospace;
+.nopad {
+ padding: 0;
+}
+li.border {
+ border: solid;
+ border-width: 1px;
}
-#content {
- margin-left: 5%;
- margin-right: 10%;
+pre, code{ background-color: #F3F5F7; }
+code {
+ /*
http://neugierig.org/software/chromium/notes/2009/09/monospace-fonts-workaround.html
*/
+ font-family: WorkAroundWebKitAndMozilla, monospace;
+ white-space: nowrap;
}
/* Styles for htmlize.el fontification. */
diff --git a/doc/stylesheets/styles.css b/doc/stylesheets/styles.css
deleted file mode 100644
index a158012..0000000
--- a/doc/stylesheets/styles.css
+++ /dev/null
@@ -1,93 +0,0 @@
-@media all
-{
- body {
- margin: 1em auto;
- /*margin: 10px 18% 10px 18%;*/
- font-family: Arial;
- /*text-align: justify;*/
- font-size: 14pt;
- padding: 10px;
- line-height: 1.2em;
- max-width: 600pt;
- }
-
- div#table-of-contents {
- position: fixed;
- left: 0%;
- right: 0%;
- top: 0px;
- z-index: 100;
- background: black;
- }
-
- div#table-of-contents h2 {
- display: none;
- }
-
- div#table-of-contents a {
- text-decoration: none;
- color: white;
- }
-
- div#table-of-contents a:visited {
- color: white;
- }
-
- div#table-of-contents a:hover {
- color: orange;
- }
-
- div.outline-2 h2{
- padding-top: 50px;
- }
-
- div#text-table-of-contents {
- text-color: white;
- text-align: center;
- margin-left: 30%;
- margin-right: 30%;
- }
-
- div#text-table-of-contents ul {
- height: 2em;
- width: 500px;
- list-style: none;
- margin: auto;
- }
-
- div#text-table-of-contents ul li {
- float: left;
- margin-left:auto;
- margin-right: auto;
- padding-left: 10px;
- }
-
- div#postamble{
- position: fixed;
- width: 800px;
- height: 250px;
- left: 50%;
- right: 50%;
- margin:-75px 0 0 -400px;
- bottom: -20px;
- font-size: 10pt;
- color: grey;
- background: url('siscog-bottom-logo.png') no-repeat;
- /* background-size: 100% 100%; */
- }
-
- div#postamble *{
- display: none;
- }
-
- div#postamble p.date{
- position: relative;
- bottom: -200px;
- text-align: center;
- display: block;
- }
-
-
-
-
-}
\ No newline at end of file
diff --git a/doc/yas-doc-helper.el b/doc/yas-doc-helper.el
index 8fbee8e..00b2d00 100644
--- a/doc/yas-doc-helper.el
+++ b/doc/yas-doc-helper.el
@@ -118,6 +118,22 @@
;; This lets all the org files be exported to HTML with
;; `org-publish-current-project' (C-c C-e P).
+(defun yas--make-preamble (props)
+ "Return contents of nav-menu-html.inc.
+But replace link to \"current\" page with a span element."
+ (with-temp-buffer
+ (let ((dir (file-name-directory (plist-get props :input-file))))
+ (insert-file-contents (expand-file-name "nav-menu.html.inc" dir))
+ (goto-char (point-min))
+ (search-forward (concat "<a href=\""
+ (file-name-nondirectory
+ (plist-get props :output-file))
+ "\">"))
+ (replace-match "<span class='current'>")
+ (search-forward "</a>")
+ (replace-match "</span>")
+ (buffer-string))))
+
(let* ((dir (if load-file-name (file-name-directory load-file-name)
default-directory))
(src-epoch (getenv "SOURCE_DATE_EPOCH"))
@@ -138,10 +154,8 @@
`(,@(when (fboundp 'org-html-publish-to-html)
'(:publishing-function org-html-publish-to-html))
:base-directory ,dir :publishing-directory ,dir
- :html-preamble
- ,(with-temp-buffer
- (insert-file-contents (expand-file-name "nav-menu.html.inc" dir))
- (buffer-string))
+ :html-preamble yas--make-preamble
+ ;;:with-broken-links mark
:html-postamble
,(concat "<hr><p class='creator'>Generated by %c from "
(or rev yas--version) " " date "</p>\n"
