Beschrijving
Citrus
Beschrijving
Citrus is a modern WordPress plugin that displays research publications beautifully on your website. Choose between automatic synchronization from the Pure API or manual entry of BibTeX data (paste or upload). Ideal for universities, research institutions, and academic departments.
Key features:
- Flexible Data Sources: Use Pure API automatic sync OR manually provide BibTeX data (paste or upload)
- Automatic synchronization from Pure API (schedule hourly, twice daily, or daily)
- Manual BibTeX entry: Paste content directly or upload .txt files
- Smart caching with WordPress transients to reduce API calls
- Beautiful, responsive publication listings with search and filters
- Multiple integration options: shortcode, Gutenberg block, and REST API
- Optional AI-powered summaries (OpenAI-compatible) with 24-hour caching and rate limiting
- 6 color schemes + custom CSS support
- Accessible, responsive design with dark mode
- Secure options handling and nonce-protected REST endpoints
Requirements
- WordPress 5.8 or higher
- PHP 7.4 or higher
- For Pure API mode: Pure API version 5.24 (legacy versioned Web Service) access credentials (API key and organization ID)
- For Manual Entry mode: BibTeX data from your reference manager (can be pasted or uploaded as .txt file)
- (Optional) OpenAI-compatible API key for AI features
Note: Pure API mode is designed and tested with Pure API version 5.24, the final version of the legacy versioned Web Service. It may not be compatible with the new Pure API.
External Services
This plugin connects to external third-party services to provide its functionality. Below is detailed information about each service:
Pure API
What it is: Pure is a research information management system (RIMS) used by universities and research institutions to manage publication data. This plugin connects to your institution’s Pure API to retrieve publication metadata.
What it’s used for: Fetching and synchronizing research publication data (titles, authors, abstracts, publication years, etc.) from your institution’s Pure system to display on your WordPress site.
What data is sent: Your Pure API key and Organization ID are sent with each request to authenticate and specify which organizational unit’s publications to retrieve. No user data or visitor information is transmitted to Pure.
When data is sent: Data is sent when:
– You test the API connection in the plugin settings
– You manually trigger a sync via the admin dashboard or REST API
– An automatic scheduled sync runs (hourly, twice daily, or daily, based on your settings)
Service provider: Your own institution’s Pure installation (self-hosted or managed by Elsevier)
Privacy and Terms: Please consult your institution’s Pure system administrator for information about data handling, privacy policies, and terms of use specific to your Pure installation.
OpenAI API (Optional)
What it is: OpenAI provides artificial intelligence models that can analyze and summarize text. This plugin optionally uses OpenAI-compatible APIs to generate summaries of research publications.
What it’s used for: Generating AI-powered summaries of selected publications when users click the “Generate AI Summary” button on the frontend.
What data is sent: Publication metadata (titles, abstracts, and years) of the selected publications is sent to the configured AI API endpoint (defaults to https://api.openai.com/v1/chat/completions). For 10 or fewer publications, full abstracts are sent. For more than 10 publications, only titles and years are sent. No visitor information or personal data is transmitted.
When data is sent: Data is only sent when:
– A user explicitly clicks the “Generate AI Summary” button in the frontend
– AI features are enabled in the plugin settings
– The request hasn’t been cached (summaries are cached for 24 hours)
Service provider: OpenAI (default) or any OpenAI-compatible API service you configure
Terms and Privacy:
– OpenAI Terms of Use: https://openai.com/policies/terms-of-use
– OpenAI Privacy Policy: https://openai.com/policies/privacy-policy
– If using an alternative OpenAI-compatible service, please consult that provider’s terms and privacy policy
Note: AI features are completely optional and disabled by default. The plugin works fully without AI integration.
Usage
Shortcode
Place on any page or post:
[citrus_publications]
With filters:
[citrus_publications author=”Smith” year=”2024″ limit=”10″]
Enable AI summary button:
[citrus_publications enable_ai_summary=”true”]
Gutenberg Block
Add the “Pure Publications” block and configure filters in the block settings.
REST API
- Get publications (BibTeX): /wp-json/citrus/v1/publications
- Get publications (JSON): /wp-json/citrus/v1/publications/json
- Trigger sync (POST): /wp-json/citrus/v1/sync (requires authentication)
Schermafbeeldingen
Default Publications Display – Responsive listing with search and filters 
Settings Page – Configure Pure API credentials and sync options 
AI Summary Generation (in progress) 
AI Summary Generation (complete) 
Compact Publications Display
Blokken
Deze plugin heeft 1 blok.
- Pure Publications
Installatie
- Upload the
citrusfolder to the/wp-content/plugins/directory, or install the plugin via the WordPress Plugins screen. - Activate the plugin through the ‘Plugins’ menu in WordPress.
- Go to Citrus in the WordPress admin menu.
- Choose your data source:
- Pure API: Enter your Pure API credentials (API key and Organization ID) for automatic synchronization.
- Manual Entry: Paste your BibTeX data directly or upload a .txt file containing your publications.
- (Optional) Configure AI features and appearance settings.
FAQ
Can I use this plugin without Pure API access?
Yes! As of version 1.2.0, you can manually provide BibTeX data instead of using the Pure API. Simply select “Manual Upload” as your data source in the settings, then either paste your BibTeX content or upload a .txt file.
Do I need Pure API access?
No, Pure API access is optional. You can choose between:
– Pure API mode: Automatic synchronization from your institution’s Pure system (requires API credentials)
– Manual Entry mode: Paste BibTeX data or upload a .txt fileFor Pure API mode, you need credentials from your institution’s Pure system (API key and organization ID). This plugin is designed for Pure API version 5.24 (the final version of the legacy versioned Web Service) and may not be compatible with the new Pure API. Contact your Pure system administrator.
Why can’t I upload .bib files directly?
WordPress restricts certain file types for security reasons, including .bib and .bibtex files. To work around this, you have two easy options:
1. Paste your BibTeX data directly into the text area (recommended)
2. Save your .bib file as .txt and upload that insteadBoth methods work perfectly – the plugin processes the BibTeX content the same way.
How do I get BibTeX data from my reference manager?
Most reference managers can export to BibTeX format:
– Zotero: File Export Library Format: BibTeX
– Mendeley: File Export BibTeX (*.bib)
– EndNote: File Export Output Style: BibTeX ExportAfter exporting, you can either:
1. Open the .bib file in a text editor, copy the content, and paste it into Citrus
2. Rename the .bib file to .txt and upload itWhat BibTeX format should I use for manual upload?
Any standard BibTeX format will work. Your data should contain entries like @article, @inproceedings, @book, etc. The plugin parses standard BibTeX fields including title, author, year, journal, booktitle, publisher, and more.
Can I switch between Pure API and manual entry?
Yes, you can change your data source at any time in the plugin settings. When you switch modes, the plugin will use the appropriate data source for displaying publications.
Are AI features required?
No. AI features are optional. The plugin works perfectly without AI. If enabled, you will need an OpenAI-compatible API key.
Where is data stored?
BibTeX data and cached files are saved to
wp-content/uploads/citrus/, not inside the plugin directory. This keeps data safe during plugin updates and avoids asking users to edit plugin files.Is my data secure?
Yes. API keys are stored securely in WordPress options and never exposed to the frontend. Only publication metadata (titles, abstracts, years) may be sent to the AI provider when summaries are generated.
Does it work with my theme?
Yes. Citrus uses clean, modern CSS that adapts to any theme and supports dark mode.
How can I customize the appearance?
Choose from 6 built-in color schemes or add custom CSS via the settings page. CSS variables are available for easy theming.
Beoordelingen
Er zijn geen beoordelingen voor deze plugin.
Bijdragers & ontwikkelaars
“Citrus” is open source software. De volgende personen hebben bijgedragen aan deze plugin.
Bijdragers
Vertaal “Citrus” in je eigen taal.
Interesse in ontwikkeling?
Bekijk de code, haal de SVN repository op, of abonneer je op het ontwikkellog via RSS.
Changelog
1.2.0
- New Feature: Manual BibTeX data entry (paste or upload)
- Added textarea for pasting BibTeX content directly
- Support for uploading .txt files containing BibTeX data
- Added data source selection: Pure API or Manual Entry
- Enhanced flexibility for users without Pure API access
- Improved admin interface with better user guidance
- Updated documentation for both data source modes
1.1.2
- Added comprehensive external services documentation for Pure API and OpenAI API
- Clarified REST API endpoint permissions with inline comments
- Migrated publications endpoint to WordPress-powered routes for improved security
- WordPress directory compliance improvements
1.1.1
- Maintenance release and documentation updates
- Minor adjustments and polish to align with directory guidelines
1.1.0
- AI Features – OpenAI-compatible API integration for publication summaries
- Appearance Settings – 6 color schemes with custom CSS support
- Enhanced Security – Rate limiting and improved API key handling
- Performance Improvements – 24-hour AI summary caching
- Better UX – Improved admin interface with visual dashboard
