Updated new documentation for readthedocs
This commit is contained in:
Alexander Meindl
parent
c7c498eb5e
commit
23bb99dea4
101
README.md
101
README.md
@ -46,105 +46,14 @@ Download the sources and put them to your vendor/plugins folder.
|
||||
|
||||
Restart Redmine and have a fun!
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
### User macro
|
||||
|
||||
* {{user(1)}} := links to user profile
|
||||
* {{user(1, avatar=true)}} := links to user profile with avatar
|
||||
* {{user(admin)}} := links to user profile
|
||||
* {{user(admin, format=system)}} := links to user profile with user format from system settings
|
||||
* {{user(admin, format=username)}} := links to user profile with username as link text
|
||||
* {{user(admin, format=firstname)}} := links to user profile with firstname as link text
|
||||
* {{user(admin, format=lastname)}} := links to user profile with lastname as link text
|
||||
* {{user(admin, format=lastname, avatar=true)}} := links to user profile with lastname as link text and avatar
|
||||
|
||||
You can use format with the same options as for system settings.
|
||||
|
||||
### Members macros
|
||||
|
||||
* project members
|
||||
|
||||
#### Description
|
||||
|
||||
* {{members}} := lists all members of the current users project
|
||||
* {{members(123)}} or {{members(identifier)}} or {{members(My project)}} := Lists all members of the project with project id 123 (or identifier or project name)
|
||||
* {{members(123, title=Manager)}} := Lists all members of the project with project id 123 and the role "Manager". If you want to use multiple roles as filters, you have to use a | as separator.
|
||||
* {{members(123, title=Manager, role=Manager only)}} := Lists all members of the project with project id 123 and the role "Manager" and adds the heading "Manager only"
|
||||
|
||||
|
||||
### Project macros
|
||||
|
||||
Lists projects of current user
|
||||
|
||||
#### Description
|
||||
|
||||
* {{projects}} := lists all projects of current users
|
||||
* {{projects(title=My title)}} := lists all projects of current users and adds the heading "My title"
|
||||
|
||||
### Calendar macro
|
||||
|
||||
* {{calendar}} := show calendar for current date
|
||||
* {{calendar(year=2014,month=6)}} := show calendar for Juni in year 2014
|
||||
* {{calendar(show_weeks=true)}} := show calendar with week numbers
|
||||
* {{calendar(select=2015-07-12 2015-07-31, show_weeks=true)}} := preselect dates and show week numbers
|
||||
* {{calendar(select=2016-03-13:2016-03-27)}} := preselect dates between 2016/3/13 and 2016/3/27
|
||||
|
||||
|
||||
### Wiki date macros
|
||||
|
||||
Macro to get current date, year, month, day
|
||||
|
||||
#### Description
|
||||
|
||||
* {{current_year}} := current year
|
||||
* {{current_month}} := current month
|
||||
* {{current_day}} := current day
|
||||
* {{current_hour}} := current hour
|
||||
* {{current_min}} := current minute
|
||||
* {{current_weekday}} := current weekday
|
||||
* {{current_weeknumber}} := current week number (The week starts with Monday)
|
||||
|
||||
### Garfield macro
|
||||
|
||||
* {{garfield}} := show Garfield strip of the current day
|
||||
* {{garfield(2014-10-31)}} := show Garfield strip of 31/12/2014
|
||||
|
||||
### Gist macro
|
||||
|
||||
* {{gist(6737338)}} := Show Github gist 6737338
|
||||
* {{gist(plentz/6737338)}} := Show Github gist 6737338
|
||||
|
||||
### Recently updated wiki pages
|
||||
|
||||
{{recently_updated}} macro displays the list of the pages that were changed within last 5 days. If you specify the argument like {{recently_updated(10)}}, it displays the pages that were changed within 10 days.
|
||||
|
||||
### Last updated by
|
||||
{{last_updated_by}} macro displays the name of user who updated the wiki page.
|
||||
|
||||
### Last updated at
|
||||
{{last_updated_at}} macro displays the timestamp when the wiki page was updated.
|
||||
|
||||
### Twitter macro
|
||||
|
||||
{{twitter('alphanodes')}} := links the twitter profile alphanodes
|
||||
|
||||
### Youtube macro
|
||||
|
||||
* {{youtube(wvsboPUjrGc)}} := youtube video with video wvsboPUjrGc (iframe) and default size 640x360
|
||||
* {{youtube(wvsboPUjrGc, width=853, height=480)}} := youtube video with size 853x480
|
||||
* {{youtube(wvsboPUjrGc, autoplay=1)}} := youtube video and autoplay
|
||||
|
||||
### Vimeo macro
|
||||
|
||||
* {{vimeo(142849533)}} := vimeo video with video 142849533 (iframe) and default size 640x360
|
||||
* {{vimeo(142849533, width=853, height=480)}} := vimeo video with size 853x480
|
||||
* {{vimeo(142849533, autoplay=1)}} := vimeo video and autoplay
|
||||
|
||||
### Custom help URL
|
||||
|
||||
### Description
|
||||
|
||||
Change help url in top menu to custom url.
|
||||
Note: Redmine must be restarted after changing "Custom Help URL"</tt> value before the new url is used.
|
||||
|
||||
|
||||
### Documentation
|
||||
|
||||
Documentation is available at https://redmine-tweaks.readthedocs.org.
|
||||
|
||||
1
docs/changelog.rst
Normal file
1
docs/changelog.rst
Normal file
@ -0,0 +1 @@
|
||||
.. include:: ../CHANGELOG.rst
|
||||
49
docs/conf.py
49
docs/conf.py
@ -1,34 +1,13 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# redmine_tweaks documentation build configuration file, created by
|
||||
# sphinx-quickstart on Sat Apr 23 16:31:21 2016.
|
||||
#
|
||||
# This file is execfile()d with the current directory set to its
|
||||
# containing dir.
|
||||
#
|
||||
# Note that not all possible configuration values are present in this
|
||||
# autogenerated file.
|
||||
#
|
||||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
import sys
|
||||
import os
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
#needs_sphinx = '1.0'
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = []
|
||||
extensions = ['sphinx.ext.autodoc']
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
@ -38,15 +17,12 @@ templates_path = ['_templates']
|
||||
# source_suffix = ['.rst', '.md']
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The encoding of source files.
|
||||
#source_encoding = 'utf-8-sig'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'redmine_tweaks'
|
||||
copyright = u'2016, Alexander Meindl'
|
||||
copyright = u'2013-2016, AlphaNodes GmbH'
|
||||
author = u'Alexander Meindl'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
@ -76,21 +52,6 @@ language = None
|
||||
# This patterns also effect to html_static_path and html_extra_path
|
||||
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all
|
||||
# documents.
|
||||
#default_role = None
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||
#add_function_parentheses = True
|
||||
|
||||
# If true, the current module name will be prepended to all description
|
||||
# unit titles (such as .. function::).
|
||||
#add_module_names = True
|
||||
|
||||
# If true, sectionauthor and moduleauthor directives will be shown in the
|
||||
# output. They are ignored by default.
|
||||
#show_authors = False
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
|
||||
@ -108,7 +69,7 @@ todo_include_todos = False
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
html_theme = 'alabaster'
|
||||
html_theme = 'default'
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
@ -170,10 +131,10 @@ html_static_path = ['_static']
|
||||
#html_split_index = False
|
||||
|
||||
# If true, links to the reST sources are added to the pages.
|
||||
#html_show_sourcelink = True
|
||||
html_show_sourcelink = False
|
||||
|
||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||
#html_show_sphinx = True
|
||||
html_show_sphinx = False
|
||||
|
||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||
#html_show_copyright = True
|
||||
|
||||
28
docs/features.rst
Normal file
28
docs/features.rst
Normal file
@ -0,0 +1,28 @@
|
||||
redmine_tweaks features
|
||||
-----------------------
|
||||
|
||||
* use "Project guide" on project overview page
|
||||
* global header for all projects
|
||||
* global footer for all projects
|
||||
* welcome text for login page
|
||||
* global sidebar content support
|
||||
* set info message above new ticket (e.g. for guidelines)
|
||||
* Wiki user macros
|
||||
* Wiki member macros
|
||||
* Wiki project macros
|
||||
* Wiki date macros
|
||||
* Wiki Garfield marco
|
||||
* Wiki Gist marco
|
||||
* Wiki Youtube marco
|
||||
* Wiki Vimeo marco
|
||||
* option to remove "my page" from top menu
|
||||
* customize "Help" url in top menu
|
||||
* customize top menu items
|
||||
* disable (hide) modules for projects
|
||||
* open external urls in new window
|
||||
* anonymize referrer for external urls
|
||||
* Hide role in project memberbox
|
||||
* Configurable issue rules
|
||||
** closing issue with open sub issues
|
||||
** change assigned_to_ automatically, if issue status changes
|
||||
** assigned_to has changed, but status change is required, too
|
||||
@ -3,10 +3,14 @@
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to redmine_tweaks's documentation!
|
||||
==========================================
|
||||
Welcome to Redmine Tweaks Plugin
|
||||
================================
|
||||
|
||||
Contents:
|
||||
.. image:: https://gemnasium.com/alexandermeindl/redmine_tweaks.svg
|
||||
:target: https://gemnasium.com/alexandermeindl/redmine_tweaks
|
||||
|
||||
.. image:: https://drone.io/github.com/alexandermeindl/redmine_tweaks/status.png
|
||||
:target: https://drone.io/github.com/alexandermeindl/redmine_tweaks/latest
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
@ -25,16 +29,23 @@ Installation
|
||||
|
||||
Install redmine_tweaks
|
||||
|
||||
Check the requirements!
|
||||
|
||||
Download the sources and put them to your plugins folder.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ cd $REDMINE_ROOT
|
||||
$ cd $REDMINE_ROOT
|
||||
$ git clone git://github.com/alexandermeindl/redmine_tweaks.git plugins/redmine_tweaks
|
||||
$ bundle install --without development test
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
Table of contents
|
||||
-----------------
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
features
|
||||
macros
|
||||
changelog
|
||||
|
||||
116
docs/macros.rst
Normal file
116
docs/macros.rst
Normal file
@ -0,0 +1,116 @@
|
||||
User macro
|
||||
----------
|
||||
|
||||
* {{user(1)}} := links to user profile
|
||||
* {{user(1, avatar=true)}} := links to user profile with avatar
|
||||
* {{user(admin)}} := links to user profile
|
||||
* {{user(admin, format=system)}} := links to user profile with user format from system settings
|
||||
* {{user(admin, format=username)}} := links to user profile with username as link text
|
||||
* {{user(admin, format=firstname)}} := links to user profile with firstname as link text
|
||||
* {{user(admin, format=lastname)}} := links to user profile with lastname as link text
|
||||
* {{user(admin, format=lastname, avatar=true)}} := links to user profile with lastname as link text and avatar
|
||||
|
||||
You can use format with the same options as for system settings.
|
||||
|
||||
Members macros
|
||||
--------------
|
||||
|
||||
* project members
|
||||
|
||||
#### Description
|
||||
|
||||
* {{members}} := lists all members of the current users project
|
||||
* {{members(123)}} or {{members(identifier)}} or {{members(My project)}} := Lists all members of the project with project id 123 (or identifier or project name)
|
||||
* {{members(123, title=Manager)}} := Lists all members of the project with project id 123 and the role "Manager". If you want to use multiple roles as filters, you have to use a | as separator.
|
||||
* {{members(123, title=Manager, role=Manager only)}} := Lists all members of the project with project id 123 and the role "Manager" and adds the heading "Manager only"
|
||||
|
||||
|
||||
Project macros
|
||||
--------------
|
||||
|
||||
Lists projects of current user
|
||||
|
||||
#### Description
|
||||
|
||||
* {{projects}} := lists all projects of current users
|
||||
* {{projects(title=My title)}} := lists all projects of current users and adds the heading "My title"
|
||||
|
||||
|
||||
Calendar macro
|
||||
--------------
|
||||
|
||||
* {{calendar}} := show calendar for current date
|
||||
* {{calendar(year=2014,month=6)}} := show calendar for Juni in year 2014
|
||||
* {{calendar(show_weeks=true)}} := show calendar with week numbers
|
||||
* {{calendar(select=2015-07-12 2015-07-31, show_weeks=true)}} := preselect dates and show week numbers
|
||||
* {{calendar(select=2016-03-13:2016-03-27)}} := preselect dates between 2016/3/13 and 2016/3/27
|
||||
|
||||
|
||||
Wiki date macros
|
||||
----------------
|
||||
|
||||
Macro to get current date, year, month, day
|
||||
|
||||
#### Description
|
||||
|
||||
* {{current_year}} := current year
|
||||
* {{current_month}} := current month
|
||||
* {{current_day}} := current day
|
||||
* {{current_hour}} := current hour
|
||||
* {{current_min}} := current minute
|
||||
* {{current_weekday}} := current weekday
|
||||
* {{current_weeknumber}} := current week number (The week starts with Monday)
|
||||
|
||||
|
||||
Garfield macro
|
||||
--------------
|
||||
|
||||
* {{garfield}} := show Garfield strip of the current day
|
||||
* {{garfield(2014-10-31)}} := show Garfield strip of 31/12/2014
|
||||
|
||||
|
||||
Gist macro
|
||||
----------
|
||||
|
||||
* {{gist(6737338)}} := Show Github gist 6737338
|
||||
* {{gist(plentz/6737338)}} := Show Github gist 6737338
|
||||
|
||||
|
||||
Recently updated wiki pages
|
||||
---------------------------
|
||||
|
||||
{{recently_updated}} macro displays the list of the pages that were changed within last 5 days. If you specify the argument like {{recently_updated(10)}}, it displays the pages that were changed within 10 days.
|
||||
|
||||
|
||||
Last updated by
|
||||
---------------
|
||||
|
||||
{{last_updated_by}} macro displays the name of user who updated the wiki page.
|
||||
|
||||
|
||||
Last updated at
|
||||
---------------
|
||||
|
||||
{{last_updated_at}} macro displays the timestamp when the wiki page was updated.
|
||||
|
||||
|
||||
Twitter macro
|
||||
-------------
|
||||
|
||||
{{twitter('alphanodes')}} := links the twitter profile alphanodes
|
||||
|
||||
|
||||
Vimeo macro
|
||||
-----------
|
||||
|
||||
* {{vimeo(142849533)}} := vimeo video with video 142849533 (iframe) and default size 640x360
|
||||
* {{vimeo(142849533, width=853, height=480)}} := vimeo video with size 853x480
|
||||
* {{vimeo(142849533, autoplay=1)}} := vimeo video and autoplay
|
||||
|
||||
|
||||
Youtube macro
|
||||
-------------
|
||||
|
||||
* {{youtube(wvsboPUjrGc)}} := youtube video with video wvsboPUjrGc (iframe) and default size 640x360
|
||||
* {{youtube(wvsboPUjrGc, width=853, height=480)}} := youtube video with size 853x480
|
||||
* {{youtube(wvsboPUjrGc, autoplay=1)}} := youtube video and autoplay
|
||||
Loading…
Reference in New Issue
Block a user