Jump to content
teppo

Version Control

Recommended Posts

@Teppo,

here's the error;

i think this only happens on pages that actually have history for some fields; there is a page where we can add pages to this field, and i think possibly the only difference is that there is no history for any fields on that page

http://mysite.com/manage/page/edit/    Error:     Exception: Can't save field from page 1951: /catalogue/name-of-album-changed/: Call $page->setOutputFormatting(false) before getting/setting values that will be modified and saved.  [album_reviews] (in /home/someaccount/int/wire/core/Pages.php line 1110)  

#0 [internal function]: Pages->___saveField(Object(Page), 'album_reviews', Array)
#1 /home/someaccount/int/wire/core/Wire.php(389): call_user_func_array(Array, Array)
#2 /home/someaccount/int/wire/core/Wire.php(344): Wire->runHooks('saveField', Array)
#3 /home/someaccount/int/wire/core/Page.php(1180): Wire->__call('saveField', Array)
#4 /home/someaccount/int/wire/core/Page.php(1180): Pages->saveField(Object(Page), 'album_reviews', Array)
#5 /home/someaccount/int/wire/modules/Inputfield/InputfieldPageTable/InputfieldPageTableAjax.php(110): Page->save('album_reviews')
#6 /home/someaccount/int/wire/modules/Inputfield/InputfieldPageTable/InputfieldPageTableAjax.php(64): InputfieldPageTableAjax->addItem(Object(Page), Object(Field), Object(Page)) #7 [internal function]: Inputf

Share this post


Link to post
Share on other sites

great little module @teppo!

feature suggestions:

1. revision drafting/editing

I would absolutely love a way to create a draft for a new revision to be published in the future. Basically a way to create an unpublished revision of the document with ability to go in and work on it before pushing it live.

2. revision scheduling

And a "draft" revision scheduling would be the next on wishlist.

perhaps there is something already available to enable this without too much effort?

Share this post


Link to post
Share on other sites

great little module @teppo!

Thanks! :)

feature suggestions:

1. revision drafting/editing

I would absolutely love a way to create a draft for a new revision to be published in the future. Basically a way to create an unpublished revision of the document with ability to go in and work on it before pushing it live.

2. revision scheduling

And a "draft" revision scheduling would be the next on wishlist.

perhaps there is something already available to enable this without too much effort?

To be honest this seems to be out of the scope of this module. I've been going over your suggestions a few times in my head, and while I think I could probably implement something like that to this module if I really wanted, I don't really think it's a good idea. Drafts would most likely be easier to implement using a completely different approach.

Ryan took some steps towards drafts support a while ago, so you might want to see where that goes. If Ryan implements that as a core module, I've no interest in trying to duplicate similar behaviour here. Though I haven't used any of those that much, there's also Process Preview by Nico, Page Draft Creator by Rob, and Process Page Drafts by Jan Romero; you could always give one of these a try.

Share this post


Link to post
Share on other sites

I have two issues on my installlation running PW 2.5.20:

The first is regarding the history tab: Method Page::snapshot does not exist or is not callable in this context. It seems that Page Snapshot is not being installed. Uninstalling and re-installing the module doesn't seem to help.

Also, it seems that if I create a new field (CKEditor in this case), assign it to a template, fill it with data, and then assign it to version control, it doesn't track anything. However, after re-installing the module, it worked... I may have missed something, but somewhere, somehow, the process didn't seem right.

Share this post


Link to post
Share on other sites

@Mike: Just gave this a try, and I can't seem to reproduce either issue.

At what point exactly does the "Method Page::snapshot ..." error appear? When you load the page, when you hit preview, when you try to restore earlier revision, or somewhere else? Do you see any additional details, line numbers, etc.?

So far I'm thinking that it might be some weird compatibility issue (PHP, other modules, something) or perhaps a problem with autoload order -- though I might be totally off the track here too. Would be much easier to debug if I could somehow reproduce this :)

Another issue seems to be out of my reach too. Same workflow works for me as expected. In fact, I'm having trouble understanding how this could even happen in the first place -- if the field is enabled via Version Control module settings and other enabled fields are working as expected, this sounds really weird. If you can reproduce this, could you check that module config is actually saved to database?

Other factors that come to mind are some sort of (opcode) caching, and perhaps some installation weirdness related to either the native GUI install/update tool or modules manager. Absolutely not trying to pass the blame, but from what I've heard, both of these have had some issues. Never really used either one myself, which might or might not be the reason I've never had any installation issues either.. :)

Share this post


Link to post
Share on other sites

The error appears when I view the snapshot in the history tab.

I'm going to give this a try on a fresh dev-install tomorrow. I tried it on a dev site (with pretty much no modules installed, and no ModulesManager), and had the issues.

Will also check the config-saving. I'm sure it did though, because the module page updates, and keeps my settings after a refresh.

Share this post


Link to post
Share on other sites

I have problems with VersionControl. We use VersionControl for Textfields which conflicts with VersionControl, well actually with PageSnapShot.

VersionControl is not installed, but PageSnapShot still seems to be active. When I try to delete PageSnapShot I get a Server Error, when I try to delete VersionControl I get an error that VersionControl could not be deleted. When I refresh modules I get 

  •  Failed module dependency: PageSnapshot requires VersionControl

So I am somehow in a trap. Is it possible to remove VersionControl and PageSnapShot manually?

your help ids much appreciated.

Share this post


Link to post
Share on other sites

You can delete any module manually - just use something like PHPMyAdmin and browse/search the "modules" database table and remove the row for the module. Then remove the module folder from the server and you should be good. In the case of this module, there are also some additional db tables to remove, prefixed with "version_control", but be careful to remove the ones for the version of version control that you want to remove.

Also, note that Version Control supersedes Version Control for Textfields. The latter is only still around for older versions of PW.

  • Like 4

Share this post


Link to post
Share on other sites

Hi Adrian

will do so thanks. The thing is we use VersionControl for Textfield in an extended manner. Guess we will have to change that in due time.

Thanks a lot.

Share this post


Link to post
Share on other sites

@bbeer: additionally, if you're using the latest version of Version Control for Text Fields, there's an option in the module settings to *not* remove it's database tables when the module is uninstalled. The purpose of this is to make transition to Version Control easier: it should be able to import old data from Version Control for Text Fields during installation.

I've only done limited amount of tests with this feature, though, so I can't 100% guarantee that it will work. It has worked for me so far, but making backup copies of the module's tables might make sense if you're going to try it.

  • Like 3

Share this post


Link to post
Share on other sites

Would it be possible to add FieldtypeOptions to the supported fields? Currently it's not working.

P.S. Maybe the preview shouldn't close on clicking. It's throwing an error for me, but with SystemNotifications installed one can't look at the whole error message, because the click on the number closes the preview.

Share this post


Link to post
Share on other sites

Would it be possible to add FieldtypeOptions to the supported fields? Currently it's not working.

Added. You can add fields there locally via module settings too.

P.S. Maybe the preview shouldn't close on clicking. It's throwing an error for me, but with SystemNotifications installed one can't look at the whole error message, because the click on the number closes the preview.

I'll have to think about this a bit more. Current behaviour (closing on click) is intentional, partly to prevent weird things happening when something on the previewed page is clicked, can't remember if there were other reasons too. I'm getting some errors also; I'll take a closer look at those first :)

Edit: forget that last part. Errors were a result of local changes, the feature is working as expected again. @LostKobrakai, any chance you could tell more about the error(s) you were getting?

Either way, the click-to-close thing is something I'll take into consideration, but changing this just to make system notifications work doesn't seem reasonable. Displaying admin views in preview mode is something that shouldn't ever happen, after all :)

Edited by teppo

Share this post


Link to post
Share on other sites

I decided to not use version control for this project as this happened in the try out phase. Renobird's ActivityLog was a light alternative in this case. Therefore I can't follow up on your concerns before I'm a little bit less busy. 

Share this post


Link to post
Share on other sites

Some parts of this module, mainly those related to the cleanup features and settings, have been completely rewritten recently. I've also removed some old hacks, mainly from the UI side, that were carried over from Version Control for Text Fields. Test suite has been updated accordingly, and so far I've been unable to find any further issues, at least in the core features of this module.

While some todo items still remain, I've just bumped the version number of the module to 1.0.0, and removed the "beta" status from the modules directory and from the first post in this thread. 1.0.0 should be considered the first stable release of this module, but of course if anyone spots any issues, I'd be more than happy to hear about them, either here or via GitHub.

Big thanks to anyone who's been using this module, reporting issues, etc.!

  • Like 3

Share this post


Link to post
Share on other sites

 I'm looking for a way to move all the version control data from one page to another.

use case:

pageA= a draft page

pageB= source draft was cloned from

pageB need to replace pageA at some point but it has a shallow history.

pageA has a long and wonderful page history, but its going to get replaced by pageB and will lose it all. OH NO! (pageA will be deleted)

Trying to make a function that can copy the history from one page to another, got stuck on how to write the SQL. Wondering if you can give any tips.

 
 
  private function moveRevisionHistory($sourcePageId, $destinationPageId)
    {
        $database = $this->wire('database');
        $this->message("UPDATE version_control__revisions SET pages_id=$sourcePageId WHERE pages_id=$destinationPageId");
        $query = $database->prepare("UPDATE version_control__revisions SET pages_id=$sourcePageId WHERE pages_id=$destinationPageId");
        $query->execute();
        $query->closeCursor();
    }

This just changing the pages_id seems to break things, any tips on what else I need to update to move a page? there are a hand full of id's spanning across a few tables not sure what other id fields are storing "pages_id" information that would need to be updated. Maybe I have to update the parent field as well?

Update: Simplified way talking about it.

I am trying to move a history from one page to another page.

I am updating the pages_id, but that does not seem to do it. Do I also need to update the "parent" field some how?

Example SQL:

UPDATE version_control__revisions SET pages_id=$new_page_id_of_page_with_same_template WHERE pages_id=$page_id_to_update ;

Share this post


Link to post
Share on other sites

@Neeks: that sounds pretty much right; revisions table is the only one containing references to page ID, so changing it there should be enough. I can't think of anything else you'd need to do straight away, though I haven't attempted anything like that before either, so it's entirely possible that something isn't working quite right after this (like you've mentioned above).

Could you explain what exactly breaks after this? I might be able to help you if I knew what went wrong. Currently I'm busy with other stuff, and can't really set up a test case for this myself.

Share this post


Link to post
Share on other sites

@Teppo, thanks for confirming that is how it should work...I stepped away from my code and tried it with straight SQL and with hard coded page ID's and it worked. I did try this earlier, but I must have been working with not enough sleep (I was on the wrong server writing SQL and watching for results in the admin of another...sigh...)

Share this post


Link to post
Share on other sites

I've just tried this out using 3.0.20 and have some observations. In the setup I selected one template and several fields but left defaults for everything else. I did not select any image or file fields.

It created tables, including one in which I found information about images.

In the edit page for the template I enabled in setup just about every field has little clock icon on it, many of them no selected in setup.

edit: Many of these don't have any changes yet but still show an icon (distracting for users)

The fields I did select seem to work as intended and the others do not record changes, they just have the icons.

Any ideas about how to record changes made to a PageTableExtended field (pages saved as children, different template)?

Another question, when it installed and populated tables I wondered if that process is timeout proof (batching of some kind to handle thousands of pages).

Thanks.

Share this post


Link to post
Share on other sites

Hey @teppo, just tried the module on 2.8 and i get the error Argument 1 passed to VersionControl::isEnabledTemplate() must be an instance of Template on line 897, you have any idea of why that might be?

  • Like 1

Share this post


Link to post
Share on other sites

Just for info. The error diego reported is also in 3.x now. (Wasn't there until the last PW3 update)

Share this post


Link to post
Share on other sites
On 20.06.2016 at 5:36 PM, diogo said:

Hey @teppo, just tried the module on 2.8 and i get the error Argument 1 passed to VersionControl::isEnabledTemplate() must be an instance of Template on line 897, you have any idea of why that might be?

Got the same error on PW 3.0.25

Share this post


Link to post
Share on other sites

The issue mentioned above was related to a recent change in the core class InputfieldWrapper. I've just created an issue for this to the ProcessWire repository in GitHub (https://github.com/ryancramerdesign/ProcessWire/issues/1936) and updated VersionControl to circumvent this issue. If you update the module to the latest version, it should work again.

Sorry for the inconvenience!

/cc @diogo, @ceberlin, @Zeka

  • Like 5

Share this post


Link to post
Share on other sites

Anybody using this with Spex in their templates? When I click to preview revision in the history tab listings it accesses a url like...

/processwire/setup/version-control/preview/?pages_id=38172&revision=333

That causes...

Fatal error: Call to a member function setLayout() on null in...

Just asking in case it's come up before. Thanks.

 

Share this post


Link to post
Share on other sites

Sorry, I've never actually used Spex myself, but just a quick comment: that URL triggers the executePreview() method of ProcessVersionControl.module, which in turn tries to render the given page in a specific version. It sounds like rendering the page this way is a problem, though I have no idea why. Someone with proper understanding of Spex could probably answer that one :)

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By robert
      I often had the need for an overview of all used fields and their contents for a specific page/template while developing new websites without switching to the backend, so I made a small module which lists all the needed information in a readable manner (at least for me):
      Debug Page Fields
      https://github.com/robertweiss/ProcessDebugPageFields
      It adds two new properties to all pages:
      $page->debugFieldValues – returns an object with all (sub-)fields, their labels, fieldtypes and values $page->debugFieldTypes – returns an object with all fieldtypes and their corresponding fields // List all values of a pages $page->debugFieldValues // List a specific field $page->debugFieldValues->fieldname // List all used fieldtypes of a page $page->debugFieldTypes I recommend using it in combination with Tracy Debugger, Ray, Xdebug etc. as it returns an object and is only meant for developing/debugging uses. 
      For now, the fieldtype support includes mostly fieldtypes I use in my projects, but can easily be extended by adding a new FieldtypeFIELDNAME method to the module. I use it with five different client installations (all PW 3.0.*), but of course there might be some (or more) field configurations which are not covered correctly yet.
      Supported fieldtypes
      Button Checkbox Color Combo Datetime Email FieldsetPage * File FontIconPicker Functional Image ImageReference MapMarker Multiplier Mystique Options Page PageIDs PageTitle Radio Repeater * RepeaterMatrix * RockAwesome SeoMaestro Table Text Textarea Textareas Toggle URL * The fields with complete subfield-support also list their corresponding subfields.
      Installation
      Download the zip file at Github or clone the repo into your site/modules directory. If you downloaded the zip file, extract it in your sites/modules directory. In your admin, go to Modules > Refresh, then Modules > New, then click on the Install button for this module. As this is my first ›public‹ module, I hope I did not miss any important things to mention here.
    • By horst
      Wire Mail SMTP

      An extension to the (new) WireMail base class that uses SMTP-transport

      This module integrates EmailMessage, SMTP and SASL php-libraries from Manuel Lemos into ProcessWire. I use this continously evolved libraries for about 10 years now and there was never a reason or occasion not to do so. I use it nearly every day in my office for automated composing and sending personalized messages with attachments, requests for Disposition Notifications, etc. Also I have used it for sending personalized Bulkmails many times.

      The WireMailSmtp module extends the new email-related WireMail base class introduced in ProcessWire 2.4.1 (while this writing, the dev-branch only).
       
      Here are Ryans announcement.



      Current Version 0.6.0
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
      get it from the Modules Directory Install and Configure

      Download the module into your site/modules/ directory and install it.

      In the config page you fill in settings for the SMTP server and optionaly the (default) sender, like email address, name and signature.
      You can test the smtp settings directly there. If it says "SUCCESS! SMTP settings appear to work correctly." you are ready to start using it in templates, modules or bootstrap scripts.


      Usage Examples
      The simplest way to use it:
      $numSent = wireMail($to, $from, $subject, $textBody); $numSent = wireMail($to, '', $subject, $textBody); // or with a default sender emailaddress on config page This will send a plain text message to each recipient.
       
      You may also use the object oriented style:
      $mail = wireMail(); // calling an empty wireMail() returns a wireMail object $mail->to($toEmail, $toName); $mail->from = $yourEmailaddress; // if you don't have set a default sender in config // or if you want to override that $mail->subject($subject); $mail->body($textBody); $numSent = $mail->send(); Or chained, like everywhere in ProcessWire:
      $mail = wireMail(); $numSent = $mail->to($toEmail)->subject($subject)->body($textBody)->send(); Additionaly to the basics there are more options available with WireMailSmtp. The main difference compared to the WireMail BaseClass is the sendSingle option. With it you can set only one To-Recipient but additional CC-Recipients.
      $mail = wireMail(); $mail->sendSingle(true)->to($toEmail, $toName)->cc(array('person1@example.com', 'person2@example.com', 'person3@example.com')); $numSent = $mail->subject($subject)->body($textBody)->send(); The same as function call with options array:
      $options = array( 'sendSingle' => true, 'cc' => array('person1@example.com', 'person2@example.com', 'person3@example.com') ); $numSent = wireMail($to, '', $subject, $textBody, $options); There are methods to your disposal to check if you have the right WireMail-Class and if the SMTP-settings are working:
      $mail = wireMail(); if($mail->className != 'WireMailSmtp') { // Uups, wrong WireMail-Class: do something to inform the user and quit echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; return; } if(!$mail->testConnection()) { // Connection not working: echo "<p>Couldn't connect to the SMTP server. Please check the {$mail->className} modules config settings!</p>"; return; }  
      A MORE ADVANCED DEBUG METHOD!
      You can add some debug code into a template file and call a page with it:
      $to = array('me@example.com'); $subject = 'Wiremail-SMTP Test ' . date('H:i:s') . ' äöü ÄÖÜ ß'; $mail = wireMail(); if($mail->className != 'WireMailSmtp') { echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; } else { $mail->from = '--INSERT YOUR SENDER ADDRESS HERE --'; // <--- !!!! $mail->to($to); $mail->subject($subject); $mail->sendSingle(true); $mail->body("Titel\n\ntext text TEXT text text\n"); $mail->bodyHTML("<h1>Titel</h1><p>text text <strong>TEXT</strong> text text</p>"); $dump = $mail->debugSend(1); } So, in short, instead of using $mail->send(), use $mail->debugSend(1) to get output on a frontend testpage.
      The output is PRE formatted and contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection, like this one:
       
      Following are a ...


      List of all options and features


      testConnection () - returns true on success, false on failures


      sendSingle ( true | false ) - default is false

      sendBulk ( true | false ) - default is false, Set this to true if you have lots of recipients (50+)


      to ($recipients) - one emailaddress or array with multiple emailaddresses

      cc ($recipients) - only available with mode sendSingle, one emailaddress or array with multiple emailaddresses

      bcc ($recipients) - one emailaddress or array with multiple emailaddresses

       
      from = 'person@example.com' - emailaddress, can be set in module config (called Sender Emailaddress) but it can be overwritten here

      fromName = 'Name Surname' - optional, can be set in module config (called Sender Name) but it can be overwritten here


      priority (3) - 1 = Highest | 2 = High | 3 = Normal | 4 = Low | 5 = Lowest

      dispositionNotification () or notification () - request a Disposition Notification


      subject ($subject) - subject of the message

      body ($textBody) - use this one alone to create and send plainText emailmessages

      bodyHTML ($htmlBody) - use this to create a Multipart Alternative Emailmessage (containing a HTML-Part and a Plaintext-Part as fallback)

      addSignature ( true | false ) - the default-behave is selectable in config screen, this can be overridden here
      (only available if a signature is defined in the config screen)

      attachment ($filename, $alternativeBasename = "") - add attachment file, optionally alternative basename


      send () - send the message(s) and return number of successful sent messages


      debugSend(1) - returns and / or outputs a (pre formatted) dump that contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection. (See above the example code under ADVANCED DEBUG METHOD for further instructions!)


      getResult () - returns a dump (array) with all recipients (to, cc, bcc) and settings you have selected with the message, the message subject and body, and lists of successfull addresses and failed addresses,


      logActivity ($logmessage) - you may log success if you want

      logError ($logmessage) - you may log warnings, too. - Errors are logged automaticaly
       
       
      useSentLog (true | false) - intended for usage with e.g. third party newsletter modules - tells the send() method to make usage of the sentLog-methods - the following three sentLog methods are hookable, e.g. if you don't want log into files you may provide your own storage, or add additional functionality here

      sentLogReset ()  - starts a new LogSession - Best usage would be interactively once when setting up a new Newsletter

      sentLogGet ()  - is called automaticly within the send() method - returns an array containing all previously used emailaddresses

      sentLogAdd ($emailaddress)  - is called automaticly within the send() method
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
       
       
    • By Cybermano
      Food Allergens Module
      A simple List of Food Allergens
      My needs were to provide a simple list of food allergens for our clients with restaurant related activity.
      The idea was to simply output the list (to speed up the data entry) without leaving the food menu editing, eg. opening another page in new tab or window.
      This isn't a perfect solution, but it works fine for my needs and I decided to share the base idea.
      This could also be easily used to show little notes or short "vademecum", not only for the list of food allergens.
      ---
      Main features
      The basis
      All moves from a short editing of the module in this tutorial: How to create custom admin pages by @bernhard
      First of all it creates an empty admin page, with a dedicated permission to let safe-user to see it (this permission has to be created as a new ones, manually or by the module).
      Once the page is created, I have hooked its behaviour into the ready.php, to show the content (basically a list).
      A step further
      With the tips of  @bernhard, @Soma (and many others), see here , the magic happens. 
      The new page will be shown as a panel, so editors will not abandon their data entry to have a quick view to the list.
      A little further
      Why scroll to the top of the page to click a link?
      The next step was to create a sticky button only in the food menu pages.
      Again with a @bernhard tip I moved into the customization of this simple module and the related hook.
      ---
      How to use this module
      After installed, it creates the page /admin/page/allergens/ and the module is to be setted up. The first field is a CKEditor with multi-language. This is the place where to write the informations that will be shown into the page. The next field is a simply text-area where to place a bit of JS that will be appended to the markup of the text (omit the 'script' tags). I also putted a checkbox with a silly statement: this to think at least twice on the safety of the written JS. Now comes the first way to display the link to the page
      Field Note with Link. Enable and save it. The module will display a new row with 4 selects (1 standard and 3 ASM):
      View mode (to show the page as Panel or as Modal PopUp); Templates to select: select one or more and save before proceed, so the  asm-select of the pages will be populated showing all the pages of the selected templates. Pages to select: also here select at least one and save before proceed to populate the asm-select for fields only with the ones that belong to the selected pages. Select the fields where to place the note and save again. That's all: now you will find into the notes of the selected fields the link "See the List of Allergens".
      At the same way, the option for the sticky button, but with a plus
      The field select is obviously unnecessary, but you could play with the last row: the inline styles to fix your sticky button where you like. Here you could set the sticky position of the <div> and the absolute ones of the <a>.

      Video Explanation
      In these screencasts you could see a custom JS that show a "copy" button near a "hanna-code" call.
      This because I've set a specific one for each allergen to show up a tooltip in the front end.

      Registrazione #33.mp4  

      Registrazione #34.mp4 ---
      Last but not the least
      Actually it works fine for my needs, even if it's much improvable: I'm working on the permissions creation, the uninstall section, a separate configs and defaults and how to include the hook into the module leaving free the ready.php. According to a simpler uninstall. Also I would make the link text as a dynamic text field, so it will be more flexible.
      I always learn a lot here, so I would share my code for whom it could be interested.
      I removed the hanna code references, but I provide you the html list of the allergens, English and Italian too, so you can paste them into the "source" of the CKEditor field to have a ready to use module.
      Obviously you are free to modify the code as per your needs.
      Please, keep in mind that I'm not a pro coder and I beg your pardon for my verbosity (speaking and coding). 😉
      I hope be helpful or for inspiration.
      Bye
      ready.phpList-ITA.htmlList-ENG.htmlAllergens.module
      README.md
    • By Robin S
      This module is sort of an upgrade to my earlier ImageToMarkdown module, and might be useful to anyone working with Markdown in ProcessWire.
      Copy Markdown
      Adds icons to images and files that allow you to copy a Markdown string to the clipboard. When you click the icon a message at the top left of the screen notifies you that the copying has occurred.
      Screencast

      Note: in the screencast an EasyMDE inputfield is used to preview the Markdown. It's not required to use EasyMDE - an ordinary textarea field could be used.
      Usage: Images
      When you hover on an item in an Images field an asterisk icon appears on the thumbnail. Click the icon to copy an image Markdown string to clipboard. If the "Description" field is populated it is used as the alt text.
      You can also open the "Variations" modal for an image and click the asterisk icon to copy an image Markdown string for an individual variation.
      Usage: Files
      When you hover on an item in a Files field an asterisk icon appears next to the filename. Click the icon to copy a link Markdown string to the clipboard. If the "Description" field is populated it is used as the link text, otherwise the filename is used.
       
      https://github.com/Toutouwai/CopyMarkdown
      https://processwire.com/modules/copy-markdown/
    • By BitPoet
      I've realized that I've been jumping back and forth between the PW API docs and the source code for site modules far too much. The idea to hold all necessary documentation locally in one place has occurred to me before, but getting PHPDocumentor et al set up and running reliably (and producing readable output) as always been too much of a hassle. Today I was asked how I find the right hooks and their arguments, and that inspired me to finally get my backside down on the chair and whip something up, namely the
      Module Api Doc Viewer
      ProcessModuleApiDoc
      It lets you browse the inline documentation and public (optionally also protected) class/method/property information for all modules, core classes and template files in the ProcessWire instance. The documentation is generated on the fly, so you don't have to remember to update your docs whenever you update a module.
      The module is quite fresh, so expect some bugs there. Behind the scenes it uses PHP-Parser together with a custom class that extracts the information I needed, and the core TextformatterMarkdownExtra module for rendering the description part in the phpdoc style comments.
      This is not a replacement / competitor to the API Viewer included in the commercial ProDevTools package. There is quite some information included in the inline documentation that my module can't (and won't) parse, but which makes up parts of the official ProcessWire API docs.
      This, instead, is a kind of Swiss army knife to view PHPDoc style information and get a quick class or function reference.
      If you feel daring and want to give it a spin, or if you just want to read a bit more, visit the module's GitHub repository.
      This is the overview page under "Setup" -> "Module API Docs":

      And this is what the documentation for an individual class looks like:

      The core module documentation can of course be found online, but it didn't make sense not to include them.
      Let me know what you think!

×
×
  • Create New...