New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Descriptive attributes for \fig ...\fig* #27

Closed
klassenjm opened this Issue Jul 8, 2016 · 0 comments

Comments

Projects
None yet
1 participant
@klassenjm
Contributor

klassenjm commented Jul 8, 2016

Proposal

Update the specification for figure (\fig ...\fig*) to follow the syntax for assigning word-level descriptive attributes (USFM 3.0 #24)

  • Use of vertical bar as multiple attribute separator is deprecated.
  • Since multiple attributes are required, there is no single, un-named default.
  • Backward compatible use of un-named attributes in \fig …\fig* would be strictly interpreted according to the USFM 2.x order.

Attributes

  • alt - short, free-form description of image
  • *src - filename
  • *size - relative size
  • loc - location / range
  • copy - rights holder / copyright information
  • *ref - scripture reference

* = required

USFM 2.x (note empty optional parameters)

\fig |avnt016.jpg|span|||At once they left their nets.|1.18\fig*

USFM 3.0 (as above with required attributes named)

\fig At once they left their nets.|src="avnt016.jpg" size="span" ref="1.18"\fig*

The illustration caption is expressed as the marked content. This structure is best aligned with the existing USX 2.5 expression which encodes the caption as element content.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment