Source code for bibstuff.bibstyles.example_numbered

#File: example_numbered.py
"""
:mod:`bibstuff.bibstyles.example_numbered`
------------------------------------------

Provides an examle of how to easily modify an existing style:
Just import everything from that style, and then override
what you wish to change.  In this case, we import from
default.py, the default style.

This style changes to numbered citation references and citations.
Citation references are numbered like this: (1,2).
Citations are numbered like this:

	1. First Citation Definition
	2. Second Citation Definition

The numbers reflect the order cited (the 'citation_rank').

:copyright: 2006 Alan G Isaac, see AUTHORS
:license: MIT (see LICENSE)

"""
__docformat__ = "restructuredtext en"
__author__  =   "Alan G. Isaac"
__version__ = "0.5"
__needs__ = '2.4'

# import everything from a useful style
from . import default
from . import shared

#####################################################################
############  Override the style choices  ###########################
#####################################################################


######## ADJUST CITATION TEMPLATE FOR NEW STYLE  ###########
######## note: see help for bibstyles.shared.NameFormatter for name details
CITATION_TEMPLATE = default.CITATION_TEMPLATE.copy()
CITATION_TEMPLATE.update(dict(
indent_left=0,
name_first = 'f{. }. |v |l|, j',
name_other = 'f{. }. |v |l|, j',
initials = 'f',
name_name_sep = (', ',' and '),
))

# Redefine the CitationManager class, even if "unchanged".
# (This is necessary if you want to change any of the global formatting functions,
#  and usually you change 'format_inline_cite')
class CitationManager(shared.CitationManager):
	default_citation_template = CITATION_TEMPLATE
	################### CITEREF FORMATTING #########################
	def format_inline_cite(self, cite_key_list):
		entry_list = self.find_entries(cite_key_list,discard=False)
		all_keys = self.citeref_processor.all_citekeys
		return format_inline_cite(entry_list,cite_key_list,all_keys)

	################### CITATION FORMATTING ########################
	def get_citation_label(self, entry, template=None):
		return ("%d."%self.get_citation_rank(entry)).ljust(5)

	def sortkey(self, bibentry):
		return self.get_citation_rank(bibentry)



def format_inline_cite(entries, keys, all_keys) :
	formatted_list = []
	assert(len(entries)==len(keys))
	for i in range(len(entries)):
		if not entries[i]:
			formatted_list.append(keys[i]) #keys appear for missing entries
		else:
			formatted_list.append('%d'%(all_keys.index(keys[i])+1))
	return '(' + ", ".join(formatted_list)+')'