matthias/mayan-edms
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #117 from EmlynC/generic_help_template

Browse Source 
Generic help template
This commit is contained in:
Roberto Rosario
2014-11-07 12:42:34 -04:00
parent 0ef7194cb5 3406f424ef
commit 0aa97bdc18
10 changed files with 162 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
mayan/apps/common/templates/generic_help.html Normal file
View File

@@ -0,0 +1,6 @@
{% load i18n %}
<div class="block notice">
<h4>{% block help_title %}{% endblock %}</h4>
<div>{% block help_text %}{% endblock %}</div>
</div>

19
mayan/apps/converter/templates/converter_file_formats_help.html
View File

@@ -1,5 +1,16 @@
{% extends 'generic_help.html' %}
{% load i18n %}
<div class="block notice">
<h4>{% trans "Help" %}</h4>
<p>{% blocktrans %}These are the file formats supported by the currently selected converter backend. In this case: '{{ backend }}'{% endblocktrans %}</p>
</div>
{% block help_title %}
{% trans "Help" %}
{% endblock %}
{% block help_text %}
<p>
{% blocktrans %}
These are the file formats supported by the currently selected
converter backend. In this case: '{{ backend }}'
{% endblocktrans %}
</p>
{% endblock %}

18
mayan/apps/document_indexing/templates/indexing_help.html
View File

@@ -1,5 +1,15 @@
{% extends 'generic_help.html' %}
{% load i18n %}
<div class="block notice">
<h4>{% trans "What are indexes?" %}</h4>
<p>{% blocktrans %}Indexes group documents into a tree like hierarchical structure.{% endblocktrans %}</p>
</div>
{% block help_title %}
{% trans "What are indexes?" %}
{% endblock %}
{% block help_text %}
<p>
{% blocktrans %}
Indexes group documents into a tree like hierarchical structure.
{% endblocktrans %}
</p>
{% endblock %}

22
mayan/apps/documents/templates/document_types_help.html
View File

@@ -1,5 +1,19 @@
{% extends 'generic_help.html' %}
{% load i18n %}
<div class="block notice">
<h4>{% trans "What are document types?" %}</h4>
<p>{% blocktrans %}Document types define a class that represents a broard group of documents, such as: invoices, regulations or manuals. The advantage of using document types are: assigning a list of typical filenames for quick renaming during creation, as well as assigning default metadata types and sets to it.{% endblocktrans %}</p>
</div>
{% block help_title %}
{% trans "What are document types?" %}
{% endblock %}
{% block help_text %}
<p>
{% blocktrans %}
Document types define a class that represents a broard group of documents,
such as: invoices, regulations or manuals. The advantage of using
document types are: assigning a list of typical filenames for quick
renaming during creation, as well as assigning default metadata types
and sets to it.
{% endblocktrans %}
</p>
{% endblock %}

19
mayan/apps/documents/templates/recent_document_list_help.html
View File

@@ -1,5 +1,16 @@
{% extends 'generic_help.html' %}
{% load i18n %}
<div class="block notice">
<h4>{% trans "What are recent documents?" %}</h4>
<p>{% blocktrans %}Here you will find the latest {{ recent_count }} documents you have either created or edited in any way.{% endblocktrans %}</p>
</div>
{% block help_title %}
{% trans "What are recent documents?" %}
{% endblock %}
{% block help_text %}
<p>
{% blocktrans %}
Here you will find the latest {{ recent_count }} documents you have either
created or edited in any way.
{% endblocktrans %}
</p>
{% endblock %}

19
mayan/apps/dynamic_search/templates/search_help.html
View File

@@ -1,5 +1,16 @@
{% extends 'generic_help.html' %}
{% load i18n %}
<div class="block notice">
<h4>{% trans "Help" %}</h4>
<p>{% blocktrans %}Enter the desired search keywords separated by space. Only the top {{ search_results_limit }} results will be available.{% endblocktrans %}</p>
</div>
{% block help_title %}
{% trans "Help" %}
{% endblock %}
{% block help_text %}
<p>
{% blocktrans %}
Enter the desired search keywords separated by space. Only the top
{{ search_results_limit }} results will be available.
{% endblocktrans %}
</p>
{% endblock %}

21
mayan/apps/folders/templates/folders_help.html
View File

@@ -1,5 +1,18 @@
{% extends 'generic_help.html' %}
{% load i18n %}
<div class="block notice">
<h4>{% trans "What are folders?" %}</h4>
<p>{% blocktrans %}These folders can also be described as user folders. They are a way to let individual users create their own document organization methods. Folders created by one user and the documents contained by them don't affect any other user folders or documents.{% endblocktrans %}</p>
</div>
{% block help_title %}
{% trans "What are folders?" %}
{% endblock %}
{% block help_text %}
<p>
{% blocktrans %}
These folders can also be described as user folders. They are a way to
let individual users create their own document organization methods.
Folders created by one user and the documents contained by them don't
affect any other user folders or documents.
{% endblocktrans %}
</p>
{% endblock %}

22
mayan/apps/linking/templates/smart_links_help.html
View File

@@ -1,5 +1,19 @@
{% extends 'generic_help.html' %}
{% load i18n %}
<div class="block notice">
<h4>{% trans "What are smart links?" %}</h4>
<p>{% blocktrans %}Smart links are a set of conditional statements that are used to query the database using the current document the user is accessing as the data source, the results of these queries are a list of documents that relate in some manner to the document being displayed and allow users the ability to jump to and from linked documents very easily.{% endblocktrans %}</p>
</div>
{% block help_title %}
{% trans "What are smart links?" %}
{% endblock %}
{% block help_text %}
<p>
{% blocktrans %}
Smart links are a set of conditional statements that are used to query the
database using the current document the user is accessing as the data
source, the results of these queries are a list of documents that relate in
some manner to the document being displayed and allow users the ability to
jump to and from linked documents very easily.
{% endblocktrans %}
</p>
{% endblock %}

20
mayan/apps/metadata/templates/metadata_set_help.html
View File

@@ -1,5 +1,17 @@
{% extends 'generic_help.html' %}
{% load i18n %}
<div class="block notice">
<h4>{% trans "What are metadata sets?" %}</h4>
<p>{% blocktrans %}A metadata set is a group of one or more metadata types. Metadata sets are useful when creating new documents; selecing a metadata set automatically attaches it's member metadata types to said document.{% endblocktrans %}</p>
</div>
{% block help_title %}
{% trans "What are metadata sets?" %}
{% endblock %}
{% block help_text %}
<p>
{% blocktrans %}
A metadata set is a group of one or more metadata types. Metadata sets
are useful when creating new documents; selecing a metadata set
automatically attaches it's member metadata types to said document.
{% endblocktrans %}
</p>
{% endblock %}

32
mayan/apps/metadata/templates/metadata_type_help.html
View File

@@ -1,5 +1,29 @@
{% extends 'generic_help.html' %}
{% load i18n %}
<div class="block notice">
<h4>{% trans "What are metadata types?" %}</h4>
<p>{% blocktrans %}A metadata type defines the characteristics of a value of some kind that can be attached to a document. Examples of metadata types are: a client name, a date, or a project to which several documents belong. A metadata type's name is the internal identifier with which it can be referenced to by other modules such as the indexing module, the title is the value that is shown to the users, the default value is the value an instance of this metadata type will have initially, and the lookup value turns an instance of a metadata of this type into a choice list which options are the result of the lookup's code execution.{% endblocktrans %}</p>
</div>
{% block help_title %}
{% trans "What are metadata types?" %}
{% endblock %}
{% block help_text %}
<p>
{% blocktrans %}
A metadata type defines the characteristics of a
value of some kind that can be attached to a document. Examples of metadata
types are: a client name, a date, or a project to which several documents
belong.
{% endblocktrans %}
</p>
<p>
{% blocktrans %}
A metadata type's name is the internal identifier with which it can
be referenced to by other modules such as the indexing module, the title is
the value that is shown to the users, the default value is the value an
instance of this metadata type will have initially, and the lookup value
turns an instance of a metadata of this type into a choice list which
options are the result of the lookup's code execution.
{% endblocktrans %}
</p>
{% endblock %}