Changeset 12901

Timestamp:

4 May 2015, 08:24:12 (10 years ago)

Author:

Henrik Bettermann

Message:

Add link ‘Kofa Docs for this page’ at the end of the content box which refers to the corresponding section of the Kofa Documentation.

Location:

main/waeup.kofa/trunk

Files:

• CHANGES.txt (modified) (1 diff)
• docs/source/userdocs/datacenter/logging.rst (modified) (1 diff)
• layout/static/css/base.css (modified) (1 diff)
• layout/theme.html (modified) (1 diff)
• src/waeup/kofa/browser/pages.py (modified) (9 diffs)
• src/waeup/kofa/browser/templates/datacenterlogsshowfilepage.pt (modified) (2 diffs)
• src/waeup/kofa/browser/templates/staffsitelayout.pt (modified) (3 diffs)
• src/waeup/kofa/interfaces.py (modified) (1 diff)
• src/waeup/kofa/reports.py (modified) (2 diffs)
• src/waeup/kofa/students/browser.py (modified) (2 diffs)

main/waeup.kofa/trunk/CHANGES.txt

@@ -4 +4 @@
 1.3.2.dev0 (unreleased)
 =======================
+
+* Add link 'Kofa Docs for this page' at the end of the content box
+  which refers to the corresponding section of the
+  `Kofa Documentation <http://kofa-doc.waeup.org>`_.
 
 * Filter students by current level in reports.

main/waeup.kofa/trunk/docs/source/userdocs/datacenter/logging.rst

@@ -111 +111 @@
 ==============
 
-All actions in the data center are logged in ``datacenter.log``.
-These are uploading import files, processing import files and
-downloading any kind of datacenter file::
+All actions in the data center (uploading, processing, downloading
+and deleting of files) are logged in ``datacenter.log``::
 
   2015-04-29 06:52:23,483 - INFO - admin - browser.pages.DatacenterUploadPage - uploaded: /kofa/trunk/var/datacenter/users_admin.csv

main/waeup.kofa/trunk/layout/static/css/base.css

@@ -163 +163 @@
     margin: 0px 0px 4px 0px;
     display: inline-block;
+}
+
+/* Documentation link*/
+
+div.documentation {
+    margin-top: -20px;
+    text-align: right;
 }
 

main/waeup.kofa/trunk/layout/theme.html

@@ -517 +517 @@
               </tbody>
             </table>
+            <br>
+            <div class="documentation">
+              <a href="#" target="_blank">
+                Kofa Docs for this page
+              </a>
+            </div>
           </div> <!-- /well kofa-content-->
         </div> <!-- /kofa-content-wide -->

main/waeup.kofa/trunk/src/waeup/kofa/browser/pages.py

@@ -59 +59 @@
     ISessionConfiguration, ISessionConfigurationAdd, IJobManager,
     IPasswordValidator, IContactForm, IKofaUtils, ICSVExporter,
-    academic_sessions_vocab)
+    academic_sessions_vocab, DOCLINK)
 from waeup.kofa.permissions import (
     get_users_with_local_roles, get_all_roles, get_all_users,
@@ -891 +891 @@
     label = _(u'Data Center')
     pnav = 0
+    doclink = DOCLINK + '/datacenter.html'
 
     @jsaction(_('Remove selected'))
@@ -1170 +1171 @@
     pnav = 0
     cancel_button =_(u'Back to Data Center')
+    doclink = DOCLINK + '/datacenter/import_stages.html'
 
     def getFiles(self):
@@ -1201 +1203 @@
     back_button =_(u'Back to step 1')
     proceed_button =_(u'Proceed to step 3')
+    doclink = DOCLINK + '/datacenter/import_stages.html'
 
     filename = None
@@ -1306 +1309 @@
     back_button =_(u'Back to step 2')
     proceed_button =_(u'Perform import')
+    doclink = DOCLINK + '/datacenter/import_stages.html'
 
     filename = None
@@ -1414 +1418 @@
     pnav = 0
     back_button =_(u'Process next')
+    doclink = DOCLINK + '/datacenter/import_stages.html'
 
     filename = None
@@ -1477 +1482 @@
     back_button = _(u'Back to Data Center')
     show_button = _(u'Show')
+    doclink = DOCLINK + '/datacenter/logging.html'
 
     def update(self, back=None):
@@ -1495 +1501 @@
     placeholder = _('Enter a regular expression here...')
 
+    def doclink(self):
+        return DOCLINK + (
+            '/datacenter/logging.html#%s' % self.filename.replace('.', '-'))
+
     def label(self):
         return "Logfile %s" % self.filename
@@ -1570 +1580 @@
     export_button = _(u'Create CSV file')
     cancel_button =_(u'Back to Data Center')
+    doclink = DOCLINK + '/datacenter/export.html'
 
     def getExporters(self):

main/waeup.kofa/trunk/src/waeup/kofa/browser/templates/datacenterlogsshowfilepage.pt

@@ -2 +2 @@
   <input type="text" name="query" class="form-control"
          tal:attributes="value view/query; placeholder view/placeholder" />
+   <br />
   <input class="btn btn-primary" type="submit" name="search"
          tal:attributes="value view/search_button" />
@@ -9 +10 @@
          tal:attributes="value view/filename" />
 </form>
-
+<br />
 <div tal:condition="view/result|nothing">
   <pre tal:content="structure view/result">

main/waeup.kofa/trunk/src/waeup/kofa/browser/templates/staffsitelayout.pt

@@ -89 +89 @@
     <div class="sidebar well">
         <div tal:condition="layout/getStudentName">
-          <div class="kofa-sidebar-title" tal:content="layout/getStudentName">STUDENTNAME</div>
+          <div class="kofa-sidebar-title" tal:content="layout/getStudentName">
+            STUDENTNAME
+          </div>
           <ul class="nav">
             <tal:left content="structure provider:left_studentmanage" />
@@ -95 +97 @@
         </div>
         <div tal:condition="layout/isAuthenticated">
-          <div class="kofa-sidebar-title" tal:content="layout/getUserTitle">USERNAME</div>
+          <div class="kofa-sidebar-title" tal:content="layout/getUserTitle">
+            USERNAME
+          </div>
           <ul class="nav">
             <tal:left content="structure provider:left_manage" />
@@ -132 +136 @@
       </div>
       <br />
-
+      <div class="documentation" tal:condition="view/doclink|nothing">
+        <a href="#" tal:attributes="href view/doclink"
+           i18n:translate="" target="_blank">
+          Kofa Docs for this page
+        </a>
+      </div>
     </div>
     <!-- /Diazo element-->

main/waeup.kofa/trunk/src/waeup/kofa/interfaces.py

@@ -44 +44 @@
 WAEUP_KEY = 'waeup.kofa'
 VIRT_JOBS_CONTAINER_NAME = 'jobs'
+DOCLINK = 'http://kofa-doc.waeup.org/userdocs'
 
 CREATED = 'created'

main/waeup.kofa/trunk/src/waeup/kofa/reports.py

@@ -153 +153 @@
 
 class ReportsOfficer(grok.Role):
-    """The Reports Officer has the permission to to view, add and remove
+    """The Reports Officer has the permission to view, add and remove
     **own** reports.
     """
@@ -161 +161 @@
 
 class ReportsManager(grok.Role):
-    """The Reports Manager has the permission to to view, add and remove
+    """The Reports Manager has the permission to view, add and remove
     **all** reports.
     """

main/waeup.kofa/trunk/src/waeup/kofa/students/browser.py

@@ -45 +45 @@
     IKofaObject, IUserAccount, IExtFileStore, IPasswordValidator, IContactForm,
     IKofaUtils, IUniversity, IObjectHistory, academic_sessions, ICSVExporter,
-    academic_sessions_vocab, IJobManager, IDataCenter)
+    academic_sessions_vocab, IJobManager, IDataCenter, DOCLINK)
 from waeup.kofa.interfaces import MessageFactory as _
 from waeup.kofa.widgets.datewidget import (
@@ -3146 +3146 @@
     pnav = 1
     redirect_target = ''
+    doclink = DOCLINK + '/datacenter/export.html#student-data-exporters'
 
     def _set_session_values(self):