未知
项目描述
此存储库已废弃！
此存储库不再维护，Crocodoc被Box.net收购，并且此产品也从未容易使用。
djcroco
djcroco是一个自定义Django模型字段，用于添加对Crocodoc API的支持。
它像标准的FileField一样工作，所以您仍然可以使用其大多数属性（例如 name、size、url 等），同时还有额外的属性可以与Crocodoc API一起使用。
需求
Python 2.6.x, 2.7.x
Django 1.3.x, 1.4.x, 1.5.x
crocodoc 0.1.1
Python 3.x将很快支持！
安装
要安装djcroco，只需运行
pip install djcroco
包含在urls.py中
url(r'', include('djcroco.urls')),
在settings.py中定义Crocodoc API令牌
CROCO_API_TOKEN = '<api_token>'
或者作为环境变量
export CROCO_API_TOKEN='<api_token>'
当使用URL的可选参数时（下面有更多细节） - 然后您需要将djcroco添加到INSTALLED_APPS
INSTALLED_APPS += ('djcroco',)
并在您要使用它们的模板中加载其模板标签
{% load croco_tags %}
用法
在您希望扩展的模型中定义字段
from django.db import models
from djcroco.fields import CrocoField
class Example(models.Model):
name = models.CharField(max_length=255)
document = CrocoField()
def __unicode__(self):
return self.name自定义缩略图大小
您可以这样传递thumbnail_size
document = CrocoField(thumbnail_size=(150, 150))其中元组表示为(width, height)。
如果您不传递自定义缩略图大小，则将使用默认值（100x100）。缩略图的最大尺寸为300x300。
缩略图缓存
默认情况下，缩略图将在模板渲染时生成，这涉及到为每个缩略图调用 Crocodoc API。如果单页上有许多项目，这可能会很耗时。为了避免上述问题，您可以指定一个字段，其中缩略图将被保存并从该字段中提供下一次。
class Example(models.Model):
name = models.CharField(max_length=255)
document = CrocoField(thumbnail_field='my_thumbnail')
my_thumbnail = models.ImageField(upload_to='whatever/')请注意，thumbnail_field 必须是 ImageField 类型。
展示神奇之处
文档
{{ obj.document.name }}
返回文档的名称。
{{ obj.document.size }}
返回文档的大小（以字节为单位）。
{{ obj.document.size_human }}
返回文档的易读大小（例如，1.3 MB）。
{{ obj.document.type }}
返回文档的类型（扩展名）。
{{ obj.document.uuid }}
返回文档的 UUID（注意：每个 Crocodoc 文档都有一个唯一的 id）。
缩略图
{{ obj.document.thumbnail }}
返回内联图像的缩略图（有关更多详细信息，请参阅 Data URI 方案）。有关如何下载缩略图，请参阅下文。
URL
{{ obj.document.url }}
返回文档的 URL，可以直接查看。
{{ obj.document.content_url }}
返回包裹在 HttpResponse 对象中的文档 URL。
您可以使用 可选参数 扩展 url 和 content_url。
{{ obj.document.url|editable:"true"|user_id:"1"|user_name:"admin" }}
editable 参数允许用户在查看文档时创建注释和评论。 默认值：false
user_id 和 user_name 将在查看器中显示，以便将注释和评论归因于其作者。 如果 editable 为 true，则必需
{{ obj.document.url|user_filter:"1,2,3" }}
限制显示哪些用户的注释和评论。可能的值是： all、none 或以逗号分隔的用户 ID 列表。 默认值：all
注意： user_filter 是为了在 Django 模板系统中工作而对 Crocodoc 的 filter 进行重命名的版本。
支持的 参数 的完整列表。
下载
{{ obj.document.download_document }}
以 PDF 格式返回原始文档。
{{ obj.document.download_document|annotated:"true" }}
以带注释的原始文档返回。 默认值：false
{{ obj.document.download_document|user_filter:"1,2,3" }}
返回带注释的原始文档，注释限于给定的用户。可能的值是： all、none 或以逗号分隔的用户 ID 列表。 默认值：all
{{ obj.document.download_thumbnail }}
以 PNG 格式返回文档第一页的缩略图。
{{ obj.document.download_thumbnail|size:"99x99" }}
与 download_thumbnail 相同，但以 {width}x{height} 格式自定义缩略图的尺寸。允许的最大尺寸为 300x300。 默认值：100x100
{{ obj.document.download_text }}
从文档中返回全文。注意：此方法仅在您的 Crocodoc 帐户已启用文本提取时可用。
django-croco-1.0.0.tar.gz 的散列
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 029d45ef232fb2d2055384393155ad1bbd82e993f7e64345a78483e3b8d1903b |
|
| MD5 | 6986c93488ec244af6e7f21477e75959 |
|
| BLAKE2b-256 | 1e3e2a267d0f93afe406785e5bae8be2871a6fb41d6c545d51d0769a415c16d8 |