Changes

Jump to: navigation, search

Rollover for the manual

2,784 bytes added, 02:20, 20 March 2020
Regenerate Version-Specific Content
== Rolling over the Gramps user manual ==
On this page, <code>5.x</code> refers to the 'old' (current) version of the manual - <code>5.z</code> refers to the new, to be created, version...
#Use phpmyadmin to backup all of the wiki tables (or the commandline if phpmyadmin times out!use the commandline )! ** [https://au.godaddy.com/help/exporting-mysql-database-in-ssh-26367 Command line:] <code>mysqldump -p -h hostname -u username database > dbname.sql</code>#Locate all pages on the wiki that have <code>5.x</code> in the title - from the {{man label|wiki menu: [[Special:AllPages|Tools > Special pages > All pages]]}}, page by page copy the text to get a full list of wiki pages.
#Copy/paste it into text processor - it may be in three columns separated by tabs. If so, use regular expression search/replace to replace tabs with carriage returns. Using GEDIT, best to replace <code>\t</code> with <code>\n</code> rather than <code>\r</code>. You now have a list of all files on the wiki, one title per line. Save it as a text file (I'll call it <code>myfile.txt</code> for this example).
#Use grep to find only the pages with <code>5.x</code> in the title: ''<code>grep "5\.x" myfile.txt > mynewfile.txt</code>'' The backslash will make the full stop a literal rather than trying to be part of a regular expression.
#Use a text editor to view the new file, and delete any pages that you don't want to roll over (That is, some pages may refer to <code>5.x</code> in the title, but are not pages that we want duplicated into <code>5.z</code>...)
#Go to the {{man label|wiki menu: [[Special:Export|Tools > Special pages > Export pages]]}} and Copy/paste the new list of page titles into the {{man label|Add pages manually:}} section then {{man menu|Be sure the checkbox is ticked for {{man label|Include only the current revision, not the full history}}}} and then to create the xml to screen press the {{man label|Export}} button.
#Copy/paste the xml into a text processor and use search/replace to replace <code>5.x</code> with <code>5.z</code>
#Save the file (I'll call it <code>export.xml</code> for this example).
===Update searchindex table===
Before doing this backup the database. {{man warn|Update searchindex table|New pages created by this sort of import do not automatically get added into the search index of the wiki. ''}} * Use phpmyadmin from the cpanel and use the repair tool (on the ''Operations'' tab and under ''table Maintenance>Repair table''for the <code>searchindex </code> table.''}}
===Set previous version pages to be protected===
https://www.mediawiki.org/wiki/Manual:Page_table#page_restrictions }}
I do Do that by using concatenation in a spreadsheet(call it <code>protectoldpages.xls</code>), creating the (long) SQL statements by combining a first part, the page names and the last part. You'll need to search for any single quotes and put a backslash in front of them in the page names first, too...
That updates a blob field to force protection without having to do the pages individually. You need to do the above sql statement for each page that you want to protect...
 
* Copy the resulting SQL statement to a text file <code>protectoldpages.txt</code>
* check the SQL statements syntax [https://www.piliapp.com/mysql-syntax-check/ here]
* Then run the SQL statement by either using phpmyadmin("SQL" tab to run the query) or the commandline.
 
Backup the database.
===Screenshots===
* <code>Edit-person-50-en.png</code>
We need to know if we keep the {number of version} or if we use the new one on migration (3.1->3.2->4.0->15.0...) ?
 
===Regenerate Version-Specific Content===
Update files dependency list :
''The documentation assumes the default (English-US) language on Linux''
 
Edit the manual section :
 
<code> https://gramps-project.org/wiki/index.php?title=Gramps_{{Version manual}}_Wiki_Manual_-_Command_Line&action=edit&section=8</code>
 
 
Copy (or pipe) the updated Gramps installation output from the command line Version option :
 
<code> gramps -v</code>
 
Replace any user-specific directory information with '''<~username>'''
 
If appropriate, please reference the Gramps [[Gramps_5.1_Wiki_Manual_-_User_Directory|User Directory]] page instead of redundantly explaining the directory paths under any of the multiuser OSes.
 
<code>&#91;&#91;Gramps_5.1_Wiki_Manual_-_User_Directory|User Directory]]</code>
 
Gramps user directory available on various operating systems.
 
==Version manual template==
Update the current ( {{Version manual}} ) version number using on [[:Template:Version_manual]] for pages outside of the user manual.
 
Manually update any REDIRECT pages also eg: "Third-party Addons" link redirects to 5.1 Addons etc..
 
==Email announcement==
Send the following email announcement (see embedded email) to the mailing list.
<!--
Hello,
 
Due to scheduled maintenance the Gramps Wiki services will be unavailable for most of the day on Sunday, 23rd of June 2019.
 
Please Note: during this offline period you may still be able to view the wiki.
 
The wiki software Mediawiki is being upgraded.
 
Then Gramps User Manual is being rolled over for the upcoming release of Gramps 5.1.x.
 
Apologies for any inconvenience that this may cause and thank you for patience and understanding.
 
Regards,
 
Sam
Volunteer Website Administrator
The Gramps Project
 
-->
<!--
Hello,
 
The rollover of the wiki user manual pages in preparation for the 5.1 version has been completed.
 
Please let me know if you see any obvious problems with the rollover.
 
Over the next few days, I'll be making all of the 5.0 manual pages non-editable, so please only edit the new 5.1 manual.
 
Sam
Volunteer Website Administrator
The Gramps Project
 
-->
==See also==
* [[User manual]]
* [[Manual Generation 3.0]]
* [[What to do for a release]]
[[Category:Developers/General]]

Navigation menu