Issues 78-80, 25 #81

LeviPetty · 2018-06-06T00:35:47Z

Changes:

Implemented custom CSS loading.
Implemented custom logo loading.
Implemented config for site name and short site name.

…to use

…nes/mozzarella into Field_Session

…club-logo' on line 19 of master.xhtml.

…e not configured show up

jackrosenthal · 2018-06-06T00:39:20Z

acmwebsite/templates/archives.xhtml

@@ -5,7 +5,7 @@
  <py:extends href="master.xhtml" />

  <head py:block="head" py:strip="True">
-    <title>Mines ACM - Mailing List Archives</title>
+    <title>${tg.config.get('short_site_name', 'not configured')} - Mailing List Archives</title>


Default value should be in config/app_config.py and have a default of "Mozzarella".

jackrosenthal · 2018-06-06T00:39:45Z

acmwebsite/templates/contact.xhtml

@@ -1,6 +1,6 @@
 <html py:extends="master.xhtml" py:strip="True">
  <head py:block="head" py:strip="True">
-    <title>Mines ACM - Contact</title>
+    <title>${tg.config.get('short_site_name', 'not configured')} - Contact</title>


jackrosenthal · 2018-06-06T00:39:59Z

acmwebsite/templates/error.xhtml

@@ -1,6 +1,6 @@
 <html py:extends="master.xhtml" py:strip="True">
  <head py:block="head" py:strip="True">
-    <title>Mines ACM - Error</title>
+    <title>${tg.config.get('short_site_name', 'not configured')} - Error</title>


jackrosenthal · 2018-06-06T00:40:04Z

acmwebsite/templates/index.xhtml

@@ -4,7 +4,7 @@

  <py:extends href="master.xhtml" />
  <head py:block="head" py:strip="True">
-    <title>Mines ACM</title>
+    <title>${tg.config.get('short_site_name', 'not configured')}</title>


jackrosenthal · 2018-06-06T00:40:14Z

acmwebsite/templates/index.xhtml

@@ -16,7 +16,7 @@
      </div>
      <div class="col-md-5">
        <div class="intro-block">
-        <h2>Mines ACM Student Chapter</h2>
+        <h2>${tg.config.get('site_name', 'not configured')}</h2>


jackrosenthal · 2018-06-06T00:40:19Z

acmwebsite/templates/index.xhtml

@@ -32,7 +32,7 @@
    <div class="col-md-6">
      <div class="panel panel-default">
        <div class="panel-heading">
-          <h3 class="panel-title">Join our ACM Chapter!</h3>
+          <h3 class="panel-title">Join our ${tg.config.get('site_name', 'not configured')}!</h3>


jackrosenthal · 2018-06-06T00:41:48Z

acmwebsite/templates/survey_results.xhtml

@@ -4,7 +4,7 @@
  py:extends="master.xhtml">

  <head py:block="head" py:strip="True">
-    <title>Mines ACM - Survey ${survey_id} Responses</title>
+    <title>${tg.config.get('short_site_name', 'not configured')} - Survey ${survey_id} Responses</title>


jackrosenthal · 2018-06-06T00:43:42Z

development.ini.sample

@@ -46,6 +46,10 @@ port = 8080
 [app:main]
 use = egg:acm-website

+# Set site name and short site name
+#site_name =
+#short_site_name =


use a key like site.name and site.short_name.

It is not clear what the purpose of name vs short name is. Please document or just use one.

Also, document the behavior when only one is specified.

jackrosenthal · 2018-06-06T00:44:17Z

development.ini.sample

@@ -135,6 +139,11 @@ meetings.timezone = America/Denver
 meetings.default_duration = 7200
 meetings.icalendar.prodid = -//Mines ACM//web//EN

+# Custom Assets Configuration
+custom_assets.dir = /home/lpetty/mozzarella/assets


should be commented out by default, as this directory definately wont exist for anyone but you.

jackrosenthal · 2018-06-06T00:44:48Z

README.rst

+Static Assets
+~~~~~~~~~~~~~
+
+The location of site-specific assets for development can be configured in ``development.ini``:


The site configuration might not be named development.ini.

jackrosenthal · 2018-06-06T00:45:38Z

acmwebsite/templates/master.xhtml

  </head>

  <body>
    <!-- Navbar -->
    <div class="container">
      <div class="header-logo">
        <a href="${tg.url('/')}">
-          <img src="${tg.url('/img/full.svg')}" alt="Mines ACM" class="acm-logo" />
+          <img src="${tg.url(tg.config.get('custom_assets.logo'))}" alt="Club Logo" class="club-logo" />


What's the default when no logo was specified? Can the site name be inserted instead?

…ound.

JadElClemens · 2018-06-06T01:51:41Z

Should be up to par now

jackrosenthal · 2018-06-08T00:42:05Z

development.ini.sample

@@ -135,6 +138,11 @@ meetings.timezone = America/Denver
 meetings.default_duration = 7200
 meetings.icalendar.prodid = -//Mines ACM//web//EN

+# Custom Assets Configuration
+custom_assets.dir = /


It's a VERY bad idea to set the root of the filesystem as the custom assets dir, I would not reccomend this in the sample development.ini.

Try visiting /etc/passwd

Just use site.custom_assets for this name

jackrosenthal · 2018-06-08T00:42:25Z

development.ini.sample

@@ -13,6 +13,9 @@
 # execute malicious code after an exception is raised.
 debug = true

+# Site name configuration
+#site.name = CSM Mozzarella


Just "Mozzarella"

jackrosenthal · 2018-06-08T00:44:22Z

development.ini.sample

+# Custom Assets Configuration
+custom_assets.dir = /
+custom_assets.css = custom.css
+custom_assets.logo = custom.png


I think it's a good idea to just have the paths be equivalent to the logos under public, rather than configuring the file name. This allows the sysadmin the guaruntee that the only overridden assets will have the same paths as the public directory.

So these keys should not be necessary.

jackrosenthal · 2018-06-08T00:45:00Z

acmwebsite/templates/master.xhtml

  </head>

  <body>
    <!-- Navbar -->
    <div class="container">
      <div class="header-logo">
        <a href="${tg.url('/')}">
-          <img src="${tg.url('/img/full.svg')}" alt="Mines ACM" class="acm-logo" />
+            <img src="${tg.url(tg.config.get('custom_assets.logo', 'logo.jpg'))}" alt="${tg.config.get('site.name')}" class="club-logo" />


See below comments, this will need changed.

Just use the CSS class "logo". Also make sure to change the css class if you adjust this. BOTH sides need adjusted.

…emoved the configuration for css and logo.

…zzarella into fs-wiki

…stem asset.

…ive links.

…zzarella into fs-wiki

Links to pages on the wiki should substitute spaces for %20 or the docutils publisher will strip the spaces and make the link invalid.

…T document

seems to align better

…zzarella into fs-wiki

JadElClemens · 2018-06-17T19:36:58Z

Now includes changes per #25, minus access control for certain pages and a web-based editor

jackrosenthal

Overall looks good. The wiki controller needs converted to OO style Page and Pages controllers. I can do if you do not have time.

I will also pull and test soon ... On mobile now.

jackrosenthal · 2018-06-19T05:24:22Z

acmwebsite/controllers/wiki.py

+
+    def _init_wiki_repo(self):
+        self.repo = init_repository(tg.config.get('wiki.repo'), True)
+        signature = Signature("Example McPersonson", "[email protected]") #TODO: Replace me


Explain what - the TODO?

If so - I just mean that this Signature can be replaced if need be, though it is only used for the inital commit. Presumably page commits using the web editor (once implemented) will pull signature details from the logged in profile.

jackrosenthal · 2018-06-19T05:24:48Z

acmwebsite/controllers/wiki.py

+        try:
+            repo_path = tg.config.get('wiki.repo')
+            if not repo_path:
+                tg.abort(400, "Wiki not enabled")


jackrosenthal · 2018-06-19T05:25:19Z

acmwebsite/controllers/wiki.py

+from docutils.core import publish_parts
+
+import os
+import tg


Import modules before from import

jackrosenthal · 2018-06-19T05:26:14Z

acmwebsite/controllers/wiki.py

+        return dict(pagename=pagename, parts=document)
+
+    @expose('acmwebsite.templates.wiki_history')
+    def history(self, pagename):


Can we do in OO-manner like user profile controller?

See f30995d - I attempted to follow the style of the user controller but it still seems a little dirty to me. Let me know what you think.

I moved the repo check/initialization logic from WikiController to WikiPagesController, but I had to change _before to init as it seems WikiPagesController wasn't calling _before like WikiController did.

jackrosenthal · 2018-06-19T05:27:29Z

acmwebsite/templates/master.xhtml

  </head>

  <body>
    <!-- Navbar -->
    <div class="container">
      <div class="header-logo">
        <a href="${tg.url('/')}">
-          <img src="${tg.url('/img/full.svg')}" alt="Mines ACM" class="acm-logo" />


Careful ... Was css class adjusted as well?

Changed acm-logo to logo in style.css

jackrosenthal · 2018-06-19T05:29:07Z

acmwebsite/templates/wiki_history.xhtml

+    </py:def>  
+
+
+    <h1 class="page-header">History: <a href="${tg.url('/wiki/%s' % page)}">$page</a></h1>


Do not use oldstyle string formatting

jackrosenthal · 2018-06-19T05:30:11Z

acmwebsite/templates/wiki_view.xhtml

+      <nav class="navbar navbar-default">
+        <ul class="nav navbar-nav">
+          <li class="nav-item">
+            <a class="nav-link" href="${tg.url('/wiki/history/%s' % pagename)}">History</a>


Old style string formatting

How would you recommend formatting these URLs instead? I tried just doing '/wiki/history/$pagename' put that seemed to mangle the URL pretty bad.

This is now fixed - wiki pages now follow the example from other controllers of using '[url]/{}'.format(var)

jackrosenthal · 2018-06-19T05:31:25Z

acmwebsite/wiki-assets/FrontPage.rst

+
+.. FIXME this still resolves to a local url
+.. _reStructuredText format: <http://docutils.sourceforge.net/rst.html>
+


Is this FIXME resolved?

JadElClemens · 2018-06-21T18:47:28Z

Programming for field session actually ended this past Friday, but I'm willing to see this PR through.

…k on wiki FrontPage fixed

JadElClemens · 2018-06-21T20:36:21Z

Seems like page history is now at /wiki/[pagename]/history

Requested changes implemented in Field_Session

nklonne and others added 12 commits May 31, 2018 19:47

Added site name and short site name to dev.ini and updated templates …

83cb9cc

…to use

Merge branch 'Field_Session' of https://github.com/ColoradoSchoolOfMi…

3ad8517

…nes/mozzarella into Field_Session

Image alt and class fixed.

69855ec

Set up custom logo loading: Relative path only

62b42e1

Resolved merge conflict by changing alt to 'Club Logo' and class to '…

652e5b4

…club-logo' on line 19 of master.xhtml.

Commented out site_name and short_site_name in development.ini to mak…

c450a00

…e not configured show up

Implemented custom logo loading.

23a2341

Simplified custom logo loading.

f1f6012

Implemented custom CSS loading

263c1d8

Documented new config options

447f01c

Fixed documentation on static assets config

f9b1b39

Really fixed documentation this time

ef1eddb

jackrosenthal self-requested a review June 6, 2018 00:37

LeviPetty changed the title ~~Field session~~ Issues 78-80 Jun 6, 2018

jackrosenthal reviewed Jun 6, 2018

View reviewed changes

jackrosenthal suggested changes Jun 6, 2018

View reviewed changes

JadElClemens and others added 6 commits June 5, 2018 19:07

Changes to development.ini items

93220e9

Added site name to config defaults

a788600

Default value for site.name is now Mozzarella.

9c82e5b

There is now a default image name for the site logo.

aae73d2

Shows site name in place of logo if the file for the logo cannot be f…

e467d68

…ound.

Site no longer requires custom_assets config options to be set

140e84c

jackrosenthal suggested changes Jun 8, 2018

View reviewed changes

Levi Petty and others added 6 commits June 7, 2018 18:54

Commented out custom assets directory in development.ini.sample and r…

f2fa2ff

…emoved the configuration for css and logo.

Fixed up master.xhtml - no longer uses config-based file locations

52a1b9c

Created basic views and controller for wiki

8fe387a

Added a link to wiki page

d644c3e

Beginning of wiki functionality

eafcdfe

Merge branch 'fs-wiki' of https://github.com/ColoradoSchoolOfMines/mo…

5135258

…zzarella into fs-wiki

JadElClemens and others added 16 commits June 16, 2018 04:13

Index now redirects to FrontPage. FrontPage is now copied from filesy…

c79b3a2

…stem asset.

Added a skeleton page for the Page List.

41f1ded

Implemented the Page List. TODO: It only lists the name, it doesn't g…

9385621

…ive links.

Slight changes to default wiki frontpage

8ce0381

Merge branch 'fs-wiki' of https://github.com/ColoradoSchoolOfMines/mo…

ee9c098

…zzarella into fs-wiki

Made wiki pagelist link to pages, files with spaces now supported

0fba5fb

Links to pages on the wiki should substitute spaces for %20 or the docutils publisher will strip the spaces and make the link invalid.

Changed page list to use XML templating rather than filling out a ReS…

a7fc457

…T document

Cleaned up wiki controller code

d030827

Fixed the auto-initializing an extra PageList page.

5b761f7

Homepage no longer reserves space for banner if banner does not exist

56bb645

wiki view page no longer uses containers

dfd8763

seems to align better

Merge branch 'fs-wiki' of https://github.com/ColoradoSchoolOfMines/mo…

72d81e5

…zzarella into fs-wiki

Removed unnecessary PageList.rst from the wiki-assets directory.

36f5ee8

Merge branch 'fs-wiki' of https://github.com/ColoradoSchoolOfMines/mo…

db1c91e

…zzarella into fs-wiki

Merge branch 'fs-wiki' into Field_Session

de04840

Deleted assets dir

f1c95ae

JadElClemens changed the title ~~Issues 78-80~~ Issues 78-80, 25 Jun 17, 2018

jackrosenthal previously requested changes Jun 19, 2018

View reviewed changes

Site configuration values in development.ini.sample are now together.

615b2ac

JadElClemens added 5 commits June 21, 2018 12:56

Changed acm-logo CSS class to logo

93a3ba9

Wiki not enabled now results in a 404, imports fixed up, external lin…

a1141bb

…k on wiki FrontPage fixed

Merge branch 'fs-wiki' into Field_Session

442381b

Wiki pages no longer use old-style formatting

a8190ec

Began implementing wiki controller in OO manner

f30995d

jackrosenthal and others added 2 commits October 22, 2018 18:32

Change wiki initialization method

31c0537

fixed initialization of wiki controller

3f9090c

		</py:def>


		<h1 class="page-header">History: <a href="${tg.url('/wiki/%s' % page)}">$page</a></h1>


		.. FIXME this still resolves to a local url
		.. _reStructuredText format: <http://docutils.sourceforge.net/rst.html>

Issues 78-80, 25 #81

Are you sure you want to change the base?

Issues 78-80, 25 #81

Conversation

LeviPetty commented Jun 6, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JadElClemens commented Jun 6, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JadElClemens commented Jun 17, 2018

jackrosenthal left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JadElClemens commented Jun 21, 2018

JadElClemens commented Jun 21, 2018 • edited Loading

JadElClemens commented Jun 21, 2018 •

edited

Loading