[hyperlink] styles/ multiple runs

HISTORY.rst

@@ -3,6 +3,104 @@
 Release History
 ---------------
 
+0.8.5 (2015-02-21)
+++++++++++++++++++
+
+- Fix #149: KeyError on Document.add_table()
+- Fix #78: feature: add_table() sets cell widths
+- Add #106: feature: Table.direction (i.e. right-to-left)
+- Add #102: feature: add CT_Row.trPr
+
+
+0.8.4 (2015-02-20)
+++++++++++++++++++
+
+- Fix #151: tests won't run on PyPI distribution
+- Fix #124: default to inches on no TIFF resolution unit
+
+
+0.8.3 (2015-02-19)
+++++++++++++++++++
+
+- Add #121, #135, #139: feature: Font.color
+
+
+0.8.2 (2015-02-16)
+++++++++++++++++++
+
+- Fix #94: picture prints at wrong size when scaled
+- Extract `docx.document.Document` object from `DocumentPart`
+
+  Refactor `docx.Document` from an object into a factory function for new
+  `docx.document.Document object`. Extract methods from prior `docx.Document`
+  and `docx.parts.document.DocumentPart` to form the new API class and retire
+  `docx.Document` class.
+
+- Migrate `Document.numbering_part` to `DocumentPart.numbering_part`. The
+  `numbering_part` property is not part of the published API and is an
+  interim internal feature to be replaced in a future release, perhaps with
+  something like `Document.numbering_definitions`. In the meantime, it can
+  now be accessed using ``Document.part.numbering_part``.
+
+
+0.8.1 (2015-02-10)
+++++++++++++++++++
+
+- Fix #140: Warning triggered on Document.add_heading/table()
+
+
+0.8.0 (2015-02-08)
+++++++++++++++++++
+
+- Add styles. Provides general capability to access and manipulate paragraph,
+  character, and table styles.
+
+- Add ParagraphFormat object, accessible on Paragraph.paragraph_format, and
+  providing the following paragraph formatting properties:
+
+  + paragraph alignment (justfification)
+  + space before and after paragraph
+  + line spacing
+  + indentation
+  + keep together, keep with next, page break before, and widow control
+
+- Add Font object, accessible on Run.font, providing character-level
+  formatting including:
+
+  + typeface (e.g. 'Arial')
+  + point size
+  + underline
+  + italic
+  + bold
+  + superscript and subscript
+
+The following issues were retired:
+
+- Add feature #56: superscript/subscript
+- Add feature #67: lookup style by UI name
+- Add feature #98: Paragraph indentation
+- Add feature #120: Document.styles
+
+**Backward incompatibilities**
+
+Paragraph.style now returns a Style object. Previously it returned the style
+name as a string. The name can now be retrieved using the Style.name
+property, for example, `paragraph.style.name`.
+
+
+0.7.6 (2014-12-14)
+++++++++++++++++++
+
+- Add feature #69: Table.alignment
+- Add feature #29: Document.core_properties
+
+
+0.7.5 (2014-11-29)
+++++++++++++++++++
+
+- Add feature #65: _Cell.merge()
+
+
 0.7.4 (2014-07-18)
 ++++++++++++++++++
 

MANIFEST.in

@@ -1,5 +1,5 @@
 include HISTORY.rst LICENSE README.rst tox.ini
-include tests/*.py
+recursive-include tests *.py
 recursive-include features *
 recursive-include docx/templates *
 recursive-include tests/test_files *

docs/api/dml.rst

@@ -0,0 +1,16 @@
+
+.. _dml_api:
+
+DrawingML objects
+=================
+
+Low-level drawing elements like color that appear in various document
+contexts.
+
+
+|ColorFormat| objects
+---------------------
+
+.. autoclass:: docx.dml.color.ColorFormat()
+   :members:
+   :undoc-members:

docs/api/document.rst

@@ -7,24 +7,111 @@ Document objects
 The main Document and related objects.
 
 
-.. currentmodule:: docx.api
+|Document| constructor
+----------------------
+
+.. autofunction:: docx.Document
 
 
 |Document| objects
 ------------------
 
-
-.. autoclass:: Document
+.. autoclass:: docx.document.Document()
    :members:
-   :exclude-members: numbering_part, styles_part
+   :exclude-members: styles_part
 
 
-.. currentmodule:: docx.parts.document
+|CoreProperties| objects
+-------------------------
 
+Each |Document| object provides access to its |CoreProperties| object via its
+:attr:`core_properties` attribute. A |CoreProperties| object provides
+read/write access to the so-called *core properties* for the document. The
+core properties are author, category, comments, content_status, created,
+identifier, keywords, language, last_modified_by, last_printed, modified,
+revision, subject, title, and version.
 
-|Sections| objects
-------------------
+Each property is one of three types, |str|, |datetime|, or |int|. String
+properties are limited in length to 255 characters and return an empty string
+('') if not set. Date properties are assigned and returned as |datetime|
+objects without timezone, i.e. in UTC. Any timezone conversions are the
+responsibility of the client. Date properties return |None| if not set.
 
+|docx| does not automatically set any of the document core properties other
+than to add a core properties part to a presentation that doesn't have one
+(very uncommon). If |docx| adds a core properties part, it contains default
+values for the title, last_modified_by, revision, and modified properties.
+Client code should update properties like revision and last_modified_by
+if that behavior is desired.
 
-.. autoclass:: Sections
-   :members:
+.. currentmodule:: docx.opc.coreprops
+
+.. class:: CoreProperties
+
+   .. attribute:: author
+
+      *string* -- An entity primarily responsible for making the content of the
+      resource.
+
+   .. attribute:: category
+
+      *string* -- A categorization of the content of this package. Example
+      values might include: Resume, Letter, Financial Forecast, Proposal,
+      or Technical Presentation.
+
+   .. attribute:: comments
+
+      *string* -- An account of the content of the resource.
+
+   .. attribute:: content_status
+
+      *string* -- completion status of the document, e.g. 'draft'
+
+   .. attribute:: created
+
+      *datetime* -- time of intial creation of the document
+
+   .. attribute:: identifier
+
+      *string* -- An unambiguous reference to the resource within a given
+      context, e.g. ISBN.
+
+   .. attribute:: keywords
+
+      *string* -- descriptive words or short phrases likely to be used as
+      search terms for this document
+
+   .. attribute:: language
+
+      *string* -- language the document is written in
+
+   .. attribute:: last_modified_by
+
+      *string* -- name or other identifier (such as email address) of person
+      who last modified the document
+
+   .. attribute:: last_printed
+
+      *datetime* -- time the document was last printed
+
+   .. attribute:: modified
+
+      *datetime* -- time the document was last modified
+
+   .. attribute:: revision
+
+      *int* -- number of this revision, incremented by Word each time the
+      document is saved. Note however |docx| does not automatically increment
+      the revision number when it saves a document.
+
+   .. attribute:: subject
+
+      *string* -- The topic of the content of the resource.
+
+   .. attribute:: title
+
+      *string* -- The name given to the resource.
+
+   .. attribute:: version
+
+      *string* -- free-form version string

docs/api/enum/MsoColorType.rst

@@ -0,0 +1,23 @@
+.. _MsoColorType:
+
+``MSO_COLOR_TYPE``
+==================
+
+Specifies the color specification scheme
+
+Example::
+
+    from docx.enum.dml import MSO_COLOR_TYPE
+
+    assert font.color.type == MSO_COLOR_TYPE.THEME
+
+----
+
+RGB
+    Color is specified by an |RGBColor| value.
+
+THEME
+    Color is one of the preset theme colors.
+
+AUTO
+    Color is determined automatically be the application.

docs/api/enum/MsoThemeColorIndex.rst

@@ -0,0 +1,71 @@
+.. _MsoThemeColorIndex:
+
+``MSO_THEME_COLOR_INDEX``
+=========================
+
+Indicates the Office theme color, one of those shown in the color gallery on
+the formatting ribbon.
+
+Alias: ``MSO_THEME_COLOR``
+
+Example::
+
+    from docx.enum.dml import MSO_THEME_COLOR
+
+    font.color.theme_color = MSO_THEME_COLOR.ACCENT_1
+
+----
+
+NOT_THEME_COLOR
+    Indicates the color is not a theme color.
+
+ACCENT_1
+    Specifies the Accent 1 theme color.
+
+ACCENT_2
+    Specifies the Accent 2 theme color.
+
+ACCENT_3
+    Specifies the Accent 3 theme color.
+
+ACCENT_4
+    Specifies the Accent 4 theme color.
+
+ACCENT_5
+    Specifies the Accent 5 theme color.
+
+ACCENT_6
+    Specifies the Accent 6 theme color.
+
+BACKGROUND_1
+    Specifies the Background 1 theme color.
+
+BACKGROUND_2
+    Specifies the Background 2 theme color.
+
+DARK_1
+    Specifies the Dark 1 theme color.
+
+DARK_2
+    Specifies the Dark 2 theme color.
+
+FOLLOWED_HYPERLINK
+    Specifies the theme color for a clicked hyperlink.
+
+HYPERLINK
+    Specifies the theme color for a hyperlink.
+
+LIGHT_1
+    Specifies the Light 1 theme color.
+
+LIGHT_2
+    Specifies the Light 2 theme color.
+
+TEXT_1
+    Specifies the Text 1 theme color.
+
+TEXT_2
+    Specifies the Text 2 theme color.
+
+MIXED
+    Indicates multiple theme colors are used.