From 44a0aabd634a6a076dc463c2b38368c26a5afb0a Mon Sep 17 00:00:00 2001 From: Denis Kisselev Date: Tue, 23 Jul 2013 13:40:08 -0700 Subject: [PATCH 1/7] Added Date/Time of last modification to header --- libs/functions.php | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/libs/functions.php b/libs/functions.php index ab6b437..f2856a1 100644 --- a/libs/functions.php +++ b/libs/functions.php @@ -104,7 +104,19 @@ function load_page($tree) { if (isset($branch['type']) && $branch['type'] == 'file') { $html = ''; if ($branch['name'] !== 'index') { - $html .= '

'. $branch['title'] . '

'; + $html .= '
'; + $html .= '

'. $branch['title'] . '

'; + + // Show last modified time for docs. Needs to be cleaned up and use template colours. + $modified = filemtime($branch['path']); + $html .= ''; + $html .= date ("l, F j, Y", $modified); + $html .= ''; + $html .= date ("g:i A", $modified); + $html .= ''; + + $html .= '
'; + } $html .= MarkdownExtended(file_get_contents($branch['path'])); return $html; From 9f34b05cd6204454276018f171a8e439ca04900a Mon Sep 17 00:00:00 2001 From: kisselev Date: Tue, 23 Jul 2013 14:12:53 -0700 Subject: [PATCH 2/7] CSS padding tweaks for modified time --- css/daux-blue.css | 2 +- css/daux-green.css | 2 +- css/daux-navy.css | 2 +- css/daux-red.css | 2 +- less/import/daux-base.less | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/css/daux-blue.css b/css/daux-blue.css index 9d3fadd..a74fdd8 100644 --- a/css/daux-blue.css +++ b/css/daux-blue.css @@ -6720,7 +6720,7 @@ code { } .page-header { margin: 10px 0px; - padding: 0px; + padding: 0px 0 20px; } .page-header h1 { margin-top: 0px; diff --git a/css/daux-green.css b/css/daux-green.css index 5b557a2..1f846e4 100644 --- a/css/daux-green.css +++ b/css/daux-green.css @@ -6720,7 +6720,7 @@ code { } .page-header { margin: 10px 0px; - padding: 0px; + padding: 0px 0 20px; } .page-header h1 { margin-top: 0px; diff --git a/css/daux-navy.css b/css/daux-navy.css index 90a7466..77287f9 100644 --- a/css/daux-navy.css +++ b/css/daux-navy.css @@ -6720,7 +6720,7 @@ code { } .page-header { margin: 10px 0px; - padding: 0px; + padding: 0px 0 20px; } .page-header h1 { margin-top: 0px; diff --git a/css/daux-red.css b/css/daux-red.css index 9187ad0..7017f8a 100644 --- a/css/daux-red.css +++ b/css/daux-red.css @@ -6720,7 +6720,7 @@ code { } .page-header { margin: 10px 0px; - padding: 0px; + padding: 0px 0 20px; } .page-header h1 { margin-top: 0px; diff --git a/less/import/daux-base.less b/less/import/daux-base.less index 6d2faa6..ca4a8ff 100644 --- a/less/import/daux-base.less +++ b/less/import/daux-base.less @@ -474,7 +474,7 @@ code { .page-header { margin: 10px 0px; - padding: 0px; + padding: 0px 0 20px; h1 { margin-top: 0px; } From 5f4d1c43086dd1042d7eba922373c8e04e463083 Mon Sep 17 00:00:00 2001 From: Denis Kisselev Date: Sat, 27 Jul 2013 22:33:21 -0700 Subject: [PATCH 3/7] Fixed timezone issue for servers that do not have a default timezone set in PHP.ini --- README.md | 8 ++++++++ index.php | 7 +++++++ 2 files changed, 15 insertions(+) diff --git a/README.md b/README.md index 3cd1f32..d4963cf 100644 --- a/README.md +++ b/README.md @@ -167,6 +167,14 @@ Set custom files and entire folders to ignore within your `/docs` folder. For fi } } +###Timezone +If your server does not have a default timezone set in php.ini, it may return errors when it tries to generate the last modified date/time for docs. To fix these errors, specify a timezone in your config file. Valid options are available in the [PHP Manual](http://php.net/manual/en/timezones.php). + + { + "timezone": "America/Los_Angeles" + } + + ## Running Remotely Copy the files from the repo to a web server that can run PHP 5.3 or greater. diff --git a/index.php b/index.php index 28a6bee..41d0c75 100644 --- a/index.php +++ b/index.php @@ -70,6 +70,13 @@ $tree = get_tree("docs", $base_url); $homepage_url = homepage_url($tree); $docs_url = docs_url($tree); +// If a timezone has been set in the config file, override the default PHP timezone for this application. +if(isset($options['timezone'])) +{ + date_default_timezone_set($options['timezone']); +} + + // Redirect to docs, if there is no homepage if ($homepage && $homepage_url !== '/') { header('Location: '.$homepage_url); From be90aa14c92931061bc955ea350118171e9acadd Mon Sep 17 00:00:00 2001 From: kisselev Date: Mon, 29 Jul 2013 10:47:41 -0700 Subject: [PATCH 4/7] Revert "CSS padding tweaks for modified time" This reverts commit 9f34b05cd6204454276018f171a8e439ca04900a. --- css/daux-blue.css | 2 +- css/daux-green.css | 2 +- css/daux-navy.css | 2 +- css/daux-red.css | 2 +- less/import/daux-base.less | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/css/daux-blue.css b/css/daux-blue.css index a74fdd8..9d3fadd 100644 --- a/css/daux-blue.css +++ b/css/daux-blue.css @@ -6720,7 +6720,7 @@ code { } .page-header { margin: 10px 0px; - padding: 0px 0 20px; + padding: 0px; } .page-header h1 { margin-top: 0px; diff --git a/css/daux-green.css b/css/daux-green.css index 1f846e4..5b557a2 100644 --- a/css/daux-green.css +++ b/css/daux-green.css @@ -6720,7 +6720,7 @@ code { } .page-header { margin: 10px 0px; - padding: 0px 0 20px; + padding: 0px; } .page-header h1 { margin-top: 0px; diff --git a/css/daux-navy.css b/css/daux-navy.css index 77287f9..90a7466 100644 --- a/css/daux-navy.css +++ b/css/daux-navy.css @@ -6720,7 +6720,7 @@ code { } .page-header { margin: 10px 0px; - padding: 0px 0 20px; + padding: 0px; } .page-header h1 { margin-top: 0px; diff --git a/css/daux-red.css b/css/daux-red.css index 7017f8a..9187ad0 100644 --- a/css/daux-red.css +++ b/css/daux-red.css @@ -6720,7 +6720,7 @@ code { } .page-header { margin: 10px 0px; - padding: 0px 0 20px; + padding: 0px; } .page-header h1 { margin-top: 0px; diff --git a/less/import/daux-base.less b/less/import/daux-base.less index ca4a8ff..6d2faa6 100644 --- a/less/import/daux-base.less +++ b/less/import/daux-base.less @@ -474,7 +474,7 @@ code { .page-header { margin: 10px 0px; - padding: 0px 0 20px; + padding: 0px; h1 { margin-top: 0px; } From c2059e4df80c00a342bf8b8f0ca0756daf70ba25 Mon Sep 17 00:00:00 2001 From: kisselev Date: Mon, 29 Jul 2013 11:49:58 -0700 Subject: [PATCH 5/7] Added option to disable date_modified. Also began moving html/styling out of the functions/php logic. --- css/daux-blue.css | 4 ++++ css/daux-green.css | 4 ++++ css/daux-navy.css | 4 ++++ css/daux-red.css | 4 ++++ docs/config.json | 1 + index.php | 39 ++++++++++++++++++++++++++++++++++++-- less/import/daux-base.less | 3 +++ libs/functions.php | 28 ++++++++++++++------------- 8 files changed, 72 insertions(+), 15 deletions(-) diff --git a/css/daux-blue.css b/css/daux-blue.css index 9d3fadd..3b4f6fb 100644 --- a/css/daux-blue.css +++ b/css/daux-blue.css @@ -6725,6 +6725,10 @@ code { .page-header h1 { margin-top: 0px; } +/* To be applied to the same element as page-header for sites that have sub-heading content such as Last modified time */ +.page-header .sub-heading { + padding: 0px, 0px, 20px; +} pre { border: none; background-color: #82becd; diff --git a/css/daux-green.css b/css/daux-green.css index 5b557a2..2f61116 100644 --- a/css/daux-green.css +++ b/css/daux-green.css @@ -6725,6 +6725,10 @@ code { .page-header h1 { margin-top: 0px; } +/* To be applied to the same element as page-header for sites that have sub-heading content such as Last modified time */ +.page-header .sub-heading { + padding: 0px, 0px, 20px; +} pre { border: none; background-color: #8acc37; diff --git a/css/daux-navy.css b/css/daux-navy.css index 90a7466..c95a02a 100644 --- a/css/daux-navy.css +++ b/css/daux-navy.css @@ -6725,6 +6725,10 @@ code { .page-header h1 { margin-top: 0px; } +/* To be applied to the same element as page-header for sites that have sub-heading content such as Last modified time */ +.page-header .sub-heading { + padding: 0px, 0px, 20px; +} pre { border: none; background-color: #7795b4; diff --git a/css/daux-red.css b/css/daux-red.css index 9187ad0..6049831 100644 --- a/css/daux-red.css +++ b/css/daux-red.css @@ -6725,6 +6725,10 @@ code { .page-header h1 { margin-top: 0px; } +/* To be applied to the same element as page-header for sites that have sub-heading content such as Last modified time */ +.page-header .sub-heading { + padding: 0px, 0px, 20px; +} pre { border: none; background-color: #ecb5a1; diff --git a/docs/config.json b/docs/config.json index c133ecf..3dbd75c 100644 --- a/docs/config.json +++ b/docs/config.json @@ -3,6 +3,7 @@ "tagline": "The Easiest Way To Document Your Project", "image": "img/app.png", "theme": "navy", + "date_modified": true, "repo": "justinwalsh/daux.io", "twitter": ["justin_walsh", "todaymade"], "google_analytics": "UA-12653604-10", diff --git a/index.php b/index.php index 41d0c75..f9d660d 100644 --- a/index.php +++ b/index.php @@ -70,6 +70,8 @@ $tree = get_tree("docs", $base_url); $homepage_url = homepage_url($tree); $docs_url = docs_url($tree); +$page = load_page($tree); + // If a timezone has been set in the config file, override the default PHP timezone for this application. if(isset($options['timezone'])) { @@ -183,7 +185,24 @@ if ($homepage && $homepage_url !== '/') {
- + + +
'; +

'; + '; + + + '; + + +
+ +
'; +

+
+ + +
@@ -265,7 +284,23 @@ if ($homepage && $homepage_url !== '/') {
- + +
+

+ + + + + + +
+ +
+

+
+ + +
diff --git a/less/import/daux-base.less b/less/import/daux-base.less index 6d2faa6..58e9555 100644 --- a/less/import/daux-base.less +++ b/less/import/daux-base.less @@ -478,6 +478,9 @@ code { h1 { margin-top: 0px; } + sub-heading { + padding: 0px, 0px, 20px; + } } pre { border: none; diff --git a/libs/functions.php b/libs/functions.php index f2856a1..a036322 100644 --- a/libs/functions.php +++ b/libs/functions.php @@ -34,6 +34,7 @@ function get_options() { 'tagline' => false, 'image' => false, 'theme' => 'blue', + 'date_modified' => true, 'float' => true, 'repo' => false, 'twitter' => array(), @@ -101,28 +102,29 @@ function docs_url($tree, $branch = false) { function load_page($tree) { $branch = find_branch($tree); + $page = array(); + if (isset($branch['type']) && $branch['type'] == 'file') { $html = ''; if ($branch['name'] !== 'index') { - $html .= '
'; - $html .= '

'. $branch['title'] . '

'; - // Show last modified time for docs. Needs to be cleaned up and use template colours. - $modified = filemtime($branch['path']); - $html .= ''; - $html .= date ("l, F j, Y", $modified); - $html .= ''; - $html .= date ("g:i A", $modified); - $html .= ''; - - $html .= '
'; + $page['title'] = $branch['title']; + $page['modified'] = filemtime($branch['path']); } $html .= MarkdownExtended(file_get_contents($branch['path'])); - return $html; + + $page['html'] = $html; + } else { - return "Oh No. That page dosn't exist"; + + $page['title'] = "Oh no"; + $page['html'] = "

Oh No. That page dosn't exist

"; + } + + + return $page; } function find_branch($tree) { From 8c04e845045006394de45504a06774190ab3b561 Mon Sep 17 00:00:00 2001 From: kisselev Date: Mon, 29 Jul 2013 11:54:45 -0700 Subject: [PATCH 6/7] Documentation updates --- README.md | 8 ++++++++ docs/00_Getting_Started.md | 9 +++++++++ 2 files changed, 17 insertions(+) diff --git a/README.md b/README.md index d4963cf..41b9d4f 100644 --- a/README.md +++ b/README.md @@ -174,6 +174,14 @@ If your server does not have a default timezone set in php.ini, it may return er "timezone": "America/Los_Angeles" } +###Date Modified +By default, daux.io will display the last modified time as reported by the system underneath the title for each document. To disable this, change the option in your config.json to false. + +```json +{ + "date_modified": false +} +``` ## Running Remotely diff --git a/docs/00_Getting_Started.md b/docs/00_Getting_Started.md index 3cd1f32..77574f0 100644 --- a/docs/00_Getting_Started.md +++ b/docs/00_Getting_Started.md @@ -167,6 +167,15 @@ Set custom files and entire folders to ignore within your `/docs` folder. For fi } } +###Date Modified +By default, daux.io will display the last modified time as reported by the system underneath the title for each document. To disable this, change the option in your config.json to false. + +```json +{ + "date_modified": false +} +``` + ## Running Remotely Copy the files from the repo to a web server that can run PHP 5.3 or greater. From b5668554a4459161fdd5be5d42b9bd56b62eac11 Mon Sep 17 00:00:00 2001 From: kisselev Date: Mon, 29 Jul 2013 11:58:04 -0700 Subject: [PATCH 7/7] Documentation updates --- README.md | 16 +++++++++------- docs/00_Getting_Started.md | 9 +++++++++ 2 files changed, 18 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 41b9d4f..6c04067 100644 --- a/README.md +++ b/README.md @@ -167,13 +167,6 @@ Set custom files and entire folders to ignore within your `/docs` folder. For fi } } -###Timezone -If your server does not have a default timezone set in php.ini, it may return errors when it tries to generate the last modified date/time for docs. To fix these errors, specify a timezone in your config file. Valid options are available in the [PHP Manual](http://php.net/manual/en/timezones.php). - - { - "timezone": "America/Los_Angeles" - } - ###Date Modified By default, daux.io will display the last modified time as reported by the system underneath the title for each document. To disable this, change the option in your config.json to false. @@ -183,6 +176,15 @@ By default, daux.io will display the last modified time as reported by the syste } ``` +###Timezone +If your server does not have a default timezone set in php.ini, it may return errors when it tries to generate the last modified date/time for docs. To fix these errors, specify a timezone in your config file. Valid options are available in the [PHP Manual](http://php.net/manual/en/timezones.php). + +```json +{ + "timezone": "America/Los_Angeles" +} +``` + ## Running Remotely Copy the files from the repo to a web server that can run PHP 5.3 or greater. diff --git a/docs/00_Getting_Started.md b/docs/00_Getting_Started.md index 77574f0..6c04067 100644 --- a/docs/00_Getting_Started.md +++ b/docs/00_Getting_Started.md @@ -176,6 +176,15 @@ By default, daux.io will display the last modified time as reported by the syste } ``` +###Timezone +If your server does not have a default timezone set in php.ini, it may return errors when it tries to generate the last modified date/time for docs. To fix these errors, specify a timezone in your config file. Valid options are available in the [PHP Manual](http://php.net/manual/en/timezones.php). + +```json +{ + "timezone": "America/Los_Angeles" +} +``` + ## Running Remotely Copy the files from the repo to a web server that can run PHP 5.3 or greater.