addBibliography

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

removeSection

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

stream

ENCRYPT

encryptPDF

addBibliography

ADVANCED / PREMIUM

BASIC

Inserts a bibliography into the Word document.

Description

public void addBibliography() throws Exception

public void addBibliography(OptionsBibliography options) throws Exception

public void addBibliography(OptionsBibliography options, WordFragment legend) throws Exception

This method allows you to include a bibliography in you Word document.

New contents to be displayed in a bibliography can be added using addSource and addCitation methods.

Parameters

options

Option	Type	Description
autoUpdate	Boolean	If true it will try to update the bibliography when first opened.

legend

Key	Type	Description
legend	WordFragment	The placeholder text that will be shown if the autoupdate option is not activated.

Code samples

Example #1

package examples.LayoutAndGeneral.addCitation;

import com.javadocx.CreateDocx;

public class Sample1 {
    public static void main(String[] args) throws Exception {
        CreateDocx docx = new CreateDocx();

		HashMap<String, String> authorInfo1 = new HashMap<String, String>();
		authorInfo1.put("Last", "Doe");
		authorInfo1.put("First", "John");
		HashMap<String, String> authorInfo2 = new HashMap<String, String>();
		authorInfo2.put("Last", "Doe");
		authorInfo2.put("First", "Jane");
		ArrayList<HashMap<String, String>> authorList = new ArrayList<HashMap<String, String>>();
		authorList.add(authorInfo1);
		authorList.add(authorInfo2);

		HashMap<String, ArrayList<HashMap<String, String>>> author = new HashMap<String, ArrayList<HashMap<String, String>>>();
		author.put("Author", authorList);

		HashMap<String, String> info = new HashMap<String, String>();
		info.put("Title", "My book");
		info.put("Year", "2021");
		info.put("City", "My city");
		info.put("Publisher", "My publisher");

		docx.addSource("JDoe", "Report", author, info);

		authorInfo1 = new HashMap<String, String>();
		authorInfo1.put("Last", "Eod");
		authorInfo1.put("First", "John");
		authorList = new ArrayList<HashMap<String, String>>();
		authorList.add(authorInfo1);

		author = new HashMap<String, ArrayList<HashMap<String, String>>>();
		author.put("Author", authorList);

		info = new HashMap<String, String>();
		info.put("Title", "My book 2");
		info.put("Year", "2022");
		info.put("City", "My city 2");
		info.put("Publisher", "My publisher 2");

		docx.addSource("JEod", "Book", author, info);

		docx.addCitation("JDoe");

		docx.addText("Lorem ipsum dolor sit amet, consectetur adipisicing elit.");

		ArrayList<String> fields = new ArrayList<String>();
		fields.add("Author");
		fields.add("City");
		fields.add("Title");

		OptionsText stylesCitation = new OptionsText();
		stylesCitation.setBold(true);
		stylesCitation.setFontSize(18);

		docx.addCitation("JEod", fields, stylesCitation);

		fields = new ArrayList<String>();
		fields.add("Author");
		fields.add("City");

		stylesCitation = new OptionsText();
		stylesCitation.setBold(true);

		OptionsText textOptionsA = new OptionsText();
		textOptionsA.setText("Citation added as WordFragment: ");
		WordFragment textFragmentA = new WordFragment(docx);
		textFragmentA.addText(textOptionsA);

		WordFragment citationFragment = new WordFragment(docx);
		citationFragment.addCitation("JEod", fields, stylesCitation);

		OptionsText textOptionsB = new OptionsText();
		textOptionsB.setText(".");
		WordFragment textFragmentB = new WordFragment(docx);
		textFragmentB.addText(textOptionsB);

		ArrayList<WordFragment> runs = new ArrayList<WordFragment>();
		runs.add(textFragmentA);
		runs.add(citationFragment);
		runs.add(textFragmentB);

		docx.addText(runs);

		OptionsBibliography bibliographyOptions = new OptionsBibliography();
		bibliographyOptions.setAutoUpdate(true);


		OptionsText textOptions = new OptionsText();
		textOptions.setText("Document bibliography")
				   .setColor("B70000")
				   .setBold(true)
				   .setFontSize(12);
		WordFragment bibliographyLegend = new WordFragment(docx);
		bibliographyLegend.addText(textOptions);


		docx.addBibliography(bibliographyOptions, bibliographyLegend);

		docx.createDocx("example_addBibliography_1");
    }
}