Documentation

Version 2.0.0b2: - New: "Public Export" setting - the published documents everyone can view can be downloaded as JSON from /documentation/export_json (add ?since= for only the documents changed since then) - used by the jrSidekick module to keep its documentation up to date - Bug Fix: Export Documentation no longer adds backslashes to the Markdown of documents imported from the repository - re-importing an export showed literal ** and * characters - Developer: New jrDocs_doc_is_public(), jrDocs_get_public_export(), jrDocs_markdown_get_profile_documents() and jrDocs_markdown_document_body() functions - Export Documentation uses the last two (its output is unchanged) Version 2.0.0b1: - New: Documents can be kept as Markdown files in a repository (part 1 of the repository sync): documents imported from the repository are locked on the site - edit, section, delete and re-order changes are refused and the edit button opens the file in the repository web editor; master admins can detach a document - New: Repository Sync settings section: repository profile ID, repository URL and branch (repository sync is off by default) - New: Document status: draft and review documents are only shown to admins and profile owners, outdated and archived documents show a banner, and archived documents are left out of the table of contents, chapter lists and related document links - New: Documents with "applies to" or "last verified" information show it under the title - New: Export Documentation tool: downloads the documents of a profile as Markdown files in a ZIP file - one file per document with its images and downloadable files, a _chapter.md per chapter and a README.md that describes the format - to start a documentation repository - New: Import Documentation tool: creates, updates and archives the documents of a profile from a ZIP file of Markdown files (the layout the export writes), with a dry run and a report in the Activity Log - only changed files are imported, a document whose file is gone is archived (never deleted), and a file with an error is skipped and reported - New: Sections imported from Markdown are shown with the jrCore Markdown renderer (jrCore 7.1.0b1 - older versions show the text as it is) - New: Repository sync: a Gitea push webhook (Target URL /documentation/sync_webhook, signed with the webhook secret) imports the pushed commit of the configured branch in the background, and the Sync from Repository tool imports the branch on demand - new settings: repository read token and webhook secret - New: A repository chapter can list old chapter URLs in redirect_from in its _chapter.md - those URLs redirect (301) to the chapter once they have no documents left except archived ones - Change: The document, section and chapter re-order requests now check the request came from the site - Change: Repair Check now adds missing chapters to the chapter order on every run, not only when the chapter table is empty - Change: % and _ in a document search are now matched literally instead of acting as wildcards - Change: Related document links are only inserted in the text of a document, never inside an HTML tag - Change: The quota check is now only turned off for document searches on the search results page (it was turned off for every module) - Change: The fallback allowed file types now match the Global Config default - Change: A document URL with the wrong chapter or title now redirects (301) to the document's own URL - before, the document was shown under any chapter and title - Change: Code sections can be in any language (from Markdown) - languages other than PHP, JavaScript, HTML and CSS are shown without highlighting - Bug Fix: Adding a "Function Definition" section failed with an error on PHP 8 - Bug Fix: Images in documents restricted to a group other than "Profile Owner" could be viewed by anyone (regression in 1.5.10) - Bug Fix: Downloadable files in restricted documents could be downloaded by users who cannot view the document - Bug Fix: HTML entered in Function Definition parameter fields was not filtered and was shown as HTML - Bug Fix: Viewing a document that was not cached updated the document in the database on every view - Bug Fix: New documents could get the same order as other documents in the chapter, hiding the previous/next links (re-order the chapter once to fix existing documents) - Bug Fix: A chapter was missing from the documentation index when its first document was not visible to the viewer - Bug Fix: Images and files in sections added to another profile's document (by an admin or multi-profile user) were saved to the wrong profile and did not show - Bug Fix: Deleting a whole document now checks the request came from the site, the same as deleting a section - Bug Fix: "Show Table of Contents" unchecked on the Create form was ignored - Bug Fix: Changing a section to an unknown section type broke the whole document page - Bug Fix: A YouTube section saved input that was not a YouTube video (and full URLs when the YouTube module is not active), giving a broken player - Bug Fix: Deleting a function parameter could remove a comma from the function declaration - Bug Fix: Re-ordering could store order values for item IDs that do not exist - Bug Fix: Moving a document to a new chapter did not add the chapter to the chapter order (it showed last) and left the old chapter behind - Bug Fix: Related documents from the current profile were not listed first - Bug Fix: A document search with matches only in documents the viewer cannot see showed no "no topics found" message - Bug Fix: Related document links could be missing from a document, depending on which document the viewer opened first - Bug Fix: After a section could not be saved, the next new section could be saved in the wrong document with the wrong type - Bug Fix: Site search results listed documents the viewer cannot see because of their Viewable By setting, with their titles, links and chapter names - the document pages themselves were not found - Bug Fix: Export Documentation ran out of memory sending a large export ZIP file (the whole file was collected in the output buffer) - the export now shows a download link instead of starting the download, and the file can be downloaded again for a day - Developer: Removed an unused jrShareThis event listener - Developer: Chapter order is now only loaded for the profiles in a document list - Developer: The "is this chapter still used" check stops at the first match Version 1.5.11: - Change: Repair functions that were being run during an Integrity Check moved to Repair Check Version 1.5.10: - Change: Updates and optimizations to better support PHP 8+ Version 1.5.9: - Bug Fix: New lines added between paragraphs if using the editor Version 1.5.8: - Bug Fix: Cached images may not show in a document if view permissions were set to "Profile Owner" Version 1.5.7: - Change: Updated "search_item_ids" event listener to work properly with Search module 2.1.0+ Version 1.5.6: - Change: 'Category' language string in document forms changed to 'Chapter' - Bug Fix: Table of Contents may not have been listing new documents in the correct chapter Version 1.5.5: - Change: Reverted previous caching fix Version 1.5.4: - Change: Modified doc_section_screenshot.tpl so screenshot image resizes as page size is adjusted - Bug Fix: Some screenshot images for document items may load incorrectly - Bug Fix: Caching could stop the {jrProfile_disable_sidebar} template function from working Version 1.5.3: - Change: Fullscreen button for YouTube player now works Version 1.5.2: - New: Added a next chapter link to go to the next chapter when at the end of the current chapter Version 1.5.1: - Change: pressing tab to move between fields in forms has been improved - Bug Fix: documentation chapters not being reset during a Developer Tools -> System Reset Version 1.5.0: - New: "Image URL" option added to Text and Image and Screenshot sections for alternate URL - New: Updated so images look better on High DPI screens (text and Image sections) - Bug Fix: "Show Related Documents" still showing in create/update forms even if turned off - Bug Fix: Some documents may not show to all users if multiple groups selected in document Version 1.4.2: - New: Set meta details via Meta Tag Manager module for documentation detail pages - New: "Show Related Documents" can be disabled on a per-document basis Version 1.4.1: - Bug Fix: Profile sidebar was being disabled on document category view Version 1.4.0: - New: Integration with the Item Tags module to link tag words to tagged documents - New: {jrDocs_menu} template function to add a docs context menu - New: Syntax highlighter moved to the server side - Change: Focus on the search box text area when it is opened in the Table of Contents Version 1.3.4: - Change: Comments on admin or master only documents no longer records a Timeline entry Version 1.3.3: - New: Adding a document from an existing category page defaults to the selected category - Bug Fix: New documents added to existing categories may not get the correct document order - Bug Fix: 'Text and Image' block type image was not scaling at smaller resolutions Version 1.3.2: - Bug Fix: If using the Editor, bullet list bullets were not showing in text or text and image sections Version 1.3.1: - Bug Fix: The document header section could get out of order in some instances - Bug Fix: "Add New Section" button may not appear correctly in the container in some skins Version 1.3.0: - New: "Show Table of Contents" global config option to hide Table Of Contents - Bug Fix: Updating screenshot or text and image images may not show new image without refresh - Bug Fix: Documents with multiple "Viewable By" groups may not show correctly in Table of Contents Version 1.2.4: - Change: Improvement to how shared docs appear on facebook - Change: Highlighting added to the table of contents for docs set to admin only view - Bug Fix: Buttons could disappear and become unclickable under some circumstances, or stuck on Version 1.2.3: - Change: removed unused jquery.sortable.min.js file Version 1.2.2: - Bug Fix: added in missing language string for "Chapters" - Change: Updated tabs on chpaters and table of contents pages to use core provided profile tabs - Change: index_toc.tpl and item_index.tpl updated to use proper CSS classes for some sections Version 1.2.1: - New: "Enable Editor" Global Config Option of using the editor in Text and Text and Image sections Version 1.2.0: - New: "Table of Contents" tab added to profile documentation index page (new template: index_toc.tpl) - New: Top level chapter section is now sortable so the order of chapters can be re-arranged Version 1.1.3: - Bug Fix: Fix for anchor tags in the document could have empty id's Version 1.1.2: - Bug Fix: Adding a section while browsing profiles in a tab could change _profile_id on new section Version 1.1.1: - Change: The "header" document _updated timestamp is updated when a section is updated - Bug Fix: Ordering errors indicated audio items could not be found instead of documentation Version 1.1.0: - New: Ability to change documentation section type from modify section - Change: Text and Image will only show an image if it exists Version 1.0.15: - Bug Fix: Fix for incorrect error result function used on a couple views Version 1.0.14: - Bug Fix: possible 404 page not found when saving a document update Version 1.0.13: - Bug Fix: properly handles 301 moved for documentation that has changed location - Bug Fix: warning, hint and download images not working properly if replaced in images tab Version 1.0.12: - Change: Screenshot template updated to use lightbox2 instead of lightbox Version 1.0.11: - Bug Fix: Admin users not able to add HTML even if HTML allowed Version 1.0.10: - New: Form Designer support in Document create/update forms Version 1.0.9: - Bug Fix: Next Page button in document footer was linking to a page not found Version 1.0.8: - Bug Fix: included missing jquery.sortable.js Javascript file Version 1.0.7: - Bug Fix: Parameter description updates in Function table were not being saved Version 1.0.6: - Template updates to support new Item Action Buttons - Bug Fix: Page Title was not being set correctly on cached view Version 1.0.5: - Bug Fix: Bad URL for downloadable files if the user was not logged in - Bug Fix: first text entry with title in document may not show in table of contents Versin 1.0.4: - Bug Fix: Document update jumper was showing all document parts instead of the header documents Version 1.0.3: - Bug Fix: Cached pages with code blocks were not being syntax highlighted - URLs in code blocks are no longer clickable - Adding new Changelog Version 1.0.0: - Initial Release